Skip to main content
GET
Get search queries

Uso

Usa este endpoint para exportar el análisis de búsqueda de la documentación. Los resultados se ordenan de mayor a menor número de resultados, mostrando los términos que más buscan tus usuarios. Pagina los resultados usando el parámetro nextCursor devuelto en la respuesta. Continúa obteniendo resultados mientras nextCursor no sea nulo.

Filtrado

Filtra los datos de búsqueda por rango de fechas usando los parámetros dateFrom y dateTo.

Límites de uso

Este endpoint permite 100 solicitudes por organización por hora. Todos los endpoints de analytics comparten este límite.

Autorizaciones

Authorization
string
header
requerido

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.

Parámetros de ruta

projectId
string
requerido

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

Parámetros de consulta

dateFrom
string

Date in ISO 8601 or YYYY-MM-DD format

Ejemplo:

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

Ejemplo:

"2024-01-01"

limit
number
predeterminado:50

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

Rango requerido: 1 <= x <= 100
cursor
string

Opaque pagination cursor from the previous response

Respuesta

Search term aggregates with pagination

searches
object[]
requerido

Search terms ordered by hit count descending.

totalSearches
integer
requerido

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

Rango requerido: x >= 0
nextCursor
string | null
requerido

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

Temas relacionados

Analíticasllms.txtSEO