Get page views

Retrieve per-page and site-wide content view counts, split by human and AI traffic.

GET /v1/analytics/{projectId}/views

Get page views

cURL

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

200

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

Usage

Use this endpoint to export page view analytics. Results include both site-wide totals and per-page breakdowns, split by human and AI traffic.

Paginate through results using offset-based pagination. Increment offset by limit while hasMore is true.

Filtering

Filter view data by date range using dateFrom and dateTo parameters.

Response data

The response includes a totals object with site-wide aggregates and a views array with per-page data. Each entry includes:

• path: The documentation page path
• human: Content view events from human traffic
• ai: Content view events from AI bot traffic
• total: Total content view events on this path

Authorizations

Authorization · string · header · required

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.

Path Parameters

projectId · string · required

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

Query Parameters

dateFrom · string

Date in ISO 8601 or YYYY-MM-DD format

Example:

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

Example:

"2024-01-01"

limit · integer · default: 50

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

Required range: 1 <= x <= 250

offset · integer · default: 0

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

Required range: x >= 0

Response

200

application/json

Site-wide and per-path content view event counts

totals · object · required

Site-wide view totals for the date range.

Show child attributes

views · object[] · required

Per-page view counts.

Show child attributes

hasMore · boolean · required

Whether additional results are available beyond this page.