Create a Sales Attribution export

Create a Sales Attribution export (attributed performance metrics)

curl --request POST \
  --url https://api.northbeam.io/v1/exports/data-export \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Data-Client-ID: <api-key>' \
  --data '
{
  "attribution_options": {
    "attribution_models": [
      "<string>"
    ],
    "attribution_windows": [],
    "accounting_modes": []
  },
  "metrics": [
    {
      "id": "<string>",
      "label": "<string>"
    }
  ],
  "export_file_name": "<string>",
  "level": "platform",
  "time_granularity": "DAILY",
  "period_type": "LAST_7_DAYS",
  "period_options": {
    "period_starting_at": "2023-11-07T05:31:56Z",
    "period_ending_at": "2023-11-07T05:31:56Z"
  },
  "breakdowns": [
    {
      "key": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "options": {
    "export_aggregation": "BREAKDOWN",
    "remove_zero_spend": false,
    "aggregate_data": false,
    "include_ids": false,
    "include_kind_and_platform": false
  }
}
'

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'Data-Client-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    attribution_options: {
      attribution_models: ['<string>'],
      attribution_windows: [],
      accounting_modes: []
    },
    metrics: [{id: '<string>', label: '<string>'}],
    export_file_name: '<string>',
    level: 'platform',
    time_granularity: 'DAILY',
    period_type: 'LAST_7_DAYS',
    period_options: {
      period_starting_at: '2023-11-07T05:31:56Z',
      period_ending_at: '2023-11-07T05:31:56Z'
    },
    breakdowns: [{key: '<string>', values: ['<string>']}],
    options: {
      export_aggregation: 'BREAKDOWN',
      remove_zero_spend: false,
      aggregate_data: false,
      include_ids: false,
      include_kind_and_platform: false
    }
  })
};

