Upsert one or multiple spend records

Upsert daily spend records

curl --request POST \
  --url https://api.northbeam.io/v1/spend \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Data-Client-ID: <api-key>' \
  --data '
{
  "data": [
    {
      "date": "1970-01-01",
      "platform_name": "Facebook",
      "campaign_id": "12345",
      "campaign_name": "Banana Festival Awareness Campaign",
      "spend": "123",
      "spend_currency": "USD",
      "platform_account_id": "12345",
      "adset_id": "12345",
      "adset_name": "Banana Adset",
      "ad_id": "12345",
      "ad_name": "Banana Ad",
      "impressions": 299,
      "clicks": 0
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'Data-Client-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: [
      {
        date: '1970-01-01',
        platform_name: 'Facebook',
        campaign_id: '12345',
        campaign_name: 'Banana Festival Awareness Campaign',
        spend: '123',
        spend_currency: 'USD',
        platform_account_id: '12345',
        adset_id: '12345',
        adset_name: 'Banana Adset',
        ad_id: '12345',
        ad_name: 'Banana Ad',
        impressions: 299,
        clicks: 0
      }
    ]
  })
};

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

import requests

url = "https://api.northbeam.io/v1/spend"

payload = { "data": [
        {
            "date": "1970-01-01",
            "platform_name": "Facebook",
            "campaign_id": "12345",
            "campaign_name": "Banana Festival Awareness Campaign",
            "spend": "123",
            "spend_currency": "USD",
            "platform_account_id": "12345",
            "adset_id": "12345",
            "adset_name": "Banana Adset",
            "ad_id": "12345",
            "ad_name": "Banana Ad",
            "impressions": 299,
            "clicks": 0
        }
    ] }
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/spend",
  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([
    'data' => [
        [
                'date' => '1970-01-01',
                'platform_name' => 'Facebook',
                'campaign_id' => '12345',
                'campaign_name' => 'Banana Festival Awareness Campaign',
                'spend' => '123',
                'spend_currency' => 'USD',
                'platform_account_id' => '12345',
                'adset_id' => '12345',
                'adset_name' => 'Banana Adset',
                'ad_id' => '12345',
                'ad_name' => 'Banana Ad',
                'impressions' => 299,
                'clicks' => 0
        ]
    ]
  ]),
  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/spend")

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  \"data\": [\n    {\n      \"date\": \"1970-01-01\",\n      \"platform_name\": \"Facebook\",\n      \"campaign_id\": \"12345\",\n      \"campaign_name\": \"Banana Festival Awareness Campaign\",\n      \"spend\": \"123\",\n      \"spend_currency\": \"USD\",\n      \"platform_account_id\": \"12345\",\n      \"adset_id\": \"12345\",\n      \"adset_name\": \"Banana Adset\",\n      \"ad_id\": \"12345\",\n      \"ad_name\": \"Banana Ad\",\n      \"impressions\": 299,\n      \"clicks\": 0\n    }\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/spend"

	payload := strings.NewReader("{\n  \"data\": [\n    {\n      \"date\": \"1970-01-01\",\n      \"platform_name\": \"Facebook\",\n      \"campaign_id\": \"12345\",\n      \"campaign_name\": \"Banana Festival Awareness Campaign\",\n      \"spend\": \"123\",\n      \"spend_currency\": \"USD\",\n      \"platform_account_id\": \"12345\",\n      \"adset_id\": \"12345\",\n      \"adset_name\": \"Banana Adset\",\n      \"ad_id\": \"12345\",\n      \"ad_name\": \"Banana Ad\",\n      \"impressions\": 299,\n      \"clicks\": 0\n    }\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/spend")
  .header("Authorization", "<api-key>")
  .header("Data-Client-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": [\n    {\n      \"date\": \"1970-01-01\",\n      \"platform_name\": \"Facebook\",\n      \"campaign_id\": \"12345\",\n      \"campaign_name\": \"Banana Festival Awareness Campaign\",\n      \"spend\": \"123\",\n      \"spend_currency\": \"USD\",\n      \"platform_account_id\": \"12345\",\n      \"adset_id\": \"12345\",\n      \"adset_name\": \"Banana Adset\",\n      \"ad_id\": \"12345\",\n      \"ad_name\": \"Banana Ad\",\n      \"impressions\": 299,\n      \"clicks\": 0\n    }\n  ]\n}")
  .asString();

{
  "data": [
    {
      "date": "1970-01-01",
      "platform_name": "Facebook",
      "campaign_id": "12345",
      "campaign_name": "Banana Festival Awareness Campaign",
      "spend": "123",
      "spend_currency": "USD",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "platform_account_id": "12345",
      "adset_id": "12345",
      "adset_name": "Banana Adset",
      "ad_id": "12345",
      "ad_name": "Banana Ad",
      "impressions": 299,
      "clicks": 0
    }
  ]
}

{
  "message": "<string>",
  "errors": [
    {
      "loc": "<string>",
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "<string>",
  "errors": [
    {
      "loc": "<string>",
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "<string>",
  "errors": [
    {
      "loc": "<string>",
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "<string>",
  "errors": [
    {
      "loc": "<string>",
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

POST

spend

Upsert daily spend records

curl --request POST \
  --url https://api.northbeam.io/v1/spend \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Data-Client-ID: <api-key>' \
  --data '
{
  "data": [
    {
      "date": "1970-01-01",
      "platform_name": "Facebook",
      "campaign_id": "12345",
      "campaign_name": "Banana Festival Awareness Campaign",
      "spend": "123",
      "spend_currency": "USD",
      "platform_account_id": "12345",
      "adset_id": "12345",
      "adset_name": "Banana Adset",
      "ad_id": "12345",
      "ad_name": "Banana Ad",
      "impressions": 299,
      "clicks": 0
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'Data-Client-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: [
      {
        date: '1970-01-01',
        platform_name: 'Facebook',
        campaign_id: '12345',
        campaign_name: 'Banana Festival Awareness Campaign',
        spend: '123',
        spend_currency: 'USD',
        platform_account_id: '12345',
        adset_id: '12345',
        adset_name: 'Banana Adset',
        ad_id: '12345',
        ad_name: 'Banana Ad',
        impressions: 299,
        clicks: 0
      }
    ]
  })
};

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

import requests

url = "https://api.northbeam.io/v1/spend"

payload = { "data": [
        {
            "date": "1970-01-01",
            "platform_name": "Facebook",
            "campaign_id": "12345",
            "campaign_name": "Banana Festival Awareness Campaign",
            "spend": "123",
            "spend_currency": "USD",
            "platform_account_id": "12345",
            "adset_id": "12345",
            "adset_name": "Banana Adset",
            "ad_id": "12345",
            "ad_name": "Banana Ad",
            "impressions": 299,
            "clicks": 0
        }
    ] }
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/spend",
  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([
    'data' => [
        [
                'date' => '1970-01-01',
                'platform_name' => 'Facebook',
                'campaign_id' => '12345',
                'campaign_name' => 'Banana Festival Awareness Campaign',
                'spend' => '123',
                'spend_currency' => 'USD',
                'platform_account_id' => '12345',
                'adset_id' => '12345',
                'adset_name' => 'Banana Adset',
                'ad_id' => '12345',
                'ad_name' => 'Banana Ad',
                'impressions' => 299,
                'clicks' => 0
        ]
    ]
  ]),
  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/spend")

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  \"data\": [\n    {\n      \"date\": \"1970-01-01\",\n      \"platform_name\": \"Facebook\",\n      \"campaign_id\": \"12345\",\n      \"campaign_name\": \"Banana Festival Awareness Campaign\",\n      \"spend\": \"123\",\n      \"spend_currency\": \"USD\",\n      \"platform_account_id\": \"12345\",\n      \"adset_id\": \"12345\",\n      \"adset_name\": \"Banana Adset\",\n      \"ad_id\": \"12345\",\n      \"ad_name\": \"Banana Ad\",\n      \"impressions\": 299,\n      \"clicks\": 0\n    }\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/spend"

	payload := strings.NewReader("{\n  \"data\": [\n    {\n      \"date\": \"1970-01-01\",\n      \"platform_name\": \"Facebook\",\n      \"campaign_id\": \"12345\",\n      \"campaign_name\": \"Banana Festival Awareness Campaign\",\n      \"spend\": \"123\",\n      \"spend_currency\": \"USD\",\n      \"platform_account_id\": \"12345\",\n      \"adset_id\": \"12345\",\n      \"adset_name\": \"Banana Adset\",\n      \"ad_id\": \"12345\",\n      \"ad_name\": \"Banana Ad\",\n      \"impressions\": 299,\n      \"clicks\": 0\n    }\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/spend")
  .header("Authorization", "<api-key>")
  .header("Data-Client-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": [\n    {\n      \"date\": \"1970-01-01\",\n      \"platform_name\": \"Facebook\",\n      \"campaign_id\": \"12345\",\n      \"campaign_name\": \"Banana Festival Awareness Campaign\",\n      \"spend\": \"123\",\n      \"spend_currency\": \"USD\",\n      \"platform_account_id\": \"12345\",\n      \"adset_id\": \"12345\",\n      \"adset_name\": \"Banana Adset\",\n      \"ad_id\": \"12345\",\n      \"ad_name\": \"Banana Ad\",\n      \"impressions\": 299,\n      \"clicks\": 0\n    }\n  ]\n}")
  .asString();

{
  "data": [
    {
      "date": "1970-01-01",
      "platform_name": "Facebook",
      "campaign_id": "12345",
      "campaign_name": "Banana Festival Awareness Campaign",
      "spend": "123",
      "spend_currency": "USD",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "platform_account_id": "12345",
      "adset_id": "12345",
      "adset_name": "Banana Adset",
      "ad_id": "12345",
      "ad_name": "Banana Ad",
      "impressions": 299,
      "clicks": 0
    }
  ]
}

{
  "message": "<string>",
  "errors": [
    {
      "loc": "<string>",
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "<string>",
  "errors": [
    {
      "loc": "<string>",
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "<string>",
  "errors": [
    {
      "loc": "<string>",
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "<string>",
  "errors": [
    {
      "loc": "<string>",
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "request_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

Field	Type	Description
`data` required	object[]
		Show child attributes Field Type Description Example `date` required string (date) The date of spend entry to upsert, required `”1970-01-01”` `platform_account_id` string The Ad Platform Account ID to upsert, used for segregating ad objects per ad platform account Default: `""` `"12345”` `platform_name` required string The Ad Platform Name to upsert, required `”Facebook”` `campaign_id` required string The Ad Platform’s Campaign ID (utm_campaign, if known) to upsert, required `”12345”` `campaign_name` required string The Ad Platform Campaign Name to upsert - will be as Ad Name in the Northbeam Dashboard - can be the same as `campaign_id` `”Banana Festival Awareness Campaign”` `adset_id` string The Ad Platform’s Adset ID (utm_term, if known) to upsert, defaults to ” if empty (not all platforms support adsets) Default: `""` `"12345”` `adset_name` string The Ad Platform Adset Name to upsert - will be as Ad Name in the Northbeam Dashboard - can be the same as `adset_id` - defaults to ” if empty Default: `""` `"Banana Adset”` `ad_id` string The Ad Platform’s Ad ID (utm_content, if known) to upsert, defaults to ” if empty (not all platforms support ads) Default: `""` `"12345”` `ad_name` string The Ad Platform Ad Name to upsert - will be as Ad Name in the Northbeam Dashboard - can be the same as `adset_id` - defaults to ” if empty Default: `""` `"Banana Ad”` `spend` required number Amount (in currency) spent on ad object to upsert, defaults to 0 if empty Required range: `x >= 0` `”123”` `spend_currency` required string The Currency of the Spend per ISO 4217 to upsert, required Required string length: `3 - 3` `”USD”` `impressions` number The amount of impressions the ad object received on a given date, defaults to 0 if empty Required range: `x >= 0` Default: `0` `299` `clicks` number The amount of clicks the ad object received on a given date, defaults to 0 if empty Required range: `x >= 0` Default: `0` `0`

Responses

Status	Description
`201`	The spend records were successfully upserted.
`401`	Authentication failed.
`422`	The request body is invalid.
`4XX`	An unexpected error occurred.
`5XX`	An unexpected error occurred.

`201` response body

Field	Type	Description
`data` required	object[]
		Show child attributes Field Type Description Example `date` required string (date) The date of spend entry to upsert, required `”1970-01-01”` `platform_account_id` string The Ad Platform Account ID to upsert, used for segregating ad objects per ad platform account Default: `""` `"12345”` `platform_name` required string The Ad Platform Name to upsert, required `”Facebook”` `campaign_id` required string The Ad Platform’s Campaign ID (utm_campaign, if known) to upsert, required `”12345”` `campaign_name` required string The Ad Platform Campaign Name to upsert - will be as Ad Name in the Northbeam Dashboard - can be the same as `campaign_id` `”Banana Festival Awareness Campaign”` `adset_id` string The Ad Platform’s Adset ID (utm_term, if known) to upsert, defaults to ” if empty (not all platforms support adsets) Default: `""` `"12345”` `adset_name` string The Ad Platform Adset Name to upsert - will be as Ad Name in the Northbeam Dashboard - can be the same as `adset_id` - defaults to ” if empty Default: `""` `"Banana Adset”` `ad_id` string The Ad Platform’s Ad ID (utm_content, if known) to upsert, defaults to ” if empty (not all platforms support ads) Default: `""` `"12345”` `ad_name` string The Ad Platform Ad Name to upsert - will be as Ad Name in the Northbeam Dashboard - can be the same as `adset_id` - defaults to ” if empty Default: `""` `"Banana Ad”` `spend` required number Amount (in currency) spent on ad object to upsert, defaults to 0 if empty Required range: `x >= 0` `”123”` `spend_currency` required string The Currency of the Spend per ISO 4217 to upsert, required Required string length: `3 - 3` `”USD”` `impressions` number The amount of impressions the ad object received on a given date, defaults to 0 if empty Required range: `x >= 0` Default: `0` `299` `clicks` number The amount of clicks the ad object received on a given date, defaults to 0 if empty Required range: `x >= 0` Default: `0` `0` `created_at` required string (date-time) `updated_at` required string (date-time)

`401` response body

Field	Type	Description
`errors`	object[], nullable
`message` required	string
`request_id`	string (uuid), nullable

`422` response body

Field	Type	Description
`errors`	object[], nullable
`message` required	string
`request_id`	string (uuid), nullable

`4XX` response body

Field	Type	Description
`errors`	object[], nullable
`message` required	string
`request_id`	string (uuid), nullable

`5XX` response body

Field	Type	Description
`errors`	object[], nullable
`message` required	string
`request_id`	string (uuid), nullable

Authorizations

Authorization

string

header

required

Data-Client-ID

string

header

required

Body

application/json

data

Spend Entry · object[]

required

Show child attributes

Response

The spend records were successfully upserted.

data

Spend Entry Return · object[]

required

Show child attributes

Using the API

Orders API

Spend API

Data Export API

Upsert one or multiple spend records

Headers

Body

Responses

`201` response body

`401` response body

`422` response body

`4XX` response body

`5XX` response body

Authorizations

Body

Response

​Headers

​Body

​Responses

​201 response body

​401 response body

​422 response body

​4XX response body

​5XX response body

Authorizations

Body

Response

Headers

Body

Responses

`201` response body

`401` response body

`422` response body

`4XX` response body

`5XX` response body