Loading ...

REST API: Get Search Analytics | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Analytics » REST API: Get Search Analytics
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 25

REST API: Get Search Analytics

0 
 /5
0 (0votes)
Open API Guide
GET/api/searchqueries

Enables administrators and developers to programmatically retrieve a list of search queries such as keywords, click counts and click-through rate for each keyword.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
StartPageIntegerYESQuerySpecifies the starting page of list to be returned
PageLengthIntegerYESQuerySpecifies the number of results to be returned per page

Optional Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerNOQueryUnique ID of the space from which the content is to be returned.Don't pass any value if you want content from every space, where you have access
StartDateStringNOQueryStart date of range to Search history. The date format is YYYY-MM-DD:HH:mm:ssZ. 
EndDateStringNOQueryEnd date of range to Search history. The date format is YYYY-MM-DD:HH:mm:ssZ. 
SearchTermStringNOQuerySpecifies the search term to display results. Note: Only available in version 20 and above.
PersonIntegerNOQueryUser ID to return results for. Note: Only available in version 20 and above.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/searchqueries?startPage=1&pageLength=10

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "SearchTerm": "a",
      "UserID": 0,
      "DateSearched": "0001-01-01T00:00:00",
      "SearchCount": 925,
      "ClickCount": 154,
      "ClickThroughRate": 0.16648648648648648
    }
  ]
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (startPage, pageLength)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages