API Reference

Create a data export config

post
https://api.northbeam.io/v1/exports/data-export
Body Params
string

Name of the bucket, if you choose to export to an external bucket.

string
enum
Defaults to platform

Level of metrics to export.

Allowed:
string
enum
Defaults to DAILY

Data time granularity.

Allowed:
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

429

Too many requests

500

Internal server error

Updated almost 3 years ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated almost 3 years ago