AnalyticsSearch summary

Search summary

Total searches, sessions, no-result rate, and click-through rate for a date range. Returns zeroes when the range contains no search activity.

curl -X GET "https://api.documentationai.app/api/v1/analytics/search?startDate=2026-05-01&endDate=2026-05-31" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "startDate": "example_string",
  "endDate": "example_string",
  "totalSearches": 42,
  "sessions": 42,
  "noResultRate": 3.14,
  "clickThroughRate": 3.14
}
GET
/analytics/search
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}$
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

Responses

startDatestring
endDatestring
totalSearchesinteger
sessionsinteger

Distinct sessions that performed at least one search

noResultRatenumber

Share of searches that returned zero results, 0-1

clickThroughRatenumber

Share of searches where a result was clicked, 0-1