SolutionsPricingDocsStart Free
Api

Get Program Summary

GET
/v1/programs/{programId}/summary

Read the totals of a Program: participants, referrals, conversions, and Rewards. Needs the referrals:read key permission.

Authorization

WorkspaceApiKey
X-Api-Key<token>

Workspace-owned Better Auth API key of one environment (Sandbox or Live); it authorizes the Projects of that environment in its Workspace. A Project of the other environment returns 403 ENVIRONMENT_MISMATCH. Never expose it in the browser.

In: header

Path Parameters

programId*string
Match\S
Length1 <= length <= 512

Query Parameters

projectId*string
Length1 <= length <= 128

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/programs/string/summary?projectId=string"
{  "success": true,  "data": {    "enrollments": 0,    "referrals": 0,    "earnedRewards": 0,    "customTotals": [      {        "customUnitId": "string",        "unitKey": "string",        "name": "string",        "namePlural": "string",        "rewardCount": 0,        "earnedQuantity": 0,        "fulfilledQuantity": 0,        "pendingQuantity": 0,        "voidedQuantity": 0      }    ]  }}