GET
/
public
/
v1
/
offsite-ads
/
reporting
/
campaigns
/
{campaign-id}
/
products
Get Campaign Products Report
curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/reporting/campaigns/{campaign-id}/products \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "reports": [
    {
      "clicks": {
        "adSpent": 123,
        "adSpentDecimal": "<string>",
        "charged": 123,
        "total": 123
      },
      "impressions": {
        "adSpent": 123,
        "adSpentDecimal": "<string>",
        "charged": 123,
        "total": 123
      },
      "productId": "<string>",
      "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 to get ad groups for.

Query Parameters

vendor_id
string
required

The ID of the vendor to get the campaign products 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.

limit
integer
default:100

The pagination limit.

Required range: 0 <= x <= 365
next_page
string

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

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.

reports
ProductReportData · object[]
required

The products for the campaign

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
Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="