Searching API

The search endpoint will provide a list of search results. Each search result by default has a title, URL and if any, html content of the relevant section.

These API attributes are completely customized from mapping in the Keyspider dashboard.

Endpoint

GET https://app.keyspider.io/api/v1/{{Organization-Id}}/{{API-Key}}/search

Try Yourself: Searching API Swagger workplace

Description: You can interact with the live API to experience and explore the capabilities of the Searching API. The demo allows you to simulate API requests, view responses, and understand how the Searching API functions in a real-world scenario. Feel free to input different search queries or words to see how the API responds with search results with relevant information.

Query Parameters

• q (required): The search query string.
• start (optional): The index of the first search result to retrieve (default is 0).
• rows (optional): The number of search results to retrieve per request (default is 10).

Request Example

curl -X 'GET' 
  'https://app.keyspider.io/api/v1/16575912397417890_8007/80rf53f98adf5526f2b5fffffbf55b24/search?q=freshworks&start=0&rows=10' 
  -H 'accept: application/json'

Response

The response will include a list of search results matching the provided query and parameters.

Response Format

The response is in JSON format and contains information about the search results.

Response Structure

• code: The HTTP status code indicating the success of the request (200 for success).
• message: A status message indicating the success of the operation.
• numFound: The total number of search results found.
• response: Details about the search results.
  • docs: An array of individual search result documents.
    • body: Content of the search result.
    • id: Unique identifier of the result.
    • title: Title of the result.
    • url: URL of the result.
• highlight_v2: An array of search result highlights.
  • body: The highlighted content of the result.
  • id: Unique identifier for the result.
  • title: The highlighted title of the result.
  • url: The URL of the result.
• start: The starting index of the results in the full list.
• track_id: A unique tracking ID for this API request.

Example Response

{
  "code": 200,
  "message": "success",
  "numFound": 230,
  "response": {
    "docs": [
      {
        "body": [
          "Ask questions and find answers on the community. Connect with others and share feedback on our Products. Join the community.",
        ],
        "id": "1ec7b62935299086",
        "title": [
          "Freshworks Academy | Refresh Community"
        ],
        "url": [
          "https://community.freshworks.com/freshworks-academy-10030"
        ]
      },
      {
        "body": [
            "Greetings Freshworks Community members! We have a proposition for you, one that will unveil a world of exclusive benefits and extraordinary experiences. We are keeping the finer details under wraps for now.",
        ],
        "id": "228696e731d36a72",
        "title": [
            "Unlock the gates of the Freshworks inner circle | Freshworks Community"
        ],
        "url": [
            "https://community.freshworks.com/announcements-and-events-11308/unlock-the-gates-of-the-freshworks-inner-circle-32185"
        ]
      },
    ]
  },
  "highlight_v2": [
    {
      "body": [
        "<em>Freshworks</em> Academy Ask questions and find answers on the community. Connect with others and share feedback on our Products. Join the community."
      ],
      "id": "1ec7b62935299086",
      "title": [
        "<em>Freshworks</em> Academy | Refresh Community"
      ],
      "url": [
        "https://community.freshworks.com/<em>freshworks</em>-academy-10030"
      ]
    },
    {
        "body": [
                "Greetings <em>Freshworks</em> Community members! We have a proposition for you, one that will unveil a world of exclusive benefits and extraordinary experiences. We are keeping the finer details under wraps for now."
        ],
        "id": "228696e731d36a72",
        "title": [
                "Unlock the gates of the <em>Freshworks</em> inner circle | Freshworks Community"
        ],
        "url": [
                "https://community.freshworks.com/announcements-and-events-11308/unlock-the-gates-of-the-<em>Freshworks</em>-inner-circle-32185"
        ]
     },
  ],
  "start": 0,
  "track_id": "1-64ce5f57-3f4725333e59e94e285a9e8c"
}

Note

This API response provides detailed information about search results, including highlighted content and URLs. Make sure to integrate this API response effectively into your application for a seamless user experience.