Create a data export config

post

https://api.northbeam.io/v1/exports/data-export

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

export_file_name

string

length ≥ 3

Name of the exported file, if not provided, default one will be used.

level

string

enum

Defaults to platform

Level of metrics to export.

Allowed:

time_granularity

string

enum

Defaults to DAILY

Data time granularity.

Allowed:

period_type

string

enum

Defaults to LAST_7_DAYS

Time period to be exported. It can be either a relative window or a fixed window. If you choose to export a fixed window, the period_options property must be set.

period_options

object

Time frame to be exported if period_type is set to "FIXED". The time period cannot be greater than 2 years.

breakdowns

array of objects

Labels used to breakdown the data. If you are unsure which breakdowns to use, you can fetch them using the /breakdowns endpoint.

breakdowns

options

object

attribution_options

object

required

metrics

array of objects

required

≥ 1

Metrics to export. Check in /metrics for available metrics.

metrics*

Responses

401

Unauthorized

422

Invalid Body Params

429

Too many requests

500

Internal server error

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Data Export created successfully