fetch('https://api.northbeam.io/v1/exports/data-export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

payload = {
    "attribution_options": {
        "attribution_models": ["<string>"],
        "attribution_windows": [],
        "accounting_modes": []
    },
    "metrics": [
        {
            "id": "<string>",
            "label": "<string>"
        }
    ],
    "export_file_name": "<string>",
    "level": "platform",
    "time_granularity": "DAILY",
    "period_type": "LAST_7_DAYS",
    "period_options": {
        "period_starting_at": "2023-11-07T05:31:56Z",
        "period_ending_at": "2023-11-07T05:31:56Z"
    },
    "breakdowns": [
        {
            "key": "<string>",
            "values": ["<string>"]
        }
    ],
    "options": {
        "export_aggregation": "BREAKDOWN",
        "remove_zero_spend": False,
        "aggregate_data": False,
        "include_ids": False,
        "include_kind_and_platform": False
    }
}
headers = {
    "Authorization": "<api-key>",
    "Data-Client-ID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.northbeam.io/v1/exports/data-export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'attribution_options' => [
        'attribution_models' => [
                '<string>'
        ],
        'attribution_windows' => [
                
        ],
        'accounting_modes' => [
                
        ]
    ],
    'metrics' => [
        [
                'id' => '<string>',
                'label' => '<string>'
        ]
    ],
    'export_file_name' => '<string>',
    'level' => 'platform',
    'time_granularity' => 'DAILY',
    'period_type' => 'LAST_7_DAYS',
    'period_options' => [
        'period_starting_at' => '2023-11-07T05:31:56Z',
        'period_ending_at' => '2023-11-07T05:31:56Z'
    ],
    'breakdowns' => [
        [
                'key' => '<string>',
                'values' => [
                                '<string>'
                ]
        ]
    ],
    'options' => [
        'export_aggregation' => 'BREAKDOWN',
        'remove_zero_spend' => false,
        'aggregate_data' => false,
        'include_ids' => false,
        'include_kind_and_platform' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "Data-Client-ID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.northbeam.io/v1/exports/data-export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Data-Client-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attribution_options\": {\n    \"attribution_models\": [\n      \"<string>\"\n    ],\n    \"attribution_windows\": [],\n    \"accounting_modes\": []\n  },\n  \"metrics\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ],\n  \"export_file_name\": \"<string>\",\n  \"level\": \"platform\",\n  \"time_granularity\": \"DAILY\",\n  \"period_type\": \"LAST_7_DAYS\",\n  \"period_options\": {\n    \"period_starting_at\": \"2023-11-07T05:31:56Z\",\n    \"period_ending_at\": \"2023-11-07T05:31:56Z\"\n  },\n  \"breakdowns\": [\n    {\n      \"key\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"options\": {\n    \"export_aggregation\": \"BREAKDOWN\",\n    \"remove_zero_spend\": false,\n    \"aggregate_data\": false,\n    \"include_ids\": false,\n    \"include_kind_and_platform\": false\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"attribution_options\": {\n    \"attribution_models\": [\n      \"<string>\"\n    ],\n    \"attribution_windows\": [],\n    \"accounting_modes\": []\n  },\n  \"metrics\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ],\n  \"export_file_name\": \"<string>\",\n  \"level\": \"platform\",\n  \"time_granularity\": \"DAILY\",\n  \"period_type\": \"LAST_7_DAYS\",\n  \"period_options\": {\n    \"period_starting_at\": \"2023-11-07T05:31:56Z\",\n    \"period_ending_at\": \"2023-11-07T05:31:56Z\"\n  },\n  \"breakdowns\": [\n    {\n      \"key\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"options\": {\n    \"export_aggregation\": \"BREAKDOWN\",\n    \"remove_zero_spend\": false,\n    \"aggregate_data\": false,\n    \"include_ids\": false,\n    \"include_kind_and_platform\": false\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Data-Client-ID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.northbeam.io/v1/exports/data-export")
  .header("Authorization", "<api-key>")
  .header("Data-Client-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attribution_options\": {\n    \"attribution_models\": [\n      \"<string>\"\n    ],\n    \"attribution_windows\": [],\n    \"accounting_modes\": []\n  },\n  \"metrics\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ],\n  \"export_file_name\": \"<string>\",\n  \"level\": \"platform\",\n  \"time_granularity\": \"DAILY\",\n  \"period_type\": \"LAST_7_DAYS\",\n  \"period_options\": {\n    \"period_starting_at\": \"2023-11-07T05:31:56Z\",\n    \"period_ending_at\": \"2023-11-07T05:31:56Z\"\n  },\n  \"breakdowns\": [\n    {\n      \"key\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"options\": {\n    \"export_aggregation\": \"BREAKDOWN\",\n    \"remove_zero_spend\": false,\n    \"aggregate_data\": false,\n    \"include_ids\": false,\n    \"include_kind_and_platform\": false\n  }\n}")
  .asString();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

POST

data-export

Create a Sales Attribution export (attributed performance metrics)

curl --request POST \
  --url https://api.northbeam.io/v1/exports/data-export \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Data-Client-ID: <api-key>' \
  --data '
{
  "attribution_options": {
    "attribution_models": [
      "<string>"
    ],
    "attribution_windows": [],
    "accounting_modes": []
  },
  "metrics": [
    {
      "id": "<string>",
      "label": "<string>"
    }
  ],
  "export_file_name": "<string>",
  "level": "platform",
  "time_granularity": "DAILY",
  "period_type": "LAST_7_DAYS",
  "period_options": {
    "period_starting_at": "2023-11-07T05:31:56Z",
    "period_ending_at": "2023-11-07T05:31:56Z"
  },
  "breakdowns": [
    {
      "key": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "options": {
    "export_aggregation": "BREAKDOWN",
    "remove_zero_spend": false,
    "aggregate_data": false,
    "include_ids": false,
    "include_kind_and_platform": false
  }
}
'

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'Data-Client-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    attribution_options: {
      attribution_models: ['<string>'],
      attribution_windows: [],
      accounting_modes: []
    },
    metrics: [{id: '<string>', label: '<string>'}],
    export_file_name: '<string>',
    level: 'platform',
    time_granularity: 'DAILY',
    period_type: 'LAST_7_DAYS',
    period_options: {
      period_starting_at: '2023-11-07T05:31:56Z',
      period_ending_at: '2023-11-07T05:31:56Z'
    },
    breakdowns: [{key: '<string>', values: ['<string>']}],
    options: {
      export_aggregation: 'BREAKDOWN',
      remove_zero_spend: false,
      aggregate_data: false,
      include_ids: false,
      include_kind_and_platform: false
    }
  })
};

