Skip to main content
GET
Get search queries

Utilisation

Utilisez cet endpoint pour exporter les analyses de recherche de la documentation. Les résultats sont triés par nombre de résultats décroissant, montrant les termes que vos utilisateurs recherchent le plus. Parcourez les résultats à l’aide du paramètre nextCursor renvoyé dans la réponse. Continuez à effectuer des requêtes tant que nextCursor n’est pas nul.

Filtrage

Filtrez les données de recherche par plage de dates à l’aide des paramètres dateFrom et dateTo.

Limites de débit

Cet endpoint autorise 100 requêtes par organisation et par heure. Tous les endpoints d’analytics partagent cette limite.

Autorisations

Authorization
string
header
requis

The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the API keys page in your dashboard.

Paramètres de chemin

projectId
string
requis

Your project ID. Can be copied from the API keys page in your dashboard.

Paramètres de requête

dateFrom
string

Date in ISO 8601 or YYYY-MM-DD format

Exemple:

"2024-01-01"

dateTo
string

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.

Exemple:

"2024-01-01"

limit
number
défaut:50

Max search terms per page (ordered by hit count descending)

Plage requise: 1 <= x <= 100
cursor
string

Opaque pagination cursor from the previous response

Réponse

Search term aggregates with pagination

searches
object[]
requis

Search terms ordered by hit count descending.

totalSearches
integer
requis

Total count of search events in the requested date range (sum of all hits, not distinct queries).

Plage requise: x >= 0
nextCursor
string | null
requis

Opaque pagination cursor for the next page. Null if no more results.