Saltar al contenido principal
GET
/
v1
/
analytics
/
{projectId}
/
views
Get page views
curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/views \
  --header 'Authorization: Bearer <token>'
{
  "totals": {
    "human": 123,
    "ai": 123,
    "total": 123
  },
  "views": [
    {
      "path": "<string>",
      "human": 123,
      "ai": 123,
      "total": 123
    }
  ],
  "hasMore": true
}

Uso

Usa este endpoint para exportar los datos analíticos de vistas de páginas. Los resultados incluyen totales a nivel del sitio y desgloses por página, divididos entre tráfico humano e IA. Pagina los resultados usando paginación basada en offset. Incrementa offset por limit mientras hasMore sea true.

Filtrado

Filtra los datos de vistas por rango de fechas usando los parámetros dateFrom y dateTo.

Datos de respuesta

La respuesta incluye un objeto totals con agregados a nivel del sitio y un arreglo views con datos por página. Cada entrada incluye:
  • path: La ruta de la página de documentación
  • human: Eventos de vista de contenido del tráfico humano
  • ai: Eventos de vista de contenido del tráfico IA
  • total: Total de eventos de vista de contenido en esta página

Autorizaciones

Authorization
string
header
requerido

The Authorization header expects a Bearer token. Use an admin API key (prefixed with mint_). This is a server-side secret key. Generate one on the API keys page in your dashboard.

Parámetros de ruta

projectId
string
requerido

Your project ID. Can be copied from the API keys page in your dashboard.

Parámetros de consulta

dateFrom
string

Date in ISO 8601 or YYYY-MM-DD format

Ejemplo:

"2024-01-01"

dateTo
string

Date in ISO 8601 or YYYY-MM-DD format. dateTo is an exclusive upper limit. Results include dates before, but not on, the specified date.

Ejemplo:

"2024-01-01"

limit
integer
predeterminado:50

Max results per page (1-250, default 50). Increment offset by limit while hasMore is true to paginate.

Rango requerido: 1 <= x <= 250
offset
integer
predeterminado:0

Number of rows to skip. Use offset = (page - 1) * limit for page-based access.

Rango requerido: x >= 0

Respuesta

Site-wide and per-path content view event counts

totals
object
requerido

Site-wide view totals for the date range.

views
object[]
requerido

Per-page view counts.

hasMore
boolean
requerido

Whether additional results are available beyond this page.