GET
/
public
/
v1
/
reporting-service
/
campaigns
/
{campaign-id}
/
daily
{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "reports": [
    {
      "clicks": {
        "adSpent": 123,
        "adSpentDecimal": "<string>",
        "charged": 123,
        "total": 123
      },
      "date": "2023-12-25",
      "impressions": {
        "adSpent": 123,
        "adSpentDecimal": "<string>",
        "charged": 123,
        "total": 123
      },
      "purchases": {
        "amount": 123,
        "count": 123,
        "countByProduct": {},
        "quantity": 123
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Path Parameters

​
campaign-id
string<uuid>
required

The ID of the campaign.

Query Parameters

​
limit
integer
default:100

The pagination limit.

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

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.

​
purchase_count_by_product
boolean
default:false

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

Response

200
application/json

Successful Response

Response for daily aggregation reports