Skip to main content
Mintlify

Search documentation

Type to search this documentation.

On this pageOverview

Get page views

GET

/

v1

/

analytics

/

/

views

Get page views

curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/views \
  --header 'Authorization: Bearer <token>'
title="200"
{
  "totals": {
    "human": 123,
    "ai": 123,
    "total": 123
  },
  "views": [
    {
      "path": "<string>",
      "human": 123,
      "ai": 123,
      "total": 123
    }
  ],
  "hasMore": true
}
title="400"
{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}
title="500"
{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}

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.

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

This endpoint allows 100 requests per organization per hour. All analytics endpoints share this limit.

Authorization

string

header

required

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

projectId

string

required

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

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

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.

⌘I

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu