Skip to content
Topsort Documentation
API

Get Vendor Charges

GET
/v1/billing-service/vendor-charges

Endpoint to Get Vendor Charges.

Please note this is a beta API and therefore it is subject to change.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Query Parameters

object
start_date
required

The start of the date range for which to retrieve. Must include the Timezone definition.

string format: date-time

The start of the date range for which to retrieve. Must include the Timezone definition.

end_date
required

The end of the date range for which to retrieve. Must include the Timezone definition.

string format: date-time

The end of the date range for which to retrieve. Must include the Timezone definition.

Responses

Successful Response

application/json
object
currencyCode
required

The marketplace currency’s ISO 4217 code (e.g. USD).

string
>= 3 characters <= 3 characters
data
required
Array<object>
object
amount
required

Charged amount for a campaign. (In Local Marketplace Currency, ISO 4217 standard)

integer
campaignId
required

Campaign ID.

string format: uuid
externalVendorId

The vendor’s external ID in Marketplace.

string
interactionId
required

Click uuid

string format: uuid
interactionType
required

The type of the Interaction ID used in Vendor Charge.

string
Allowed values: Impression Click
productId
required

The product ID in Topsort.

string
timestamp
required

Timestamp of the click

string format: date-time
vendorId
required

The vendor’s internal ID in Topsort.

string format: uuid
endDate
required

Query end date.

string format: date-time
startDate
required

Query start date.

string format: date-time