getUserStats([payload,])
Fetches the completion status of a program requirement for the user
Params
Param | Required | Type | Description |
---|---|---|---|
campaign.id | required | String | the id of the program/campaign the requirement belongs to. Note: this campaign/program must belong to your account. |
Response
UserStatsResponse
Field | Type | Description |
---|---|---|
links_clicked.total | number | Total links clicked for the user and campaign |
rewards_earnings.unclaimed_earnings_sum | string | Total unclaimed earnings amount formatted to two decimal points. |
rewards_earnings.display_amount | string | Total unclaimed earnings amount formatted to two decimal points with the currency |
Examples
Last updated