Skip to main content
POST
Create a data export

Autorisierungen

Authorization
string
header
erforderlich

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Body

application/json

The data you want to export.

dataset
enum<string>
erforderlich

The dataset to export. The datasets endpoint lists the ones you can request.

Verfügbare Optionen:
monitoring_metrics
Beispiel:

"monitoring_metrics"

dimensions
enum<string>[]
erforderlich

Dimensions to group the rows by; each one becomes a column in the file. Send each value once. Columns appear in the order you send them: dimensions first, then metrics.

Required array length: 1 - 27 elements

Dimensions you can group an export by; each one becomes a column in the file.

Verfügbare Optionen:
vendor_id,
campaign_id,
entity_type,
entity_id,
day_local,
device_type,
page_id,
page_type,
page_value,
placement_page,
auction_device,
auction_location,
auction_page_type,
auction_page_id,
auction_page_value,
auction_search_query,
auction_category,
currency_code,
external_vendor_id,
vendor_name,
campaign_name,
external_campaign_id,
status,
campaign_type,
ad_format,
charge_type,
is_active
Beispiel:
metrics
enum<string>[]
erforderlich

Metrics to include in each row; each one becomes a column in the file. Send each value once.

Required array length: 1 - 19 elements

Metrics you can include in an export; each one becomes a column in the file.

Verfügbare Optionen:
impressions,
clicks,
charged_clicks,
charged_impressions,
charged_attributed_purchases,
quantity,
purchase_count,
ad_spent_clicks,
ad_spent_impressions,
ad_spent_exclusive_campaign,
ad_spent_attributed_purchases,
ad_spend,
total_purchase_amount,
ctr,
conversion_rate,
cpc,
cpm,
roas,
acos
Beispiel:
granularity
enum<string>
erforderlich

How the rows are grouped in time. It must be one of the dataset's granularities; today only day_local is supported, one row per local day.

Verfügbare Optionen:
day_local
Beispiel:

"day_local"

startDate
string<date>
erforderlich

First local day to export (YYYY-MM-DD, inclusive). It can be at most 120 days before today in UTC.

Beispiel:

"2026-09-01"

endDate
string<date>
erforderlich

Last local day to export (YYYY-MM-DD, inclusive). It must be on or after startDate, and the window can cover up to 31 days counting both.

Beispiel:

"2026-09-07"

Antwort

Your export was accepted and is pending. Check it with the returned exportId until it is completed or failed.

The export you requested, which runs in the background.

exportId
string<uuid>
erforderlich

ID of your export. Use it to check the export's status.

Beispiel:

"218ad339-00cd-4e11-aeaa-8d96694908a0"

status
enum<string>
erforderlich

Always pending: your export starts in the background.

Verfügbare Optionen:
pending,
running,
completed,
failed
Beispiel:

"pending"

dataset
enum<string>
erforderlich

The dataset being exported.

Verfügbare Optionen:
monitoring_metrics
Beispiel:

"monitoring_metrics"

createdAt
string<date-time>
erforderlich

When you requested the export.

Beispiel:

"2026-09-08T14:03:12Z"