AnalyticsPopular search queries

Popular search queries

Search queries ranked by frequency, highest first. Set noResultsOnly to true to return only queries that returned zero results, which is the fastest way to find content gaps.

curl -X GET "https://api.documentationai.app/api/v1/analytics/search/queries?startDate=2026-05-01&endDate=2026-05-31&limit=20&offset=0&noResultsOnly=false" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "startDate": "example_string",
  "endDate": "example_string",
  "queries": [
    {
      "query": "example_string",
      "count": 10,
      "noResults": true,
      "clicks": 42,
      "aiEscalations": 42
    }
  ],
  "total": 42
}
GET
/analytics/search/queries
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...
query
startDatestring

First UTC day to include, as YYYY-MM-DD. Defaults to six days before endDate. The range must not exceed 90 days.

Pattern: ^\d{4}-\d{2}-\d{2}$
query
endDatestring

Last UTC day to include, as YYYY-MM-DD. Inclusive — the whole day is counted. Defaults to today.

Pattern: ^\d{4}-\d{2}-\d{2}$
query
limitinteger

Maximum number of rows to return

Min: 1 • Max: 100
query
offsetinteger

Number of rows to skip. Combined with total, this is how you page through results.

Min: 0
query
noResultsOnlyboolean

Return only queries that produced zero results

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

Query Parameters

startDatestring

First UTC day to include, as YYYY-MM-DD. Defaults to six days before endDate. The range must not exceed 90 days.

Example:
2026-05-01
endDatestring

Last UTC day to include, as YYYY-MM-DD. Inclusive — the whole day is counted. Defaults to today.

Example:
2026-05-31
limitinteger

Maximum number of rows to return

offsetinteger

Number of rows to skip. Combined with total, this is how you page through results.

noResultsOnlyboolean

Return only queries that produced zero results

Responses

startDatestring
endDatestring
queriesarray
totalinteger