Ferndesk

Analítica

Obtener analítica de búsquedas

Términos de búsqueda más frecuentes y sin resultados (sin coincidencias), con sus resultados. Las métricas se calculan a partir del flujo de analítica y pueden aparecer como cero durante una interrupción del flujo, en lugar de devolver un error. Requiere el alcance analytics:read.

Alcance requerido: analytics:read

GET /analytics/searches

Obtener analítica de búsquedas

curl --request GET \
  --url 'https://api.ferndesk.com/v1/analytics/searches' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "key": "<string>"
}

Carga útil de analítica

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse en secreto. Puedes generar y administrar claves desde la página de Configuración del desarrollador.

    Las claves pueden restringirse a cualquier subconjunto de estos alcances (cada endpoint indica el alcance que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, retirar la publicación, restaurar y enviar contenido a la papelera (hacer efectivos los cambios)
    • analytics:read: Leer informes, analítica y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Otorgar content:write o content:publish implica content:read. Las claves creadas antes de la definición de alcances tienen alcances nulos = acceso total (modo heredado).

Query Parameters

  • end_date string

    Límite superior de fecha ISO.

  • limit integer

    Límite de filas para analítica de tipo lista.

  • start_date string

    Límite inferior de fecha ISO.

Response

application/json
  • [key: string] any additional