Skip to main content
POST
Create a data export

Autorizaciones

Authorization
string
header
requerido

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.

Cuerpo

application/json

The data you want to export.

dataset
enum<string>
requerido

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

Opciones disponibles:
monitoring_metrics
Ejemplo:

"monitoring_metrics"

dimensions
enum<string>[]
requerido

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.

Opciones disponibles:
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
Ejemplo:
metrics
enum<string>[]
requerido

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.

Opciones disponibles:
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
Ejemplo:
granularity
enum<string>
requerido

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.

Opciones disponibles:
day_local
Ejemplo:

"day_local"

startDate
string<date>
requerido

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

Ejemplo:

"2026-09-01"

endDate
string<date>
requerido

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.

Ejemplo:

"2026-09-07"

Respuesta

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>
requerido

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

Ejemplo:

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

status
enum<string>
requerido

Always pending: your export starts in the background.

Opciones disponibles:
pending,
running,
completed,
failed
Ejemplo:

"pending"

dataset
enum<string>
requerido

The dataset being exported.

Opciones disponibles:
monitoring_metrics
Ejemplo:

"monitoring_metrics"

createdAt
string<date-time>
requerido

When you requested the export.

Ejemplo:

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