Skip to main content
GET
/
v1
/
reports
/
program-activity
Get program activity
curl --request GET \
  --url https://api.scrip.dev/v1/reports/program-activity \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "asset_count": 1,
      "event_count": 12543,
      "journal_count": 8721,
      "last_activity_at": "2024-01-15T10:30:00Z",
      "program_id": "550e8400-e29b-41d4-a716-446655440000",
      "program_name": "Q1 Sales Bonus",
      "reward_count": 8,
      "rule_count": 12,
      "tier_count": 2,
      "total_issued": "250000.00",
      "total_redeemed": "175000.00",
      "unique_participants": 3421
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt

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

Compares activity across programs in a single request. For each program, the response includes event_count, journal_count, total_issued, total_redeemed, unique_participants, and last_activity_at. Use the since parameter to limit results to programs with activity after a given timestamp. This is useful for filtering out dormant programs and focusing on the ones that matter. Programs with no activity in the specified window are excluded from the response.
For usage patterns and examples, see the Reporting guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

​
since
string<date-time>

Only include programs with activity after this timestamp (RFC 3339). Does not filter metric values.

​
from
string<date-time>

Period start (inclusive, RFC3339). Must be provided with to. Scopes event_count, total_issued and total_redeemed.

​
to
string<date-time>

Period end (inclusive, RFC3339). Must be provided with from. Scopes event_count, total_issued and total_redeemed.

Response

Program activity metrics

Program activity results

​
data
object[]

Per-program activity metrics

​
pagination
object

Pagination metadata for list responses