---
title: "REST API: Get Search Activity Analytics"
type: "wiki"
space: "Axero Documentation"
author: "Vladana Garic"
created: 2024-12-16T17:09:51Z
updated: 2026-09-07T03:23:04Z
url: "https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/106624/rest-api-get-search-activity-analytics"
---

# REST API: Get Search Activity Analytics

[Open API Guide](https://my.axerosolutions.com/spaces/5/axero-documentation/api-guide?id=106624)
GET/api/search/activity

Enables administrators and developers to programmatically retrieves analytics data for search activity, including search frequency, popular queries, and search trends over time.

## Request

### Request Header
| Header | Required | Value | Description |
| :--- | :--- | :--- | :--- |
| `Authorization` | YES | `Bearer YOUR_TOKEN` | Bearer token for the authenticated user. [Learn how to create Bearer tokens](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens). |
### Required Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `StartPage` | Integer | YES | Query | Specifies the starting page of list to be returned |
| `PageLength` | Integer | YES | Query | Specifies the number of results to be returned per page |
### Optional Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `SpaceID` | Integer | NO | Query | Unique 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 |
| `StartDate` | String | NO | Query | Start of the range, ISO 8601 \(for example 2026-08-01 or 2026-08-01T00:00:00Z\). A value without a time zone designator is read in the calling user's time zone and converted to UTC; a value that is not a date answers 500. |
| `EndDate` | String | NO | Query | End of the range, ISO 8601 \(for example 2026-08-31 or 2026-08-31T23:59:59Z\). A value without a time zone designator is read in the calling user's time zone and converted to UTC; a value that is not a date answers 500. |
| `Term` | String | NO | Query | Specifies the search term to display results. |
| `UserID` | Integer | NO | Query | User ID to return results for. |
## Example

### Request Header

```
Authorization: Bearer YOUR_TOKEN
```

### Request URL

`https://your-site.com/api/search/activity?startPage=1&pageLength=2`

### Success Response

```
{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "SearchTerm": "dpt",
      "UserID": 626,
      "UserDisplayName": "Dave Trowbridge",
      "UserProfileURL": "https://your-site.com/people/dave",
      "DateSearched": "2026-07-07T19:16:57.52",
      "DateSearchedString": "7/7/2026",
      "ClickedEntityID": 0,
      "ClickedEntityType": 0,
      "SearchCount": 0,
      "ClickCount": 0,
      "ClickThroughRate": 0.0,
      "TenantID": 0
    }
  ]
}
```

### Error Response

```
{
  "Message": "No HTTP resource was found that matches the request URI 'https://your-site.com/api/search/activity?PageLength=5'."
}
```

## Error Handling

| Status Code | Likely Cause | Next Action |
| :--- | :--- | :--- |
| 400 Bad Request | One or more required fields are missing or invalid. \(startPage, pageLength\) | Verify the request payload against the required parameters. |
| 401 Unauthorized | Missing or invalid Bearer token. | Check token validity. [Learn how to create Bearer tokens →](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens) |
| 403 Forbidden | User does not have sufficient permissions. | Confirm the user has the required roles for this action. |
| 500 Server Error | StartDate or EndDate is not a date, or another internal failure. | Send ISO 8601 dates; then retry later. |
| 404 or 405 | A required query parameter was left out, so the request matched a different action or none: the message reads No HTTP resource was found or The requested resource does not support http method. | Send every required query parameter; the message is not about the resource. |

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