Reports
Campaigns Report
Returns performance metrics grouped by campaign and channel for the authenticated publisher. Each row represents a unique campaign–channel combination with aggregated clicks, transactions, commission, sale amount, conversion rate, and EPC over the date range.
GET
/pub_api/v3/reports/campaigns
read:reports
Query parameters
|
start_date
date (YYYY-MM-DD)
|
Start of date range. Default: 7 days ago. |
|
end_date
date (YYYY-MM-DD)
|
End of date range. Default: yesterday. Maximum range: 90 days. |
|
campaign_id
integer
|
Filter to a single campaign. |
|
channel_id
integer
|
Filter to a single channel. Must belong to the authenticated publisher. |
|
sort
string
|
Sort field: clicks (default), transactions, commission, sale_amount, cr, epc, campaign_id, channel_id. |
|
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[].campaign_id
integer
Campaign ID.
data[].campaign_name
string
Campaign display name.
data[].campaign_type
string
Campaign type (e.g. "CPS", "CPC", "CPL").
data[].channel_id
integer
Channel ID.
data[].channel_name
string
Channel display name.
data[].clicks
integer
Total clicks.
data[].transactions
integer
Number of conversions.
data[].commission
string
Publisher commission earned (decimal string; trailing zeros trimmed).
data[].sale_amount
string
Total sale amount (decimal string; trailing zeros trimmed).
data[].cr
string
Conversion rate as percentage.
data[].epc
string
Earnings per click.
totals
object
Aggregated totals across all campaigns for the date range (not just the current page).
meta
object
Pagination:
page, per_page, total, total_pages, next_page, prev_page.
Request
curl https://developers.cuelinks.com/pub_api/v3/reports/campaigns \ -H "Authorization: Token YOUR_API_KEY" \ -G \ -d "start_date=2026-04-04" \ -d "end_date=2026-04-10" \ -d "sort=clicks" \ -d "order=desc"
200 OK
200
{ "data": [ { "campaign_id": 101, "campaign_name": "Flipkart", "campaign_type": "CPS", "channel_id": 3424, "channel_name": "My Telegram", "clicks": 178312, "transactions": 587, "commission": "15986.19", "sale_amount": "1250000", "cr": "0.33", "epc": "0.09" }, { "campaign_id": 102, "campaign_name": "Amazon", "campaign_type": "CPS", "channel_id": 3424, "channel_name": "My Telegram", "clicks": 95000, "transactions": 320, "commission": "8500", "sale_amount": "750000", "cr": "0.34", "epc": "0.09" } ], "totals": { "clicks": 273312, "transactions": 907, "commission": "24486.19", "sale_amount": "2000000", "cr": "0.33", "epc": "0.09" }, "meta": { "page": 1, "per_page": 30, "total": 12, "total_pages": 1, "next_page": null, "prev_page": null } }