Passer au contenu 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
}

Utilisation

Utilisez cet endpoint pour exporter les données analytiques de vues de pages. Les résultats incluent les totaux à l’échelle du site et les détails par page, répartis entre trafic humain et IA. Parcourez les résultats avec une pagination basée sur l’offset. Incrémentez offset de limit tant que hasMore est true.

Filtrage

Filtrez les données de vues par plage de dates à l’aide des paramètres dateFrom et dateTo.

Données de la réponse

La réponse inclut un objet totals avec les agrégats à l’échelle du site et un tableau views avec les données par page. Chaque entrée inclut :
  • path : le chemin de la page de documentation
  • human : événements de vue de contenu provenant du trafic humain
  • ai : événements de vue de contenu provenant du trafic IA
  • total : total des événements de vue de contenu sur cette page

Autorisations

Authorization
string
header
requis

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.

Paramètres de chemin

projectId
string
requis

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

Paramètres de requête

dateFrom
string

Date in ISO 8601 or YYYY-MM-DD format

Exemple:

"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.

Exemple:

"2024-01-01"

limit
integer
défaut:50

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

Plage requise: 1 <= x <= 250
offset
integer
défaut:0

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

Plage requise: x >= 0

Réponse

Site-wide and per-path content view event counts

totals
object
requis

Site-wide view totals for the date range.

views
object[]
requis

Per-page view counts.

hasMore
boolean
requis

Whether additional results are available beyond this page.