Skip to main content
GET
/
public
/
v1
/
reporting-service
/
interactions
Get Marketplace Interactions Report
curl --request GET \
  --url https://api.topsort.com/public/v1/reporting-service/interactions \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "interactions": [
    {
      "vendorId": "<string>",
      "campaignId": "<string>",
      "productId": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "impressions": 123,
      "clicks": 123,
      "chargedClicks": 123,
      "adSpentClicks": 123,
      "chargedImpressions": 123,
      "adSpentImpressions": 123,
      "totalPurchaseAmount": 123,
      "totalPurchaseQuantity": 123,
      "totalPurchaseCount": 123,
      "adSpentExclusiveCampaign": 123,
      "chargedAttributedPurchases": 123,
      "adSpentAttributedPurchases": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

Query Parameters

start_date
string<date-time>
required
end_date
string<date-time>
required
limit
integer
default:1000
Required range: 0 <= x <= 1000
group_by
enum<string>
Available options:
vendor,
campaign,
product
granularity
enum<string>
Available options:
daily,
hourly
next_page
string | null

Response

hasMore
boolean
required
interactions
InteractionReportEntry · object[]
required
nextPage
string | null
Minimum length: 1
Examples: