Skip to main content
GET
/
public
/
v1
/
reporting-service
/
marketplace
/
campaigns-kpis
Get Marketplace Campaigns Kpis
curl --request GET \
  --url https://api.topsort.com/public/v1/reporting-service/marketplace/campaigns-kpis \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "campaignsKpis": [
    {
      "adSpend": 1,
      "cpc": 123,
      "ctr": 123,
      "conversionRate": 123,
      "impressions": 1,
      "chargedImpressions": 1,
      "clicks": 1,
      "chargedClicks": 1,
      "purchaseCount": 1,
      "purchaseRevenue": 1,
      "roas": 123,
      "vendorId": "<string>",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "quantity": 1,
      "campaignName": "<string>"
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
limit
integer
default:100

The pagination limit.

Required range: 0 <= x <= 100
​
next_page
string | null

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

​
start_date
string<date>
required

The start date for which reports will be generated.

​
end_date
string<date>
required

The end date for which reports will be generated.

​
search
string

The search string for a given query.

​
ad_format
enum<string> | null

The ad format for which reports will be generated. If not specified, all ad formats will be included.

Available options:
listing,
banner,
sponsored_brand,
exclusive_listing,
exclusive_banner,
travel_listing,
flight_listing
​
vendor_id
string | null

External vendor ID.

​
order_by
enum<string>[]

Order by field.

The dimension to order by.

Available options:
impressions,
charged_impressions,
clicks,
charged_clicks,
purchase_count,
purchase_revenue,
ad_spend,
cpc,
cpm,
ctr,
conversion_rate,
roas,
vendor_id,
vendor_name,
timegroup,
campaign_name,
campaign_id,
status,
ad_format,
active_campaigns,
wallet_name,
days_until_topup,
balance,
quantity
​
direction
enum<string>[]

Order direction. Must be one of: asc, desc.

The direction to order by.

Available options:
asc,
desc

Response

Successful Response

Response for marketplace campaign KPIs using external vendor IDs.

​
hasMore
boolean
required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

​
campaignsKpis
PublicCampaignsKpis · object[]
required

A list with the marketplace campaign KPIs.

​
nextPage
string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1
Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="