Skip to main content
GET
Download analytics report (PDF or CSV)

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

The same header also accepts an OAuth 2.1 access token (scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except webhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer 403 scope_missing to every API key. Operations that name no scope accept any valid token of the workspace.

Headers

Scripe-Api-Version
string

Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Example:

"2026-08-10"

Query Parameters

projectId
string

One project id, or a comma-separated list. If omitted, defaults to all available projects.

Example:

"proj_a1b2c3d4e5f6g7h8"

dateFrom
string<date-time>

ISO 8601 or YYYY-MM-DD lower bound (inclusive).

dateTo
string<date-time>

ISO 8601 or YYYY-MM-DD upper bound (inclusive).

currency
enum<string>
default:USD

Currency for the Earned Media Value figure.

Available options:
EUR,
USD,
GBP
cpm
number
default:35

Cost-per-mille rate used to compute Earned Media Value (impressions / 1000 × cpm). Defaults to 35.

Required range: x >= 1
mode
enum<string>
default:pdf

Format of the returned report document.

Available options:
pdf,
csv

Response

The analytics report in the requested format.

The response is of type file.