Meet the new Scripe, live on October 7.Register

OpenAPI reference · Analytics

Analytics overview (current vs previous period)

GET/analytics/overview

Aggregate analytics for one or more projects over a date range: post count, impressions, engagement rate, follower growth, and posting activity — each compared against the immediately preceding period of equal length.

Pass a comma-separated projectId to aggregate multiple projects. If omitted, aggregates across all projects available to the caller in the workspace. Defaults to the last 30 days.

Required scope: analytics:read.

Authorization

  • Authorizationstringrequired

    Bearer token in the Authorization header.

    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.

Query parameters

  • projectIdstring

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

  • dateFromstring <date-time>

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

  • dateTostring <date-time>

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

Header parameters

  • Scripe-Api-Versionstring

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

Responses

  • 200

    Analytics overview.

  • 400

    Malformed request (bad cursor, bad limit, etc.).

  • 401

    Missing, malformed, expired, or revoked API key.

  • 403

    Plan not eligible, scope missing, or workspace mismatch.

  • 404

    Resource not found in this workspace.

  • 429

    Sliding-window rate limit exceeded.

Example request

bash
curl --request GET \
  --url 'https://api.scripe.io/v1/analytics/overview' \
  --header 'Authorization: Bearer <token>'

Example response (200)

json
{
  "data": {
    "posts": {
      "current": 0,
      "previous": 0
    },
    "impressions": {
      "current": 0,
      "previous": 0
    },
    "engagement": {
      "current_rate": 0,
      "previous_rate": 0
    },
    "followers": {
      "current": 0,
      "growth": 0
    },
    "activity": {
      "current_posts_per_week": 0,
      "previous_posts_per_week": 0
    },
    "range": {
      "from": "2026-08-10T09:00:00Z",
      "to": "2026-08-10T09:00:00Z",
      "days": 0
    }
  }
}