Skip to content
Topsort Documentation
API

Get Campaign Report

GET
/v1/reporting-service/campaigns/{campaign-id}

Endpoint to get a campaign’s total behavioral summary report between given dates.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Path Parameters

object
campaign-id
required

The ID of the campaign.

string format: uuid

The ID of the campaign.

Query Parameters

object
start_date
required

The start date for which reports will be generated.

string format: date

The start date for which reports will be generated.

end_date
required

The end date for which reports will be generated.

string format: date

The end date for which reports will be generated.

Responses

Successful Response

Auctions information attributed to this report item in addition to normal report data.

application/json
object
auctions
required

How many auctions are attributed to this report item.

object
lost
required

Number of auctions lost for a campaign in a given period of time.

integer
percentageWon
required

Percentage of auctions won for a campaign in a given period of time.

number
won
required

Number of auctions won for a campaign in a given period of time.

integer
clicks
required

How many clicks are attributed to this report item.

object
adSpent
required

Ad spent over a period of time, in minor units of currency according to ISO 4217.

integer format: int64
charged
required

Number of charged events.

integer format: int64
total
required

Total number of events.

integer format: int64
impressions
required

How many impressions are attributed to this report item.

object
adSpent
required

Ad spent over a period of time, in minor units of currency according to ISO 4217.

integer format: int64
charged
required

Number of charged events.

integer format: int64
total
required

Total number of events.

integer format: int64
purchases
required

How many purchases are attributed to this report item.

object
amount
required

Amount of money made by purchases over a period of time, in minor units of currency according to ISO 4217.

integer format: int64
count
required

Amount of purchase events.

integer format: int64
countByProduct

Purchase count by product. Available if count_by_product is set to true.

object
key
additional properties
integer
quantity
required

Amount of items purchased.

integer format: int64