Get dashboard stats

Retrieve aggregated stats for your organization — campaigns, advocates, referrals, and conversion rate.

GET /api/app/dashboard

Returns a snapshot of your organization's key metrics. All counts are computed at request time from live data. This endpoint is available to any authenticated org member regardless of plan tier — referral and advocate counts will be zero if the campaigns feature is not enabled on your plan.

Request

Requires authentication.

See API Basics for required headers.

This endpoint takes no request body or query parameters.

Sample request

curl https://api.recomly.com/api/app/dashboard \
  -H "Authorization: Bearer rk_live_abc123:def456"

Sample response

Status: 200 OK

{
  "campaigns": {
    "total": 3,
    "active": 2
  },
  "advocates": {
    "total": 41,
    "withPendingRewards": 5,
    "totalCreditBalanceCents": 1250
  },
  "referrals": {
    "total": 87,
    "pending": 34,
    "converted": 53,
    "conversionRate": 0.609
  }
}

Response fields

`campaigns`

Field	Type	Description
`total`	`number`	Total number of non-deleted campaigns (active + paused).
`active`	`number`	Number of campaigns with status `active`.

`advocates`

Field	Type	Description
`total`	`number`	Total enrolled advocates across all campaigns.
`withPendingRewards`	`number`	Number of advocates with an outstanding credit balance (`creditBalanceCents > 0`).
`totalCreditBalanceCents`	`number`	Sum of all outstanding advocate credit balances, in cents. Divide by 100 for the dollar amount.

`referrals`

Field	Type	Description
`total`	`number`	Total referrals across all campaigns.
`pending`	`number`	Referrals not yet converted (includes any expired referrals).
`converted`	`number`	Referrals that have been marked as converted.
`conversionRate`	`number`	`converted / total`, rounded to 3 decimal places. `0` when there are no referrals.

Error responses

See API Basics for standard status codes and error response format.

On this page