Ferndesk

Retours

Lister les retours sur les articles

Retours sur les articles avec pagination par curseur et filtres (article_id, type, resolved). Nécessite le scope analytics:read.

Scope requis : analytics:read

GET /feedback

Lister les retours sur les articles

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>"
}

Page des retours

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un jeton Bearer dans l’en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page Paramètres développeur.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces scopes (chaque endpoint indique le scope requis via x-required-scopes) :

    • content:read : Lire et rechercher les articles, collections, sections et traductions du centre d’aide
    • content:write : Créer et modifier des brouillons d’articles, des utilisateurs et des tâches ; déplacer des articles et des collections
    • content:publish : Publier, dépublier, restaurer et supprimer définitivement du contenu (rendre les modifications effectives)
    • analytics:read : Lire les rapports, analyses et retours sur les articles du centre d’aide
    • conversations:read : Lire les conversations et transcriptions de l’assistant IA
    • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

    L’attribution de content:write ou content:publish implique content:read. Les clés créées avant la mise en place des scopes ont des scopes null = accès complet (mode hérité).

Query Parameters

  • article_id string

    Filtrer par article.

  • page_size integer

    Nombre d’éléments à renvoyer par page (1-100). Exemple: 20

  • resolved string enum

    Filtrer par état de résolution.

  • start_cursor string

    Curseur de pagination opaque. Transmettez le next_cursor d’une réponse précédente pour récupérer la page suivante. Exemple: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ

  • type string enum

    Filtrer par type de retour.

Response

application/json
  • results[] object array

    Éléments de cette page. Entrée de retour sur un article.

    + 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

      Horodatage ISO 8601 en UTC.

    • user anyOf

      Utilisateur du centre d’aide automatiquement associé à partir de l’adresse e-mail de l’expéditeur (unique pour l’e-mail + helpdesk), ou null lorsque l’expéditeur est anonyme ou non reconnu.

      + 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

            Identifiant d’utilisateur du centre d’aide Ferndesk (hcusr_...).

          • name string | null

            Nom d’affichage de l’utilisateur du centre d’aide.

          • email string (email)

            Adresse e-mail de l’utilisateur du centre d’aide. Les e-mails sont stockés en minuscules.

        • option 2 null
  • has_more boolean

    Indique si d’autres éléments sont disponibles après cette page.

  • next_cursor string | null

    Curseur à transmettre comme start_cursor pour la page suivante, ou null sur la dernière page.