# Get search queries (/api/analytics/searches)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1714 · updated: 2026-07-30 -->
Related: [Get feedback](/api/analytics/feedback.md), [Get feedback by page](/api/analytics/feedback-by-page.md), [Get assistant conversations](/api/analytics/assistant-conversations.md), [Get assistant caller stats](/api/analytics/assistant-caller-stats.md), [Get page views](/api/analytics/views.md), [Get unique visitors](/api/analytics/visitors.md)

## Usage [#usage]

Use this endpoint to export documentation search analytics. Results are ordered by hit count descending, showing which terms your users search for most.

Paginate through results using the `nextCursor` parameter returned in the response. Continue fetching while `nextCursor` is not null.

## Filtering [#filtering]

Filter search data by date range using `dateFrom` and `dateTo` parameters.

## Rate limits [#rate-limits]

This endpoint allows 100 requests per organization per hour. All analytics endpoints share this limit.

`GET /v1/analytics/{projectId}/searches`

Returns paginated documentation search terms for the date range, ordered by hit count descending. Each row includes click-through rate, the most-clicked result path for that query (if any), and the last time the term was searched. `totalSearches` is the total number of search query events in the same date range (sum of all hits, not distinct queries).

Authenticate with an admin API key.

## OpenAPI

```json
{
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard."
      },
      "required": true,
      "name": "projectId",
      "in": "path"
    },
    {
      "schema": {
        "type": "string",
        "description": "Date in ISO 8601 or YYYY-MM-DD format",
        "example": "2024-01-01"
      },
      "required": false,
      "name": "dateFrom",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "description": "Date in ISO 8601 or YYYY-MM-DD format. `dateTo` is an exclusive upper limit. Results include dates before, but not on, the specified date.",
        "example": "2024-01-01"
      },
      "required": false,
      "name": "dateTo",
      "in": "query"
    },
    {
      "schema": {
        "type": "number",
        "minimum": 1,
        "maximum": 100,
        "default": 50,
        "description": "Max search terms per page (ordered by hit count descending)"
      },
      "required": false,
      "name": "limit",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "description": "Opaque pagination cursor from the previous response"
      },
      "required": false,
      "name": "cursor",
      "in": "query"
    }
  ],
  "responses": {
    "200": {
      "description": "Search term aggregates with pagination",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "searches": {
                "type": "array",
                "description": "Search terms ordered by hit count descending.",
                "items": {
                  "type": "object",
                  "properties": {
                    "searchQuery": {
                      "type": "string",
                      "description": "The search term entered by users."
                    },
                    "hits": {
                      "type": "number",
                      "description": "Number of times this term was searched."
                    },
                    "ctr": {
                      "type": "number",
                      "description": "Click-through rate for this search term."
                    },
                    "topClickedPage": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "The most-clicked result path for this query, if any."
                    },
                    "lastSearchedAt": {
                      "type": "string",
                      "description": "Timestamp of the last time this term was searched."
                    }
                  },
                  "required": [
                    "searchQuery",
                    "hits",
                    "ctr",
                    "topClickedPage",
                    "lastSearchedAt"
                  ]
                }
              },
              "totalSearches": {
                "type": "integer",
                "minimum": 0,
                "description": "Total count of search events in the requested date range (sum of all hits, not distinct queries)."
              },
              "nextCursor": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Opaque pagination cursor for the next page. Null if no more results."
              }
            },
            "required": [
              "searches",
              "totalSearches",
              "nextCursor"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Invalid query parameters or cursor",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Error message describing what went wrong."
              },
              "details": {
                "type": "array",
                "description": "Additional details about the error.",
                "items": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Description of a specific validation or processing error."
                    }
                  },
                  "required": [
                    "message"
                  ]
                }
              }
            },
            "required": [
              "error"
            ]
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Error message describing what went wrong."
              },
              "details": {
                "type": "array",
                "description": "Additional details about the error.",
                "items": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Description of a specific validation or processing error."
                    }
                  },
                  "required": [
                    "message"
                  ]
                }
              }
            },
            "required": [
              "error"
            ]
          }
        }
      }
    }
  }
}
```