---
title: "List spend records"
method: GET
path: "/spend"
---

# List spend records

`GET /spend`

## Query parameters

- `date` string, date — The date of spend entries to search for - provide this OR the Date Start/End ONLY
- `date_start` string, date — The date range of a spend entries to search for - provide this or and a end date OR a date ONLY
- `date_end` string, date — The date range of a spend entries to search for - provide this or and a start date OR a date ONLY
- `platform_account_id` string — The Ad Platform Account ID to search for, required
- `campaign_id` string — The Ad Platform's Campaign ID to search for
- `adset_id` string — The Ad Platform's Adset ID to search for
- `ad_id` string — The Ad Platform's Ad ID to search for
- `page` integer — If Paginating - supply page number
- `page_size` integer — Results per page - Maximum of 1000 results per page

## Response `200`

List of spend records.

- SpendListOutputPayload
  - `data` SpendDefaultOutput[], required
    - `date` string, date, required — The date of spend entry to upsert, required
    - `platform_account_id` string — The Ad Platform Account ID to upsert, used for segregating ad objects per ad platform account
    - `platform_name` string, required — The Ad Platform Name to upsert, required
    - `campaign_id` string, required — The Ad Platform's Campaign ID (utm_campaign, if known) to upsert, required
    - `campaign_name` string, required — The Ad Platform Campaign Name to upsert - will be as Ad Name in the Northbeam Dashboard - can be the same as `campaign_id`
    - `adset_id` string — The Ad Platform's Adset ID (utm_term, if known) to upsert, defaults to '' if empty (not all platforms support adsets)
    - `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
    - `ad_id` string — The Ad Platform's Ad ID (utm_content, if known) to upsert, defaults to '' if empty (not all platforms support ads)
    - `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
    - `spend` number, required — Amount (in currency) spent on ad object to upsert, defaults to 0 if empty
    - `spend_currency` string, required — The Currency of the Spend per ISO 4217 to upsert, required
    - `impressions` number — The amount of impressions the ad object received on a given date, defaults to 0 if empty
    - `clicks` number — The amount of clicks the ad object received on a given date, defaults to 0 if empty
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `page` integer, required
  - `page_size` integer, required
  - `total_pages` integer, required
  - `total_count` integer, required

## Other responses

- `401` — Authentication failed.
- `422` — The request body is invalid.
- `4XX` — An unexpected error occurred.
- `5XX` — An unexpected error occurred.

---

[API](https://skmtc.net/northbeam/apis/api-spend-v1.md) · [All operations](https://skmtc.net/northbeam/apis/api-spend-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/northbeam/api-spend-v1/versions/ce42b431eeeb/schema)