{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/2016/campaigns","auth":"required","settings":"5eb0433271fd4503c0318dd8","results":{"codes":[{"name":"","code":"{\n  \"id\": 123,\n  \"label\": \"Campaign 1\",\n  \"name\": \"Campaign 1\",\n  \"campaign_id\": 123,\n  \"definer_id\": 456,\n  \"start_date\": \"2013/10/03 00:00:00\",\n  \"end_date\": \"2016/03/31 23:59:59\",\n  \"is_deleted\": false,\n  \"is_enabled\": false,\n  \"agency_id\": \"null\",\n  \"agency_name\": \"Agency 1\",\n  \"billing_source_id\": 1,\n  \"currency\": \"USD\",\n  \"exchange_frequency_cap_limit\": \"null\",\n  \"exchange_frequency_cap_reset_after_n_hours\": \"null\",\n  \"frequency_cap_limit\": \"null\",\n  \"frequency_cap_reset_after_n_hours\": \"null\",\n  \"sales_force_id\": \"00000000sfid\",\n  \"second_frequency_cap_limit\": \"null\",\n  \"second_frequency_cap_reset_after_n_hours\": \"null\",\n  \"adchoices_icon_type\": 0,\n  \"tag_corner\": 1,\n  \"privacy_tag\": false,\n  \"time_zone\": \"America/New_York\",\n  \"version_id\": 100000,\n  \"vertical\": \"Retail\",\n  \"frequency_cap_first\": \"null\",\n  \"frequency_cap_second\": \"null\",\n  \"frequency_cap_exchange\": \"null\",\n  \"max_cpm_cents\": 500,\n  \"landing_url\": \"https://www.test.com\",\n  \"fbx_impression_mode\": 0,\n  \"video_measurement_vendor_id\": \"null\",\n  \"advertiser_domain\": \"https://www.test.com\",\n  \"use_assigned_pixels_only\": false,\n  \"frequency_cap_source\": \"null\",\n  \"second_frequency_cap_source\": \"null\",\n  \"is_cross_device\": false,\n  \"service_type\": 1,\n  \"has_launched\": true,\n  \"cpa_cents\": 0,\n  \"cpc_cents\": 0,\n  \"cpm_cents\": 400,\n  \"daily_budget_cents\": \"null\",\n  \"daily_impressions\": \"null\",\n  \"objective_clicks\": \"null\",\n  \"objective_conversions\": \"null\",\n  \"objective_cpa_cents\": 500,\n  \"objective_cpc_cents\": 0,\n  \"objective_cpm_cents\": 0,\n  \"objective_ctr\": \"null\",\n  \"objective_impressions\": \"null\",\n  \"objective_revenue_share_percent\": 0,\n  \"objective_roas\": \"null\",\n  \"overall_budget_cents\": \"null\",\n  \"revenue_share_percent\": 0,\n  \"target_cpa_cents\": 0,\n  \"target_cpc_cents\": 0,\n  \"target_cpm_cents\": 400,\n  \"assigned_budget\": 1000000.01,\n  \"assigned_partner_budget\": 1000000.01,\n  \"objective\": {\n    \"type\": \"cpa\",\n    \"value\": 5,\n    \"default_lift_type\": \"cvr\"\n  },\n  \"countries\": [\n    \"US\"\n  ],\n  \"video_campaign\": false,\n  \"partner_margin_pct\": \"null\"\n}","language":"json","status":200},{"name":"","code":"Invalid API Auth Token","language":"text","status":401},{"code":"Insufficient permissions to update a campaign","language":"text","status":403}]},"params":[{"name":"campaign_id","type":"int","default":"","desc":"The Campaign ID","required":true,"in":"query","ref":"","_id":"5eb1768c8e40a301c89d4e98"},{"name":"content-type","type":"string","default":"application/json","desc":"The Content-Type for the response","required":true,"in":"header","ref":"","_id":"5eb1768c8e40a301c89d4e97"},{"name":"x-auth-token","type":"string","default":"","desc":"Token for API access (sandbox/production)","required":true,"in":"header","ref":"","_id":"5eb1768c8e40a301c89d4e96"},{"name":"include_archived_and_ended","type":"boolean","default":"false","desc":"Set to true if you want to see archived and ended campaigns","required":true,"in":"query","ref":"","_id":"5eb1850cac32f102bf6c0356"}],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Get Campaign Details","type":"endpoint","slug":"get-all-campaigns-for-an-advertiser","excerpt":"","body":"","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5eb1850cac32f102bf6c0355","createdAt":"2020-05-05T15:23:56.482Z","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":1,"parentDoc":null}

getGet Campaign Details


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

campaign_id:
required
integer
The Campaign ID
include_archived_and_ended:
required
booleanfalse
Set to true if you want to see archived and ended campaigns

Headers

content-type:
required
stringapplication/json
The Content-Type for the response
x-auth-token:
required
string
Token for API access (sandbox/production)

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 }}