Sign in

v3

latestOpenAPI 3.1.02026-08-0121336267.1 KB
Reporting

Partner Summary

Your monthly referral activity and earnings summary.

Use start_month and end_month to set the reporting window. Defaults to the earliest activity when omitted. Lifetime totals span all time, regardless of the window.

get/v1/report/summary

Query parameters

start_monthstring nullable

Window start month (inclusive), YYYY-MM

Window start month (inclusive), YYYY-MM

end_monthstring nullable

Window end month (inclusive), YYYY-MM

Window end month (inclusive), YYYY-MM

Response

Successful Response

window_start_monthstring

First month of the resolved window, YYYY-MM

window_end_monthstring

Last month of the resolved window, YYYY-MM

Example response

{
  "monthly": [
    {
      "month": "2026-05"
    }
  ]
}