Skip to main content
GET
/
analytics
/
overview
Analytics overview (current vs previous period)
curl --request GET \
  --url https://api.scripe.io/v1/analytics/overview \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "posts": {
      "current": 123,
      "previous": 123
    },
    "impressions": {
      "current": 123,
      "previous": 123
    },
    "engagement": {
      "current_rate": 123,
      "previous_rate": 123
    },
    "followers": {
      "current": 123,
      "growth": 123
    },
    "activity": {
      "current_posts_per_week": 123,
      "previous_posts_per_week": 123
    },
    "range": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z",
      "days": 123
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.scripe.io/llms.txt

Use this file to discover all available pages before exploring further.

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.

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

Query Parameters

projectId
string
required

One project id, or a comma-separated list.

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

Response

Analytics overview.

data
object
required