Docs / Reference / Earnings Report
Reports

Earnings Report

Returns monthly earnings summaries for the authenticated publisher, broken down by commission status: pending, validated, payable, claimed, and rejected. This is summary data updated at periodic intervals — for real-time transaction data, use the Transactions endpoint.

GET /pub_api/v3/reports/earnings read:reports
Query parameters
start_date
date (YYYY-MM-DD)
 Start of date range. Rounded to the beginning of the month. Default: 3 months ago.
end_date
date (YYYY-MM-DD)
 End of date range. Rounded to the end of the month. Default: yesterday. Maximum range: 24 months.
sort
string
 Sort field: month (default), pending, validated, payable, claimed, rejected, total.
order
string
 asc or desc (default).
page
integer
 Page number. Default: 1.
per_page
integer
 Results per page, 1–100. Default: 30.
Response fields
FieldTypeDescription
data[].month string Month in YYYY-MM format.
data[].pending string Commission awaiting advertiser confirmation.
data[].validated string Commission approved by advertiser, payment awaited.
data[].payable string Commission received from merchant, ready to invoice.
data[].claimed string Commission invoiced or already paid out.
data[].rejected string Commission rejected by the merchant.
data[].total string Sum of all commission statuses.
data[].updated_at string When this month's summary was last recalculated (ISO 8601).
totals object Aggregated totals across the date range. Same fields minus month and updated_at.
meta object Pagination: page, per_page, total, total_pages, next_page, prev_page.
Request 
curl https://developers.cuelinks.com/pub_api/v3/reports/earnings \
  -H "Authorization: Token YOUR_API_KEY" \
  -G \
  -d "start_date=2026-01-01" \
  -d "end_date=2026-04-12"
200 OK 200 
{
  "data": [
    {
      "month": "2026-04",
      "pending": "5000",
      "rejected": "200",
      "validated": "8000",
      "payable": "3000",
      "claimed": "12000",
      "total": "28200",
      "updated_at": "2026-04-11T15:00:00Z"
    },
    {
      "month": "2026-03",
      "pending": "3000",
      "rejected": "500",
      "validated": "6000",
      "payable": "2000",
      "claimed": "15000",
      "total": "26500",
      "updated_at": "2026-04-01T10:00:00Z"
    }
  ],
  "totals": {
    "pending": "8000",
    "rejected": "700",
    "validated": "14000",
    "payable": "5000",
    "claimed": "27000",
    "total": "54700"
  },
  "meta": {
    "page": 1,
    "per_page": 30,
    "total": 4,
    "total_pages": 1,
    "next_page": null,
    "prev_page": null
  }
}
⚠️
Summary data
This report uses pre-aggregated summary data that is updated periodically. For real-time transaction-level data, use the Transactions endpoint.
← Previous Campaigns Report