← Tools Reference

Northbeam

Northbeam integration (Data, Marketing). Imported from open-connector.

API key5 toolshttps://api.northbeam.io/v1
GET
northbeam_list_metrics
List the metrics available for Northbeam data exports.

/exports/metrics

GET
northbeam_list_attribution_models
List the attribution models available for Northbeam data exports.

/exports/attribution-models

GET
northbeam_list_breakdowns
List the breakdown keys and values available for Northbeam data exports.

/exports/breakdowns

GET
northbeam_list_spend
List paginated Northbeam daily spend records.

/spend

9 parameters
ParamTypeRequiredDescription
datestringoptionalThe single spend date to fetch. Use this instead of date_start/date_end.
date_startstringoptionalThe start date for a spend date range.
date_endstringoptionalThe end date for a spend date range.
platform_account_idstringoptionalThe ad platform account ID to filter spend by.
campaign_idstringoptionalThe ad platform campaign ID to filter spend by.
adset_idstringoptionalThe ad platform ad set ID to filter spend by.
ad_idstringoptionalThe ad platform ad ID to filter spend by.
pageintegeroptionalThe result page to fetch.
page_sizeintegeroptionalThe number of results per page. Northbeam documents a maximum of 1000.
GET
northbeam_list_hourly_spend
List paginated Northbeam hourly spend records.

/spend_hourly

8 parameters
ParamTypeRequiredDescription
hour_start_iso_beginstringoptionalThe start date-time for the hourly spend range.
hour_start_iso_endstringoptionalThe end date-time for the hourly spend range.
platform_account_idstringoptionalThe ad platform account ID to filter spend by.
campaign_idstringoptionalThe ad platform campaign ID to filter spend by.
adset_idstringoptionalThe ad platform ad set ID to filter spend by.
ad_idstringoptionalThe ad platform ad ID to filter spend by.
pageintegeroptionalThe result page to fetch.
page_sizeintegeroptionalThe number of results per page. Northbeam documents a maximum of 1000.