List campaigns
GET {{baseUrl}}/ad_accounts/:ad_account_id/campaigns?campaign_ids=978&entity_statuses=ACTIVE&entity_statuses=PAUSED&page_size=25&order=DESCENDING&bookmark=<string>
Get a list of the campaigns in the specified adaccountid
, filtered by the specified options.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
campaign_ids | number | List of Campaign Ids to use to filter the results. | |
entity_statuses | string | Entity status | |
entity_statuses | string | Entity status | |
page_size | number | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information. | |
order | string | The order in which to sort the items returned: “ASCENDING” or “DESCENDING” | |
by ID. Note that higher-value IDs are associated with more-recently added | |||
items. | |||
bookmark | string | Cursor used to fetch the next page of items |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"51459571","ad_account_id":"716625","name":"\u003cstring\u003e","status":"ACTIVE","lifetime_spend_cap":"\u003cinteger\u003e","daily_spend_cap":"\u003cinteger\u003e","order_line_id":"6373432117","tracking_urls":{"impression":["\u003cstring\u003e","\u003cstring\u003e"],"click":["\u003cstring\u003e","\u003cstring\u003e"],"engagement":["\u003cstring\u003e","\u003cstring\u003e"],"buyable_button":["\u003cstring\u003e","\u003cstring\u003e"],"audience_verification":["\u003cstring\u003e","\u003cstring\u003e"]},"start_time":"\u003cinteger\u003e","end_time":"\u003cinteger\u003e","summary_status":"COMPLETED","objective_type":"WEB_CONVERSION","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e","type":"\u003cstring\u003e","is_flexible_daily_budgets":"\u003cboolean\u003e","is_campaign_budget_optimization":"\u003cboolean\u003e"},{"id":"486570","ad_account_id":"4863823960","name":"\u003cstring\u003e","status":"ACTIVE","lifetime_spend_cap":"\u003cinteger\u003e","daily_spend_cap":"\u003cinteger\u003e","order_line_id":"361629","tracking_urls":{"impression":["\u003cstring\u003e","\u003cstring\u003e"],"click":["\u003cstring\u003e","\u003cstring\u003e"],"engagement":["\u003cstring\u003e","\u003cstring\u003e"],"buyable_button":["\u003cstring\u003e","\u003cstring\u003e"],"audience_verification":["\u003cstring\u003e","\u003cstring\u003e"]},"start_time":"\u003cinteger\u003e","end_time":"\u003cinteger\u003e","summary_status":"ADVERTISER_DISABLED","objective_type":"WEB_CONVERSION","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e","type":"\u003cstring\u003e","is_flexible_daily_budgets":"\u003cboolean\u003e","is_campaign_budget_optimization":"\u003cboolean\u003e"}],"bookmark":"\u003cstring\u003e"}