Obtenir les visiteurs uniques

Récupérez les compteurs approximatifs de visiteurs uniques par page et à l’échelle du site, répartis entre trafic humain et IA.

GET /v1/analytics/{projectId}/visitors

Get unique visitors

cURL

curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/visitors \
  --header 'Authorization: Bearer <token>'

200

{
  "totals": {
    "human": 123,
    "ai": 123,
    "total": 123
  },
  "visitors": [
    {
      "path": "<string>",
      "human": 123,
      "ai": 123,
      "total": 123
    }
  ],
  "hasMore": true
}

​

Utilisation

Utilisez cet endpoint pour exporter les données analytiques de visiteurs uniques. Les résultats incluent les totaux à l’échelle du site et les détails par page, répartis entre trafic humain et IA. Le champ total est dédupliqué entre le 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 visiteurs 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 visitors avec les données par page. Chaque entrée inclut :

• path : le chemin de la page de documentation
• human : visiteurs uniques provenant du trafic humain
• ai : visiteurs uniques provenant du trafic IA
• total : visiteurs distincts approximatifs (dédupliqués entre humain et IA)

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

200

application/json

Site-wide totals and per-path visitor counts

totals · object · requis

Site-wide unique visitor totals for the date range.

Show child attributes

visitors · object[] · requis

Per-page visitor counts.

Show child attributes

hasMore · boolean · requis

Whether additional results are available beyond this page.