Clicks, conversion rate, earnings per click and what is owed
Programme performance. Clicks, visitors, conversions, revenue, commission and earnings per click cover the number of days you ask for (rejected and reversed sales are left out); the pending, owed, paid and reversed sums and the partner counts cover all time. A days value outside 1 to 400 answers 400 invalid_days.
GET
https://app.softsolz.uk/api/v1/services/affiliates/affiliates/reports/overviewRecent Requests
Kept only in this browserTimeStatusTook
Send a request with Try it to see it here.
Headers
AuthorizationstringrequiredBearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.
Query Params
daysintegerDays to report on, 1-400 (default 30).
Response
Response Body
daysintegerDays the click and sale figures cover.clicksintegerReferral link clicks in the window.visitorsintegerDistinct visitors behind those clicks.conversionsintegerSales credited to partners in the window (clawbacks excluded).click_conversionsintegerSales in the window that came from a referral link click.conversion_ratenumberSales that came from a referral click per 100 clicks, to two decimal places, never above 100.revenue_centsintegerValue of those sales, in minor units.commission_centsintegerCommission credited in the window, in minor units.epc_centsintegerEarnings per click: commission credited in the window divided by clicks in the window.pending_centsintegerAll commission waiting for approval.owed_centsintegerAll commission approved and not yet paid.paid_centsintegerAll commission paid out to date, including commission later clawed back after it was paid.clawed_back_after_payment_centsintegerCommission that was paid and then clawed back, so it is still to recover.reversed_centsintegerAll commission clawed back to date.partnersintegerPartners in the programme.active_partnersintegerPartners who are active.Request
curl --request GET \ --url https://app.softsolz.uk/api/v1/services/affiliates/affiliates/reports/overview \ --header 'Authorization: Bearer sk_live_your_key'Credentials
Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.
Response · 200
{ "data": { "days": 30, "clicks": 148, "visitors": 121, "conversions": 3, "click_conversions": 3, "conversion_rate": 2.03, "revenue_cents": 640000, "commission_cents": 37500, "epc_cents": 650, "pending_cents": 37500, "owed_cents": 12000, "paid_cents": 48000, "clawed_back_after_payment_cents": 0, "reversed_cents": 0, "partners": 6, "active_partners": 5 }}