v1

latestOpenAPI 3.1.02026-07-24152752.3 KB

List spend records

get/spend_hourly

Query parameters

hour_start_iso_beginstring date-time

The date range of a spend entries to search for - provide this or and a end date OR a date ONLY

Example:1970-01-01T00:00:00-0000

hour_start_iso_endstring date-time

The date range of a spend entries to search for - provide this or and a start date OR a date ONLY

Example:1970-01-01T01:00:00-0000

platform_account_idstring

The Ad Platform Account ID to search for, required

Example:12345

campaign_idstring

The Ad Platform's Campaign ID to search for

Example:12345

adset_idstring

The Ad Platform's Adset ID to search for

Example:12345

ad_idstring

The Ad Platform's Ad ID to search for

Example:12345

pageinteger

If Paginating - supply page number

Example:1

page_sizeinteger

Results per page - Maximum of 1000 results per page

Example:1000

Response

List of spend records.

pageinteger required

page_sizeinteger required

total_pagesinteger required

total_countinteger required

Example response

{
  "data": [
    {
      "hour_start_iso": "1970-01-01T00:00:00-0000",
      "platform_account_id": "12345",
      "platform_name": "Facebook",
      "campaign_id": "12345",
      "campaign_name": "Banana Festival Awareness Campaign",
      "adset_id": "12345",
      "adset_name": "Banana Adset",
      "ad_id": "12345",
      "ad_name": "Banana Ad",
      "spend": 123.5,
      "spend_currency": "USD",
      "impressions": 299
    }
  ]
}