Obtener consultas de búsqueda

Obtén los términos de búsqueda de la documentación con conteos de búsquedas, tasas de clics y las páginas más clicadas.

GET /v1/analytics/{projectId}/searches

Obtener consultas de busqueda

cURL

curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/searches \
  --header 'Authorization: Bearer <token>'

200

{
  "searches": [
    {
      "searchQuery": "<string>",
      "hits": 123,
      "ctr": 123,
      "topClickedPage": "<string>",
      "lastSearchedAt": "<string>"
    }
  ],
  "totalSearches": 1,
  "nextCursor": "<string>"
}

​

Uso

Usa este endpoint para exportar los datos analíticos de búsqueda de tu documentación. Los resultados se ordenan por número de búsquedas de forma descendente, 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 null.

​

Filtrado

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

​

Datos de respuesta

Cada entrada de término de búsqueda incluye:

• searchQuery: El término de búsqueda introducido por los usuarios
• hits: Número de veces que se buscó este término
• ctr: Tasa de clics para este término de búsqueda
• topClickedPage: La ruta del resultado más clicado para esta consulta, si existe
• lastSearchedAt: Marca de tiempo de la última vez que se buscó este término

La respuesta también incluye totalSearches, que es el conteo total de todos los eventos de búsqueda en el rango de fechas solicitado (suma de todos los hits, no consultas distintas).

Autorizaciones

Authorization · string · header · requerido

El encabezado Authorization requiere un token Bearer. Usa una clave de API de administrador (con el prefijo mint_). Esta es una clave secreta del lado del servidor. Genérala en la página de claves de API de tu dashboard.

Parámetros de ruta

projectId · string · requerido

Tu ID de proyecto. Puedes copiarlo desde la página API keys en tu dashboard.

Parámetros de consulta

dateFrom · string

Fecha en formato ISO 8601 o AAAA-MM-DD

Ejemplo:

"2024-01-01"

dateTo · string

Limite superior exclusivo

Ejemplo:

"2024-01-01"

limit · number · predeterminado: 50

Numero maximo de terminos por pagina

Rango requerido: 1 <= x <= 100

cursor · string

Cursor de paginacion opaco

Respuesta

200

application/json

Terminos de busqueda agregados

searches · object[] · requerido

Search terms ordered by hit count descending.

Show child attributes

totalSearches · integer · requerido

Total count of search events in the requested date range.

Rango requerido: x >= 0

nextCursor · string | null · requerido

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