v22

latestOpenAPI 3.0.0raw.githubusercontent.com2025-08-12131543.9 KB
Performance Report

Performance Report

Performance Report

Default Grouping: campaign_name, campaign_id Default KPI in response: clicks, approvedConversions, payout, revenue, profit

To update the report grouping or kpi:

  • &group[]=campaign_id&group[]=publisher_id
  • List of grouping parameters can be found below
  • &kpi[]=clicks&kpi[]=rejectedClicks&kpi[]=grossClicks
  • List of KPI can be found in query parameter section below

Rate Limit: 200 req/min

get/v2/publishers/reports

Query parameters

{"stackTrail":"paths:/v2/publishers/reports:get:parameters:0:schema:items","oasType":"schema","type":"unknown"}

Allowed Group parameters: campaign_name, campaign_id, campaign_long_id, external_offer_id, campaign_status, campaign_geo, objective, publisher, publisher_id, publisher_long_id, source, advertiser, advertiser_id, goal_name, goal_id, ref_camp, ref_camp_id, lp_title, lp_id, os, country, hour, created, month

{"stackTrail":"paths:/v2/publishers/reports:get:parameters:1:schema:items","oasType":"schema","type":"unknown"}

Allowed KPIs: uniqueClicks, rejectedClicks, clicks, grossClicks, approvedConversions, pendingConversions, cancelledConversions, rejectedConversions, extConversions, grossConversions, cr, impressions, campaign_payout, campaign_revenue, payout, revenue, profit, saleAmount, pendingPayout, pendingSaleAmount, extPayout, extSaleAmount, extRevenue, grossRevenue, grossProfit, grossSaleAmount, epc, ctr

{"stackTrail":"paths:/v2/publishers/reports:get:parameters:2:schema:items","oasType":"schema","type":"unknown"}

To filter the report for a particular campaign add campaign id in query parameters like: &camp_ids[]=16&camp_ids[]=30

startstring

Report start date in YYYY-MM-DD format

endstring

Report end date in YYYY-MM-DD format

Response

OK