Get project-global affiliate breakdown

Returns aggregated affiliate statistics for an entire project, grouped by a selected dimension (audience, region, or status).

This endpoint is designed for the Affiliate Management Breakdown page and provides project-wide totals along with per-group breakdowns.

Grouping:

  • groupBy=region — Groups affiliates by their geographic region (CN, JP, KR, SEA, EN, LATAM, Other)
  • groupBy=audience — Groups affiliates by the audience they belong to
  • groupBy=status — Groups affiliates by their status (active, flagged, etc.)

Date Filtering Options:

  • All-time (default): Omit date parameters
  • Preset ranges: Use dateRange=7d, 30d, MTD, or QTD
  • Custom range: Use dateRange=custom together with dateFrom and dateTo

Sorting:

  • Use sortBy to sort groups by a metric: totalReferralVolume, revenueFromReferrals, earnings, or pointsPaid
  • Use sortOrder to control direction: asc or desc (default: desc)

Required API Key Scope: service_role

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

The dimension to group affiliates by

Allowed:
string
enum

Preset date range. Use custom together with dateFrom and dateTo for a custom range.

Allowed:
date

Start date for custom date range (ISO 8601). Required when dateRange=custom.

date

End date for custom date range (ISO 8601). Required when dateRange=custom.

string
enum

Metric to sort the groups by. Defaults to totalReferralVolume.

Allowed:
string
enum

Sort direction. Defaults to desc.

Allowed:
Responses

400

Bad Request - Missing required groupBy parameter or invalid date parameters

401

Unauthorized - Missing or invalid API key, or insufficient scope

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json