Get Marketplace Report

Endpoint to get a marketplace’s total behavioral summary report between given dates.

GET /public/v1/reporting-service/marketplace

Get Marketplace Report

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/reporting-service/marketplace \
  --header 'Authorization: Bearer <token>'

200

{
  "impressions": {
    "total": 123,
    "charged": 123,
    "adSpent": 123,
    "adSpentDecimal": "<string>"
  },
  "clicks": {
    "total": 123,
    "charged": 123,
    "adSpent": 123,
    "adSpentDecimal": "<string>"
  },
  "purchases": {
    "amount": 123,
    "count": 123,
    "quantity": 123,
    "countByProduct": {}
  }
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Query Parameters

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.

Response

200

application/json

Successful Response

Clicks, impressions and purchases attributed to this report item so far.

impressions · Events · object · required

How many impressions are attributed to this report item.

Show child attributes

clicks · Events · object · required

How many clicks are attributed to this report item.

Show child attributes

purchases · Purchases · object · required

How many purchases are attributed to this report item.

Show child attributes