{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/campaigns.json","auth":"required","settings":"","results":{"codes":[{"name":"","code":"[\n    {\n        \"name\": \"$0.1\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 500.0,\n        \"bid_amount\": 0.1,\n        \"status\": \"Active\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": null,\n        \"lifetime_budget_per_product\": null\n    },\n    {\n        \"name\": \"$0.2\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 100000000.0,\n        \"bid_amount\": 0.2,\n        \"status\": \"Active\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": 100000000.0,\n        \"lifetime_budget_per_product\": null\n    },\n    {\n        \"name\": \"$0.3\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 500.0,\n        \"bid_amount\": 0.3,\n        \"status\": \"Active\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": null,\n        \"lifetime_budget_per_product\": null\n    },\n    {\n        \"name\": \"$0.5\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 500.0,\n        \"bid_amount\": 0.5,\n        \"status\": \"Active\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": null,\n        \"lifetime_budget_per_product\": null\n    },\n    {\n        \"name\": \"$0.6\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 100000000.0,\n        \"bid_amount\": 0.6,\n        \"status\": \"Active\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": 100000000.0,\n        \"lifetime_budget_per_product\": null\n    },\n    {\n        \"name\": \"$0.7\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 5000.0,\n        \"bid_amount\": 0.7,\n        \"status\": \"Active\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": null,\n        \"lifetime_budget_per_product\": null\n    },\n    {\n        \"name\": \"$0.8\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 500.0,\n        \"bid_amount\": 0.8,\n        \"status\": \"Active\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": null,\n        \"lifetime_budget_per_product\": null\n    },\n    {\n        \"name\": \"$1\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 5000.0,\n        \"bid_amount\": 1.0,\n        \"status\": \"Active\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": null,\n        \"lifetime_budget_per_product\": null\n    },\n  \t{\n        \"name\": \"New Product Extended Promotional Campaign\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 5000.0,\n        \"bid_amount\": 1.7,\n        \"status\": \"Expired\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": null,\n        \"lifetime_budget_per_product\": null\n    },\n    {\n        \"name\": \"$1.1\",\n        \"type\": \"AuctionCampaign\",\n        \"daily_budget\": 5000.0,\n        \"bid_amount\": 1.1,\n        \"status\": \"Active\",\n        \"daily_budget_per_product\": null,\n        \"lifetime_budget\": null,\n        \"lifetime_budget_per_product\": null\n    },...\n]","language":"json","status":200}]},"params":[{"name":"status","type":"string","default":"","desc":"An optional filter. Lists the campaign(s) status. There are 3 status available: active, expired, and paused","required":false,"in":"query","ref":"","_id":"5e7c5f3c42c3c600491ea168"},{"name":"type","type":"string","default":"","desc":"An optional filter. Lists the campaign(s) type. Please take a look at Campaign Definition for the campaign(s) types list","required":false,"in":"query","ref":"","_id":"5e7c5f3c42c3c600491ea167"},{"name":"page","type":"int","default":"1","desc":"When paginating, the page of orders to return. Example: Assuming a per_page value of 50, page 1 would return orders 1 to 50 and page 2 would return products 51 to 100.","required":false,"in":"query","ref":"","_id":"5e870829f0917600611f3dda"},{"name":"per_page","type":"int","default":"50","desc":"The number of orders to return per page. 1000 is the maximum value.","required":false,"in":"query","ref":"","_id":"5e870829f0917600611f3dd9"}],"examples":{"codes":[{"code":"","language":"curl"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"List Campaigns","type":"endpoint","slug":"list-campaigns","excerpt":"","body":"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e7c5ad8727ddc0048dd8fa4","createdAt":"2020-03-26T07:33:44.060Z","user":"567f0baca74a1c0d003e1fba","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Campaigns","slug":"account","order":4,"from_sync":false,"reference":false,"_id":"5c64c200244bda003204b97f","project":"567f0c06143cc60d00c1fdbe","version":"567f0c06143cc60d00c1fdc1","createdAt":"2019-02-14T01:18:56.582Z","__v":1},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["567f0c07143cc60d00c1fdc2","56a9783109cb9c0d00f0c7d3","56a97837f834950d0037b363","56a9783b2d8fd90d0036eed6","56a979912d8fd90d0036eed8","5834b5691a80690f00d31faf","5834b5e4f775120f00c45f9d","5bf1a1473031e4005075ae14","5c64c200244bda003204b97f"],"_id":"567f0c06143cc60d00c1fdc1","__v":9,"createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","project":"567f0c06143cc60d00c1fdbe"},"project":"567f0c06143cc60d00c1fdbe","__v":9,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

status:
string
An optional filter. Lists the campaign(s) status. There are 3 status available: active, expired, and paused
type:
string
An optional filter. Lists the campaign(s) type. Please take a look at Campaign Definition for the campaign(s) types list
page:
integer1
When paginating, the page of orders to return. Example: Assuming a per_page value of 50, page 1 would return orders 1 to 50 and page 2 would return products 51 to 100.
per_page:
integer50
The number of orders to return per page. 1000 is the maximum value.

Result Format