Reporting

Get program activity

Returns activity metrics per program with a per-asset breakdown. Pass program_id for a single program's scorecard. This report does not accept created_after or created_before.

get/v1/reports/program-activity

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/reports/program-activity
Auth: HTTP bearer

Query parameters

program_idstring uuid

Narrow the report to a single program (one row)

active_afterstring date-time

Return only programs with activity after this time, RFC 3339; metric values are unchanged.

period_startstring date-time

Start of the reporting period, inclusive, RFC 3339; send it together with period_end.

period_endstring date-time

End of the reporting period, inclusive, RFC 3339; send it together with period_start.

Response

Program activity metrics

Example response

{
  "data": [
    {
      "asset_count": 1,
      "by_asset": [
        {
          "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
          "asset_name": "Loyalty Points",
          "asset_symbol": "POINTS",
          "issued": "15000.00",
          "redeemed": "3200.00",
          "scale": 2
        }
      ],
      "event_count": 12543,
      "journal_count": 8721,
      "last_activity_at": "2027-01-15T10:30:00Z",
      "program_id": "8f14e45f-ceea-4e70-9df8-2a7d1b3c9f01",
      "program_name": "Q1 Sales Bonus",
      "reward_count": 8,
      "rule_count": 12,
      "tier_count": 2,
      "unique_participants": 3421
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.