Skip to main content
GET
/
public
/
v1
/
toppie
/
reporting
/
campaigns
/
{campaign-id}
/
products
[BETA] Get Campaign Products Report.
curl --request GET \
  --url https://api.topsort.com/public/v1/toppie/reporting/campaigns/{campaign-id}/products \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "products": [
    {
      "adSpend": 1,
      "cpc": 123,
      "ctr": 123,
      "conversionRate": 123,
      "impressions": 1,
      "chargedImpressions": 1,
      "clicks": 1,
      "chargedClicks": 1,
      "purchaseCount": 1,
      "purchaseRevenue": 1,
      "roas": 123,
      "ean": "<string>",
      "totalPurchaseQuantity": 1,
      "productName": "<string>",
      "imageUrl": "<string>",
      "isActive": true
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

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

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

​
search
string

The search string for a given query.

​
next_page
string | null

Token for retrieving the next page.

​
limit
integer
default:100

Maximum number of products to retrieve.

Required range: 1 <= x <= 100

Response

Successful Response

​
hasMore
boolean
required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

​
products
GlobalCatalogProductKpi · object[]
required
​
nextPage
string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1
Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="