Saltar al contenido principal
GET
/
v1
/
analytics
/
{projectId}
/
feedback
/
by-page
Obtener comentarios agrupados por página
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 obtener una visión general del volumen de comentarios en las páginas de tu documentación. Los resultados se agregan por ruta de página y se ordenan por recuento total de comentarios en orden descendente. Verifica el campo hasMore en la respuesta para determinar si hay más páginas de resultados disponibles. Aumenta el parámetro limit para obtener más resultados por solicitud.

​
Filtrado

Filtra los agregados de 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

​
Campos de la respuesta

Cada elemento de la respuesta representa una página de documentación e incluye:
  • thumbsUp: Número de valoraciones contextuales positivas (útil)
  • thumbsDown: Número de valoraciones contextuales negativas (no útil)
  • code: Número de comentarios sobre fragmentos de código
  • total: Recuento combinado de todos los tipos 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

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 fuente de comentarios

Opciones disponibles:
code_snippet,
contextual
​
status
string

Lista de estados separados por comas para filtrar

​
limit
number
predeterminado:10

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

Rango requerido: 1 <= x <= 100

Respuesta

Agregados de comentarios por página con indicador de paginación

​
feedback
object[]
requerido

Lista de agregados de comentarios por página.

​
hasMore
boolean
requerido

Indica si hay más resultados disponibles más allá de esta página.