Saltar al contenido principal
GET
/
v1
/
analytics
/
{projectId}
/
feedback
Obtener comentarios de los usuarios
curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/feedback \
  --header 'Authorization: Bearer <token>'
{
  "feedback": [
    {
      "id": "<string>",
      "path": "<string>",
      "comment": "<string>",
      "createdAt": "<string>",
      "source": "code_snippet",
      "status": "pending"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

​
Uso

Usa este endpoint para exportar los comentarios de los usuarios recopilados desde tu documentación. Los comentarios incluyen comentarios contextuales de las páginas, votos de pulgar únicamente y comentarios sobre fragmentos de código. Pagina los resultados usando el parámetro cursor devuelto en la respuesta. Continúa obteniendo resultados mientras hasMore sea true.

​
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 thumbs_only
  • Estado: Filtra por valores de estado como pending, in_progress, resolved o dismissed

​
Tipos de respuesta

La respuesta contiene diferentes tipos de comentarios según la fuente:
  • Comentarios contextuales: Comentarios a nivel de página con texto. Incluyen el valor booleano helpful y un correo electrónico opcional en contact.
  • Votos de pulgar únicamente: Un voto de pulgar arriba o abajo sin texto. Comparten el mismo esquema que los comentarios contextuales.
  • Comentarios sobre fragmentos de código: Comentarios sobre un bloque de código específico. Incluyen los campos code, filename y lang.

Autorizaciones

​
Authorization
string
header
requerido

El encabezado Authorization requiere un token Bearer. Usa una clave de API de administrador (con el prefijo mint_). Esta es una clave secreta del lado del servidor. Genérala en la página de claves de API de tu dashboard.

Parámetros de ruta

​
projectId
string
requerido

Tu ID de proyecto. Puedes copiarlo desde la página API keys en tu dashboard.

Parámetros de consulta

​
dateFrom
string

Fecha en formato ISO 8601 o AAAA-MM-DD

Ejemplo:

"2024-01-01"

​
dateTo
string

Fecha en formato ISO 8601 o AAAA-MM-DD. dateTo es un límite superior exclusivo. Los resultados incluyen fechas anteriores, pero no la fecha especificada.

Ejemplo:

"2024-01-01"

​
source
enum<string>

Filtrar por el origen de los comentarios

Opciones disponibles:
code_snippet,
contextual,
thumbs_only
​
status
string

Lista de estados separados por comas por los que filtrar

​
limit
number
predeterminado:50

Número máximo de resultados por página

Rango requerido: 1 <= x <= 100
​
cursor
string

Cursor de paginación

Respuesta

Datos de comentarios paginados

​
feedback
object[]
requerido

Lista de entradas de comentarios.

​
nextCursor
string | null
requerido

Cursor para recuperar la página siguiente de resultados. Nulo si no hay más resultados.

​
hasMore
boolean
requerido

Indica si hay más resultados después de esta página.