Skip to content
Topsort Documentation
API

Get Campaign Daily Report

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

Endpoint to get a campaign’s daily 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
limit

The pagination limit.

integer
default: 100 <= 100

The pagination limit.

next_page

A token provided in a previous response. If not empty, it is used to retrieve the page that follows.

string

A token provided in a previous response. If not empty, it is used to retrieve the page that follows.

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.

purchase_count_by_product

Whether to include the purchase count by product inside purchases. Defaults to False.

boolean

Whether to include the purchase count by product inside purchases. Defaults to False.

Responses

Successful Response

Response for daily aggregation reports

application/json
object
hasMore
required

Whether this is the last page of results or not.

boolean
nextPage

A token to retrieve the next page of results.

string
>= 1 characters
reports
required

A list with report data aggregated by day.

Array<object>

Clicks, impressions and purchases attributed to this report item so far, for a particular date

object
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
date
required

The date for this aggregation.

string format: date
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