{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/2016/ads/cards","auth":"required","settings":"5eb0433271fd4503c0318dd8","results":{"codes":[{"name":"","code":"{\n  \"totalRows\": 1525,\n  \"totalPages\": 763,\n  \"page\": 1,\n  \"pageSize\": 2,\n  \"meta\": {\n    \"size\": {\n      \"0x0\": 1,\n      \"100x72\": 1,\n      \"1024x512\": 1,\n      \"1200x627\": 1,\n      \"120x20\": 1,\n      \"120x600\": 1,\n      \"1275x3450\": 1,\n      \"1280x627\": 1,\n      \"160x600\": 1,\n      \"161x601\": 1,\n      \"168x28\": 1,\n      \"180x150\": 1,\n      \"1x1\": 1,\n      \"200x200\": 1,\n      \"211x48\": 1,\n      \"216x36\": 1,\n      \"250x250\": 1,\n      \"254x133\": 1,\n      \"276x91\": 1,\n      \"2x4\": 1,\n      \"300x100\": 1,\n      \"300x1050\": 1,\n      \"300x250\": 1,\n      \"300x50\": 1,\n      \"300x600\": 1,\n      \"301x251\": 1,\n      \"320x480\": 1,\n      \"320x50\": 1,\n      \"336x280\": 1,\n      \"468x60\": 1,\n      \"468x80\": 1,\n      \"500x500\": 1,\n      \"640x480\": 1,\n      \"701x240\": 1,\n      \"728x90\": 1,\n      \"729x91\": 1,\n      \"950x90\": 1,\n      \"970x251\": 1,\n      \"970x90\": 1,\n      \"980x120\": 1\n    }\n  },\n  \"items\": [\n    {\n      \"id\": 2467321,\n      \"advertisement_id\": 2467321,\n      \"advertisement_type\": 2,\n      \"name\": \"160808 SizeFitsAll160x600 Retargeting\",\n      \"is_enabled\": true,\n      \"creative_width\": 160,\n      \"creative_height\": 600,\n      \"cpm_cents\": null,\n      \"last_modified_time\": \"08-17-2016 05:43 PM\"\n    },\n    {\n      \"id\": 2467319,\n      \"advertisement_id\": 2467319,\n      \"advertisement_type\": 2,\n      \"name\": \"160808 SizeFitsAll-728x90 Retargeting\",\n      \"is_enabled\": true,\n      \"creative_width\": 728,\n      \"creative_height\": 90,\n      \"cpm_cents\": null,\n      \"last_modified_time\": \"08-17-2016 05:43 PM\"\n    }\n  ]\n}\n","language":"json","status":200},{"name":"","code":"Invalid API Auth Token","language":"text","status":401},{"code":"Insufficient permissions to fetch advertisements","language":"text","status":403},{"code":"[\n  [\n    \"Application error\",\n    \"Support team has been notified\"\n  ]\n]\n","language":"json","status":500}]},"params":[{"name":"x-auth-token","type":"string","default":"","desc":"Token for API access","required":false,"in":"header","ref":"","_id":"5eb04981e4d16801b0356537"},{"name":"campaign_id","type":"string","default":"","desc":"Either company_id or campaign_id is required","required":false,"in":"query","ref":"","_id":"5eb049f813cde700605c9c9c"},{"name":"company_id","type":"string","default":"","desc":"Either company_id or campaign_id is required","required":false,"in":"query","ref":"","_id":"5eb049f813cde700605c9c9b"},{"name":"filter[bonus]","type":"string","default":"one of (true, false)","desc":"Filter advertisements based on whether they are bonus advertisements.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b064"},{"name":"filter[end_date]","type":"yyyy-mm-dd","default":"","desc":"Filter advertisements by their end date.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b063"},{"name":"filter[paused]","type":"string","default":"one of (true, false)","desc":"Filter advertisements based on whether they are paused or running.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b062"},{"name":"filter[size]","type":"string","default":"matching ^(?:[0-9]+x[0-9]+,)*(?:[0-9]+x[0-9]+)$","desc":"Filter advertisements by CSV of their creatives' size.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b061"},{"name":"filter[start_date]","type":"yyyy-mm-dd","default":"","desc":"Filter advertisements by their start date.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b060"},{"name":"filter[type]","type":"string","default":"matching ^(?:[0-8],)*(?:[0-8])$","desc":"Filter advertisements by CSV of advertisement types. 0 - Text, 1 - HTML, 2 - Image, 3 - Flash, 4 - VAST Video","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b05f"},{"name":"order[advertisement_id]","type":"string","default":"one of (asc, desc)","desc":"Sort by advertisement_id, older advertisements have smaller advertisement_id.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b05e"},{"name":"order[advertisement_type]","type":"string","default":"one of (asc, desc)","desc":"Sort by advertisement_type.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b05d"},{"name":"order[creation_time]","type":"string","default":"one of (asc, desc)","desc":"Sort by the time advertisement was created at.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b05c"},{"name":"order[creative_height]","type":"string","default":"one of (asc, desc)","desc":"Sort by advertisement's creative's height.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b05b"},{"name":"order[creative_width]","type":"string","default":"one of (asc, desc)","desc":"Sort by advertisement's creative's width.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b05a"},{"name":"order[end_date]","type":"string","default":"one of (asc, desc)","desc":"Sort by the end date of the advertisement.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b059"},{"name":"order[last_modified_time]","type":"string","default":"one of (asc, desc)","desc":"Sort by the time advertisement was last modified at.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b058"},{"name":"order[name]","type":"string","default":"one of (asc, desc)","desc":"Sort by name alphabetically.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b057"},{"name":"order[start_date]","type":"string","default":"one of (asc, desc)","desc":"Sort by the start date of the advertisement.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b056"},{"name":"page","type":"int","default":"","desc":"Pagination parameter, gets the page based on the page_size. If page_size = 20 and page = 2, it will return advertisments 21 to 40.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b055"},{"name":"page_size","type":"int","default":"","desc":"Pagination parameter, defines page size.","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b054"},{"name":"released_feature_native_ads","type":"boolean","default":"","desc":"Show the native ads","required":false,"in":"query","ref":"","_id":"5eb05213ca2c23002452b053"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Get All Ads for a Campaign or an Advertiser","type":"endpoint","slug":"test-input","excerpt":"","body":"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5eb0434b79e8dd032b381949","createdAt":"2020-05-04T16:31:07.333Z","user":"5eb01f8e661699003c0d571b","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Zeta DSP API","slug":"dsp-api","order":14,"from_sync":false,"reference":false,"_id":"5ea811617bf4b5007328a0af","createdAt":"2020-04-28T11:20:01.502Z","version":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","__v":0},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56aff08d3a5b810d00745d9d","56aff24f3a5b810d00745da0","56aff25dbc304a0d00ace207","56aff287e0b1e40d00c53798","56aff2b260a37a0d00ed8883","56aff2b8e0b1e40d00c53799","56aff2bd5b1f01170014dc7b","56aff2c9d21e9c0d00b62993","56aff493aef9a21700da0e67","56aff4ce1486990d009c0f64","56aff4da5b1f01170014dc7d","56aff4dfe0b1e40d00c537a2","56aff4e59d32e30d0006d3e9","56aff4e91486990d009c0f65","56aff4f93a5b810d00745da2","56aff4fe9d32e30d0006d3ea","56b91c7ab1e03e0d001057c5","56c4f51aba4a540d0091b9a2","56cd09488c4a331d002c1e44","56d4ec4773dcd20b00fb8769","56e79bc515f96b2200878e54","56ec25c538ff1d2200d56cc2","56ec3a6f36bc8e0e00f190c8","56ec3e308ea7ce0e00a3d8b0","5724d8fe4255580e005938b2","5724dc842ad0bc1700122803","5776ef2a04f7500e0095dc37","57ab9f70b5e8742000e17eb9","57d7117646dcc30e007dd21f","58e6abd5b1eece19008b7d31","59288c65e2653627003e1221","5a8f4797a44f8600128e75ee","5bbf8833eb416300039a2c14","5ea811617bf4b5007328a0af"],"_id":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","releaseDate":"2016-02-01T23:55:56.544Z","__v":34,"createdAt":"2016-02-01T23:55:56.544Z"},"project":"56aff08c3a5b810d00745d99","__v":6,"parentDoc":null}

