Saltar para o conteúdo principal
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,
  "interactions": [
    {
      "vendorId": "<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,
      "campaignId": "<string>",
      "productId": "<string>"
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Autorizações

Authorization
string
header
obrigatório

A valid API key generated in Topsort's UI.

Parâmetros de consulta

start_date
string<date-time>
obrigatório

The start date for which reports will be generated, specified in RFC 3339.

end_date
string<date-time>
obrigatório

The end date for which reports will be generated, specified in RFC 3339.

limit
integer
padrão:1000

The pagination limit.

Intervalo necessário: 0 <= x <= 1000
group_by
enum<string>
padrão:vendor

How to group the results (vendor, campaign, or product).

Opções disponíveis:
vendor,
campaign,
product
granularity
enum<string>
padrão:daily

The time granularity of the report (daily or hourly).

Opções disponíveis:
daily,
hourly
next_page
string | null

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

Resposta

Successful Response

Unified response model for both daily and hourly interactions reports.

Contains a list of interaction entries, each representing detailed metrics for a specific entity (vendor, campaign, or product) at a given timestamp. The response is paginated to handle large datasets.

hasMore
boolean
obrigatório

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.

interactions
InteractionReportEntry · object[]
obrigatório

List of interaction report entries, each containing detailed metrics for a specific entity and timestamp.

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

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="