Ferndesk

Analíticas

Obtener analíticas generales

KPI de visitantes, vistas y búsquedas con historial diario. Las métricas se calculan a partir del pipeline de analítica y pueden mostrarse como cero durante una interrupción del pipeline, en lugar de generar un error. Requiere el scope analytics:read.

Scope requerido: analytics:read

GET /analytics/overview

Obtener analíticas generales

curl --request GET \
  --url 'https://api.ferndesk.com/v1/analytics/overview' \
  --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 API tienen el prefijo fdsk_ y deben mantenerse en secreto. Puedes generar y gestionar claves desde la página Configuración para desarrolladores.

    Las claves pueden restringirse a cualquier subconjunto de estos scopes (cada endpoint indica el scope 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íticas y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y gestionar suscripciones a webhooks salientes

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

Query Parameters

  • end_date string

    Límite superior de fecha ISO.

  • start_date string

    Límite inferior de fecha ISO.

Response

application/json
  • [key: string] any additional