Reporting API

Get Marketplace Interactions Report

Get interactions report for a marketplace grouped by entity type.

This endpoint returns detailed interaction data (impressions, clicks, purchases, etc.) aggregated by the specified entity type (vendor, campaign, or product) and time granularity (daily or hourly). Results can optionally be filtered to a single vendor or campaign. The response is paginated to handle large datasets.

get/public/v1/reporting-service/interactions

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/public/v1/reporting-service/interactions
  • Auth: HTTP bearer

Query parameters

start_datestring date-time required

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

end_datestring date-time required

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

limitinteger

The pagination limit.

group_by'vendor' | 'campaign' | 'product'

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

granularity'daily' | 'hourly'

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

vendor_idstring nullable

External vendor ID. Filters the report to a single vendor.

campaign_idstring uuid nullable

Campaign ID. Filters the report to a single campaign.

next_pagestring nullable

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

Response

Successful Response

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

nextPagestring nullable

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

Example response

{
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Changes

No recorded changes to this operation across all 1 revision of this API.