getGet All Ads for a Campaign or an Advertiser


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

campaign_id:
string
Either company_id or campaign_id is required
company_id:
string
Either company_id or campaign_id is required
filter[bonus]:
stringone of (true, false)
Filter advertisements based on whether they are bonus advertisements.
filter[end_date]:
yyyy-mm-dd
Filter advertisements by their end date.
filter[paused]:
stringone of (true, false)
Filter advertisements based on whether they are paused or running.
filter[size]:
stringmatching ^(?:[0-9]+x[0-9]+,)*(?:[0-9]+x[0-9]+)$
Filter advertisements by CSV of their creatives' size.
filter[start_date]:
yyyy-mm-dd
Filter advertisements by their start date.
filter[type]:
stringmatching ^(?:[0-8],)*(?:[0-8])$
Filter advertisements by CSV of advertisement types. 0 - Text, 1 - HTML, 2 - Image, 3 - Flash, 4 - VAST Video
order[advertisement_id]:
stringone of (asc, desc)
Sort by advertisement_id, older advertisements have smaller advertisement_id.
order[advertisement_type]:
stringone of (asc, desc)
Sort by advertisement_type.
order[creation_time]:
stringone of (asc, desc)
Sort by the time advertisement was created at.
order[creative_height]:
stringone of (asc, desc)
Sort by advertisement's creative's height.
order[creative_width]:
stringone of (asc, desc)
Sort by advertisement's creative's width.
order[end_date]:
stringone of (asc, desc)
Sort by the end date of the advertisement.
order[last_modified_time]:
stringone of (asc, desc)
Sort by the time advertisement was last modified at.
order[name]:
stringone of (asc, desc)
Sort by name alphabetically.
order[start_date]:
stringone of (asc, desc)
Sort by the start date of the advertisement.
page:
integer
Pagination parameter, gets the page based on the page_size. If page_size = 20 and page = 2, it will return advertisments 21 to 40.
page_size:
integer
Pagination parameter, defines page size.
released_feature_native_ads:
boolean
Show the native ads

Headers

x-auth-token:
string
Token for API access

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}