Loading ...

REST API: Get Search Content Analytics | Axero Documentation

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

REST API: Get Search Content Analytics

0 
 /5
0 (0votes)
Open API Guide
GET/api/search/content

Get a list of Search Content Analytics, such as search terms, content titles, and click counts for each entry

Request

Request Header

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

Optional Parameters

ParameterTypeRequiredLocationDescription
StartPageIntegerNOQuerySpecifies the starting page of list to be returned (defaults to 1 if not provided)
PageLengthIntegerNOQuerySpecifies the number of results to be returned per page. (defaults to 20)
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
EntityTypeIDIntegerNOQueryThe entity type ID of the content to be returned. Here are the values of EntityTypeID parameter: Forum = 1, ForumGroup = 2, Article = 3, Blog = 4, Photo = 6, Video = 7, Wiki = 9, CMSPage = 12, File = 14, Album = 18, Idea = 44, ForumPost = 54, ForumTopic = 55
noOfSearchTermResultIntegerNOQuerySpecifies the maximum number of search terms to include for each piece of content (defaults to 20)

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/search/content

Success Response

{
  "IsError": false,
  "ResponseMessage": "Success message.",
  "ResponseData": [
    {
      "ContentID": 220,
      "EntityTypeID": 1,
      "ContentTypeID": 3,
      "ContentTypeText": "Article",
      "ContentTitle": "Open Enrollment Starts Today! Time to Choose Your          Health Plan for This Upcoming Year",
      "SpaceID": 252,
      "SpaceName": "Human Resources",
      "ClickCount": 25,
      "SearchTerms": "a,benefits,open enroll,open enrollment"
    },
    {
      "ContentID": 220,
      "EntityTypeID": 1,
      "ContentTypeID": 3,
      "ContentTypeText": "Article",
      "ContentTitle": "The Value of Processes and Procedures in the Work          place",
      "SpaceID": 252,
      "SpaceName": "Human Resources",
      "ClickCount": 32,
      "SearchTerms": "value,work"
    }
  ]
}

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.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