Saltar al contenido principal
GET
/
v1
/
analytics
/
{projectId}
/
feedback
/
by-page
Obtener comentarios por pagina
curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/feedback/by-page \
  --header 'Authorization: Bearer <token>'
{
  "feedback": [
    {
      "path": "<string>",
      "thumbsUp": 123,
      "thumbsDown": 123,
      "code": 123,
      "total": 123
    }
  ],
  "hasMore": true
}

​
Uso

Usa este endpoint para exportar los comentarios de los usuarios agregados por ruta de página de documentación. Cada entrada muestra el conteo total de comentarios para una página, desglosado por tipo. Pagina los resultados usando el indicador hasMore en la respuesta.

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

​
Datos de respuesta

Cada entrada de página incluye:
  • path: La ruta de la página de documentación
  • thumbsUp: Conteo de comentarios contextuales positivos
  • thumbsDown: Conteo de comentarios contextuales negativos
  • code: Conteo de comentarios sobre fragmentos de código
  • total: Total de entradas de comentarios para la página

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

Limite superior exclusivo

Ejemplo:

"2024-01-01"

​
limit
number
predeterminado:10

Numero maximo de resultados por pagina

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

Filtrar por origen de los comentarios

Opciones disponibles:
code_snippet,
contextual
​
status
string

Estados separados por comas

Respuesta

Comentarios agregados por pagina

​
feedback
object[]
requerido

Feedback counts aggregated by documentation page path.

​
hasMore
boolean
requerido

Whether additional results are available beyond this page.