mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
69cdff9efd
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
36 lines
1.6 KiB
Plaintext
36 lines
1.6 KiB
Plaintext
---
|
|
title: "Obtener comentarios"
|
|
description: "Obtén comentarios de los usuarios sobre tu documentación,
|
|
incluidas las valoraciones de las páginas y los comentarios sobre fragmentos
|
|
de código."
|
|
openapi: /es/analytics.openapi.json GET /v1/analytics/{projectId}/feedback
|
|
keywords: [ "Analytics", "feedback", "exportación", "comentarios de los usuarios" ]
|
|
---
|
|
|
|
<div id="usage">
|
|
## Uso
|
|
</div>
|
|
|
|
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`.
|
|
|
|
<div id="filtering">
|
|
## Filtrado
|
|
</div>
|
|
|
|
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`
|
|
|
|
<div id="response-types">
|
|
## Tipos de respuesta
|
|
</div>
|
|
|
|
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 |