fetch('https://api.northbeam.io/v1/exports/data-export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

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

payload = {
    "attribution_options": {
        "attribution_models": ["<string>"],
        "attribution_windows": [],
        "accounting_modes": []
    },
    "metrics": [
        {
            "id": "<string>",
            "label": "<string>"
        }
    ],
    "export_file_name": "<string>",
    "level": "platform",
    "time_granularity": "DAILY",
    "period_type": "LAST_7_DAYS",
    "period_options": {
        "period_starting_at": "2023-11-07T05:31:56Z",
        "period_ending_at": "2023-11-07T05:31:56Z"
    },
    "breakdowns": [
        {
            "key": "<string>",
            "values": ["<string>"]
        }
    ],
    "options": {
        "export_aggregation": "BREAKDOWN",
        "remove_zero_spend": False,
        "aggregate_data": False,
        "include_ids": False,
        "include_kind_and_platform": False
    }
}
headers = {
    "Authorization": "<api-key>",
    "Data-Client-ID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.northbeam.io/v1/exports/data-export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'attribution_options' => [
        'attribution_models' => [
                '<string>'
        ],
        'attribution_windows' => [
                
        ],
        'accounting_modes' => [
                
        ]
    ],
    'metrics' => [
        [
                'id' => '<string>',
                'label' => '<string>'
        ]
    ],
    'export_file_name' => '<string>',
    'level' => 'platform',
    'time_granularity' => 'DAILY',
    'period_type' => 'LAST_7_DAYS',
    'period_options' => [
        'period_starting_at' => '2023-11-07T05:31:56Z',
        'period_ending_at' => '2023-11-07T05:31:56Z'
    ],
    'breakdowns' => [
        [
                'key' => '<string>',
                'values' => [
                                '<string>'
                ]
        ]
    ],
    'options' => [
        'export_aggregation' => 'BREAKDOWN',
        'remove_zero_spend' => false,
        'aggregate_data' => false,
        'include_ids' => false,
        'include_kind_and_platform' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "Data-Client-ID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.northbeam.io/v1/exports/data-export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Data-Client-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attribution_options\": {\n    \"attribution_models\": [\n      \"<string>\"\n    ],\n    \"attribution_windows\": [],\n    \"accounting_modes\": []\n  },\n  \"metrics\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ],\n  \"export_file_name\": \"<string>\",\n  \"level\": \"platform\",\n  \"time_granularity\": \"DAILY\",\n  \"period_type\": \"LAST_7_DAYS\",\n  \"period_options\": {\n    \"period_starting_at\": \"2023-11-07T05:31:56Z\",\n    \"period_ending_at\": \"2023-11-07T05:31:56Z\"\n  },\n  \"breakdowns\": [\n    {\n      \"key\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"options\": {\n    \"export_aggregation\": \"BREAKDOWN\",\n    \"remove_zero_spend\": false,\n    \"aggregate_data\": false,\n    \"include_ids\": false,\n    \"include_kind_and_platform\": false\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"attribution_options\": {\n    \"attribution_models\": [\n      \"<string>\"\n    ],\n    \"attribution_windows\": [],\n    \"accounting_modes\": []\n  },\n  \"metrics\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ],\n  \"export_file_name\": \"<string>\",\n  \"level\": \"platform\",\n  \"time_granularity\": \"DAILY\",\n  \"period_type\": \"LAST_7_DAYS\",\n  \"period_options\": {\n    \"period_starting_at\": \"2023-11-07T05:31:56Z\",\n    \"period_ending_at\": \"2023-11-07T05:31:56Z\"\n  },\n  \"breakdowns\": [\n    {\n      \"key\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"options\": {\n    \"export_aggregation\": \"BREAKDOWN\",\n    \"remove_zero_spend\": false,\n    \"aggregate_data\": false,\n    \"include_ids\": false,\n    \"include_kind_and_platform\": false\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Data-Client-ID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.northbeam.io/v1/exports/data-export")
  .header("Authorization", "<api-key>")
  .header("Data-Client-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attribution_options\": {\n    \"attribution_models\": [\n      \"<string>\"\n    ],\n    \"attribution_windows\": [],\n    \"accounting_modes\": []\n  },\n  \"metrics\": [\n    {\n      \"id\": \"<string>\",\n      \"label\": \"<string>\"\n    }\n  ],\n  \"export_file_name\": \"<string>\",\n  \"level\": \"platform\",\n  \"time_granularity\": \"DAILY\",\n  \"period_type\": \"LAST_7_DAYS\",\n  \"period_options\": {\n    \"period_starting_at\": \"2023-11-07T05:31:56Z\",\n    \"period_ending_at\": \"2023-11-07T05:31:56Z\"\n  },\n  \"breakdowns\": [\n    {\n      \"key\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"options\": {\n    \"export_aggregation\": \"BREAKDOWN\",\n    \"remove_zero_spend\": false,\n    \"aggregate_data\": false,\n    \"include_ids\": false,\n    \"include_kind_and_platform\": false\n  }\n}")
  .asString();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Headers

Header	Description
`Authorization` required	Your Northbeam API key
`Data-Client-ID` required	Your Northbeam client ID
`Content-Type` required	`application/json`

Body

Send one of the following 3 shapes.

Export to Northbeam documents

Field	Type	Description
`export_file_name`	string	Name of the exported file, if not provided, default one will be used. Minimum string length: `3` Pattern: `^[A-Za-z0-9_-]+$`
`level`	string	Level of metrics to export. Available options: `“platform”`, `“campaign”`, `“adset”`, `“ad”` Default: `“platform”`
`time_granularity`	string	Data time granularity. Available options: `“MONTHLY”`, `“WEEKLY”`, `“DAILY”`, `“HOURLY”` Default: `“DAILY”`
`period_type`	string	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. Available options: `“FIXED”`, `“TODAY”`, `“YESTERDAY”`, `“YESTERDAY_AND_TODAY”`, `“LAST_3_DAYS”`, `“LAST_7_DAYS”`, `“LAST_14_DAYS”`, `“LAST_28_DAYS”`, `“LAST_30_DAYS”`, `“LAST_60_DAYS”`, `“LAST_90_DAYS”`, `“LAST_180_DAYS”`, `“MONTH_TO_DATE”`, `“LAST_MONTH”`, `“THIS_WEEK”`, `“LAST_WEEK”`, `“THIS_WEEK_AND_LAST_WEEK”`, `“LAST_3_WEEKS”`, `“LAST_4_WEEKS”`, `“LAST_7_WEEKS”`, `“LAST_12_WEEKS”`, `“LAST_14_WEEKS”`, `“LAST_26_WEEKS”`, `“LAST_28_WEEKS”`, `“LAST_52_WEEKS”`, `“THIS_MONTH”`, `“THIS_MONTH_AND_LAST_MONTH”`, `“LAST_3_MONTHS”`, `“LAST_6_MONTHS”`, `“LAST_9_MONTHS”`, `“LAST_12_MONTHS”`, `“YEAR_TO_DATE”`, `“LAST_YEAR”`, `“LAST_3_YEARS”`, `“LAST_5_YEARS”` Default: `“LAST_7_DAYS”`
`period_options`	object	Time frame to be exported if `period_type` is set to “FIXED”. The time period cannot be greater than 2 years.
		Show child attributes Field Type Description `period_starting_at` string (date-time) `period_ending_at` string (date-time)
`breakdowns`	object[]	Labels used to breakdown the data. If you are unsure which breakdowns to use, you can fetch them using the `/breakdowns` endpoint.
		Show child attributes Field Type Description `key` string `values` string[]
`options`	object
		Show child attributes Field Type Description `export_aggregation` string Aggregation type. Available options: `“BREAKDOWN”`, `“DATE”` Default: `“BREAKDOWN”` `remove_zero_spend` boolean Remove rows with zero spend. Default: `false` `aggregate_data` boolean Aggregate data, ignoring campaign, adset and ad levels. Default: `false` `include_ids` boolean Include campaign, adset and ad ids in exported data. Default: `false` `include_kind_and_platform` boolean Include campaign, adset and ad kind and platform in exported data. Default: `false`
`attribution_options` required	object
		Show child attributes Field Type Description `attribution_models` string[] Attribution models to use. Check in `/attribution-models` for available models. Required range: `x >= 1` `attribution_windows` string[] Required range: `x >= 1` `accounting_modes` string[] Required range: `x >= 1`
`metrics` required	object[]	Metrics to export. Check in `/metrics` for available metrics. Required range: `x >= 1`
		Show child attributes Field Type Description `id` required string Metric ID `label` string Metric label to be used as file header. If not provided, a default label will be used. Pattern: `^[a-zA-Z][a-zA-Z0-9_]+[a-zA-Z0-9]$`

Export to GCS bucket

Field	Type	Description
`bucket_name` required	string	Name of the external bucket where to export your file.
`export_file_name`	string	Name of the exported file, if not provided, default one will be used. Can include subdirectory paths (e.g., `folder/subfolder/file`). Minimum string length: `3` Pattern: `^(?!/)(?!.*//)[A-Za-z0-9_/-]+(?<!/)$`
`level`	string	Level of metrics to export. Available options: `“platform”`, `“campaign”`, `“adset”`, `“ad”` Default: `“platform”`
`time_granularity`	string	Data time granularity. Available options: `“MONTHLY”`, `“WEEKLY”`, `“DAILY”`, `“HOURLY”` Default: `“DAILY”`
`period_type`	string	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. Available options: `“FIXED”`, `“TODAY”`, `“YESTERDAY”`, `“YESTERDAY_AND_TODAY”`, `“LAST_3_DAYS”`, `“LAST_7_DAYS”`, `“LAST_14_DAYS”`, `“LAST_28_DAYS”`, `“LAST_30_DAYS”`, `“LAST_60_DAYS”`, `“LAST_90_DAYS”`, `“LAST_180_DAYS”`, `“MONTH_TO_DATE”`, `“LAST_MONTH”`, `“THIS_WEEK”`, `“LAST_WEEK”`, `“THIS_WEEK_AND_LAST_WEEK”`, `“LAST_3_WEEKS”`, `“LAST_4_WEEKS”`, `“LAST_7_WEEKS”`, `“LAST_12_WEEKS”`, `“LAST_14_WEEKS”`, `“LAST_26_WEEKS”`, `“LAST_28_WEEKS”`, `“LAST_52_WEEKS”`, `“THIS_MONTH”`, `“THIS_MONTH_AND_LAST_MONTH”`, `“LAST_3_MONTHS”`, `“LAST_6_MONTHS”`, `“LAST_9_MONTHS”`, `“LAST_12_MONTHS”`, `“YEAR_TO_DATE”`, `“LAST_YEAR”`, `“LAST_3_YEARS”`, `“LAST_5_YEARS”` Default: `“LAST_7_DAYS”`
`period_options`	object	Time frame to be exported if `period_type` is set to “FIXED”. The time period cannot be greater than 2 years.
		Show child attributes Field Type Description `period_starting_at` string (date-time) `period_ending_at` string (date-time)
`breakdowns`	object[]	Labels used to breakdown the data. If you are unsure which breakdowns to use, you can fetch them using the `/breakdowns` endpoint.
		Show child attributes Field Type Description `key` string `values` string[]
`options`	object
		Show child attributes Field Type Description `export_aggregation` string Aggregation type. Available options: `“BREAKDOWN”`, `“DATE”` Default: `“BREAKDOWN”` `remove_zero_spend` boolean Remove rows with zero spend. Default: `false` `aggregate_data` boolean Aggregate data, ignoring campaign, adset and ad levels. Default: `false` `include_ids` boolean Include campaign, adset and ad ids in exported data. Default: `false` `include_kind_and_platform` boolean Include campaign, adset and ad kind and platform in exported data. Default: `false`
`attribution_options` required	object
		Show child attributes Field Type Description `attribution_models` string[] Attribution models to use. Check in `/attribution-models` for available models. Required range: `x >= 1` `attribution_windows` string[] Required range: `x >= 1` `accounting_modes` string[] Required range: `x >= 1`
`metrics` required	object[]	Metrics to export. Check in `/metrics` for available metrics. Required range: `x >= 1`
		Show child attributes Field Type Description `id` required string Metric ID `label` string Metric label to be used as file header. If not provided, a default label will be used. Pattern: `^[a-zA-Z][a-zA-Z0-9_]+[a-zA-Z0-9]$`

Export to S3 bucket

Field	Type	Description
`aws_role` required	string	AWS role ARN with access to the S3 bucket.
`region` required	string	Region of the S3 bucket.
`export_file_name`	string	Name of the exported file, if not provided, default one will be used. Can include subdirectory paths (e.g., `folder/subfolder/file`). Minimum string length: `3` Pattern: `^(?!/)(?!.*//)[A-Za-z0-9_/-]+(?<!/)$`
`level`	string	Level of metrics to export. Available options: `“platform”`, `“campaign”`, `“adset”`, `“ad”` Default: `“platform”`
`time_granularity`	string	Data time granularity. Available options: `“MONTHLY”`, `“WEEKLY”`, `“DAILY”`, `“HOURLY”` Default: `“DAILY”`
`period_type`	string	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. Available options: `“FIXED”`, `“TODAY”`, `“YESTERDAY”`, `“YESTERDAY_AND_TODAY”`, `“LAST_3_DAYS”`, `“LAST_7_DAYS”`, `“LAST_14_DAYS”`, `“LAST_28_DAYS”`, `“LAST_30_DAYS”`, `“LAST_60_DAYS”`, `“LAST_90_DAYS”`, `“LAST_180_DAYS”`, `“MONTH_TO_DATE”`, `“LAST_MONTH”`, `“THIS_WEEK”`, `“LAST_WEEK”`, `“THIS_WEEK_AND_LAST_WEEK”`, `“LAST_3_WEEKS”`, `“LAST_4_WEEKS”`, `“LAST_7_WEEKS”`, `“LAST_12_WEEKS”`, `“LAST_14_WEEKS”`, `“LAST_26_WEEKS”`, `“LAST_28_WEEKS”`, `“LAST_52_WEEKS”`, `“THIS_MONTH”`, `“THIS_MONTH_AND_LAST_MONTH”`, `“LAST_3_MONTHS”`, `“LAST_6_MONTHS”`, `“LAST_9_MONTHS”`, `“LAST_12_MONTHS”`, `“YEAR_TO_DATE”`, `“LAST_YEAR”`, `“LAST_3_YEARS”`, `“LAST_5_YEARS”` Default: `“LAST_7_DAYS”`
`period_options`	object	Time frame to be exported if `period_type` is set to “FIXED”. The time period cannot be greater than 2 years.
		Show child attributes Field Type Description `period_starting_at` string (date-time) `period_ending_at` string (date-time)
`breakdowns`	object[]	Labels used to breakdown the data. If you are unsure which breakdowns to use, you can fetch them using the `/breakdowns` endpoint.
		Show child attributes Field Type Description `key` string `values` string[]
`options`	object
		Show child attributes Field Type Description `export_aggregation` string Aggregation type. Available options: `“BREAKDOWN”`, `“DATE”` Default: `“BREAKDOWN”` `remove_zero_spend` boolean Remove rows with zero spend. Default: `false` `aggregate_data` boolean Aggregate data, ignoring campaign, adset and ad levels. Default: `false` `include_ids` boolean Include campaign, adset and ad ids in exported data. Default: `false` `include_kind_and_platform` boolean Include campaign, adset and ad kind and platform in exported data. Default: `false`
`attribution_options` required	object
		Show child attributes Field Type Description `attribution_models` string[] Attribution models to use. Check in `/attribution-models` for available models. Required range: `x >= 1` `attribution_windows` string[] Required range: `x >= 1` `accounting_modes` string[] Required range: `x >= 1`
`metrics` required	object[]	Metrics to export. Check in `/metrics` for available metrics. Required range: `x >= 1`
		Show child attributes Field Type Description `id` required string Metric ID `label` string Metric label to be used as file header. If not provided, a default label will be used. Pattern: `^[a-zA-Z][a-zA-Z0-9_]+[a-zA-Z0-9]$`

Responses

Status	Description
`201`	Data Export created successfully
`401`	Unauthorized
`422`	Invalid Body Params
`429`	Too many requests
`500`	Internal server error

`201` response body

Field	Type	Description
`id` required	string (uuid)

Authorizations

Authorization

string

header

required

Data-Client-ID

string

header

required

Body

application/json

Option 1
Option 2
Option 3

attribution_options

object

required

Show child attributes

metrics

object[]

required

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

Show child attributes

export_file_name

string

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

Minimum string length: 3

Pattern: ^[A-Za-z0-9_-]+$

level

enum<string>

default:platform

Level of metrics to export.

Available options:

platform,

campaign,

adset,

ad

time_granularity

enum<string>

default:DAILY

Data time granularity.

Available options:

MONTHLY,

WEEKLY,

DAILY,

HOURLY

period_type

enum<string>

default: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.

Available options:

FIXED,

TODAY,

YESTERDAY,

YESTERDAY_AND_TODAY,

LAST_3_DAYS,

LAST_7_DAYS,

LAST_14_DAYS,

LAST_28_DAYS,

LAST_30_DAYS,

LAST_60_DAYS,

LAST_90_DAYS,

LAST_180_DAYS,

MONTH_TO_DATE,

LAST_MONTH,

THIS_WEEK,

LAST_WEEK,

THIS_WEEK_AND_LAST_WEEK,

LAST_3_WEEKS,

LAST_4_WEEKS,

LAST_7_WEEKS,

LAST_12_WEEKS,

LAST_14_WEEKS,

LAST_26_WEEKS,

LAST_28_WEEKS,

LAST_52_WEEKS,

THIS_MONTH,

THIS_MONTH_AND_LAST_MONTH,

LAST_3_MONTHS,

LAST_6_MONTHS,

LAST_9_MONTHS,

LAST_12_MONTHS,

YEAR_TO_DATE,

LAST_YEAR,

LAST_3_YEARS,

LAST_5_YEARS

period_options

object

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

Show child attributes

breakdowns

object[]

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

Show child attributes

options

object

Show child attributes

Response

Data Export created successfully

string<uuid>

required

​Headers

​Body

​Export to Northbeam documents

​Export to GCS bucket

​Export to S3 bucket

​Responses

​201 response body

Authorizations

Body

Response

Headers

Body

Export to Northbeam documents

Export to GCS bucket

Export to S3 bucket

Responses

`201` response body