Skip to main content
GET
/
public
/
v1
/
offsite-ads
/
reporting
/
campaigns
/
{campaign-id}
Get Campaign Aggregated Report
curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/reporting/campaigns/{campaign-id} \
  --header 'Authorization: Bearer <token>'
{
  "impressions": {
    "total": 123,
    "charged": 123,
    "adSpent": 123,
    "adSpentDecimal": "<string>"
  },
  "clicks": {
    "total": 123,
    "charged": 123,
    "adSpent": 123,
    "adSpentDecimal": "<string>"
  },
  "purchases": {
    "amount": 123,
    "count": 123,
    "quantity": 123,
    "countByProduct": {}
  }
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Path Parameters

​
campaign-id
string<uuid>
required

The ID of the campaign to get the report for.

Query Parameters

​
vendor_id
string
required

The ID of the vendor to get the campaign report for.

​
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.

Response

Successful Response

Clicks, impressions and purchases attributed to this report item so far.

​
impressions
OffsiteEvents · object
required

How many impressions are attributed to this report item.

​
clicks
OffsiteEvents · object
required

How many clicks are attributed to this report item.

​
purchases
OffsitePurchases · object
required

How many purchases are attributed to this report item.