Ferndesk

Analíticas

Obtener analíticas por artículo

Conteos de visualizaciones, espectadores únicos, selecciones en búsquedas y comentarios por cada artículo publicado. Las métricas se calculan a partir del flujo de analíticas y pueden aparecer como cero durante una interrupción del flujo, en lugar de generar un error. Requiere el scope analytics:read.

Scope requerido: analytics:read

GET /analytics/articles

Obtener analíticas por artículo

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

Carga útil de analíticas

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API llevan el prefijo fdsk_ y deben mantenerse secretas. Puedes generar y administrar claves desde la página de Configuración de 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, anular la publicación, restaurar y eliminar contenido (hacer efectivos los cambios)
    • analytics:read: Leer informes, analíticas y comentarios de 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

    Conceder content:write o content:publish implica content:read. Las claves creadas antes de la aplicación de scopes tienen scopes null = acceso completo (modo heredado).

Query Parameters

  • end_date string

    Límite superior de fecha ISO.

  • limit integer

    Límite de filas para analíticas en formato de lista.

  • start_date string

    Límite inferior de fecha ISO.

Response

application/json
  • [key: string] any additional