GET
/
public
/
v1
/
toppie
/
reporting
/
campaigns
/
{campaign-id}
/
products
curl --request GET \
  --url https://api.topsort.com/public/v1/toppie/reporting/campaigns/{campaign-id}/products
{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "products": [
    {
      "adSpend": 1,
      "chargedClicks": 1,
      "chargedImpressions": 1,
      "clicks": 1,
      "conversionRate": 123,
      "cpc": 123,
      "ctr": 123,
      "ean": "<string>",
      "imageUrl": "<string>",
      "impressions": 1,
      "isActive": true,
      "productName": "<string>",
      "purchaseCount": 1,
      "purchaseRevenue": 1,
      "roas": 123,
      "totalPurchaseQuantity": 1
    }
  ]
}

Path Parameters

campaign-id
string
required

The ID of the campaign.

Query Parameters

start_date
string
required

The start date for which reports will be generated.

end_date
string
required

The end date for which reports will be generated.

The search string for a given query.

next_page
string

Token for retrieving the next page.

limit
integer
default:
100

Maximum number of products to retrieve.

Required range: 1 < x < 100

Response

200
application/json
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
object[]
required
nextPage
string

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

Minimum length: 1