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>'
import requests

url = "https://api.scrip.dev/v1/reports/program-activity"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.scrip.dev/v1/reports/program-activity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrip.dev/v1/reports/program-activity",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.scrip.dev/v1/reports/program-activity"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/reports/program-activity")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/reports/program-activity")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "asset_count": 1,
      "by_asset": [
        {
          "asset_id": "550e8400-e29b-41d4-a716-446655440000",
          "asset_name": "Loyalty Points",
          "asset_symbol": "POINTS",
          "issued": "15000.00",
          "redeemed": "3200.00",
          "scale": 2
        }
      ],
      "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"
  }
}
{
"code": "bad_request",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Invalid request parameters"
}
{
"code": "unauthorized",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Missing or invalid credentials"
}
{
"code": "internal_error",
"message": "An internal error occurred"
}
Returns a per-program scorecard: event_count, journal_count, total_issued, total_redeemed, unique_participants, last_activity_at, and a by_asset breakdown with per-asset scale. Pass program_id for a single program’s row, since to exclude dormant programs, or from/to to window the count and amount fields. Prefer the by_asset rows over the top-level totals for multi-asset programs, since the top-level figures sum across assets.
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

program_id
string<uuid>

Narrow the report to a single program (one row)

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, total_redeemed, and by_asset.

to
string<date-time>

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

Response

Program activity metrics

Program activity results

data
object[]

Per-program activity metrics

pagination
object

Pagination metadata for list responses