Ferndesk

Comentarios

Lista los comentarios de artículos

Comentarios de artículos paginados mediante cursor con filtros (article_id, type, resolved). Requiere el scope analytics:read.

Scope requerido: analytics:read

GET /feedback

Lista los comentarios de artículos

curl --request GET \
  --url 'https://api.ferndesk.com/v1/feedback' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "results": [
    {
      "id": "<string>",
      "articleId": "<string>",
      "articleTitle": "<string>",
      "type": "positive",
      "feedback": "<string>",
      "email": "<string>",
      "resolved": true,
      "createdAt": "<string>",
      "user": {}
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Página de comentarios

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 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, dejar de publicar, restaurar y enviar a la papelera contenido (hacer efectivos los cambios)
    • analytics:read: Leer informes, análisis 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

    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

  • article_id string

    Filtrar por artículo.

  • page_size integer

    Número de elementos que se devolverán por página (1-100). Ejemplo: 20

  • resolved string enum

    Filtrar por estado de resolución.

  • start_cursor string

    Cursor de paginación opaco. Pasa el next_cursor de una respuesta anterior para obtener la página siguiente. Ejemplo: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ

  • type string enum

    Filtrar por tipo de comentario.

Response

application/json
  • results[] object array

    Elementos de esta página. Entrada de comentarios de artículo.

    + Show Child Attributes
    • id string
    • articleId string | null
    • articleTitle string | null
    • type string enum enum

      Allowed values: positive, negative.

    • feedback string
    • email string | null
    • resolved boolean
    • createdAt string

      Marca de tiempo ISO 8601 en UTC.

    • user anyOf

      Usuario del centro de ayuda asociado automáticamente a partir del correo electrónico del remitente (único por correo electrónico + helpdesk), o null cuando el remitente es anónimo o no se reconoce.

      + Show Child Attributes
      • anyOf options 2 variants anyOf

        One or more options can apply.

        + Show Child Attributes
        • option 1 object
          + Show Child Attributes
          • id string

            ID de usuario del centro de ayuda de Ferndesk (hcusr_...).

          • name string | null

            Nombre visible del usuario del centro de ayuda.

          • email string (email)

            Dirección de correo electrónico del usuario del centro de ayuda. Los correos electrónicos se almacenan en minúsculas.

        • option 2 null
  • has_more boolean

    Indica si hay más elementos disponibles después de esta página.

  • next_cursor string | null

    Cursor que se debe pasar como start_cursor para la página siguiente, o null en la última página.