Get Campaign Aggregated Report

Get campaign report.

GET /public/v1/offsite-ads/reporting/campaigns/{campaign-id}

Try it

Get Campaign Aggregated Report

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/reporting/campaigns/{campaign-id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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.

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

200

application/json

Successful Response

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

impressions · Events · object · required

How many impressions are attributed to this report item.

Show child attributes

impressions. total · integer<int64> · required

Total number of events.

impressions. charged · integer<int64> · required

Number of charged events.

impressions. adSpent · integer<int64> · required

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

impressions. adSpentDecimal · string | null

Ad spent over a period of time.

clicks · Events · object · required

How many clicks are attributed to this report item.

Show child attributes

clicks. total · integer<int64> · required

Total number of events.

clicks. charged · integer<int64> · required

Number of charged events.

clicks. adSpent · integer<int64> · required

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

clicks. adSpentDecimal · string | null

Ad spent over a period of time.

purchases · Purchases · object · required

How many purchases are attributed to this report item.

Show child attributes

purchases. amount · integer<int64> · required

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

purchases. count · integer<int64> · required

Amount of purchase events.

purchases. quantity · integer<int64> · required

Amount of items purchased.

purchases. countByProduct · Countbyproduct · object

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

Show child attributes

purchases.countByProduct. {key} · integer