Scripe relaunch is live.See what's new

OpenAPI reference · Analytics

Analytics per profile

GET/analytics/profiles

One row per profile the caller can read, for a date range: follower total, posts, impressions, likes, comments and engagement. This is the way to export a whole workspace: /analytics/overview answers with one aggregate, and its rates cannot be added up from one call per profile.

A profile with no post in the range, or with no LinkedIn connected, is a row of zeros with connected saying which, so the list always names everyone. At most 300 profiles; meta.projects_truncated says when the workspace holds more. 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

  • 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

    One row per profile.

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

  • 429

    Sliding-window rate limit exceeded.

Example request

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

Example response (200)

json
{
  "data": [
    {
      "project_id": "proj_a1b2c3d4e5f6g7h8",
      "name": "string",
      "connected": true,
      "followers": 0,
      "posts": 0,
      "impressions": 0,
      "likes": 0,
      "comments": 0,
      "engagement": 0
    }
  ],
  "meta": {
    "range": {
      "from": "2026-08-10T09:00:00Z",
      "to": "2026-08-10T09:00:00Z"
    },
    "projects_truncated": true
  }
}