Skip to main content
GET
Get feedback by page

Uso

Usa este endpoint para exportar los comentarios de los usuarios agregados por ruta de página de documentación. Cada entrada muestra el recuento total de comentarios de una página, desglosado por tipo.

Filtrado

Filtra los comentarios por:
  • Rango de fechas: Utiliza dateFrom y dateTo para limitar los resultados a un período de tiempo específico
  • Fuente: Filtra por tipos de feedback code_snippet, contextual o agent
  • Estado: Filtra por valores de estado como pending, in_progress, resolved o dismissed

Límites de uso

Este endpoint permite 100 solicitudes por organización por hora. Todos los endpoints de analytics comparten este límite.

Autorizaciones

Authorization
string
header
requerido

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.

Parámetros de ruta

projectId
string
requerido

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

Parámetros de consulta

dateFrom
string

Date in ISO 8601 or YYYY-MM-DD format

Ejemplo:

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

Ejemplo:

"2024-01-01"

limit
number
predeterminado:10

Max results per page

Rango requerido: 1 <= x <= 100
source
enum<string>

Filter by feedback source

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

Comma-separated list of statuses to filter by

Respuesta

Per-page feedback aggregates with pagination flag

feedback
object[]
requerido

Feedback counts aggregated by documentation page path.

hasMore
boolean
requerido

Whether additional results are available beyond this page.