Skip to main content
GET
Get feedback by page

Utilisation

Utilisez cet endpoint pour exporter les retours utilisateurs agrégés par chemin de page de documentation. Chaque entrée affiche le nombre total de retours pour une page, ventilé par type.

Filtrage

Filtrez les feedbacks par :
  • Plage de dates : utilisez dateFrom et dateTo pour limiter les résultats à une période donnée
  • Source : filtrez par type de feedback, code_snippet, contextual ou agent
  • Statut : filtrez par des valeurs de statut comme pending, in_progress, resolved ou dismissed

Limites de débit

Cet endpoint autorise 100 requêtes par organisation et par heure. Tous les endpoints d’analytics partagent cette limite.

Autorisations

Authorization
string
header
requis

The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the API keys page in your dashboard.

Paramètres de chemin

projectId
string
requis

Your project ID. Can be copied from the API keys page in your dashboard.

Paramètres de requête

dateFrom
string

Date in ISO 8601 or YYYY-MM-DD format

Exemple:

"2024-01-01"

dateTo
string

Date in ISO 8601 or YYYY-MM-DD format. dateTo is an exclusive upper limit. Results include dates before, but not on, the specified date.

Exemple:

"2024-01-01"

limit
number
défaut:10

Max results per page

Plage requise: 1 <= x <= 100
source
enum<string>

Filter by feedback source

Options disponibles:
code_snippet,
contextual,
agent,
thumbs_only
status
string

Comma-separated list of statuses to filter by

Réponse

Per-page feedback aggregates with pagination flag

feedback
object[]
requis

Feedback counts aggregated by documentation page path.

hasMore
boolean
requis

Whether additional results are available beyond this page.