Skip to content
Mintlify
Mintlify
Analytics

Obtener comentarios

GET/v1/analytics/{projectId}/feedback

Usa este endpoint para exportar los comentarios de los usuarios recopilados desde tu documentación. Los comentarios incluyen comentarios contextuales de las calificaciones de las páginas, comentarios sobre fragmentos de código y comentarios de agentes.

Pagina los resultados usando el parámetro cursor devuelto en la respuesta. Continúa obteniendo resultados mientras hasMore sea true.

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

La respuesta contiene diferentes tipos de comentarios según la fuente:

  • Comentarios contextuales: Incluyen el valor booleano helpful y un correo electrónico opcional en contact
  • Comentarios sobre fragmentos de código: Incluyen los campos code, filename y lang
  • Comentarios de agentes: Incluyen un comment con el texto del comentario del agente y el path de la página a la que se refiere

Límites de uso

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

Was this page helpful?Suggest editsRaise issue