{"openapi":"3.1.0","info":{"title":"Buzz","version":"0.5"},"servers":[{"url":"https://buzz-key.api.beeswax.com/rest/"}],"components":{"securitySchemes":{}},"security":[{}],"paths":{"/account_setting":{"put":{"summary":"account_setting","description":"","operationId":"accountsetting-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["as_id","account_setting","value"],"properties":{"as_id":{"type":"integer","description":"Unique ID of the account_setting","format":"int32"},"account_setting":{"type":"string","description":"The name of the setting, generally in ALL_CAPS. <40 chars, must be a valid setting as defined in the account_setting_fields view"},"value":{"type":"string","description":"<200 chars. Each account_setting has a type, which is used for further validation. For example, the account_setting \"BUDGET\" might have a type of \"NUMERIC.\" Note, this type validation is not strict as the values in the database are always stored as Strings so \"1\" has the same value as 1."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"account_setting updated with ID 1\"\n        }\n    ],\n    \"message\": \"account_setting update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"account_setting updated with ID 1"}}}},"message":{"type":"string","example":"account_setting update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/account_setting\" -b cookies.txt -d '{\"as_id\":1, \"account_setting\":\"CUSTOM_LOGO\",\"value\":\"http://mysite.com/images/logo.jpg\"}'"}],"samples-languages":["curl"]}},"post":{"summary":"account_setting","description":"","operationId":"accountsetting-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["account_setting","value"],"properties":{"account_setting":{"type":"string","description":"The name of the setting, generally in ALL_CAPS. <40 chars, must be a valid setting as defined in the account_setting_fields view"},"value":{"type":"string","description":"<200 chars. Each account_setting has a type, which is used for further validation. For example, the account_setting \"BUDGET\" might have a type of \"NUMERIC.\" Note, this type validation is not strict as the values in the database are always stored as Strings so \"1\" has the same value as 1."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"account_setting created with ID = 3\",\n    \"payload\": {\n        \"id\": 3\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"account_setting created with ID = 3"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/account_setting\" -b cookies.txt -d '{\"account_setting\":\"CUSTOM_LOGO\",\"value\":\"http://mysite.com/images/logo.jpg\"}'"}],"samples-languages":["curl"]}},"delete":{"summary":"account_setting","description":"","operationId":"accountsetting-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["as_id"],"properties":{"as_id":{"type":"integer","description":"Unique ID of the account_setting","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"account_setting deleted with ID 1\"\n        }\n    ],\n    \"message\": \"account_setting deletion: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"account_setting deleted with ID 1"}}}},"message":{"type":"string","example":"account_setting deletion: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/account_setting\" -b cookies.txt -d '{\"as_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"account_setting","description":"","operationId":"accountsetting-get","parameters":[{"name":"as_id","in":"query","description":"Unique ID of the AccountSetting","schema":{"type":"integer","format":"int32"}},{"name":"account_setting","in":"query","description":"The name of the setting to search for.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"as_id\": 1,\n            \"account_id\": 1,\n            \"account_setting\": \"CUSTOM_LOGO\",\n            \"value\": \"http://mysite.com/images/logo.jpg\",\n            \"buzz_key\": \"stingertest\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"as_id":{"type":"integer","example":1,"default":0},"account_id":{"type":"integer","example":1,"default":0},"account_setting":{"type":"string","example":"CUSTOM_LOGO"},"value":{"type":"string","example":"http://mysite.com/images/logo.jpg"},"buzz_key":{"type":"string","example":"stingertest"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/account_setting\" -b cookies.txt -d '{\"account_setting\":\"CUSTOM_LOGO\"}'"}],"samples-languages":["curl"]}}},"/account":{"post":{"summary":"account","description":"","operationId":"account-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["account_name","active"],"properties":{"customer_id":{"type":"string","description":"An ID to identify the Account in an external customer system. For Beeswax use only!"},"account_name":{"type":"string","description":"Name of the account"},"primary_account":{"type":"boolean","description":"Not currently used"},"locale":{"type":"string","description":"Locale to use for the account, currently only en_US is supported","default":"en_US"},"timezone":{"type":"string","description":"Timezone to use for the Account. Once set all API dates and reporting will use this timezone.","default":"America/New_York"},"currency_id":{"type":"string","description":"Currency to use for the Account. Currently the API assumes all currencies are dollars.","default":"USD"},"date_format_string":{"type":"string","description":"Format of dates for both inputs and outputs to the API.","default":"Y-m-d H:i:s"},"alternative_id":{"type":"string","description":"An alternative id to lookup the account, if desired"},"notes":{"type":"string","description":"Notes about the Account, up to 255 chars"},"active":{"type":"boolean","description":"Is the Account active?","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"account created with ID = 3\",\n    \"payload\": {\n        \"id\": 3\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"account created with ID = 3"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/account\" -b cookies.txt -d '{\"account_name\":\"new account\", \"active\":true}'"}],"samples-languages":["curl"]}},"get":{"summary":"account","description":"","operationId":"account-get","parameters":[{"name":"account_id","in":"query","description":"Unique ID of the account","schema":{"type":"integer","format":"int32"}},{"name":"customer_id","in":"query","description":"Beeswax use only","schema":{"type":"string"}},{"name":"account_name","in":"query","schema":{"type":"string"}},{"name":"primary_account","in":"query","description":"Not currently used","schema":{"type":"boolean"}},{"name":"alternative_id","in":"query","description":"An alternative id to lookup the account, if desired","schema":{"type":"string"}},{"name":"active","in":"query","description":"Is the Account active?","schema":{"type":"boolean"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"customer_id\": \"1\",\n            \"account_name\": \"Primary account\",\n            \"primary_account\": true,\n            \"locale\": \"en_US\",\n            \"currency_id\": \"USD\",\n            \"timezone\": \"America/New_York\",\n            \"date_format_string\": \"Y-m-d H:i:s\",\n            \"account_id\": 1,\n            \"create_date\": \"2016-02-03 17:40:31\",\n            \"update_date\": \"2016-02-03 17:40:31\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string","example":"1"},"account_name":{"type":"string","example":"Primary account"},"primary_account":{"type":"boolean","example":true,"default":true},"locale":{"type":"string","example":"en_US"},"currency_id":{"type":"string","example":"USD"},"timezone":{"type":"string","example":"America/New_York"},"date_format_string":{"type":"string","example":"Y-m-d H:i:s"},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-02-03 17:40:31"},"update_date":{"type":"string","example":"2016-02-03 17:40:31"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/account\" -b cookies.txt -d '{\"account_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"account","description":"","operationId":"account-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["account_id"],"properties":{"account_id":{"type":"integer","description":"Unique ID of the account to update","format":"int32"},"customer_id":{"type":"string","description":"An ID to identify the Account in an external customer system. For Beeswax use only!","default":"A default value can be set as an environment variable using the DEFAULT_CUSTOMER_ID variable"},"account_name":{"type":"string","description":"Name of the account"},"primary_account":{"type":"boolean","description":"Not currently used"},"locale":{"type":"string","description":"Locale to use for the account, currently only en-US is supported","default":"en_US"},"timezone":{"type":"string","description":"Timezone to use for the Account.","default":"America/New_York"},"currency_id":{"type":"string","description":"Currency to use for the Account. Currently the API assumes all currencies are dollars.","default":"USD"},"date_format_string":{"type":"string","description":"Format for date fields on both input and output from the API. Not currently used.","default":"Y-m-d H:i:s"},"alternative_id":{"type":"string","description":"An alternative id to lookup the account, if desired"},"notes":{"type":"string","description":"Notes about the Account, up to 255 chars"},"active":{"type":"boolean","description":"Is the Account active?","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"account updated with ID 1\"\n        }\n    ],\n    \"message\": \"account update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"account updated with ID 1"}}}},"message":{"type":"string","example":"account update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/account/1\" -b cookies.txt -d '{\"account_name\":\"new account\", \"active\":true}'"}],"samples-languages":["curl"]}}},"/account_alert":{"post":{"summary":"account_alert","description":"","operationId":"account_alert-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["system_alert_key"],"properties":{"system_alert_key":{"type":"string","description":"key representing the type of alert. For example `bad_ad` alert will send when Buzz detects a bad ad."},"email":{"type":"string","description":"One or more emails to forward the alert to, separated by commas"},"slack_api":{"type":"string","description":"Slack API key"},"slack_channel":{"type":"string","description":"Slack channel such as #buzz-alerts"},"slack_emoji":{"type":"string","description":"Emoji to post next to alert in slack, such as :poop:"},"active":{"type":"boolean","description":"Is the Account Alert currently active","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"Account alerts created successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"Account alerts created successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/account_alert\" -b cookies.txt -d '{\"system_alert_key\":\"bad_ad\",\"email\":\"alerts@foo.com,emergency@bar.net\",\"slack_api\":\"xoxo-23-345\",\"slack_channel\":\"#bad-stuff\",\"slack_emoji\":\":poop\"}'"}],"samples-languages":["curl"]}},"put":{"summary":"account_alert","description":"","operationId":"account_alert-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["account_alert_id"],"properties":{"account_alert_id":{"type":"integer","description":"Unique ID of the account_alert","format":"int32"},"system_alert_key":{"type":"string","description":"key representing the type of alert. For example `bad_ad` alert will send when Buzz detects a bad ad."},"email":{"type":"string","description":"One or more emails to forward the alert to, separated by commas"},"slack_api":{"type":"string","description":"Slack API key"},"slack_channel":{"type":"string","description":"Slack channel such as #buzz-alerts"},"slack_emoji":{"type":"string","description":"Emoji to post next to alert in slack, such as :poop:"},"active":{"type":"boolean","description":"Is the Account Alert currently active","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"Account alerts updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"Account alerts updated successfully"}}}}}},"406":{"description":"406","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": false,\n    \"message\": \"advertiser could not be created\",\n    \"errors\": [\n        \"ERROR: Advertiser name already in use\"\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"default":true},"message":{"type":"string","example":"advertiser could not be created"},"errors":{"type":"array","items":{"type":"string","example":"ERROR: Advertiser name already in use"}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/account_alert\" -b cookies.txt -d '{\"account_alert_id\":123, \"system_alert_key\":\"bad_ad\",\"email\":\"alerts@foo.com,emergency@bar.net\",\"slack_api\":\"xoxo-23-345\",\"slack_channel\":\"#bad-stuff\",\"slack_emoji\":\":poop\"}'"}],"samples-languages":["curl"]}},"delete":{"summary":"account_alert","description":"","operationId":"account_alert-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["account_alert_id"],"properties":{"account_alert_id":{"type":"integer","description":"Unique ID of the account_alert","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"account_alert deleted with ID 1\"\n        }\n    ],\n    \"message\": \"account_alert deletion: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"account_alert deleted with ID 1"}}}},"message":{"type":"string","example":"account_alert deletion: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/account_alert\" -b cookies.txt -d '{\"account_alert_id\":1}'"}],"samples-languages":["curl"]}}},"/advertiser":{"get":{"summary":"advertiser","description":"","operationId":"advertiser-get","parameters":[{"name":"advertiser_id","in":"query","description":"Unique ID of the advertiser","schema":{"type":"integer","format":"int32"}},{"name":"alternative_id","in":"query","description":"An alternative id to lookup the object, if desired","schema":{"type":"string"}},{"name":"advertiser_name","in":"query","description":"Unique name for the advertiser. Supports `%LIKE%` syntax","schema":{"type":"string"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"advertiser_id\": 1,\n            \"advertiser_name\": \"new advertiser\",\n            \"default_click_url\": \"http://www.yahoo.com\",\n            \"default_continent\": \"NAM\",\n            \"default_currency\": \"USD\",\n            \"conversion_method_id\": 1,\n            \"attributes\": {\n                \"advertiser\": {\n                    \"advertiser_category\": [\n                        \"IAB1\"\n                    ]\n                }\n            },         \n          \t\"default_campaign_preset_id\": null,\n            \"default_line_item_preset_id\": null,\n            \"enable_skad_tracking\":false,\n            \"account_id\": 1,\n            \"create_date\": \"2016-02-25 14:27:02\",\n            \"update_date\": \"2016-02-25 14:27:02\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"advertiser_id":{"type":"integer","example":1,"default":0},"advertiser_name":{"type":"string","example":"new advertiser"},"default_click_url":{"type":"string","example":"http://www.yahoo.com"},"default_continent":{"type":"string","example":"NAM"},"default_currency":{"type":"string","example":"USD"},"conversion_method_id":{"type":"integer","example":1,"default":0},"attributes":{"type":"object","properties":{"advertiser":{"type":"object","properties":{"advertiser_category":{"type":"array","items":{"type":"string","example":"IAB1"}}}}}},"default_campaign_preset_id":{},"default_line_item_preset_id":{},"enable_skad_tracking":{"type":"boolean","example":false,"default":true},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-02-25 14:27:02"},"update_date":{"type":"string","example":"2016-02-25 14:27:02"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/advertiser\" -b cookies.txt -d '{\"advertiser_name\":\"new advertiser\"}'"}],"samples-languages":["curl"]}},"delete":{"summary":"advertiser","description":"","operationId":"advertiser-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["advertiser_id"],"properties":{"advertiser_id":{"type":"integer","description":"Unique ID of the advertiser","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"advertiser deleted with ID 1\"\n        }\n    ],\n    \"message\": \"advertiser deletion: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"advertiser deleted with ID 1"}}}},"message":{"type":"string","example":"advertiser deletion: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/advertiser\" -b cookies.txt -d '{\"advertiser_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"advertiser","description":"","operationId":"advertiser-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["advertiser_name"],"properties":{"advertiser_name":{"type":"string","description":"Unique name for the advertiser, must be unique per account."},"attributes":{"type":"object","description":"Creative attributes in JSON.","properties":{"<module_name>":{"type":"object","description":"The overall statement can include any number of modules, but each module may only appear once. Example of a module is `advertiser`","properties":{"<key>":{"type":"array","description":"Key must belong to the module selected, the value must be a list of one or more values corresponding to the key. Values may be integers or strings depending on the key.","items":{"type":"string"}}}}}},"conversion_method_id":{"type":"integer","description":"The conversion attribution to use for Events owned by this Advertiser. Must be a valid attribution method as found in the conversion_atrtibution_methods view. At this time only method 1 (last click) is supported. Once a conversion method is chosen, it cannot be changed.","default":1,"format":"int32"},"default_click_url":{"type":"string","description":"Click URL to use by default for objects created under this advertiser"},"default_continent":{"type":"string","description":"Continent in which this Advertiser's Campaigns should be eligible to serve. Can be changed at the Campaign level.","default":"NAM"},"default_currency":{"type":"string","description":"Currency to use as default for all Campaigns under this Advertiser","default":"USD"},"default_creative_thumbnail_url":{"type":"string","description":"URL of a thumbnail image to use when a Creative does not have one. This is useful since some exchanges may not allow a Creative to run without a thumbnail.","default":"URL of a thumbnail image to use when a Creative does not have one. This is useful since some exchanges may not allow a Creative to run without a thumbnail."},"default_campaign_preset_id":{"type":"integer","description":"The preset to use by default for all campaigns created under this advertiser. Note, presets can only be created in the UI.","format":"int32"},"default_line_item_preset_id":{"type":"integer","description":"The preset to use by default for all line items created under this advertiser. Note, presets can only be created in the UI.","format":"int32"},"enable_skad_tracking":{"type":"boolean","description":"Should Apple's SKAdNetwork tracking be enabled for this advertiser. If set to true, the `advertiser_app_bundle` elements of the `attributes` must be set.","default":false},"alternative_id":{"type":"string","description":"An alternative id to associate, if desired"},"notes":{"type":"string","description":"Any notes desired, less than 255 chars"},"active":{"type":"boolean","description":"Is the advertiser active","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"advertiser created with ID = 5\",\n    \"payload\": {\n        \"id\": 5\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"advertiser created with ID = 5"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":5,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/advertiser\" -b cookies.txt -d '{\"advertiser_name\":\"new advertiser\", \"conversion_method_id\":1, \"attributes\":{\"advertiser\":{\"advertiser_domain\":[\"www.beeswax.com\"]}}, \"default_continent\":\"NAM\", \"default_currency\":\"CAD\", \"default_creative_thumbnail_url\":\"https://server.com/thumb.jpg\",\"enable_skad_tracking\":false}'"}],"samples-languages":["curl"]}},"put":{"summary":"advertiser","description":"","operationId":"advertiser-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["advertiser_id"],"properties":{"advertiser_id":{"type":"integer","description":"Unique ID of the advertiser","format":"int32"},"advertiser_name":{"type":"string","description":"Unique name for the advertiser, must be unique per account"},"attributes":{"type":"object","description":"Creative attributes in JSON","properties":{"<module_name>":{"type":"object","description":"The overall statement can include any number of modules, but each module may only appear once. Example of a module is `advertiser`","properties":{"<key>":{"type":"array","description":"Key must belong to the module selected, the value must be a list of one or more values corresponding to the key. Values may be integers or strings depending on the key.","items":{"type":"string"}}}}}},"default_click_url":{"type":"string","description":"Click URL to use by default for objects created under this advertiser"},"default_continent":{"type":"string","description":"Continent in which this Advertiser's Campaigns should be eligible to serve. Can be changed at the Campaign level."},"default_currency":{"type":"string","description":"Default currency to use for all Campaigns created under this Advertiser","default":"NAM"},"default_creative_thumbnail_url":{"type":"string","description":"URL of a thumbnail image to use when a Creative does not have one. This is useful since some exchanges may not allow a Creative to run without a thumbnail."},"default_campaign_preset_id":{"type":"integer","description":"The preset to use by default for all campaigns created under this advertiser. Note, presets can only be created in the UI.","format":"int32"},"default_line_item_preset_id":{"type":"integer","description":"The preset to use by default for all line items created under this advertiser. Note, presets can only be created in the UI.","format":"int32"},"enable_skad_tracking":{"type":"boolean","description":"Should Apple's SKAdNetwork tracking be enabled for this advertiser. If set to true, the `advertiser_app_bundle` elements of the `attributes` must be set.","default":false},"alternative_id":{"type":"string","description":"An alternative id to associate, if desired"},"notes":{"type":"string"},"active":{"type":"boolean","description":"Is the advertiser active?"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"advertiser updated with ID 1\"\n        }\n    ],\n    \"message\": \"advertiser update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"advertiser updated with ID 1"}}}},"message":{"type":"string","example":"advertiser update: 1 updated successfully"}}}}}},"406":{"description":"406","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": false,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": false,\n            \"error_code\": \"AD_BAD_VALIDATION\",\n            \"message\": [\n                \"ERROR: Error creating conversion_method_id, field improperly formatted int\"\n            ]\n        }\n    ],\n    \"errors\": [\n        \"ERROR: advertiser update: 0 updated successfully, 1 with errors\"\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":false,"default":true},"error_code":{"type":"string","example":"AD_BAD_VALIDATION"},"message":{"type":"array","items":{"type":"string","example":"ERROR: Error creating conversion_method_id, field improperly formatted int"}}}}},"errors":{"type":"array","items":{"type":"string","example":"ERROR: advertiser update: 0 updated successfully, 1 with errors"}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/advertiser\" -b cookies.txt -d '{\"advertiser_id\":1, \"advertiser_name\":\"new advertiser\", \"default_click_url\":\"http://www.foo.com\", \"default_continent\":\"EMEA\"}'"}],"samples-languages":["curl"]}}},"/activity_log":{"get":{"summary":"activity_log","description":"","operationId":"activitylog-get","parameters":[{"name":"log_id","in":"query","description":"Unique id of the log entry","schema":{"type":"integer","format":"int32"}},{"name":"user_id","in":"query","description":"ID of the user that took the action that was logged","schema":{"type":"integer","format":"int32"}},{"name":"object_id","in":"query","description":"The unique ID of the object that was affected. For example, if a User object was created, this ID will be the user_id of that User","schema":{"type":"integer","format":"int32"}},{"name":"object_type","in":"query","description":"The type of object affected. e.g. `user` or `line_item`","schema":{"type":"string"}},{"name":"activity_date","in":"query","description":"The date the activity took place","schema":{"type":"string","format":"date"}},{"name":"action","in":"query","description":"`CREATE`, `UPDATE`, or `DELETE`","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"log_id\": 131,\n            \"user_id\": 1,\n            \"account_id\": 1,\n            \"object_id\": 6,\n            \"object_type\": \"advertiser\",\n            \"action\": \"CREATE\",\n            \"details\": {\n                \"advertiser_id\": 6,\n                \"advertiser_name\": \"foo2\",\n                \"attributes\": {\n                    \"advertiser\": {\n                        \"advertiser_category\": [\n                            \"IAB1\"\n                        ]\n                    }\n                },\n          \t    \"default_targeting\": [],\n                \"conversion_method_id\": 1,\n                \"default_click_url\": \"http://www.yahoo.com\",\n                \"active\": 1,\n                \"alternative_id\": null,\n                \"notes\": null,\n                \"original_object_id\": 6,\n                \"account_id\": 1,\n                \"view_name\": null,\n                \"fields\": null,\n                \"create_date\": \"2016-02-25 14:51:08\",\n                \"push_status\": 0,\n                \"push_update\": 1,\n                \"payload\": null\n            },\n            \"activity_date\": \"2016-02-25 14:51:08\",\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"log_id":{"type":"integer","example":131,"default":0},"user_id":{"type":"integer","example":1,"default":0},"account_id":{"type":"integer","example":1,"default":0},"object_id":{"type":"integer","example":6,"default":0},"object_type":{"type":"string","example":"advertiser"},"action":{"type":"string","example":"CREATE"},"details":{"type":"object","properties":{"advertiser_id":{"type":"integer","example":6,"default":0},"advertiser_name":{"type":"string","example":"foo2"},"attributes":{"type":"object","properties":{"advertiser":{"type":"object","properties":{"advertiser_category":{"type":"array","items":{"type":"string","example":"IAB1"}}}}}},"default_targeting":{"type":"array","items":{"type":"object","properties":{}}},"conversion_method_id":{"type":"integer","example":1,"default":0},"default_click_url":{"type":"string","example":"http://www.yahoo.com"},"active":{"type":"integer","example":1,"default":0},"alternative_id":{},"notes":{},"original_object_id":{"type":"integer","example":6,"default":0},"account_id":{"type":"integer","example":1,"default":0},"view_name":{},"fields":{},"create_date":{"type":"string","example":"2016-02-25 14:51:08"},"push_status":{"type":"integer","example":0,"default":0},"push_update":{"type":"integer","example":1,"default":0},"payload":{}}},"activity_date":{"type":"string","example":"2016-02-25 14:51:08"},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/activity_log\" -b cookies.txt -d '{\"object_type\":\"advertiser\",\"object_id\":6}'"}],"samples-languages":["curl"]}}},"/alert":{"post":{"summary":"alert","description":"","operationId":"alert-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["subject","content","from_address"],"properties":{"user_id":{"type":"integer","description":"ID of the user receiving the alert, must be an active user","format":"int32"},"account_id":{"type":"integer","description":"When a super user sends a `global` alert the `account_id` can be specified or can be set to `all` to send the alert to all users in all accounts.","default":null,"format":"int32"},"subject":{"type":"string","description":"Subject of the alert, <100 chars"},"content":{"type":"string","description":"Content of the alert"},"object_type":{"type":"string","description":"If the alert refers to an object, such as a Creative, you can specify the type and ID (below) to allow for deep linking into an application. Must be a valid object_type. A list of object_types can be found using the `\"view_name\":\"object_type\"`"},"object_id":{"type":"integer","description":"The object_id to link to if the object_type is specified.","format":"int32"},"global":{"type":"boolean","description":"When set, sends the alert to all users within the account","default":false},"icon":{"type":"string","description":"A string representing an icon or emoji to associate with the alert. e.g. `:POOP:`"},"from_address":{"type":"string","description":"Sender of the alert. Can be a name or an email address."},"active":{"type":"boolean","description":"Is the alert unread (1) or read (0)","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"Global alerts sent successfully to 2 users with 0 errors\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"Global alerts sent successfully to 2 users with 0 errors"}}}}}},"406":{"description":"406","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": false,\n    \"message\": \"advertiser could not be created\",\n    \"errors\": [\n        \"ERROR: Advertiser name already in use\"\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"default":true},"message":{"type":"string","example":"advertiser could not be created"},"errors":{"type":"array","items":{"type":"string","example":"ERROR: Advertiser name already in use"}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/alert\" -b cookies.txt -d '{\"subject\":\"new alert\",\"content\":\"Hey boys and girls here is an alert\",\"global\":1,\"from_address\":\"your boss\"}'"}],"samples-languages":["curl"]}},"delete":{"summary":"alert","description":"","operationId":"alert-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["alert_id"],"properties":{"alert_id":{"type":"integer","description":"Unique ID of the alert","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"alert deleted with ID 1\"\n        }\n    ],\n    \"message\": \"alert deletion: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"alert deleted with ID 1"}}}},"message":{"type":"string","example":"alert deletion: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/alert\" -b cookies.txt -d '{\"alert_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"alert","description":"","operationId":"alert-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"alert_id":{"type":"integer","description":"Unique ID of the alert","format":"int32"},"user_id":{"type":"integer","description":"ID of the user receiving the alert, defaults to current user","format":"int32"},"global":{"type":"boolean","description":"Set to 1 to execute a \"Mark all as read\"","default":false},"active":{"type":"boolean","description":"Mark an individual alert as read","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"20 alerts marked as read\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"20 alerts marked as read"}}}}}},"406":{"description":"406","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": false,\n    \"message\": \"advertiser could not be created\",\n    \"errors\": [\n        \"ERROR: Advertiser name already in use\"\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"default":true},"message":{"type":"string","example":"advertiser could not be created"},"errors":{"type":"array","items":{"type":"string","example":"ERROR: Advertiser name already in use"}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"#Set a single alert to read\ncurl -X PUT \"[host]/rest/alert\" -b cookies.txt -d '{\"alert_id\":1,\"active\":0}'\n#Set all alerts to read for the current user\ncurl -X PUT \"[host]/rest/alert\" -b cookies.txt -d '{\"global\":1, \"active\":0}'"}],"samples-languages":["curl"]}},"get":{"summary":"alert","description":"","operationId":"alert-get","parameters":[{"name":"alert_id","in":"query","description":"Unique ID of the alert","schema":{"type":"integer","format":"int32"}},{"name":"user_id","in":"query","description":"ID of the user receiving the alert","schema":{"type":"integer","format":"int32"}},{"name":"subject","in":"query","description":"Subject of the alert, supports `%LIKE%` syntax","schema":{"type":"string"}},{"name":"active","in":"query","description":"Is the alert unread (1) or read (0)","schema":{"type":"boolean","default":true}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"alert_id\": 1,\n            \"user_id\": 1,\n            \"account_id\": 1,\n            \"subject\": \"Creative Approval Updated\",\n            \"content\": \"Creative approval for Creative 4 was updated with message Suspicious\",\n            \"object_id\": 4,\n            \"object_type\": \"creative\",\n            \"icon\": \":cop:\",\n            \"system\": true,\n            \"from_address\": \"Buzz System\",\n            \"active\": false,\n            \"create_date\": \"2016-02-05 12:42:14\",\n            \"update_date\": \"2016-02-25 16:11:17\",\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"alert_id":{"type":"integer","example":1,"default":0},"user_id":{"type":"integer","example":1,"default":0},"account_id":{"type":"integer","example":1,"default":0},"subject":{"type":"string","example":"Creative Approval Updated"},"content":{"type":"string","example":"Creative approval for Creative 4 was updated with message Suspicious"},"object_id":{"type":"integer","example":4,"default":0},"object_type":{"type":"string","example":"creative"},"icon":{"type":"string","example":":cop:"},"system":{"type":"boolean","example":true,"default":true},"from_address":{"type":"string","example":"Buzz System"},"active":{"type":"boolean","example":false,"default":true},"create_date":{"type":"string","example":"2016-02-05 12:42:14"},"update_date":{"type":"string","example":"2016-02-25 16:11:17"},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}},"406":{"description":"406","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": false,\n    \"message\": \"advertiser could not be created\",\n    \"errors\": [\n        \"ERROR: Advertiser name already in use\"\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"default":true},"message":{"type":"string","example":"advertiser could not be created"},"errors":{"type":"array","items":{"type":"string","example":"ERROR: Advertiser name already in use"}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/alert\" -b cookies.txt -d '{\"alert_id\":1}'"}],"samples-languages":["curl"]}}},"/authenticate":{"post":{"summary":"authenticate","description":"Login","operationId":"authenticate-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","description":"User Email"},"password":{"type":"string","description":"User Password"},"account_id":{"type":"integer","description":"For Multi-Account Users only, allows the user to authenticate into a different account on the same Buzz instance","format":"int32"},"keep_logged_in":{"type":"boolean","description":"When set to true, the user will be kept logged in for up to 30 days","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": \"true\",\n    \"payload\": \"Cookie set successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"string","example":"true"},"payload":{"type":"string","example":"Cookie set successfully"}}}}}}},"deprecated":false,"security":[],"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"/rest/authenticate\" -c cookies.txt -d '{\"email\":\"foo@bar.com\", \"password\":\"123456\", \"keep_logged_in\":true}'\n\n#Example of masquerading into account 123 for Buzz instances enabled with multi-account access\ncurl -X POST \"/rest/authenticate\" -c cookies.txt -d '{\"email\":\"foo@bar.com\", \"password\":\"123456\", \"keep_logged_in\":true,\"account_id\":123}'"}],"samples-languages":["curl"]}},"delete":{"summary":"authenticate","description":"Logout","operationId":"authenticate-delete","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"You have been successfully logged out\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"You have been successfully logged out"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"/rest/authenticate\" -b cookies.txt"}],"samples-languages":["curl"]}},"put":{"summary":"authenticate","description":"Allows the user to change their password","operationId":"authenticate-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","password","new_password"],"properties":{"email":{"type":"string","description":"User ID"},"password":{"type":"string","description":"User Password"},"new_password":{"type":"integer","description":"New Password","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"Password updated\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"Password updated"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"security":[],"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"/rest/authenticate\" -b cookies.txt -d '{\"email\":\"foo@bar.com\", \"password\":\"123456\", \"new_password\":\"abcdef\"}'"}],"samples-languages":["curl"]}}},"/bid_model_version":{"get":{"summary":"bid_model_version","description":"","operationId":"bid-model-versions-get","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bid_model_version_name"],"properties":{"bid_model_version_id":{"type":"integer","description":"Unique identifier of the Bid Model Version to be updated","format":"int32"},"bid_model_id":{"type":"integer","description":"Unique ID of the Bid Model this version is associated with.","format":"int32"},"bid_model_version_name":{"type":"string","description":"Name of the Bid Model Version, e.g. \"Model 17.x.3\""},"manifest_s3_path":{"type":"string","description":"Path to the file on S3"},"upload_status":{"type":"string","description":"The current status of the version."},"alternative_id":{"type":"string","description":"An alternative id to lookup the  Line Item, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"bid_model_version_id\": 1,\n            \"bid_model_id\": 2,\n            \"bid_model_version_name\": \"Version 1\",\n            \"manifest_s3_path\": \"s3://path/to/file/file.json\",\n            \"upload_status\": \"FAILED\",\n            \"account_id\": 1,\n            \"create_date\": \"2018-12-13 17:37:04\",\n            \"update_date\": \"2019-01-08 14:50:00\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stinger\", \n            \"errors\": [\n                {\n                    \"type\": \"Read Error\",\n                    \"error_message\": \"failed to read manifest file from S3\",\n                    \"file\": \"some_file_name\",\n                    \"first_row\": null,\n                    \"region\": \"eu-west-1\"          \n                }\n            ],\n            \"bid_model_version_key\": \"stinger-2-1\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"bid_model_version_id":{"type":"integer","example":1,"default":0},"bid_model_id":{"type":"integer","example":2,"default":0},"bid_model_version_name":{"type":"string","example":"Version 1"},"manifest_s3_path":{"type":"string","example":"s3://path/to/file/file.json"},"upload_status":{"type":"string","example":"FAILED"},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2018-12-13 17:37:04"},"update_date":{"type":"string","example":"2019-01-08 14:50:00"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stinger"},"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"Read Error"},"error_message":{"type":"string","example":"failed to read manifest file from S3"},"file":{"type":"string","example":"some_file_name"},"first_row":{},"region":{"type":"string","example":"eu-west-1"}}}},"bid_model_version_key":{"type":"string","example":"stinger-2-1"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/bid_model_version\" -b cookies.txt -d '{\"bid_model_version_id\":1}'"}],"samples-languages":["curl"]}},"delete":{"summary":"bid_model_version","description":"","operationId":"bid-model-versions-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bid_model_version_id"],"properties":{"bid_model_version_id":{"type":"integer","description":"Unique ID of the Bid Model Version","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"bid_model_version deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"bid_model_version deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/bid_model_version\" -b cookies.txt -d '{\"bid_model_version_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"bid_model_version","description":"","operationId":"bid-model-versions-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bid_model_id","bid_model_version_name","active"],"properties":{"bid_model_id":{"type":"integer","description":"Unique ID of the Bid Model this version is associated with.","format":"int32"},"bid_model_version_name":{"type":"string","description":"Name of the Bid Model Version, e.g. \"Model 17.x.3\""},"manifest_s3_path":{"type":"string","description":"Path to the file on S3. Should be in the format `s3://beeswax-data-<region>/bid_models/<buzz_key>/customer_manifests/<file_name>`"},"alternative_id":{"type":"string","description":"An alternative id to lookup the  Line Item, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"bid_model_version created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"bid_model_version created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/bid_model_version\" -b cookies.txt -d '{\"bid_model_version_name\":\"CPI Model 2.3\", \"manifest_s3_path\":\"s3://beeswax-data-us-east-1/bid_models/stinger/customer_manifests/my_newest_model.txt\"}'"}],"samples-languages":["curl"]}},"put":{"summary":"bid_model_version","description":"","operationId":"bid-model-versions-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bid_model_version_id","bid_model_version_name"],"properties":{"bid_model_version_id":{"type":"integer","description":"Unique identifier of the Bid Model Version to be updated","format":"int32"},"bid_model_id":{"type":"integer","description":"Unique ID of the Bid Model this version is associated with.","format":"int32"},"bid_model_version_name":{"type":"string","description":"Name of the Bid Model Version, e.g. \"Model 17.x.3\""},"manifest_s3_path":{"type":"string","description":"Path to the file on S3. Should be in the format `s3://beeswax-data-<region>/bid_models/<buzz_key>/customer_manifests/<file_name>`"},"alternative_id":{"type":"string","description":"An alternative id to lookup the  Line Item, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"bid_model_version updated with ID 1\"\n        }\n    ],\n    \"message\": \"bid_model_version update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"bid_model_version updated with ID 1"}}}},"message":{"type":"string","example":"bid_model_version update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/bid_model_version\" -b cookies.txt -d '{\"bid_model_version_id\":1 \"bid_model_version_name\":\"CPI Model 2.3\"}'"}],"samples-languages":["curl"]}}},"/bid_modifier":{"put":{"summary":"bid_modifier","description":"","operationId":"bid_modifier-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bid_modifier_id"],"properties":{"bid_modifier_id":{"type":"integer","description":"ID of the Bid Modifier to update","format":"int32"},"bid_model_id":{"type":"integer","description":"The ID of the Bid Model to be associated with this Bid Modifier. The Model must be of type `BID` or `MULTIPLIER`.","format":"int32"},"bid_modifier_name":{"type":"string","description":"Name of the Bid Modifier, e.g. \"Video complete modifier\""},"bid_modifier_terms":{"type":"object","description":"List of modification objects, see note.","properties":{"<none>":{"type":"object","required":["targeting_module","targeting_key","value","modifier"],"properties":{"targeting_module":{"type":"string","description":"The targeting module, e.g. `geo`"},"targeting_key":{"type":"string","description":"The targeting key within the module, e.g. `country`"},"value":{"type":"string","description":"Value of the key to match, e.g. \"USA\" for the country key. Must always be a string, even if value is an integer or array."},"modifier_type":{"type":"string","description":"The matching method for the modifier","default":"INCLUDE"},"modifier":{"type":"number","description":"Amount to apply to the modifier. For Bid Modifiers this will be the multiplier, for Delivery Models this will be the relative weight of delivery. Min=0 (don't bid) Max = 100","format":"double"},"field_label":{"type":"string","description":"Human readable label for the field. Automatically added to the Terms. Do not set on POST."}}}}},"alternative_id":{"type":"string","description":"An alternative ID to lookup the Bid Modifier, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"bid_modifier updated with ID 1\"\n        }\n    ],\n    \"message\": \"bid_modifier: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"bid_modifier updated with ID 1"}}}},"message":{"type":"string","example":"bid_modifier: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/bid_modifier\" -b cookies.txt -d '{\"bid_modifier_id\":1, \"bid_modifier_name\":\"new BM\", \"bid_modifier_terms\":[{\"targeting_module\":\"geo\",\"targeting_key\":\"country\",\"value\":\"USA\",\"modifier\":0.8,\"modifier_type\":\"include\"}], \"active\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"bid_modifier","description":"","operationId":"bid_modifier-get","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bid_modifier_id":{"type":"integer","description":"The ID of the Bid Modifier to GET","format":"int32"},"advertiser_id":{"type":"integer","description":"The ID of the Advertiser, if set","format":"int32"},"bid_model_id":{"type":"integer","description":"The ID of the Bid Model associated with this Bid Modifier","format":"int32"},"bid_modifier_name":{"type":"string","description":"Name of the Bid Modifier, e.g. \"Video complete modifier\""},"alternative_id":{"type":"string","description":"An alternative ID to lookup the Bid Modifier, if desired"},"active":{"type":"boolean","description":"Is it active?"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"bid_modifier_id\": 1,\n            \"advertiser_id\": null,\n            \"bid_modifier_id\": null,\n            \"bid_modifier_name\": \"new BM\",\n            \"account_id\": 1,\n            \"create_date\": \"2018-02-20 17:24:40\",\n            \"update_date\": \"2018-02-20 17:24:40\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\",\n            \"bid_modifier_terms\": [\n                {\n                    \"targeting_module\": \"geo\",\n                    \"targeting_key\": \"country\",\n                    \"modifier_type\": \"include\",\n                    \"value\": \"USA\",\n                    \"modifier\": 0.8\n                }\n            ]\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"bid_modifier_id":{},"advertiser_id":{},"bid_modifier_name":{"type":"string","example":"new BM"},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2018-02-20 17:24:40"},"update_date":{"type":"string","example":"2018-02-20 17:24:40"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"},"bid_modifier_terms":{"type":"array","items":{"type":"object","properties":{"targeting_module":{"type":"string","example":"geo"},"targeting_key":{"type":"string","example":"country"},"modifier_type":{"type":"string","example":"include"},"value":{"type":"string","example":"USA"},"modifier":{"type":"number","example":0.8,"default":0}}}}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/bid_modifier\" -b cookies.txt -d '{\"bid_modifier_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"bid_modifier","description":"","operationId":"bid_modifier-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bid_modifier_name"],"properties":{"advertiser_id":{"type":"integer","description":"Optional. Allows a Bid Modifier to be restricted to a single Advertiser","format":"int32"},"bid_model_id":{"type":"integer","description":"The ID of the Bid Model to be associated with this Bid Modifier. Model must be of type `BID` or `MULTIPLIER`","format":"int32"},"bid_modifier_name":{"type":"string","description":"Name of the Bid Modifier, e.g. \"Video complete modifier\""},"bid_modifier_terms":{"type":"object","description":"List of modification objects.","properties":{"<none>":{"type":"object","required":["targeting_module","targeting_key","value","modifier"],"properties":{"targeting_module":{"type":"string","description":"The targeting module, e.g. `geo`"},"targeting_key":{"type":"string","description":"The targeting key within the module, e.g. `country`"},"value":{"type":"string","description":"Value of the key to match, e.g. \"USA\" for the country key. Must always be a string, even if value is an integer or array."},"modifier_type":{"type":"string","description":"The matching method for the modifier","default":"INCLUDE"},"modifier":{"type":"number","description":"Amount to apply to the modifier. For Bid Modifiers this will be the multiplier, for Delivery Models this will be the relative weight of delivery. Min=0 (don't bid) Max = 100","format":"double"},"field_label":{"type":"string","description":"Human readable label for the field. Automatically added to the Terms. Do not set on POST."}}}}},"alternative_id":{"type":"string","description":"An alternative ID to lookup the Bid Modifier, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"bid_modifier created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"bid_modifier created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/bid_modifier\" -b cookies.txt -d '{\"bid_modifier_name\":\"new BM\", \"advertiser_id\":1, \"bid_modifier_terms\":[{\"targeting_module\":\"geo\",\"targeting_key\":\"country\",\"value\":\"USA\",\"modifier\":0.8,\"modifier_type\":\"include\"}], \"active\":1}'"}],"samples-languages":["curl"]}},"delete":{"summary":"bid_modifier","description":"","operationId":"bid_modifier-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bid_modifier_id"],"properties":{"bid_modifier_id":{"type":"integer","description":"ID of the Bid Modifier to delete","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"bid_modifier deleted with ID 1\"\n        }\n    ],\n    \"message\": \"bid_modifier: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"bid_modifier deleted with ID 1"}}}},"message":{"type":"string","example":"bid_modifier: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/bid_modifier\" -b cookies.txt -d '{\"bid_modifier_id\":1}'"}],"samples-languages":["curl"]}}},"/bid_model":{"get":{"summary":"bid_model","description":"","operationId":"bid-models-get","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bid_model_id":{"type":"integer","description":"Unique identifier for the Bid Model","format":"int32"},"bid_model_name":{"type":"string","description":"Name of the Bid Model, e.g. \"CPI Model\""},"value_type":{"type":"string","description":"Valid values are `BID`, `MULTIPLIER`,  or `BUDGET_WEIGHT`. Determines whether the values in the Bid Model should be multiplied by the base bid at the Line Item level or used instead of that bid. `BUDGET_WEIGHT` should be used for Delivery Models.","default":"MULTIPLIER"},"alternative_id":{"type":"string","description":"An alternative ID to lookup the Bid Model, if desired"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"bid_model_id\": 1,\n            \"bid_model_name\": \"CPI Model\",\n            \"value_type\": \"BID\",\n            \"current_version\": null,\n            \"account_id\": 1,\n            \"create_date\": \"2018-02-20 17:24:40\",\n            \"update_date\": \"2018-02-20 17:24:40\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\",\n        }\n    ]\n}"}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/bid_model\" -b cookies.txt -d '{\"bid_model_name\":\"CPI Model\"}'"}],"samples-languages":["curl"]}},"put":{"summary":"bid_model","description":"","operationId":"bid-models-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bid_model_id"],"properties":{"bid_model_id":{"type":"integer","description":"The unique ID of the Bid Model to be updated","format":"int32"},"bid_model_name":{"type":"string","description":"Name of the Bid Model, e.g. \"CPI Model\""},"value_type":{"type":"string","description":"Valid values are `BID`, `MULTIPLIER`,  or `BUDGET_WEIGHT`. Determines whether the values in the Bid Model should be multiplied by the base bid at the Line Item level or used instead of that bid. `BUDGET_WEIGHT` should be used for Delivery Models.","default":"MULTIPLIER"},"current_version":{"type":"integer","description":"The Bid Model Version to use.","format":"int32"},"alternative_id":{"type":"string","description":"An alternative ID to lookup the Bid Model, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"bid_model updated with ID 1\"\n        }\n    ],\n    \"message\": \"bid_model update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"bid_model updated with ID 1"}}}},"message":{"type":"string","example":"bid_model update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/bid_model\" -b cookies.txt -d '{\"bid_model_id\":12, \"bid_model_name\":\"CPI Model\", \"value_type\":\"BID\", \"active\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"bid_model","description":"","operationId":"bid-models-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bid_model_name"],"properties":{"bid_model_name":{"type":"string","description":"Name of the Bid Model, e.g. \"CPI Model\""},"value_type":{"type":"string","description":"Valid values are `BID`, `MULTIPLIER`, or `BUDGET_WEIGHT`. Determines whether the values in the Bid Model should be multiplied by the base bid at the Line Item level or used instead of that bid. `BUDGET_WEIGHT` should be used for Delivery Models.","default":"MULTIPLIER"},"alternative_id":{"type":"string","description":"An alternative ID to lookup the Bid Model, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"bid_model created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"bid_model created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/bid_model\" -b cookies.txt -d '{\"bid_model_name\":\"CPI Model\", \"value_type\":\"BID\", \"active\":1}'"}],"samples-languages":["curl"]}}},"/campaign":{"post":{"summary":"campaign","description":"","operationId":"campaign-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["advertiser_id","campaign_name","campaign_budget","start_date","active"],"properties":{"advertiser_id":{"type":"integer","description":"Must belong to the same account as the Campaign and be active","format":"int32"},"campaign_name":{"type":"string","description":"Name of the Campaign, e.g. \"Winter lead generation\""},"campaign_budget":{"type":"number","description":"Maximum amount to spend on this Campaign","format":"double"},"daily_budget":{"type":"number","description":"Maximum amount to spend or deliver in a day, Cannot exceed `campaign_budget` or be so low as to prevent `campaign_budget` from being reached over the length of the campaign. Cannot be lower than the `daily_budget` for any Line Items associated with this campaign.","format":"double"},"budget_type":{"type":"integer","description":"Type of budget, `0`=spend, `1`=impressions, `2`=spend with vendor fees","default":0,"format":"int32"},"revenue_type":{"type":"string","description":"Supported revenue types:  `CPM`, `CPC`, `CPCV`, `CPI`, `CPA`"},"revenue_amount":{"type":"number","description":"If a revenue_type is set, this is field is the basis of calculation. For example, if revenue_type is `CPM` and revenue_amount is `5.12`, revenue will be calculated as a $5.12 CPM.","format":"double"},"pacing":{"type":"integer","description":"This field is deprecated. Pacing is available at the Line Item level.","default":0,"format":"int32"},"bid_modifier_id":{"type":"integer","description":"ID of a Bid Modifier object to associate with the Campaign. If set, `max_bid` must also be set.","format":"int32"},"delivery_modifier_id":{"type":"integer","description":"ID of the Delivery Modifier to associate with Line Items under this Campaign","format":"int32"},"max_bid":{"type":"number","description":"Maximum bid after taking into consideration any Bid Modifiers.","format":"double"},"start_date":{"type":"string","description":"Start date of the Campaign. No Line Items associated with the Campaign can have start dates prior to this date.","format":"date"},"end_date":{"type":"string","description":"End date of the Campaign. No Line Items associated with the Campaign can have end dates after this date. End date must be provided in order to pace.","format":"date"},"frequency_cap":{"type":"object","description":"Frequency cap JSON.","required":["duration","impressions"],"properties":{"duration":{"type":"integer","description":"Duration of time in which to cap impressions, in seconds. 30-day (2592000) max.","format":"int32"},"impressions":{"type":"integer","description":"Number of impressions to allow within the duration set","format":"int32"}}},"frequency_cap_type":{"type":"integer","description":"The method of frequency capping. All Line Items must match Campaign-level if set. For definitions, see the Frequency Cap guide.","default":0,"format":"int32"},"frequency_cap_vendor":{"type":"string","description":"Extends frequency cap using a device graph (fees may apply). Valid values may be `TAPAD` or `LIVERAMP` depending on what has been enabled"},"continents":{"type":"array","description":"Continents in which the Campaign is eligible to serve. Inherited from the Advertiser object if left blank.","items":{"type":"string"}},"currency":{"type":"string","description":"Currency in which all Line Items under this Campaign will bid. Cannot be changed once set. If a default is set at the Advertiser level, it will be inherited here.","default":"USD"},"segment_extension_default":{"type":"string","description":"Determines the type of audience extension to use at the Line Item level. Valid values are `none`,`person`,`household`,`person_extend_only`, and `household_extend_only`.","default":"none"},"segment_extension_type_default":{"type":"string","description":"Determines the type of audience extension to be used at the Line Item level. Valid options include `none`,`1P`,`3P`, and `ALL`.","default":"none"},"segment_extension_vendors_default":{"type":"array","description":"Lists of vendors to use at the Line Item level for audience extension. Valid values are `TAPAD` and `LIVERAMP`.","default":["'[\"TAPAD\"]`"],"items":{"type":"string"}},"enable_skad_tracking":{"type":"boolean","description":"Should Apple's SKAdNetwork tracking be enabled for this Campaign. Must be enabled at the Advertiser level to be enabled here.","default":false},"alternative_id":{"type":"string","description":"An alternative id to lookup the Campaign, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"campaign created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"campaign created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/campaign\" -b cookies.txt -d '{\"advertiser_id\":1, \"budget_type\":0,\"campaign_name\":\"foo\", \"campaign_budget\":1000, \"start_date\":\"1/1/2015\", \"frequency_cap\":[{\"duration\":500,\"impressions\":1}, \"frequency_cap_type\":1, {\"duration\":1000,\"impressions\":2}], \"frequency_cap_vendor\":\"TAPAD\",\"continents\":[\"NAM\",\"EMEA\"],\"currency\":\"CAD\",\"segment_extension_default\":\"person\",\"segment_extension_type_default\":\"1P\",\"segment_extension_vendors_default\":[\"TAPAD\"],\"enable_skad_tracking\":false}'"}],"samples-languages":["curl"]}},"delete":{"summary":"campaign","description":"","operationId":"campaign-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["campaign_id"],"properties":{"campaign_id":{"type":"integer","description":"Unique ID of the campaign","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"campaign deleted with ID 1\"\n        }\n    ],\n    \"message\": \"campaign deletion: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"campaign deleted with ID 1"}}}},"message":{"type":"string","example":"campaign deletion: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/campaign\" -b cookies.txt -d '{\"campaign_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"campaign","description":"","operationId":"campaign-get","parameters":[{"name":"campaign_id","in":"query","description":"Unique ID of the campaign","schema":{"type":"integer","format":"int32"}},{"name":"advertiser_id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"campaign_name","in":"query","description":"Name of the campaign, e.g. \"Winter lead generation\"","schema":{"type":"string"}},{"name":"bid_modifier_id","in":"query","description":"ID of the Bid Modifier associated with this Campaign","schema":{"type":"integer","format":"int32"}},{"name":"delivery_modifier_id","in":"query","description":"ID of the Delivery Modifier associated with this Campaign","schema":{"type":"integer","format":"int32"}},{"name":"alternative_id","in":"query","description":"An alternative id to lookup the campaign, if desired","schema":{"type":"string"}},{"name":"active","in":"query","description":"Is it active?","schema":{"type":"boolean"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"campaign_id\": 1,\n            \"advertiser_id\": 1,\n            \"campaign_name\": \"Campaign Name\",\n            \"campaign_budget\": 1000,\n            \"campaign_spend\": 0,\n            \"daily_budget\": null,\n            \"budget_type\": 0,\n            \"start_date\": \"2015-01-01 00:00:00\",\n            \"end_date\": null,\n            \"pacing\": 0,\n            \"bid_modifier_id\": null,\n            \"delivery_modifier_id\": null,\n          \t\"max_bid\": null,\n            \"test_plan_id\": null,\n            \"revenue_type\": null,\n            \"revenue_amount\": null,\n            \"frequency_cap\": [\n                {\n                    \"duration\": 500,\n                    \"impressions\": 1\n                },\n                {\n                    \"duration\": 1000,\n                    \"impressions\": 2\n                }\n            ],\n            \"frequency_cap_type\": 1,\n            \"frequency_cap_vendor\": \"TAPAD\",\n            \"default_targeting\": [],\n            \"continents\": [\"NAM\",\"EMEA\"],\n            \"currency\": \"CAD\",\n            \"segment_extension_default\": \"person\",\n            \"segment_extension_type_default\": \"1P\",\n            \"segment_extension_vendors_default\": [\"TAPAD\"],\n            \"enable_skad_tracking\":false,          \n            \"push_status\": 0,\n            \"push_update\": 1,\n            \"account_id\": 1,\n            \"create_date\": \"2016-02-19 13:31:12\",\n            \"update_date\": \"2016-02-25 16:43:36\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"campaign_id":{"type":"integer","example":1,"default":0},"advertiser_id":{"type":"integer","example":1,"default":0},"campaign_name":{"type":"string","example":"Campaign Name"},"campaign_budget":{"type":"integer","example":1000,"default":0},"campaign_spend":{"type":"integer","example":0,"default":0},"daily_budget":{},"budget_type":{"type":"integer","example":0,"default":0},"start_date":{"type":"string","example":"2015-01-01 00:00:00"},"end_date":{},"pacing":{"type":"integer","example":0,"default":0},"bid_modifier_id":{},"delivery_modifier_id":{},"max_bid":{},"test_plan_id":{},"revenue_type":{},"revenue_amount":{},"frequency_cap":{"type":"array","items":{"type":"object","properties":{"duration":{"type":"integer","example":500,"default":0},"impressions":{"type":"integer","example":1,"default":0}}}},"frequency_cap_type":{"type":"integer","example":1,"default":0},"frequency_cap_vendor":{"type":"string","example":"TAPAD"},"default_targeting":{"type":"array","items":{"type":"object","properties":{}}},"continents":{"type":"array","items":{"type":"string","example":"NAM"}},"currency":{"type":"string","example":"CAD"},"segment_extension_default":{"type":"string","example":"person"},"segment_extension_type_default":{"type":"string","example":"1P"},"segment_extension_vendors_default":{"type":"array","items":{"type":"string","example":"TAPAD"}},"enable_skad_tracking":{"type":"boolean","example":false,"default":true},"push_status":{"type":"integer","example":0,"default":0},"push_update":{"type":"integer","example":1,"default":0},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-02-19 13:31:12"},"update_date":{"type":"string","example":"2016-02-25 16:43:36"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/campaign\" -b cookies.txt -d '{\"campaign_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"campaign","description":"","operationId":"campaign-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["campaign_Id"],"properties":{"campaign_Id":{"type":"integer","description":"Unique ID of the campaign","format":"int32"},"campaign_name":{"type":"string","description":"Name of the campaign, e.g. \"Winter lead generation\""},"campaign_budget":{"type":"number","description":"Maximum amount to spend on this Campaign","format":"double"},"daily_budget":{"type":"number","description":"Maximum amount to spend or deliver in a day, Cannot exceed `campaign_budget` or be so low as to prevent `campaign_budget` from being reached over the length of the campaign. Cannot be lower than the `daily_budget` for any Line Items associated with this Campaign.","format":"double"},"budget_type":{"type":"integer","description":"Type of budget, `0`=spend, `1`=impressions, `2`=spend with vendor fees","default":0,"format":"int32"},"revenue_type":{"type":"string","description":"Supported revenue types:  `CPM`, `CPC`, `CPCV`, `CPI`, `CPA`"},"revenue_amount":{"type":"number","description":"If a `revenue_type` is set, this is field is the basis of calculation. For example, if `revenue_type` is `CPM` and `revenue_amount` is `5.12`, revenue will be calculated as a $5.12 CPM.","format":"double"},"pacing":{"type":"integer","description":"This field is deprecated. Pacing is available at the Line Item level.","default":0,"format":"int32"},"bid_modifier_id":{"type":"integer","description":"ID of a Bid Modifier object to associate with the Campaign. If set, `max_bid` must also be set.","format":"int32"},"delivery_modifier_id":{"type":"integer","description":"ID of the Delivery Modifier to associate with Line Items under this Campaign","format":"int32"},"max_bid":{"type":"number","description":"Maximum bid after taking into consideration any Bid Modifiers.","format":"double"},"start_date":{"type":"string","description":"Start date of the Campaign. No Line Items associated with the Campaign can have start dates prior to this date.","format":"date"},"end_date":{"type":"string","description":"End date of the Campaign. No Line Items associated with the Campaign can have end dates after this date.","format":"date"},"frequency_cap":{"type":"object","description":"Frequency cap JSON.","required":["duration","impressions"],"properties":{"duration":{"type":"integer","description":"Duration of time in which to cap impressions, in seconds. 30-day (2592000) max.","format":"int32"},"impressions":{"type":"integer","description":"Number of impressions to allow within the duration set","format":"int32"}}},"frequency_cap_type":{"type":"integer","description":"The method of frequency capping. All Line Items must match Campaign-level if set. For definitions, see the Frequency Cap guide.","format":"int32"},"frequency_cap_vendor":{"type":"string","description":"Extends frequency cap using a device graph (fees may apply). Valid values may be `TAPAD` or `LIVERAMP` depending on what has been enabled"},"continents":{"type":"array","description":"Continents in which the Campaign is eligible to serve. Inherited from the Advertiser object if left blank.","items":{"type":"string"}},"segment_extension_default":{"type":"string","description":"Determines the type of audience extension to use at the Line Item level. Valid values are `none`,`person`,`household`,`person_extend_only`, and `household_extend_only`.","default":"none"},"segment_extension_type_default":{"type":"string","description":"Determines the type of audience extension to be used at the Line Item level. Valid options include `none`,`1P`,`3P`, and `ALL`.","default":"none"},"segment_extension_vendors_default":{"type":"array","description":"Lists of vendors to use at the Line Item level for audience extension. Valid values are `TAPAD` and `LIVERAMP`.","default":["`[\"TAPAD\"]`"],"items":{"type":"string"}},"enable_skad_tracking":{"type":"boolean","description":"Should Apple's SKAdNetwork tracking be enabled for this Campaign. Must be enabled at the Advertiser level to be enabled here.","default":false},"alternative_id":{"type":"string","description":"An alternative id to lookup the campaign, if desired"},"notes":{"type":"string","description":"Notes up to 255 chars"},"active":{"type":"boolean","description":"Is it active?"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"campaign updated with ID 1\"\n        }\n    ],\n    \"message\": \"campaign update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"campaign updated with ID 1"}}}},"message":{"type":"string","example":"campaign update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/campaign\" -b cookies.txt -d '{\"campaign_id\":1, \"start_date\":\"2/1/2015\"}'"}],"samples-languages":["curl"]}}},"/campaign_experiment_assignment":{"post":{"summary":"campaign_experiment_assignment","description":"This method is used to assign a Campaign and all of its Line Items to an `Experiment` in one POST. Other methods (PUT, GET, DELETE) are not supported.","operationId":"campaign_experiment_assignment","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","test_plan_id","line_item_test_groups"],"properties":{"campaign_id":{"type":"integer","description":"ID of the Campaign","format":"int32"},"test_plan_id":{"type":"integer","description":"The ID of the Test Plan at the Campaign level.","format":"int32"},"line_item_test_groups":{"type":"object","description":"Array describing the assignment of Line Items under the Campaign to Test Groups under the Test Plan in the format  `line_item_id:test_group_id`. Note, ALL Line Items within the Campaign must be assigned.","required":["<line_item_id>"],"properties":{"<line_item_id>":{"type":"integer","description":"Set the value to the <group_id> of the experiment","format":"int32"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n}"}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/campaign_experiment_assignment\" -b cookies.txt -d '{\"campaign_id\":1, \"test_plan_id\":1, \"line_item_test_groups\":{123:1,456:3,789:2}}'"}],"samples-languages":["curl"]}}},"/change_password":{"post":{"summary":"change_password","description":"Sends an email to reset password","operationId":"changepassword-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"User Email"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": \"true\",\n    \"payload\": \"Email sent successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"string","example":"true"},"payload":{"type":"string","example":"Email sent successfully"}}}}}}},"deprecated":false,"security":[],"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"/rest/change_password\" -b cookies.txt -d '{\"email\":\"foo@bar.com\"}'"}],"samples-languages":["curl"]}},"put":{"summary":"change_password","description":"Resets password from an email","operationId":"changepassword-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","login_token","new_password"],"properties":{"email":{"type":"string","description":"User Email"},"login_token":{"type":"string","description":"Token emailed to the user as a result of the POST"},"new_password":{"type":"string","description":"New password desired"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": \"true\",\n    \"payload\": \"Password updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"string","example":"true"},"payload":{"type":"string","example":"Password updated successfully"}}}}}}},"deprecated":false,"security":[],"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"/rest/change_password\" -d '{\"email\":\"foo@bar.com\",\"login_token\":\"dfdskjKDJD\",\"new_password\":\"abcdef\"}'"}],"samples-languages":["curl"]}}},"/creative":{"delete":{"summary":"creative","description":"","operationId":"creative-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["creative_id"],"properties":{"creative_id":{"type":"integer","description":"Unique ID of the creative","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"creative deleted with ID 1\"\n        }\n    ],\n    \"message\": \"creative deletion: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"creative deleted with ID 1"}}}},"message":{"type":"string","example":"creative deletion: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/creative\" -b cookies.txt -d '{\"creative_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"creative","description":"","operationId":"creative-get","parameters":[{"name":"creative_id","in":"query","description":"Unique ID of the Creative","schema":{"type":"integer","format":"int32"}},{"name":"advertiser_id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"creative_name","in":"query","description":"Name of the Creative, e.g. \"Blue Banner Ad\"","schema":{"type":"string"}},{"name":"creative_type","in":"query","description":"ID for the type of creative. 0=banner, 1=video, 2=native, etc.","schema":{"type":"integer","format":"int32","default":0}},{"name":"creative_template_id","in":"query","description":"The ID of the Creative Template to use for this creative. Must be a valid and active Creative Template that either belongs to this Account, OR is marked as \"global\".","schema":{"type":"integer","format":"int32"}},{"name":"alternative_id","in":"query","description":"An alternative id to lookup the creative, if desired","schema":{"type":"string"}},{"name":"active","in":"query","description":"Is the Creative active?","schema":{"type":"boolean","default":false}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"creative_id\": 1,\n            \"advertiser_id\": 1,\n            \"creative_type\": 0,\n            \"creative_template_id\": 4,\n            \"creative_status_id\": 1,\n            \"creative_rule_id\": null,\n            \"creative_rule_key\": \"dfa\",\n            \"width\": 468,\n            \"height\": 60,\n            \"sizeless\": false,\n            \"secure\": false,\n            \"click_url\": null,\n            \"creative_name\": \"test banner\",\n            \"creative_attributes\": {\n                \"advertiser\": {\n                    \"advertiser_category\": [\n                        \"IAB1\"\n                    ],\n                    \"advertiser_index_id\": [\n                        1143\n                    ]\n                },\n                \"approval\": {\n                    \"vendor_id\": [\n                        3\n                    ]\n                },\n                \"technical\": {\n                    \"tag_type\": [\n                        3\n                    ]\n                }\n            },\n            \"creative_assets\": [],\n            \"primary_asset\": null,\n            \"secondary_asset\": null,\n            \"creative_content\": {\n                \"TAG\": \"<SCRIPT language=\\\"JavaScript1.1\\\" SRC=\\\"https://ad.doubleclick.net/ddm/trackimpj/N3093.888888.SITE/B9058599.122522097;dc_trk_aid=295586985;dc_trk_cid=65391418;click={{CLICK_URL}};ord={{CACHEBUSTER}}?\\\"></SCRIPT>\"\n            },\n            \"creative_content_munge\": \"<img src={{IMPRESSION_URL}} width='0' height='0'><SCRIPT language=\\\"JavaScript1.1\\\" SRC=\\\"https://ad.doubleclick.net/ddm/trackimpj/N3093.888888.SITE/B9058599.122522097;dc_trk_aid=295586985;dc_trk_cid=65391418;click={{CLICK_URL}};ord={{CACHEBUSTER}}?\\\"></SCRIPT>\",\n            \"creative_content_tag\": null,\n            \"preview_token\": \"aALCTJGkf9iv7r6Q5wtEvffFoQNZCt8M4UpXE6iU\",\n            \"creative_thumbnail_url\": null,\n            \"start_date\": \"2020-01-01 12:00:00\",\n            \"end_date\": null,\n            \"frequency_cap\": [],\n            \"scripts\": [],\n            \"pixels\": [],\n            \"events\": [],\n            \"progress_events\": [],\n          \t\"push_status\": 0,\n            \"push_update\": true,\n            \"account_id\": 1,\n            \"create_date\": \"2016-02-03 17:42:20\",\n            \"update_date\": \"2016-02-23 14:56:24\",\n            \"alternative_id\": null,\n            \"notes\": \"test1\",\n            \"active\": false,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"creative_id":{"type":"integer","example":1,"default":0},"advertiser_id":{"type":"integer","example":1,"default":0},"creative_type":{"type":"integer","example":0,"default":0},"creative_template_id":{"type":"integer","example":4,"default":0},"creative_status_id":{"type":"integer","example":1,"default":0},"creative_rule_id":{},"creative_rule_key":{"type":"string","example":"dfa"},"width":{"type":"integer","example":468,"default":0},"height":{"type":"integer","example":60,"default":0},"sizeless":{"type":"boolean","example":false,"default":true},"secure":{"type":"boolean","example":false,"default":true},"click_url":{},"creative_name":{"type":"string","example":"test banner"},"creative_attributes":{"type":"object","properties":{"advertiser":{"type":"object","properties":{"advertiser_category":{"type":"array","items":{"type":"string","example":"IAB1"}},"advertiser_index_id":{"type":"array","items":{"type":"integer","example":1143,"default":0}}}},"approval":{"type":"object","properties":{"vendor_id":{"type":"array","items":{"type":"integer","example":3,"default":0}}}},"technical":{"type":"object","properties":{"tag_type":{"type":"array","items":{"type":"integer","example":3,"default":0}}}}}},"creative_assets":{"type":"array","items":{"type":"object","properties":{}}},"primary_asset":{},"secondary_asset":{},"creative_content":{"type":"object","properties":{"TAG":{"type":"string","example":"<SCRIPT language=\"JavaScript1.1\" SRC=\"https://ad.doubleclick.net/ddm/trackimpj/N3093.888888.SITE/B9058599.122522097;dc_trk_aid=295586985;dc_trk_cid=65391418;click={{CLICK_URL}};ord={{CACHEBUSTER}}?\"></SCRIPT>"}}},"creative_content_munge":{"type":"string","example":"<img src={{IMPRESSION_URL}} width='0' height='0'><SCRIPT language=\"JavaScript1.1\" SRC=\"https://ad.doubleclick.net/ddm/trackimpj/N3093.888888.SITE/B9058599.122522097;dc_trk_aid=295586985;dc_trk_cid=65391418;click={{CLICK_URL}};ord={{CACHEBUSTER}}?\"></SCRIPT>"},"creative_content_tag":{},"preview_token":{"type":"string","example":"aALCTJGkf9iv7r6Q5wtEvffFoQNZCt8M4UpXE6iU"},"creative_thumbnail_url":{},"start_date":{"type":"string","example":"2020-01-01 12:00:00"},"end_date":{},"frequency_cap":{"type":"array","items":{"type":"object","properties":{}}},"scripts":{"type":"array","items":{"type":"object","properties":{}}},"pixels":{"type":"array","items":{"type":"object","properties":{}}},"events":{"type":"array","items":{"type":"object","properties":{}}},"progress_events":{"type":"array","items":{"type":"object","properties":{}}},"push_status":{"type":"integer","example":0,"default":0},"push_update":{"type":"boolean","example":true,"default":true},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-02-03 17:42:20"},"update_date":{"type":"string","example":"2016-02-23 14:56:24"},"alternative_id":{},"notes":{"type":"string","example":"test1"},"active":{"type":"boolean","example":false,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/creative\" -b cookies.txt -d '{\"creative_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"creative","description":"","operationId":"creative-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["advertiser_id","creative_name","creative_type","secure","creative_template_id"],"properties":{"advertiser_id":{"type":"integer","description":"Must belong to the same account as the Advertiser and be active","format":"int32"},"creative_name":{"type":"string","description":"Name of the Creative, e.g. \"Blue Banner Ad\""},"creative_type":{"type":"integer","description":"The type of creative. `0`=banner, `1`=video, `2`=native","default":0,"format":"int32"},"width":{"type":"integer","description":"Width in pixels. Use the `creative_sizes` view to see all acceptable width and height combinations.","format":"int32"},"height":{"type":"integer","description":"Height in pixels. Use the `creative_sizes` view to see all acceptable width and height combinations.","format":"int32"},"sizeless":{"type":"boolean","description":"Is the creative sizeless, meaning it can match any size placement that is an interstitial. Native creatives should also be marked as sizeless.","default":false},"secure":{"type":"boolean","description":"Is the creative intended to serve in a secure (HTTPS) environment.","default":false},"click_url":{"type":"string","description":"URL the ad should click or tap to, must be a valid URL. This field is required when using a Creative Template that is not a tag (e.g. an image or video)","default":"0"},"creative_assets":{"type":"array","description":"DEPRECATED, use `primary_asset` and `secondary_asset` fields instead.","items":{"type":"integer","format":"int32"}},"primary_asset":{"type":"integer","description":"ID of the `creative_asset` to use in the Creative, for example the ID of an Image or Video.","format":"int32"},"secondary_asset":{"type":"integer","description":"ID of a secondary `creative_asset` to use in the Creative. Most commonly used for the companion asset within a Video Creative","format":"int32"},"native_offer":{"type":"integer","description":"For Native creatives, the NativeOffer to be used for the Creative content","format":"int32"},"creative_content":{"type":"object","description":"A JSON representation of the fields required by the Creative Template, validated against the Creative Template. Schema of json varies.","properties":{}},"creative_content_tag":{"type":"string","description":"For tag creatives the tag can be placed in this field and on save the `creative_rule_key` will be applied to insert relevant macros. This is recommended vs completing the `creative_content` field directly."},"creative_template_id":{"type":"integer","description":"The ID of the Creative Template to use for this creative. Must be a valid and active Creative Template that either belongs to this Account, OR is marked as \"global\".","format":"int32"},"creative_rule_id":{"type":"integer","description":"DEPRECATED","format":"int32"},"creative_rule_key":{"type":"string","description":"The key corresponding to the `creative_rule` to apply to the `creative_content_tag` field. The rule will insert click and timestamp macros. You can use `auto_detect` for easiest implementation.","default":"none"},"creative_attributes":{"type":"object","description":"Creative Attributes JSON.","properties":{"<module_name>":{"type":"object","description":"The overall statement can include any number of modules, but each module may only appear once. Example of a module is `advertiser`","properties":{"<key>":{"type":"array","description":"Key must belong to the module selected, the value must be a list of one or more values corresponding to the key. Values may be integers or strings depending on the key.","items":{"type":"string"}}}}}},"scripts":{"type":"array","description":"List of URLs to be added to the Creative as scripts","items":{"type":"string"}},"pixels":{"type":"array","description":"List of URLs to be added to the Creative as pixels","items":{"type":"string"}},"events":{"type":"object","description":"List of VAST tracking events and associated URLs to allow third party tracking of video events","properties":{"<none>":{"type":"object","description":"List of video event objects","required":["<video_event>"],"properties":{"<video_event>":{"type":"string","description":"Key should be a standard VAST video event, value should be the URL to request when the video player calls that event."}}}}},"progress_events":{"type":"object","description":"List of objects to track VAST video progress","properties":{"<none>":{"type":"object","description":"List of key-value pairs representing duration and URLs","required":["<HH:MM:SS>"],"properties":{"<HH:MM:SS>":{"type":"string","description":"Key should be the number of elapsed seconds in form `HH:MM:SS`, value should be the URL to request when the video player plays for that duration.."}}}}},"creative_addons":{"type":"array","description":"List of CreativeAddOn IDs to add to the Creative","items":{"type":"integer","format":"int32"}},"creative_thumbnail_url":{"type":"string","description":"URL to an image thumbnail for the creative. This field will be automatically set if you associate the creative with a Creative Asset that has a valid thumbnail but must be updated manually when using a tag-based Creative. Thumbnail is required by some exchanges to serve."},"start_date":{"type":"string","description":"Start date for the creative, optional","format":"date"},"end_date":{"type":"string","description":"End date for the creative, optional","format":"date"},"alternative_id":{"type":"string","description":"An alternative id to lookup the Creative, if desired"},"notes":{"type":"string","description":"Notes about the Creative, up to 255 chars"},"active":{"type":"boolean","description":"Is the Creative active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"creative created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"creative created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/creative\" -b cookies.txt -d '{\"advertiser_id\":1,\"creative_type\":0,\"width\":468,\"height\":60,\"creative_name\":\"test banner\",\"creative_template_id\":4,\"creative_rule_key\":\"dfa\",\"creative_content\":{\"TAG\":\"<SCRIPT language=\\\"JavaScript1.1\\\" SRC=\\\"https://ad.doubleclick.net/ddm/trackimpj/N9999.88888.SITE/B9058599.122522097;dc_trk_aid=295586985;dc_trk_cid=65391418;click=;ord=[timestamp]?\\\"></SCRIPT>\"},\"creative_attributes\":{\"advertiser\":{\"advertiser_category\":[\"IAB1\"],\"advertiser_index_id\":[1143]}},\"pixels\":[\"https://www.mysite.com/pixel?foo\"],\"scripts\":[\"https://www.mysite.com/pixel?bar\"],\"events\":[],\"active\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"creative","description":"","operationId":"creative-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["creative_id"],"properties":{"creative_id":{"type":"integer","description":"Unique ID of the Creative","format":"int32"},"advertiser_id":{"type":"integer","description":"Must belong to the same account as the Advertiser and be active","format":"int32"},"creative_name":{"type":"string","description":"Name of the Creative, e.g. \"Blue Banner Ad\""},"width":{"type":"integer","description":"Width in pixels. Use the `creative_sizes` view to see all acceptable width and height combinations.","format":"int32"},"height":{"type":"integer","description":"Height in pixels. Use the `creative_sizes` view to see all acceptable width and height combinations.","format":"int32"},"sizeless":{"type":"boolean","description":"Is the creative sizeless, meaning it can match any size placement that is an interstitial.","default":false},"secure":{"type":"boolean","description":"Is the creative intended to serve in a secure (HTTPS) environment.","default":false},"click_url":{"type":"string","description":"URL the ad should click or tap to, must be a valid URL. This field is required when using a Creative Template that is not a tag (e.g. an image or video)","default":"0"},"creative_assets":{"type":"array","description":"DEPRECATED, use `primary_asset` and `secondary_asset` fields instead.","items":{"type":"integer","format":"int32"}},"primary_asset":{"type":"integer","description":"ID of the `creative_asset` to use in the Creative, for example the ID of an Image or Video.","format":"int32"},"secondary_asset":{"type":"integer","description":"ID of a secondary `creative_asset` to use in the Creative. Most commonly used for the companion asset within a Video Creative.","format":"int32"},"native_offer":{"type":"integer","description":"For Native creatives, the NativeOffer to be used for the Creative content","format":"int32"},"creative_content":{"type":"object","description":"A JSON representation of the fields required by the Creative Template, validated against the Creative Template","properties":{}},"creative_content_tag":{"type":"string","description":"For tag creatives the tag can be placed in this field and on save the `creative_rule_key` will be applied to insert relevant macros. This is recommended vs completing the `creative_content` field directly."},"creative_template_id":{"type":"integer","description":"The ID of the Creative Template to use for this creative. Must be a valid and active Creative Template that either belongs to this Account, OR is marked as \"global\".","format":"int32"},"creative_rule_id":{"type":"integer","description":"DEPRECATED","format":"int32"},"creative_rule_key":{"type":"string","description":"Thy key corresponding to the creative_rule to apply to the `creative_content_tag` field. The rule will insert click and timestamp macros. You can use `auto_detect` for easiest implementation.","default":"none"},"attributes":{"type":"object","description":"Creative Attributes JSON.","properties":{"<module_name>":{"type":"object","description":"The overall statement can include any number of modules, but each module may only appear once. Example of a module is `advertiser`","properties":{"<key>":{"type":"array","description":"Key must belong to the module selected, the value must be a list of one or more values corresponding to the key. Values may be integers or strings depending on the key.","items":{"type":"string"}}}}}},"pixels":{"type":"array","description":"List of URLs to be added to the Creative as pixels","items":{"type":"string"}},"scripts":{"type":"array","description":"List of URLs to be added to the Creative as scripts","items":{"type":"string"}},"events":{"type":"object","description":"List of video event objects","properties":{"<none>":{"type":"object","description":"List of video event objects","required":["<video_event>"],"properties":{"<video_event>":{"type":"string","description":"Key should be a standard VAST video event, value should be the URL to request when the video player calls that event."}}}}},"progess_events":{"type":"object","description":"List of objects to track VAST video progress","properties":{"<none>":{"type":"object","description":"List of key-value pairs representing duration and URLs","required":["<HH:MM:SS>"],"properties":{"<HH:MM:SS>":{"type":"string","description":"Key should be the number of elapsed seconds in form `HH:MM:SS`, value should be the URL to request when the video player plays for that duration.."}}}}},"creative_addons":{"type":"array","description":"List of CreativeAddOn IDs to add to the Creativ","items":{"type":"integer","format":"int32"}},"creative_thumbnail_url":{"type":"string","description":"URL to an image thumbnail for the creative. This field will be automatically set if you associate the creative with a Creative Asset that has a valid thumbnail but must be updated manually when using a tag-based Creative. Thumbnail is required by some exchanges to serve."},"start_date":{"type":"string","description":"Start date of the creative, optional","format":"date"},"end_date":{"type":"string","description":"End date of the creative, optional","format":"date"},"alternative_id":{"type":"string","description":"An alternative id to lookup the creative, if desired"},"notes":{"type":"string","description":"Notes about the Creative, up to 255 chars"},"active":{"type":"boolean","description":"Is the Creative active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"creative updated with ID 1\"\n        }\n    ],\n    \"message\": \"creative update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"creative updated with ID 1"}}}},"message":{"type":"string","example":"creative update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/creative\" -b cookies.txt -d '{\"creative_id\":1, \"creative_name\":\"new banner\"}"}],"samples-languages":["curl"]}}},"/creative_addon":{"delete":{"summary":"creative_addon","description":"","operationId":"creative_addon-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["creative_addon_id"],"properties":{"creative_addon_id":{"type":"integer","description":"Unique ID of the Creative AddOn","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"creative_addon deleted with ID 1\"\n        }\n    ],\n    \"message\": \"creative_addon deletion: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"creative_addon deleted with ID 1"}}}},"message":{"type":"string","example":"creative_addon deletion: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/creative_addon\" -b cookies.txt -d '{\"creative_addon_id\":123}'"}],"samples-languages":["curl"]}},"put":{"summary":"creative_addon","description":"","operationId":"creative_addon-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["creative_addon_id","creative_addon_content"],"properties":{"creative_addon_id":{"type":"integer","description":"Unique ID of the Creative AddOn","format":"int32"},"creative_addon_name":{"type":"string","description":"Name of the Creative AddOn, e.g. \"MOAT Viewabiity\""},"advertiser_id":{"type":"integer","description":"Make the addon only available to a single Advertiser","format":"int32"},"include_by_default":{"type":"boolean","description":"Should this addon always be included when creating a new Creative of the same creative_type","default":false},"creative_addon_content":{"type":"string","description":"Should always be a URL"},"secure":{"type":"boolean","description":"Is the pixel secure (https)?","default":false},"cpm_cost":{"type":"number","description":"Cost to be attributed to use of the pixel.","format":"double"},"notes":{"type":"string","description":"<255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"creative_addon updated with ID 1\"\n        }\n    ],\n    \"message\": \"creative_addon update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"creative_addon updated with ID 1"}}}},"message":{"type":"string","example":"creative_addon update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/creative_addon\" -b cookies.txt -d '{\"creative_addon_id\":1, \"creative_addon_name\":\"new creative addon\", \"creative_addon_content\":\"http://foo.com/pixel.jpg\", \"creative_addon_type\":\"PIXEL\",\"active\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"creative_addon","description":"","operationId":"creative_addon-get","parameters":[{"name":"creative_addon_id","in":"query","description":"Unique ID of the Creative AddOn","schema":{"type":"integer","format":"int32"}},{"name":"creative_addon_name","in":"query","description":"Name of the Creative AddOn, e.g. \"MOAT Viewabiity\"","schema":{"type":"string"}},{"name":"advertiser_id","in":"query","description":"Advertiser the CreativeAddOn is associated with","schema":{"type":"integer","format":"int32"}},{"name":"creative_type","in":"query","description":"0 = banner, 1 = video, 2 = native","schema":{"type":"integer","format":"int32"}},{"name":"creative_addon_type","in":"query","description":"Must be either `PIXEL` or `SCRIPT`","schema":{"type":"string"}},{"name":"secure","in":"query","description":"Is the pixel secure (https)?","schema":{"type":"boolean"}},{"name":"global","in":"query","description":"Is this a global addon, available to all Buzz accounts?","schema":{"type":"boolean"}},{"name":"active","in":"query","description":"Is it active?","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"creative_addon_id\": 1,\n            \"account_id\": 1,\n            \"creative_addon_name\": \"new creative addon\",\n            \"global\": false,\n            \"secure\": true,\n            \"creative_type\": 1,\n            \"creative_addon_type\": \"PIXEL\",\n\t          \"creative_addon_content\":\"http://foo.com/pixel.jpg\",\n          \t\"notes\": null,\n            \"buzz_key\": \"stingertest\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"creative_addon_id":{"type":"integer","example":1,"default":0},"account_id":{"type":"integer","example":1,"default":0},"creative_addon_name":{"type":"string","example":"new creative addon"},"global":{"type":"boolean","example":false,"default":true},"secure":{"type":"boolean","example":true,"default":true},"creative_type":{"type":"integer","example":1,"default":0},"creative_addon_type":{"type":"string","example":"PIXEL"},"creative_addon_content":{"type":"string","example":"http://foo.com/pixel.jpg"},"notes":{},"buzz_key":{"type":"string","example":"stingertest"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/creative_addon\" -b cookies.txt -d '{\"creative_addon_name\":\"new creative addon\"}'"}],"samples-languages":["curl"]}},"post":{"summary":"creative_addon","description":"","operationId":"creative_addon-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["creative_addon_name","creative_addon_type","creative_addon_content","active"],"properties":{"creative_addon_name":{"type":"string","description":"Name of the Creative AddOn, e.g. \"MOAT Viewabiity\""},"advertiser_id":{"type":"integer","description":"Make the addon only available to a single Advertiser","format":"int32"},"include_by_default":{"type":"boolean","description":"Should this addon always be included when creating a new Creative of the same creative_type","default":false},"creative_type":{"type":"integer","description":"0 = banner, 1=video","default":0,"format":"int32"},"creative_addon_type":{"type":"string","description":"Must be either `PIXEL` or `SCRIPT`"},"creative_addon_content":{"type":"string","description":"Should always be a URL"},"secure":{"type":"boolean","description":"Is the pixel secure (https)?","default":false},"cpm_cost":{"type":"number","description":"Cost to be attributed to use of the pixel.","format":"double"},"notes":{"type":"string","description":"<255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"creative_addon created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"creative_addon created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/creative_addon\" -b cookies.txt -d '{\"creative_addon_name\":\"new creative addon\", \"creative_addon_content\":\"http://foo.com/pixel.jpg\", \"creative_type\":-1, \"creative_addon_type\":\"PIXEL\",\"active\":1}'"}],"samples-languages":["curl"]}}},"/creative_line_item":{"delete":{"summary":"creative_line_item","description":"","operationId":"creative_line_item-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["cli_id"],"properties":{"cli_id":{"type":"integer","description":"Unique ID of the Creative Line Item association.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"creative_line_item deleted with ID 1\"\n        }\n    ],\n    \"message\": \"creative_line_item update: 1 deleted successfully\",\n}"}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/creative_line_item\" -b cookies.txt -d '{\"cli_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"creative_line_item","description":"","operationId":"creativelineitem-get","parameters":[{"name":"cli_id","in":"query","description":"Unique ID of the Creative Line Item association","schema":{"type":"integer","format":"int32"}},{"name":"creative_id","in":"query","description":"Unique ID of the Creative.","schema":{"type":"integer","format":"int32"}},{"name":"line_item_id","in":"query","description":"Unique D of the Line Item.","schema":{"type":"integer","format":"int32"}},{"name":"start_date","in":"query","description":"Start date for the Creative to serve within this Line Item. If either `start_date` or `end_date` is set, both values will override the Creative level dates, otherwise Creative level will be used.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"End date for the Creative to serve within this Line Item. If either `start_date` or `end_date` is set, both values will override the Creative level dates, otherwise Creative level will be used.","schema":{"type":"string","format":"date"}},{"name":"active","in":"query","description":"Is it active?","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"cli_id\": 1,\n            \"creative_id\": 1,\n            \"line_item_id\": 1,\n            \"start_date\": \"2020-01-01 12:00:00\",\n            \"end_date\": \"2021-01-01 12:00:00\",\n            \"account_id\": 1,\n            \"weighting\": 50,\n            \"active\": true,\n            \"create_date\": \"2015-08-01 19:25:14\",\n            \"update_date\": \"2015-08-01 19:25:14\",\n            \"push_status\": 0,\n            \"push_update\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"cli_id":{"type":"integer","example":1,"default":0},"creative_id":{"type":"integer","example":1,"default":0},"line_item_id":{"type":"integer","example":1,"default":0},"start_date":{"type":"string","example":"2020-01-01 12:00:00"},"end_date":{"type":"string","example":"2021-01-01 12:00:00"},"account_id":{"type":"integer","example":1,"default":0},"weighting":{"type":"integer","example":50,"default":0},"active":{"type":"boolean","example":true,"default":true},"create_date":{"type":"string","example":"2015-08-01 19:25:14"},"update_date":{"type":"string","example":"2015-08-01 19:25:14"},"push_status":{"type":"integer","example":0,"default":0},"push_update":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/creative_line_item\" -b cookies.txt -d '{\"cli_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"creative_line_item","description":"","operationId":"creativelineitem-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["creative_id","line_item_id","active"],"properties":{"creative_id":{"type":"integer","description":"Unique ID of the Creative to be associated. Must bethe same type as the Line Item.","format":"int32"},"line_item_id":{"type":"integer","description":"Unique D of the Line Item to be associated. Must be the same type as the Creative.","format":"int32"},"weighting":{"type":"integer","description":"When the Line Item has `creative_weighting_method` set to `WEIGHTED`, this field represents the desired ratio of delivery against all other associated Creatives of the same size and type. Should be an integer between 1 and 100.","format":"int32"},"start_date":{"type":"string","description":"Start date for the Creative to serve within this Line Item, optional. If either `start_date` or `end_date` is set, both values will override the Creative level dates, otherwise Creative level will be used.","format":"date"},"end_date":{"type":"string","description":"End date for the Creative to serve within this Line Item, optional. If either `start_date` or `end_date` is set, both values will override the Creative level dates, otherwise Creative level will be used.","format":"date"},"active":{"type":"boolean","description":"Must be true for the creative to serve.","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"creative_line_item created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"creative_line_item created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/creative_line_item\" -b cookies.txt -d '{\"creative_id\":1, \"line_item_id\":1, \"weighting\":50, \"active\":1, \"start_date\":\"2020-01-01\", \"end_date\":\"2021-01-01\"}'"}],"samples-languages":["curl"]}},"put":{"summary":"creative_line_item","description":"","operationId":"creativelineitem-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["cli_id"],"properties":{"cli_id":{"type":"integer","description":"Unique ID of the Creative Line Item association.","format":"int32"},"weighting":{"type":"integer","description":"When the Line Item has `creative_weighting_method` set to `WEIGHTED`, this field represents the desired ratio of delivery against all other associated Creatives of the same size and type. Should be an integer between 1 and 100.","format":"int32"},"start_date":{"type":"string","description":"Start date for the Creative to serve within this Line Item, optional. If either `start_date` or `end_date` is set, both values will override the Creative level dates, otherwise Creative level will be used.","format":"date"},"end_date":{"type":"string","description":"End date for the Creative to serve within this Line Item, optional. If either `start_date` or `end_date` is set, both values will override the Creative level dates, otherwise Creative level will be used.","format":"date"},"active":{"type":"boolean","description":"Must be true for the creative to serve.","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"creative_line_item updated with ID 1\"\n        }\n    ],\n    \"message\": \"creative_line_item update: 1 updated successfully\",\n}"}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/creative_line_item\" -b cookies.txt -d '{\"cli_id\":1, \"active\":1, \"weighting\":50}'"}],"samples-languages":["curl"]}}},"/creative_approval_queue_history":{"get":{"summary":"creative_approval_queue_history","description":"","operationId":"creativeapprovalqueuehistory","parameters":[{"name":"creative_approval_queue_history_id","in":"query","description":"Unique id of the creative_approval_queue_history entry","schema":{"type":"integer","format":"int32"}},{"name":"creative_approval_id","in":"query","description":"Unique id of the creative_approval_queue entry","schema":{"type":"integer","format":"int32"}},{"name":"creative_id","in":"query","description":"ID of the creative","schema":{"type":"integer","format":"int32"}},{"name":"vendor_id","in":"query","description":"ID of the `vendor` such as Google","schema":{"type":"integer","format":"int32"}},{"name":"action","in":"query","description":"The latest action that is required to be performed on this queue entry. Valid actions are `CREATE`, `PAUSE`, `RESUME`, and `DELETE`. Not all actions are relevant to all vendors.","schema":{"type":"string"}},{"name":"request_date","in":"query","description":"Date the latest approval was submitted","schema":{"type":"string","format":"date"}},{"name":"request_status","in":"query","description":"Status of the latest approval request. Note, this is not the same as the status of the Creative with this vendor.","schema":{"type":"integer","format":"int32"}},{"name":"approved","in":"query","description":"Whether this `creative_id` to `vendor_id` combination is currently in an approved state.","schema":{"type":"boolean"}},{"name":"update_date","in":"query","description":"Date the queue entry was created or updated","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"creative_approval_history_id\": 1,\n            \"creative_approval_id\": 1,\n            \"creative_id\": 1,\n            \"vendor_id\": 3,\n            \"account_id\": 1,\n            \"alternative_id\": null,\n            \"action\": \"CREATE\",\n            \"request_date\": \"2016-02-03 17:42:20\",\n            \"request_status\": 0,\n            \"approval_status_message\": {\n              \"message\":\"Creative submitted to Google\",\n              \"issues\":[\n                {\n                  \"code\":\"unique code for an issue\",\n                \t\"description\":\"Wow, this creative is really bad\"}\n                ]\n            }\n            \"update_date\": \"2016-02-03 17:42:20\",\n            \"approved\": 0,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/creative_approval_queue_history\" -b cookies.txt -d '{\"creative_id\":1}'"}],"samples-languages":["curl"]}}},"/creative_asset":{"get":{"summary":"creative_asset","description":"","operationId":"creativeasset-get","parameters":[{"name":"creative_asset_id","in":"query","description":"Unique ID of the creative_asset","schema":{"type":"integer","format":"int32"}},{"name":"advertiser_id","in":"query","description":"Advertiser ID","schema":{"type":"integer","format":"int32"}},{"name":"creative_asset_name","in":"query","description":"Name of the Creative Asset, e.g. \"Blue Banner Ad\"","schema":{"type":"string"}},{"name":"asset_type","in":"query","description":"`SOURCE_VIDEO`, `IMAGE`, or `DESTINATION_VIDEO`","schema":{"type":"string"}},{"name":"mime_type","in":"query","description":"Auto-detected mime-type","schema":{"type":"string"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"active","in":"query","description":"Is it active?","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"creative_asset_id\": 1,\n            \"advertiser_id\": 1,\n            \"creative_asset_name\": \"4_small.mp4\",\n            \"creative_thumbnail_name\": null,\n            \"asset_type\": \"SOURCE_VIDEO\",\n            \"mime_type\": \"application/octet-stream\",\n            \"path_to_asset\": \"stingertest/1/1/4_small.mp4\",\n            \"size_in_bytes\": 383631,\n            \"metadata\": [],\n            \"account_id\": 1,\n            \"create_date\": \"2016-02-26 12:30:59\",\n            \"update_date\": \"2016-02-26 12:31:12\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"creative_asset_id":{"type":"integer","example":1,"default":0},"advertiser_id":{"type":"integer","example":1,"default":0},"creative_asset_name":{"type":"string","example":"4_small.mp4"},"creative_thumbnail_name":{},"asset_type":{"type":"string","example":"SOURCE_VIDEO"},"mime_type":{"type":"string","example":"application/octet-stream"},"path_to_asset":{"type":"string","example":"stingertest/1/1/4_small.mp4"},"size_in_bytes":{"type":"integer","example":383631,"default":0},"metadata":{"type":"array","items":{"type":"object","properties":{}}},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-02-26 12:30:59"},"update_date":{"type":"string","example":"2016-02-26 12:31:12"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/creative_asset\" -b cookies.txt -d '{\"creative_asset_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"creative_asset","description":"","operationId":"creativeasset-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["creative_asset_name","size_in_bytes","active"],"properties":{"advertiser_id":{"type":"integer","description":"Advertiser that owns the asset. Highly recommended that this be present since most assets are specific to a single Advertiser.","format":"int32"},"creative_asset_name":{"type":"string","description":"Name of the Creative Asset, e.g. \"Blue Banner Ad\""},"size_in_bytes":{"type":"integer","description":"Number of bytes","default":0,"format":"int32"},"notes":{"type":"string","description":"Notes about the Creative Asset, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"creative_asset created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"creative_asset created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"#Step 1, create the asset using POST\ncurl -X POST \"[host]/rest/creative_asset\" -b cookies.txt -d '{\"creative_asset_name\":\"test.jpg\", \"size_in_bytes\":11500, \"advertiser_id\":1}'\n\n#Step 2, upload the file using the /upload/ID method \ncurl -X POST -F \"creative_content=@test.jpg\" \"[host]/rest/creative_asset/upload/5\" -b cookies.txt"}],"samples-languages":["curl"]}}},"/creative_approval_queue":{"get":{"summary":"creative_approval_queue","description":"","operationId":"creativeapprovalqueue-get","parameters":[{"name":"creative_approval_id","in":"query","description":"Unique id of the creative_approval_queue entry","schema":{"type":"integer","format":"int32"}},{"name":"creative_id","in":"query","description":"ID of the creative","schema":{"type":"integer","format":"int32"}},{"name":"vendor_id","in":"query","description":"ID of the `vendor` such as Google","schema":{"type":"integer","format":"int32"}},{"name":"action","in":"query","description":"The latest action that is required to be performed on this queue entry. Valid actions are `CREATE`, `PAUSE`, `RESUME`, and `DELETE`. Not all actions are relevant to all vendors.","schema":{"type":"string"}},{"name":"request_date","in":"query","description":"Date the latest approval was submitted","schema":{"type":"string","format":"date"}},{"name":"request_status","in":"query","description":"Status of the latest approval request. Note, this is not the same as the status of the Creative with this vendor.","schema":{"type":"integer","format":"int32"}},{"name":"approved","in":"query","description":"Whether this `creative_id` to `vendor_id` combination is currently in an approved state.","schema":{"type":"boolean"}},{"name":"update_date","in":"query","description":"Date the queue entry was created or updated","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"creative_approval_id\": 1,\n            \"creative_id\": 1,\n            \"vendor_id\": 3,\n            \"account_id\": 1,\n            \"alternative_id\": null,\n            \"action\": \"CREATE\",\n            \"request_date\": \"2016-02-03 17:42:20\",\n            \"request_status\": 0,\n            \"update_date\": \"2016-02-03 17:42:20\",\n            \"approved\": 0,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"creative_approval_id":{"type":"integer","example":1,"default":0},"creative_id":{"type":"integer","example":1,"default":0},"vendor_id":{"type":"integer","example":3,"default":0},"account_id":{"type":"integer","example":1,"default":0},"alternative_id":{},"action":{"type":"string","example":"CREATE"},"request_date":{"type":"string","example":"2016-02-03 17:42:20"},"request_status":{"type":"integer","example":0,"default":0},"update_date":{"type":"string","example":"2016-02-03 17:42:20"},"approved":{"type":"integer","example":0,"default":0},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/creative_approval_queue\" -b cookies.txt -d '{\"creative_id\":1}'"}],"samples-languages":["curl"]}}},"/creative_bulk_upload":{"get":{"summary":"creative_bulk_upload","description":"","operationId":"creativebulkupload-get","parameters":[{"name":"cbu_id","in":"query","description":"Unique ID of the bulk upload","schema":{"type":"integer","format":"int32"}},{"name":"advertiser_id","in":"query","description":"Advertiser ID","schema":{"type":"integer","format":"int32"}},{"name":"creative_template_id","in":"query","description":"The ID of the Creative Template","schema":{"type":"integer","format":"int32"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"cbu_id\": 1,\n            \"advertiser_id\": 1,\n            \"click_url\": \"http://www.yahoo.com\",\n            \"creative_template_id\": 1,\n            \"creative_rule_id\": null,\n            \"creative_rule_key\": \"none\",\n            \"secure\": false,\n            \"size_in_bytes\": 74211,\n            \"creative_name_prefix\": null,\n            \"bulk_type\": \"image\",\n            \"manifest\": [\n                {\n                    \"action\": \"creative\",\n                    \"creative_name\": \"adc_gwi_general_300x250.gif\",\n                    \"success\": true,\n                    \"id\": 20\n                },\n                {\n                    \"action\": \"creative\",\n                    \"creative_name\": \"adc_kab_jeans_300x250.png\",\n                    \"success\": true,\n                    \"id\": 21\n                },\n                {\n                    \"action\": \"creative\",\n                    \"creative_name\": \"adc_twe_brawl_160x600.jpg\",\n                    \"success\": true,\n                    \"id\": 22\n                },\n                {\n                    \"action\": \"creative\",\n                    \"creative_name\": \"adc_twe_brawl_728x90.jpg\",\n                    \"success\": true,\n                    \"id\": 23\n                }\n            ],\n            \"account_id\": 1,\n            \"create_date\": \"2016-02-26 13:58:10\",\n            \"update_date\": \"2016-02-26 13:58:27\",\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"cbu_id":{"type":"integer","example":1,"default":0},"advertiser_id":{"type":"integer","example":1,"default":0},"click_url":{"type":"string","example":"http://www.yahoo.com"},"creative_template_id":{"type":"integer","example":1,"default":0},"creative_rule_id":{},"creative_rule_key":{"type":"string","example":"none"},"secure":{"type":"boolean","example":false,"default":true},"size_in_bytes":{"type":"integer","example":74211,"default":0},"creative_name_prefix":{},"bulk_type":{"type":"string","example":"image"},"manifest":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","example":"creative"},"creative_name":{"type":"string","example":"adc_gwi_general_300x250.gif"},"success":{"type":"boolean","example":true,"default":true},"id":{"type":"integer","example":20,"default":0}}}},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-02-26 13:58:10"},"update_date":{"type":"string","example":"2016-02-26 13:58:27"},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/creative_bulk_upload\" -b cookies.txt -d '{\"cbu_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"creative_bulk_upload","description":"","operationId":"creativebulkupload-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["advertiser_id","size_in_bytes","creative_template_id","bulk_type"],"properties":{"advertiser_id":{"type":"integer","description":"Must be active","format":"int32"},"creative_name_prefix":{"type":"string","description":"A string to be added at the beginning of each filename. e.g. `spring_`. Cannot contain spaces of special characters. Max length 100 characters."},"size_in_bytes":{"type":"integer","description":"Number of bytes of the file","default":0,"format":"int32"},"secure":{"type":"boolean","description":"Whether the creatives should be marked as secure"},"click_url":{"type":"string","description":"URL the ad should click or tap to. Required for templates that require clicks (image templates)"},"creative_thumbnail_url":{"type":"string","description":"Thumbnail to use for all creatives uploaded. Note, for image uploads this field will be ignored."},"creative_content":{"type":"array","description":"Content to be added to all of the uploaded Creatives. Not typically used."},"creative_template_id":{"type":"integer","description":"The ID of the Creative Template to use for this creative. Note, when bulk uploading tags, the template is automatically determined.","format":"int32"},"creative_rule_id":{"type":"integer","description":"DEPRECATED","format":"int32"},"creative_rule_key":{"type":"string","description":"The key corresponding to the `creative_rule` to apply to the tag based creatives. The rule will insert click and timestamp macros. You can use `auto_detect` for easiest implementation.","default":"none"},"bulk_type":{"type":"string","description":"The type of creatives being uploaded. Currently `image`, `atlas_tag`, `sizmek_tag`, and `dfa_tag` are supported."},"pixels":{"type":"array","description":"List of pixel URLs to add to all uploaded Creatives","items":{"type":"string"}},"scripts":{"type":"array","description":"List of script URLs to add to all uploaded Creatives. Note, if your bulk upload includes VAST videos, including any scripts will cause an error.","items":{"type":"string"}},"creative_addons":{"type":"array","description":"List of Creative Addon IDs to add to all uploaded Creatives","items":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"creative_asset created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"creative_asset created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/creative_bulk_upload\" -b cookies.txt -d '{\"creative_name_prefix\":\"spring_\", \"advertiser_id\":1, \"click_url\":\"http://www.foo.com\", \"creative_template_id\":1, \"size_in_bytes\":10000, \"bulk_type\":\"image\", \"pixels\":[\"https://www.pixel.net/foo\"]}'\n# Get the ID from the first post and use the /upload/ID syntax to upload the file\ncurl -X POST \"[host]/rest/creative_bulk_upload/upload/1\" -b cookies.txt -F 'creative_content=@/local/path/foo.zip'"}],"samples-languages":["curl"]}}},"/creative_template":{"get":{"summary":"creative_template","description":"","operationId":"creativetemplate-get","parameters":[{"name":"creative_template_id","in":"query","description":"Unique ID of the Creative Template","schema":{"type":"integer","format":"int32"}},{"name":"creative_template_name","in":"query","description":"Name of the Creative Template, e.g. \"JPEG Banner\"","schema":{"type":"string"}},{"name":"creative_type","in":"query","description":"0 = banner, 1 = video, 2 = native","schema":{"type":"integer","format":"int32"}},{"name":"is_video","in":"query","description":"Does the template include video assets. Note, this is slightly different from creative_type since a Native creative can also include video","schema":{"type":"boolean"}},{"name":"global","in":"query","description":"Is this a global template, available to all Buzz accounts?","schema":{"type":"boolean"}},{"name":"active","in":"query","description":"Is the Creative Template active?","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"creative_template_id\": 1,\n            \"global\": true,\n            \"rendering_key\": \"IMAGE\",\n            \"creative_type\": 0,\n            \"is_video\": 0,\n            \"creative_attributes\": {\n                \"technical\": {\n                    \"tag_type\": [\n                        2\n                    ]\n                }\n            },\n            \"click_required\": true,\n            \"creative_template_name\": \"Image template\",\n            \"creative_template_content\": \"<a href='{{CLICK_URL}}' target='_blank'><img src='{{CUSTOM:IMAGE_NAME:FILE}}' alt='tap here' width='{{WIDTH}}' height='{{HEIGHT}}'></a><img src='{{IMPRESSION_URL}}' width='0' height='0'>{{#ADDITIONAL_PIXELS:0:10<img src='{{CUSTOM:PIXEL_URL:URL}}' width='0' height='0'>/}}{{#ADDITIONAL_SCRIPTS:0:10<script type='text/javascript' src='{{CUSTOM:SCRIPT_URL:URL}}'></script>/}}\",\n            \"macro_names\": {\n                \"IMAGE_NAME\": \"STRING\",\n                \"ADDITIONAL_PIXELS\": {\n                    \"min\": \"0\",\n                    \"max\": \"10\",\n                    \"fields\": {\n                        \"PIXEL_URL\": \"URL\"\n                    }\n                },\n                \"ADDITIONAL_SCRIPTS\": {\n                    \"min\": \"0\",\n                    \"max\": \"10\",\n                    \"fields\": {\n                        \"SCRIPT_URL\": \"URL\"\n                    }\n                }\n            },\n            \"account_id\": 1,\n            \"create_date\": \"2015-07-21 12:45:49\",\n            \"update_date\": \"2015-07-21 12:45:49\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"creative_template_id":{"type":"integer","example":1,"default":0},"global":{"type":"boolean","example":true,"default":true},"rendering_key":{"type":"string","example":"IMAGE"},"creative_type":{"type":"integer","example":0,"default":0},"is_video":{"type":"integer","example":0,"default":0},"creative_attributes":{"type":"object","properties":{"technical":{"type":"object","properties":{"tag_type":{"type":"array","items":{"type":"integer","example":2,"default":0}}}}}},"click_required":{"type":"boolean","example":true,"default":true},"creative_template_name":{"type":"string","example":"Image template"},"creative_template_content":{"type":"string","example":"<a href='{{CLICK_URL}}' target='_blank'><img src='{{CUSTOM:IMAGE_NAME:FILE}}' alt='tap here' width='{{WIDTH}}' height='{{HEIGHT}}'></a><img src='{{IMPRESSION_URL}}' width='0' height='0'>{{#ADDITIONAL_PIXELS:0:10<img src='{{CUSTOM:PIXEL_URL:URL}}' width='0' height='0'>/}}{{#ADDITIONAL_SCRIPTS:0:10<script type='text/javascript' src='{{CUSTOM:SCRIPT_URL:URL}}'></script>/}}"},"macro_names":{"type":"object","properties":{"IMAGE_NAME":{"type":"string","example":"STRING"},"ADDITIONAL_PIXELS":{"type":"object","properties":{"min":{"type":"string","example":"0"},"max":{"type":"string","example":"10"},"fields":{"type":"object","properties":{"PIXEL_URL":{"type":"string","example":"URL"}}}}},"ADDITIONAL_SCRIPTS":{"type":"object","properties":{"min":{"type":"string","example":"0"},"max":{"type":"string","example":"10"},"fields":{"type":"object","properties":{"SCRIPT_URL":{"type":"string","example":"URL"}}}}}}},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2015-07-21 12:45:49"},"update_date":{"type":"string","example":"2015-07-21 12:45:49"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/creative_template\" -b cookies.txt -d '{\"creative_template_id\":1}'"}],"samples-languages":["curl"]}}},"/custom_list":{"delete":{"summary":"custom_list","description":"","operationId":"customlist-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"integer","description":"Unique ID of the list","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"custom_list deleted with ID 1\"\n        }\n    ],\n    \"message\": \"custom_list deletion: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"custom_list deleted with ID 1"}}}},"message":{"type":"string","example":"custom_list deletion: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/custom_list\" -b cookies.txt -d '{\"list_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"custom_list","description":"","operationId":"customlist-get","parameters":[{"name":"list_id","in":"query","description":"Unique ID of the Custom List","schema":{"type":"integer","format":"int32"}},{"name":"list_name","in":"query","description":"Name of the Custom List","schema":{"type":"string"}},{"name":"list_type","in":"query","description":"Type of list","schema":{"type":"string"}},{"name":"active","in":"query","schema":{"type":"boolean","default":false}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"list_id\": 1,\n            \"list_type\": \"domain\",\n            \"list_name\": \"Domain List\",\n            \"list_attributes\": [],\n          \t\"list_upload_type\": \"DIRECT_UPLOAD\",\n            \"account_id\": 2,\n            \"create_date\": \"2015-07-24 15:09:31\",\n            \"update_date\": \"2015-12-14 16:56:16\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"list_id":{"type":"integer","example":1,"default":0},"list_type":{"type":"string","example":"domain"},"list_name":{"type":"string","example":"Domain List"},"list_attributes":{"type":"array","items":{"type":"object","properties":{}}},"list_upload_type":{"type":"string","example":"DIRECT_UPLOAD"},"account_id":{"type":"integer","example":2,"default":0},"create_date":{"type":"string","example":"2015-07-24 15:09:31"},"update_date":{"type":"string","example":"2015-12-14 16:56:16"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/custom_list\" -b cookies.txt -d '{\"list_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"custom_list","description":"","operationId":"customlist-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["list_name","list_type"],"properties":{"list_name":{"type":"string","description":"Name of the Custom List"},"list_type":{"type":"string","description":"Must be a valid list type."},"delimiter":{"type":"string","description":"If desired, you can set a custom delimiter to use when uploading a file to the `custom_list_item` method. This field only takes a single character."},"list_attributes":{"type":"array","description":"Only used for `lat_long` lists. Allows setting of a default_radius is form `{\"default_radius_km\":1.0}`"},"alternative_id":{"type":"string","description":"Up to 191 characters"},"notes":{"type":"string","description":"Up to 255 characters of notes"},"active":{"type":"boolean","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"custom_list created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"custom_list created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/custom_list\" -b cookies.txt -d '{\"list_name\":\"my domain list\",\"list_type\":\"domain\",\"delimiter\":\"|\"}'"}],"samples-languages":["curl"]}},"put":{"summary":"custom_list","description":"","operationId":"customlist-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"integer","description":"Unique ID of the Custom List","format":"int32"},"list_name":{"type":"string","description":"Name of the Custom List"},"delimiter":{"type":"string","description":"If desired, you can set a custom delimiter to use when uploading a file to the `custom_list_item` method. This field only takes a single character."},"list_attributes":{"type":"array","description":"For future use"},"alternative_id":{"type":"string","description":"Alternative ID"},"notes":{"type":"string","description":"<255 chars"},"active":{"type":"boolean","description":"Is the list active","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"custom_list updated with ID 1\"\n        }\n    ],\n    \"message\": \"custom_list update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"custom_list updated with ID 1"}}}},"message":{"type":"string","example":"custom_list update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/custom_list\" -b cookies.txt -d '{\"list_id\":1, \"list_name\":\"new name\"}'"}],"samples-languages":["curl"]}}},"/delivery_modifier":{"delete":{"summary":"delivery_modifier","description":"","operationId":"delivery-modifier-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["delivery_modifier_id"],"properties":{"delivery_modifier_id":{"type":"integer","description":"ID of the Delivery Modifier to delete","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"delivery_modifier deleted with ID 1\"\n        }\n    ],\n    \"message\": \"delivery_modifier: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"delivery_modifier deleted with ID 1"}}}},"message":{"type":"string","example":"delivery_modifier: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/delivery_modifier\" -b cookies.txt -d '{\"delivery_modifier_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"delivery_modifier","description":"","operationId":"delivery-modifier-get","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["delivery_modifier_name"],"properties":{"delivery_modifier_id":{"type":"integer","description":"ID of the Delivery Modifier","format":"int32"},"advertiser_id":{"type":"integer","description":"Advertiser ID associated with the Delivery Modifier","format":"int32"},"alternative_id":{"type":"string","description":"An alternative ID to lookup the Delivery Modifier"},"delivery_model_id":{"type":"integer","description":"The ID of the Bid Model to be associated with this Delivery Modifier.","format":"int32"},"delivery_modifier_name":{"type":"string","description":"Name of the Delivery Modifier, e.g. \"Video complete modifier\""},"active":{"type":"boolean","description":"Is it active?"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"advertiser_id\": 123,\n            \"default_delivery\": 0,\n            \"delivery_model_id\": null,\n            \"account_id\": 1,\n            \"create_date\": \"2020-02-04 09:47:14\",\n            \"update_date\": \"2020-02-04 09:50:05\",\n            \"alternative_id\": null,\n            \"notes\": \"Notes about this DM\",\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\",\n            \"delivery_modifier_terms\": [\n                {\n                    \"targeting_module\": \"platform\",\n                    \"targeting_key\": \"os\",\n                    \"modifier_type\": \"include\",\n                    \"value\": \"Android\",\n                    \"modifier\": 0.5,\n                    \"field_label\": \"Android\"\n                },\n                {\n                    \"targeting_module\": \"platform\",\n                    \"targeting_key\": \"os\",\n                    \"modifier_type\": \"include\",\n                    \"value\": \"iOS\",\n                    \"modifier\": 2,\n                    \"field_label\": \"Apple iOS\"\n                }\n            ],\n            \"delivery_modifier_id\": 123,\n            \"delivery_modifier_name\": \"DM name\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"advertiser_id":{"type":"integer","example":123,"default":0},"default_delivery":{"type":"integer","example":0,"default":0},"delivery_model_id":{},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2020-02-04 09:47:14"},"update_date":{"type":"string","example":"2020-02-04 09:50:05"},"alternative_id":{},"notes":{"type":"string","example":"Notes about this DM"},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"},"delivery_modifier_terms":{"type":"array","items":{"type":"object","properties":{"targeting_module":{"type":"string","example":"platform"},"targeting_key":{"type":"string","example":"os"},"modifier_type":{"type":"string","example":"include"},"value":{"type":"string","example":"Android"},"modifier":{"type":"number","example":0.5,"default":0},"field_label":{"type":"string","example":"Android"}}}},"delivery_modifier_id":{"type":"integer","example":123,"default":0},"delivery_modifier_name":{"type":"string","example":"DM name"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/delivery_modifier\" -b cookies.txt -d '{\"delivery_modifier_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"delivery_modifier","description":"","operationId":"delivery-modifier-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["delivery_modifier_name","default_delivery"],"properties":{"advertiser_id":{"type":"integer","description":"Optional. Allows a Delivery Modifier to be restricted to a single Advertiser","format":"int32"},"delivery_model_id":{"type":"integer","description":"The ID of the Bid Model to be associated with this Delivery Modifier. Model must be of type `BUDGET_WEIGHT`","format":"int32"},"delivery_modifier_name":{"type":"string","description":"Name of the Delivery Modifier, e.g. \"Video complete modifier\""},"delivery_modifier_terms":{"type":"object","description":"List of modification objects, see note.","properties":{"<none>":{"type":"object","required":["targeting_module","targeting_key","value","modifier"],"properties":{"targeting_module":{"type":"string","description":"The targeting module, e.g. `geo`"},"targeting_key":{"type":"string","description":"The targeting key within the module, e.g. `country`"},"value":{"type":"string","description":"Value of the key to match, e.g. \"USA\" for the country key. Must always be a string, even if value is an integer or array."},"modifier_type":{"type":"string","description":"The matching method for the modifier","default":"INCLUDE"},"modifier":{"type":"number","description":"Amount to apply to the modifier. For Bid Modifiers this will be the multiplier, for Delivery Models this will be the relative weight of delivery. Min=0 (don't bid) Max = 100","format":"double"},"field_label":{"type":"string","description":"Human readable label for the field. Automatically added to the Terms. Do not set on POST."}}}}},"default_delivery":{"type":"number","description":"The default delivery value to be used when no terms match. Set to zero to prevent delivery when terms do not match.","format":"double"},"alternative_id":{"type":"string","description":"An alternative ID to lookup the Delivery Modifier, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"delivery_modifier created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"delivery_modifier created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/delivery_modifier\" -b cookies.txt -d '{\"delivery_modifier_name\":\"new DM\", \"advertiser_id\":1, \"delivery_modifier_terms\":[{\"targeting_module\":\"geo\",\"targeting_key\":\"country\",\"value\":\"USA\",\"modifier\":0.8,\"modifier_type\":\"include\"}], \"active\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"delivery_modifier","description":"","operationId":"delivery-modifier-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["delivery_modifier_id","delivery_modifier_name"],"properties":{"delivery_modifier_id":{"type":"integer","description":"ID of the Delivery Modifier to update","format":"int32"},"advertiser_id":{"type":"integer","description":"Optional. Allows a Delivery Modifier to be restricted to a single Advertiser","format":"int32"},"delivery_model_id":{"type":"integer","description":"The ID of the Bid Model to be associated with this Delivery Modifier. Model must be of type `BUDGET_WEIGHT`","format":"int32"},"delivery_modifier_name":{"type":"string","description":"Name of the Delivery Modifier, e.g. \"Video complete modifier\""},"delivery_modifier_terms":{"type":"object","description":"List of modification objects, see note.","properties":{"<none>":{"type":"object","required":["targeting_module","targeting_key","value","modifier"],"properties":{"targeting_module":{"type":"string","description":"The targeting module, e.g. `geo`"},"targeting_key":{"type":"string","description":"The targeting key within the module, e.g. `country`"},"value":{"type":"string","description":"Value of the key to match, e.g. \"USA\" for the country key. Must always be a string, even if value is an integer or array."},"modifier_type":{"type":"string","description":"The matching method for the modifier","default":"INCLUDE"},"modifier":{"type":"number","description":"Amount to apply to the modifier. For Bid Modifiers this will be the multiplier, for Delivery Models this will be the relative weight of delivery. Min=0 (don't bid) Max = 100","format":"double"},"field_label":{"type":"string","description":"Human readable label for the field. Automatically added to the Terms. Do not set on POST."}}}}},"default_delivery":{"type":"number","description":"The default delivery value to be used when no terms match. Set to zero to prevent delivery when terms do not match.","format":"double"},"alternative_id":{"type":"string","description":"An alternative ID to lookup the Delivery Modifier, if desired"},"notes":{"type":"string","description":"Notes, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"delivery_modifier updated with ID 1\"\n        }\n    ],\n    \"message\": \"delivery_modifier update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"delivery_modifier updated with ID 1"}}}},"message":{"type":"string","example":"delivery_modifier update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/delivery_modifier\" -b cookies.txt -d '{\"delivery_modifier_id\":1, \"delivery_modifier_name\":\"new DM\", \"advertiser_id\":1, \"delivery_modifier_terms\":[{\"targeting_module\":\"geo\",\"targeting_key\":\"country\",\"value\":\"USA\",\"modifier\":0.8,\"modifier_type\":\"include\"}], \"active\":1}'"}],"samples-languages":["curl"]}}},"/event_assignment":{"post":{"summary":"event_assignment","description":"","operationId":"event-assignments-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["event_id","object_id","object_type"],"properties":{"event_id":{"type":"integer","description":"Must be a valid Event in the same Account. Unlike many other objects, the Event does not need to be Active to be assigned.","format":"int32"},"object_id":{"type":"integer","description":"Either the `line_item_id` or `campaign_id` assigned to this event.","format":"int32"},"object_type":{"type":"string","description":"The type of object, as a string, must be either `campaign` or `line_item`."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"event_assignment created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"event_assignment created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/event_assignment\" -b cookies.txt -d '{\"event_id\":1, \"object_id\":25, \"object_type\":\"campaign\"}'"}],"samples-languages":["curl"]}},"delete":{"summary":"event_assignment","description":"","operationId":"event_assignments-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ead_id":{"type":"integer","description":"Unique ID of the event","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"event_assignment deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"event_assignment deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/event_assignment\" -b cookies.txt -d '{\"ead_id\":1}'"},{"language":"curl","code":"curl -X DELETE \"[host]/rest/custom_list_item\" -b cookies.txt -d '{\"list_item_id\":1,\"list_item\":\"all\"}'","name":"cURL-ALL"},{"language":"curl","code":"curl -X DELETE \"[host]/rest/custom_list_item\" -b cookies.txt -d '{\"list_item_id\":1,\"list_item\":[\"foo.bar.iphone.app\",\"foo.bar.watch.app\"]}'","name":"cURL-LIST"}],"samples-languages":["curl"]}},"get":{"summary":"event_assignment","description":"","operationId":"event_assignments-get","parameters":[{"name":"ea_id","in":"query","description":"Unique ID of the event_assignment to be updated","schema":{"type":"integer","format":"int32"}},{"name":"event_id","in":"query","description":"The event object","schema":{"type":"integer","format":"int32"}},{"name":"object_id","in":"query","description":"The object the event is associated with","schema":{"type":"integer","format":"int32"}},{"name":"object_type","in":"query","description":"The object type, either `line_item` or `campaign`","schema":{"type":"string"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"ea_id\": 2,\n            \"object_id\": 1,\n            \"event_id\": 19,\n            \"account_id\": 1,\n            \"object_type\": \"campaign\",\n            \"create_date\": \"2016-03-30 11:06:36\",\n            \"update_date\": \"2016-03-30 11:06:36\",\n            \"push_status\": 0,\n            \"push_update\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"ea_id":{"type":"integer","example":2,"default":0},"object_id":{"type":"integer","example":1,"default":0},"event_id":{"type":"integer","example":19,"default":0},"account_id":{"type":"integer","example":1,"default":0},"object_type":{"type":"string","example":"campaign"},"create_date":{"type":"string","example":"2016-03-30 11:06:36"},"update_date":{"type":"string","example":"2016-03-30 11:06:36"},"push_status":{"type":"integer","example":0,"default":0},"push_update":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/event_assignment\" -b cookies.txt -d '{\"ea_id\":2}'"}],"samples-languages":["curl"]}}},"/event":{"delete":{"summary":"event","description":"","operationId":"event-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["event_id"],"properties":{"event_id":{"type":"integer","description":"Unique ID of the event","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"event deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"event deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/event\" -b cookies.txt -d '{\"event_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"event","description":"","operationId":"event-get","parameters":[{"name":"event_id","in":"query","description":"Unique ID of the event","schema":{"type":"integer","format":"int32"}},{"name":"event_name","in":"query","description":"Name of the event, <100 characters","schema":{"type":"string"}},{"name":"advertiser_id","in":"query","description":"Advertiser ID","schema":{"type":"integer","format":"int32"}},{"name":"event_type_id","in":"query","description":"Type of event","schema":{"type":"integer","format":"int32"}},{"name":"segment_id","in":"query","description":"Segment associated with the event","schema":{"type":"integer","format":"int32"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"attribution","in":"query","description":"Defines the line items that are eligible for this event. Possible values are `ALL` or `WHITELIST`","schema":{"type":"string","default":"ALL"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"event_id\": 1,\n            \"advertiser_id\": 1,\n            \"event_type_id\": 1,\n            \"segment_id\": null,\n            \"value\": 100,\n            \"count_unique\": false,\n            \"event_name\": \"new event\",\n            \"click_window\": 2592000,\n            \"view_window\": 2592000,\n            \"attribution\": \"ALL\",\n          \t\"push_status\": 0,\n            \"push_update\": true,\n            \"account_id\": 2,\n            \"create_date\": \"2016-03-30 10:53:09\",\n            \"update_date\": \"2016-03-30 10:53:09\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stinger\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"event_id":{"type":"integer","example":1,"default":0},"advertiser_id":{"type":"integer","example":1,"default":0},"event_type_id":{"type":"integer","example":1,"default":0},"segment_id":{},"value":{"type":"integer","example":100,"default":0},"count_unique":{"type":"boolean","example":false,"default":true},"event_name":{"type":"string","example":"new event"},"click_window":{"type":"integer","example":2592000,"default":0},"view_window":{"type":"integer","example":2592000,"default":0},"attribution":{"type":"string","example":"ALL"},"push_status":{"type":"integer","example":0,"default":0},"push_update":{"type":"boolean","example":true,"default":true},"account_id":{"type":"integer","example":2,"default":0},"create_date":{"type":"string","example":"2016-03-30 10:53:09"},"update_date":{"type":"string","example":"2016-03-30 10:53:09"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stinger"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/event\" -b cookies.txt -d '{\"event_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"event","description":"","operationId":"event-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["event_name","advertiser_id","value"],"properties":{"event_name":{"type":"string","description":"Name of the event, <100 characters"},"advertiser_id":{"type":"integer","description":"Must be a valid and active Advertiser","format":"int32"},"event_type_id":{"type":"integer","description":"Type of event, used for organizational purposes. Lookup against event_type table. Example `0`=Purchase, `1`=Landing Page, etc.","format":"int32"},"segment_id":{"type":"integer","description":"If set, the user will be placed into this Segment when the Event is called. Segment must be valid and active and must belong to the same Account as the Event.","format":"int32"},"value":{"type":"number","description":"Default value of the conversion","format":"double"},"count_unique":{"type":"boolean","description":"Not currently used","default":false},"click_window":{"type":"integer","description":"Amount, in seconds, to look back for clicks after an Event takes place. Positive number, no more than the system limit, which is generally set at `2592000` (30 days).","default":2592000,"format":"int32"},"view_window":{"type":"integer","description":"Amount, in seconds, to look back for impressions after an Event takes place. Positive number, no more than the system limit, which is generally set at `2592000` (30 days).","default":2592000,"format":"int32"},"attribution":{"type":"string","description":"Defines the line items that are eligible for this event. `ALL` = All Line Items for this Advertiser are eligible for this Event. `WHITELIST` = Only selected Campaigns or Line Items for this Advertiser are eligible for this Event","default":"ALL"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"event created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"event created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/event\" -b cookies.txt -d '{\"advertiser_id\":1, \"event_name\":\"new event\", \"value\":100, \"segment_id\":1, \"event_type_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"event","description":"","operationId":"event-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["event_id"],"properties":{"event_id":{"type":"integer","description":"Unique ID of the event to modify","format":"int32"},"event_name":{"type":"string","description":"Name of the event, <100 characters"},"advertiser_id":{"type":"integer","description":"Must be a valid and active Advertiser","format":"int32"},"event_type_id":{"type":"integer","description":"Type of event, used for organizational purposes. Lookup against event_type table. Example `0`=Purchase, `1`=Landing Page, etc.","format":"int32"},"segment_id":{"type":"integer","description":"If set, the user will be placed into this Segment when the Event is called. Segment must be valid and active and must belong to the same Account as the Event.","format":"int32"},"value":{"type":"number","description":"Default value of the conversion","format":"double"},"count_unique":{"type":"boolean","description":"Not currently used","default":false},"click_window":{"type":"integer","description":"Amount, in seconds, to look back for clicks after an Event takes place. Positive number, no more than the system limit, which is generally set at `2592000` (30 days).","default":2592000,"format":"int32"},"view_window":{"type":"integer","description":"Amount, in seconds, to look back for impressions after an Event takes place. Positive number, no more than the system limit, which is generally set at `2592000` (30 days).","default":2592000,"format":"int32"},"attribution":{"type":"string","description":"Defines which Line Items that are eligible for this event. `ALL` = All Line Items for this Advertiser are eligible for this Event. `WHITELIST` = Only selected Campaigns or Line Items for this Advertiser are eligible for this Event","default":"ALL"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"event updated with ID 1\"\n        }\n    ],\n    \"message\": \"event update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"event updated with ID 1"}}}},"message":{"type":"string","example":"event update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/event\" -b cookies.txt -d '{\"event_id\":1, \"event_name\":\"new event\", \"value\":100, \"segment_id\":1, \"event_type_id\":1}'"}],"samples-languages":["curl"]}}},"/event_tag":{"get":{"summary":"event_tag","description":"The Event Tag object allows you to get rendered code for one or more Events to use on your website or application. This object only accepts GET requests.","operationId":"event-tag","parameters":[{"name":"event_id","in":"query","description":"Unique ID for the event","schema":{"type":"integer","format":"int32"}},{"name":"event_name","in":"query","description":"Name for the event","schema":{"type":"string"}},{"name":"advertiser_id","in":"query","description":"Unique ID for the advertiser","schema":{"type":"integer","format":"int32"}},{"name":"event_type_id","in":"query","description":"Type of event, used for organizational purposes","schema":{"type":"integer","format":"int32"}},{"name":"tag_type","in":"query","description":"The tag type to render, default is `js` for javascript tags.","schema":{"type":"string","default":"js"}},{"name":"format","in":"query","description":"The format to return the tags, default is `none`. Optional values can include `csv`, `xml`, `xls`, `xlsx` and `json` If not set or set to \"none\" the tags will be returned in the standard API response. If set, a file with the content will be streamed to the output.","schema":{"type":"string","default":"none"}}],"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/event_tag\" -b cookies.txt -d '{\"event_id\":1, \"tag_type\":\"js\", \"format\":\"none\"}'"}],"samples-languages":["curl"]}}},"/html_asset":{"post":{"summary":"html_asset","description":"","operationId":"html_asset","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["advertiser_id","creative_asset_name","size_in_bytes","active"],"properties":{"advertiser_id":{"type":"integer","description":"Advertiser that owns the asset","format":"int32"},"creative_asset_name":{"type":"string","description":"Name of the Creative Asset, e.g. \"Blue Banner Ad\""},"size_in_bytes":{"type":"integer","description":"Number of bytes","default":0,"format":"int32"},"notes":{"type":"string","description":"Notes about the Creative Asset, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"html_asset created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"html_asset created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"#Step 1, create the asset using POST\ncurl -X POST \"[host]/rest/html_asset\" -b cookies.txt -d '{\"creative_asset_name\":\"creative.html\", \"size_in_bytes\":200500, \"advertiser_id\":1}'\n#Step 2, upload the file using the /upload/ID method \ncurl -X POST -F \"creative_content=@creative.html\" \"[host]/rest/html_asset/upload/5\" -b cookies.txt"}],"samples-languages":["curl"]}}},"/line_item":{"delete":{"summary":"line_item","description":"","operationId":"line_item-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["line_item_id"],"properties":{"line_item_id":{"type":"integer","description":"Unique ID of the line_item","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"line_item deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"line_item deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/line_item\" -b cookies.txt -d '{\"line_item_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"line_item","description":"","operationId":"line_item-get","parameters":[{"name":"line_item_id","in":"query","description":"Unique ID of the Line Item","schema":{"type":"integer","format":"int32"}},{"name":"campaign_id","in":"query","description":"Must be a valid and active Campaign","schema":{"type":"integer","format":"int32"}},{"name":"advertiser_id","in":"query","description":"Must belong to the same account as the Line Item and be active","schema":{"type":"integer","format":"int32"}},{"name":"line_item_type_id","in":"query","description":"The type of the Line Item. 0=banner, 1=video.","schema":{"type":"integer","format":"int32"}},{"name":"line_item_name","in":"query","description":"Name of the  Line Item, e.g. \"Winter lead generation\"","schema":{"type":"string"}},{"name":"bid_modifier_id","in":"query","description":"ID of the Bid Modifier associated with this Line Item","schema":{"type":"integer","format":"int32"}},{"name":"delivery_modifier_id","in":"query","description":"ID of the Delivery Modifier associated with this Line Item","schema":{"type":"integer","format":"int32"}},{"name":"start_date","in":"query","description":"Start date of the Line Item. No Line Items associated with the Campaign can have start dates prior to this date.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"End date of the Line Item. No Line Items associated with the Campaign can have end dates after this date.","schema":{"type":"string","format":"date"}},{"name":"guaranteed","in":"query","description":"Whether the Line Item is Programmatic Guaranteed.","schema":{"type":"boolean"}},{"name":"target_skad","in":"query","description":"Should the Line Item only target Apple SKAd-enabled inventory","schema":{"type":"boolean"}},{"name":"alternative_id","in":"query","description":"An alternative id to lookup the  Line Item, if desired","schema":{"type":"string"}},{"name":"active","in":"query","schema":{"type":"boolean"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"line_item_id\": 1,\n            \"campaign_id\": 1,\n            \"advertiser_id\": 1,\n            \"line_item_type_id\": 0,\n            \"targeting_template_id\": null,\n            \"line_item_version\": 1,\n            \"line_item_name\": \"li name\",\n            \"line_item_budget\": 1000,\n            \"daily_budget\": null,\n            \"budget_type\": 0,\n            \"line_item_spend\": 0,\n            \"currency\": \"USD\",\n            \"frequency_cap\": [\n                {\n                    \"duration\": 500,\n                    \"impressions\": 1\n                }\n            ],\n            \"frequency_cap_type\": 1,\n            \"frequency_cap_vendor\": \"TAPAD\",\n            \"bidding\": {\n                \"bidding_strategy\": \"cpm\",\n                \"bid_shading\": false,\n                \"bid_shading_win_rate_control\":\"NORMAL\",\n                \"values\": {\n                    \"cpm_bid\": 1.12\n                },\n              \t\"custom\":false,\n              \t\"pacing\":\"none\"\n            },\n            \"creative_weighting_method\": \"RANDOM\",\n            \"pacing\": null,\n            \"bid_modifier_id\": 1,\n            \"delivery_modifier_id\": null,\n            \"max_bid\": 12.23,\n            \"test_plan_id\": null,\n            \"revenue_type\": null,\n            \"revenue_amount\": null,\n            \"start_date\": \"2015-01-01 00:00:00\",\n            \"end_date\": \"2016-01-01 00:00:00\",\n            \"segment_extension_default\": \"person\",\n            \"segment_extension_type_default\": \"1P\",\n            \"segment_extension_vendors_default\": [\"TAPAD\"],\n            \"enable_skad_tracking\": false,\n            \"skad_assignment_level\": \"creative_line_item\",\n            \"guaranteed\": false,          \n            \"target_skad\": false,          \n            \"push_status\": 0,\n            \"push_update\": true,\n            \"account_id\": 1,\n            \"create_date\": \"2016-03-30 11:45:33\",\n            \"update_date\": \"2016-03-30 11:45:33\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"user_timezones\": [\"America/New_York\"],\n            \"active\": false,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"line_item_id":{"type":"integer","example":1,"default":0},"campaign_id":{"type":"integer","example":1,"default":0},"advertiser_id":{"type":"integer","example":1,"default":0},"line_item_type_id":{"type":"integer","example":0,"default":0},"targeting_template_id":{},"line_item_version":{"type":"integer","example":1,"default":0},"line_item_name":{"type":"string","example":"li name"},"line_item_budget":{"type":"integer","example":1000,"default":0},"daily_budget":{},"budget_type":{"type":"integer","example":0,"default":0},"line_item_spend":{"type":"integer","example":0,"default":0},"currency":{"type":"string","example":"USD"},"frequency_cap":{"type":"array","items":{"type":"object","properties":{"duration":{"type":"integer","example":500,"default":0},"impressions":{"type":"integer","example":1,"default":0}}}},"frequency_cap_type":{"type":"integer","example":1,"default":0},"frequency_cap_vendor":{"type":"string","example":"TAPAD"},"bidding":{"type":"object","properties":{"bidding_strategy":{"type":"string","example":"cpm"},"bid_shading":{"type":"boolean","example":false,"default":true},"bid_shading_win_rate_control":{"type":"string","example":"NORMAL"},"values":{"type":"object","properties":{"cpm_bid":{"type":"number","example":1.12,"default":0}}},"custom":{"type":"boolean","example":false,"default":true},"pacing":{"type":"string","example":"none"}}},"creative_weighting_method":{"type":"string","example":"RANDOM"},"pacing":{},"bid_modifier_id":{"type":"integer","example":1,"default":0},"delivery_modifier_id":{},"max_bid":{"type":"number","example":12.23,"default":0},"test_plan_id":{},"revenue_type":{},"revenue_amount":{},"start_date":{"type":"string","example":"2015-01-01 00:00:00"},"end_date":{"type":"string","example":"2016-01-01 00:00:00"},"segment_extension_default":{"type":"string","example":"person"},"segment_extension_type_default":{"type":"string","example":"1P"},"segment_extension_vendors_default":{"type":"array","items":{"type":"string","example":"TAPAD"}},"enable_skad_tracking":{"type":"boolean","example":false,"default":true},"skad_assignment_level":{"type":"string","example":"creative_line_item"},"guaranteed":{"type":"boolean","example":false,"default":true},"target_skad":{"type":"boolean","example":false,"default":true},"push_status":{"type":"integer","example":0,"default":0},"push_update":{"type":"boolean","example":true,"default":true},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-03-30 11:45:33"},"update_date":{"type":"string","example":"2016-03-30 11:45:33"},"alternative_id":{},"notes":{},"user_timezones":{"type":"array","items":{"type":"string","example":"America/New_York"}},"active":{"type":"boolean","example":false,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/line_item\" -b cookies.txt -d '{\"line_item_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"line_item","description":"","operationId":"line_item-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","advertiser_id","line_item_type_id","line_item_name","line_item_budget","bidding","start_date","active"],"properties":{"campaign_id":{"type":"integer","description":"Must be a valid and active Campaign","format":"int32"},"advertiser_id":{"type":"integer","description":"Must be active","format":"int32"},"line_item_type_id":{"type":"integer","description":"The type of the Line Item. `0`=banner, `1`=video, `2`=native","format":"int32"},"targeting_template_id":{"type":"integer","description":"The ID of the associated Targeting Template, must be a valid and active Targeting Template.","format":"int32"},"line_item_name":{"type":"string","description":"Name of the Line Item, e.g. \"Winter lead generation\""},"line_item_budget":{"type":"number","description":"Maximum amount to spend on this Line Item","format":"double"},"daily_budget":{"type":"number","description":"Maximum amount to spend or deliver in a day, cannot exceed `campaign_budget` or be so low as to prevent `campaign_budget` from being reached over the length of the campaign.","format":"double"},"budget_type":{"type":"integer","description":"Type of budget, `0`=spend, `1`=impressions, `2`=spend with vendor fees","default":0,"format":"int32"},"revenue_type":{"type":"string","description":"Supported revenue types:  `CPM`, `CPC`, `CPCV`, `CPI`, `CPA`"},"revenue_amount":{"type":"number","description":"If a revenue_type is set, this is field is the basis of calculation. For example, if revenue_type is `CPM` and `revenue_amount` is 5.12, revenue will be calculated as a $5.12 CPM.","format":"double"},"bid_modifier_id":{"type":"integer","description":"ID of a Bid Modifier object to associate with the Line Item. If set, `max_bid` must also be set.","format":"int32"},"delivery_modifier_id":{"type":"integer","description":"ID of the Delivery Modifier to associate with this Line Item","format":"int32"},"max_bid":{"type":"number","description":"Maximum bid after taking into consideration any Bid Modifiers.","format":"double"},"bidding":{"type":"object","description":"Bidding Strategy JSON.","required":["bidding_strategy"],"properties":{"bidding_strategy":{"type":"string","description":"The strategy to use, for example `CPM`. Must be all-caps."},"values":{"type":"object","description":"Set of keys and values specific to the `bidding_strategy`","required":["<key>"],"properties":{"<key>":{"type":"string","description":"Each `bidding_strategy` supports a set of up to five keys, each of which should be passed with a value in the correct format. Values may be ints or strings. Example `\"cpm_bid\":1.21`"}}},"bid_shading":{"type":"boolean","description":"Whether to automatically reduce the bid based on historical prices. Must be enabled on your account and for the given bidding_strategy. Fees may apply.","default":false},"bid_shading_win_rate_control":{"type":"string","description":"When `bid_shading` is set to `true`, this field determines how aggressive the Bid Shading algorithm should be. Valid values are `MORE_AGGRESSIVE`, `NORMAL`, and `LESS_AGGRESSIVE`.","default":"NORMAL"},"custom":{"type":"boolean","description":"Whether the `bidding_strategy` is a custom strategy to your account. These are set up by the administrator."},"pacing":{"type":"string","description":"If a bidding strategy can be paced, the pacing value can be set to `daily`, `flight`, or `lifetime`. If it cannot be paced, then it should be set to `none`. The flight type may only be used if the Line Item has Line Item Flights enabled and every flight includes a budget.","default":"lifetime"}}},"creative_weighting_method":{"type":"string","description":"Either `RANDOM` or `WEIGHTED`","default":"RANDOM"},"test_group_id":{"type":"integer","description":"When using `Experiments` the group to use for segregating users. The `test_group_id` must belong to the `test_plan_id` assigned to the Campaign. If a `test_plan_id` is set at the Campaign level, the `test_group_id` may not be `null`.","format":"int32"},"start_date":{"type":"string","description":"Start date of the Line Item.","format":"date"},"end_date":{"type":"string","description":"End date of the Line Item.","format":"date"},"frequency_cap":{"type":"object","description":"Frequency cap JSON.","required":["duration","impressions"],"properties":{"duration":{"type":"integer","description":"Duration of time in which to cap impressions, in seconds. 30-day (2592000) max.","format":"int32"},"impressions":{"type":"integer","description":"Number of impressions to allow within the duration set","format":"int32"}}},"frequency_cap_type":{"type":"integer","description":"The method of frequency capping. Must match Campaign-level if set. For definitions, see the Frequency Cap guide.","default":0,"format":"int32"},"frequency_cap_vendor":{"type":"string","description":"Extends frequency cap using a device graph (fees may apply). Valid values may be `TAPAD` or `LIVERAMP` depending on what has been enabled. If set at the Campaign level, must match that value."},"user_timezones":{"type":"array","description":"When targeting by `user_time_of_week`, this field should include a list of timezones you expect the ad to serve within. If not set properly, pacing will be uneven.","default":["The account's timezone"],"items":{"type":"string"}},"segment_extension_default":{"type":"string","description":"Determines the type of audience extension to use. Valid values are `none`,`person`,`household`,`person_extend_only`, and `household_extend_only`.","default":"none"},"segment_extension_type_default":{"type":"string","description":"Determines the type of audience extension to use. Valid options include `none`,`1P`,`3P`, and `ALL`.","default":"none"},"segment_extension_vendors_default":{"type":"array","description":"List of vendors to use for audience extension. Valid values are `TAPAD` and `LIVERAMP`.","default":["'[\"TAPAD\"]`"],"items":{"type":"string"}},"enable_skad_tracking":{"type":"boolean","description":"Should Apple's SKAdNetwork tracking be enabled for this Line Item. Must be enabled at the Campaign level to be enabled here.","default":false},"skad_assignment_level":{"type":"string","description":"Must be set if `enable_skad_tracking` is true. Valid options are `creative_line_item` and `line_item`. Cannot be changed once Line Item is active.","default":"creative_line_item"},"target_skad":{"type":"boolean","description":"Should the Line Item only target Apple SKAd-enabled inventory","default":false},"guaranteed":{"type":"boolean","description":"Indicates that the Line Item is Programmatic Guaranteed. When set to `true` the targeting, budgeting, pacing, and bidding parameters are restricted to ensure guaranteed delivery.","default":false},"alternative_id":{"type":"string","description":"An alternative id to lookup the  Line Item, if desired"},"notes":{"type":"string","description":"Notes about the Line Item, up to 255 chars"},"active":{"type":"boolean","description":"Is the Line Item active? Must be set to 0 on POST since no Creatives are yet assigned.","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"line_item created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"line_item created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/line_item\" -b cookies.txt -d '{\"line_item_name\":\"new LI\", \"advertiser_id\":1, \"line_item_type_id\":0, \"campaign_id\":1, \"start_date\":\"12/31/2015\", \"line_item_budget\":1000, \"bidding\":{\"bidding_strategy\":\"cpm\",\"bid_shading\":false,\"bid_shading_win_rate_control\":\"NORMAL\",\"values\":{\"cpm_bid\":1.12},\"pacing\":\"none\"}, \"creative_weighting_method\":\"WEIGHTED\", \"frequency_cap\":[{\"duration\":500,\"impressions\":1}], \"frequency_cap_type\":1, \"user_timezones\":[\"America/New_York\"], \"active\":0, \"segment_extension_default\":\"person\", \"segment_extension_type_default\":\"1P\", \"segment_extension_vendors_default\":[\"TAPAD\"],\"enable_skad_tracking\":false,\"skad_assignment_level\":\"line_item\"}'"}],"samples-languages":["curl"]}},"put":{"summary":"line_item","description":"","operationId":"line_item-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["line_item_id"],"properties":{"line_item_id":{"type":"integer","description":"Unique ID of the Line Item","format":"int32"},"campaign_id":{"type":"integer","description":"Must be a valid and active Campaign","format":"int32"},"advertiser_id":{"type":"integer","description":"Must belong to the same account as the Line Item and be active","format":"int32"},"alternative_id":{"type":"string","description":"An alternative id to lookup the  Line Item, if desired"},"line_item_type_id":{"type":"integer","description":"The type of the Line Item. `0`=banner, `1`=video, `2`=native","format":"int32"},"targeting_template_id":{"type":"integer","description":"The ID of the associated Targeting Template, must be a valid and active Targeting Template.","format":"int32"},"line_item_name":{"type":"string","description":"Name of the  Line Item, e.g. \"Winter lead generation\""},"line_item_budget":{"type":"number","description":"Maximum amount to spend on this Line Item","format":"double"},"daily_budget":{"type":"number","description":"Maximum amount to spend or deliver in a day, cannot exceed `campaign_budget` or be so low as to prevent `campaign_budget` from being reached over the length of the campaign.","format":"double"},"budget_type":{"type":"integer","description":"Type of budget, `0`=spend, `1`=impressions, `2`=spend with vendor fees","default":0,"format":"int32"},"revenue_type":{"type":"string","description":"Supported revenue types:  `CPM`, `CPC`, `CPCV`, `CPI`, `CPA`"},"revenue_amount":{"type":"number","description":"If a revenue_type is set, this field is the basis of calculation. For example, if revenue_type is `CPM` and `revenue_amount` is 5.12, revenue will be calculated as a $5.12 CPM.","format":"double"},"bid_modifier_id":{"type":"integer","description":"ID of a Bid Modifier object to associate with the Line Item. If set, `max_bid` must also be set.","format":"int32"},"delivery_modifier_id":{"type":"integer","description":"ID of the Delivery Modifier to associate with this Line Item","format":"int32"},"max_bid":{"type":"number","description":"Maximum bid after taking into consideration any Bid Modifiers.","format":"double"},"test_plan_id":{"type":"integer","description":"When using `Experiments` the group to use for segregating users. The `test_group_id` must belong to the `test_plan_id` assigned to the Campaign. If a `test_plan_id` is set at the Campaign level, the `test_group_id` may not be `null`.","format":"int32"},"bidding":{"type":"object","description":"Bidding Strategy JSON.","required":["bidding_strategy"],"properties":{"bidding_strategy":{"type":"string","description":"The strategy to use, for example `CPM`. Must be all-caps."},"values":{"type":"object","description":"Set of keys and values specific to the `bidding_strategy`","required":["<key>"],"properties":{"<key>":{"type":"string","description":"Each `bidding_strategy` supports a set of up to five keys, each of which should be passed with a value in the correct format. Values may be ints or strings. Example `\"cpm_bid\":1.21`"}}},"bid_shading":{"type":"boolean","description":"Whether to automatically reduce the bid based on historical prices. Must be enabled on your account and for the given bidding_strategy. Fees may apply.","default":false},"bid_shading_win_rate_control":{"type":"string","description":"When `bid_shading` is set to `true`, this field determines how aggressive the Bid Shading algorithm should be. Valid values are `MORE_AGGRESSIVE`, `NORMAL`, and `LESS_AGGRESSIVE`.","default":"NORMAL"},"custom":{"type":"boolean","description":"Whether the `bidding_strategy` is a custom strategy to your account. These are set up by the administrator."},"pacing":{"type":"string","description":"If a bidding strategy can be paced, the pacing value can be set to `daily`, `flight`, or `lifetime`. If it cannot be paced, then it should be set to `none`. The flight type may only be used if the Line Item has Line Item Flights enabled and every flight includes a budget.","default":"lifetime"}}},"creative_weighting_method":{"type":"string","description":"Either `RANDOM` or `WEIGHTED`","default":"RANDOM"},"start_date":{"type":"string","description":"Start date of the Line Item.","format":"date"},"end_date":{"type":"string","description":"End date of the Line Item.","format":"date"},"frequency_cap":{"type":"object","description":"Frequency cap JSON.","required":["duration","impressions"],"properties":{"duration":{"type":"integer","description":"Duration of time in which to cap impressions, in seconds. 30-day (2592000) max.","format":"int32"},"impressions":{"type":"integer","description":"Number of impressions to allow within the duration set","format":"int32"}}},"frequency_cap_type":{"type":"integer","description":"The method of frequency capping. Must match Campaign-level if set. For definitions, see the Frequency Cap guide.","format":"int32"},"frequency_cap_vendor":{"type":"string","description":"Extends frequency cap using a device graph (fees may apply). Valid values may be `TAPAD` or `LIVERAMP` depending on what has been enabled. If set at the Campaign level, must match that value."},"user_timezones":{"type":"array","description":"When targeting by `user_time_of_week`, this field should include a list of timezones you expect the ad to serve within. If not set properly, pacing will be uneven.","default":["The account's timezone"],"items":{"type":"string"}},"segment_extension_default":{"type":"string","description":"Determines the type of audience extension to use. Valid values are `none`,`person`,`household`,`person_extend_only`, and `household_extend_only`.","default":"none"},"segment_extension_type_default":{"type":"string","description":"Determines the type of audience extension to use. Valid options include `none`,`1P`,`3P`, and `ALL`.","default":"none"},"segment_extension_vendors_default":{"type":"array","description":"List of vendors to use for audience extension. Valid values are `TAPAD` and `LIVERAMP`.","default":["'[\"TAPAD\"]`"],"items":{"type":"string"}},"enable_skad_tracking":{"type":"boolean","description":"Should Apple's SKAdNetwork tracking be enabled for this Line Item. Must be enabled at the Campaign level to be enabled here.","default":false},"skad_assignment_level":{"type":"string","description":"Must be set if `enable_skad_tracking` is true. Valid options are `creative_line_item` and `line_item`. Cannot be changed once Line Item is active.","default":"creative_line_item"},"target_skad":{"type":"boolean","description":"Should the Line Item only target Apple SKAd-enabled inventory"},"notes":{"type":"string","description":"Notes about the Line Item, up to 255 chars"},"active":{"type":"boolean","description":"Is the Line Item active? Can only be set to true if associated with one or more Creatives.","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"line_item updated with ID 1\"\n        }\n    ],\n    \"message\": \"line_item update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"line_item updated with ID 1"}}}},"message":{"type":"string","example":"line_item update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/line_item\" -b cookies.txt -d '{\"line_item_id\":1, \"line_item_name\":\"new LI\", \"advertiser_id\":1, \"line_item_type_id\":0, \"campaign_id\":1, \"start_date\":\"1/1/2015\", \"line_item_budget\":1000, \"bidding\":{\"bidding_strategy\":\"cpm\",\"bid_shading\":false,\"values\":{\"cpm_bid\":1.12},\"custom\":false,\"pacing\":\"none\"}, \"creative_weighting_method\":\"WEIGHTED\",\"frequency_cap\":[{\"duration\":500,\"impressions\":1}], \"frequency_cap_type\":1, \"user_timezones\":[\"America/New_York\"], \"active\":0 \"segment_extension_default\":\"person\", \"segment_extension_type_default\":\"1P\", \"segment_extension_vendors_default\":[\"TAPAD\"]}'"}],"samples-languages":["curl"]}}},"/line_item_flight":{"get":{"summary":"line_item_flight","description":"","operationId":"line_item_flight-get","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"flight_id":{"type":"integer","description":"The unique ID of the flight to be updated","format":"int32"},"flight_name":{"type":"string","description":"Name of the flight. This is an optional field but can be useful since it will appear in aggregated reports."},"start_date":{"type":"string","description":"Start date of the flight","format":"date"},"end_date":{"type":"string","description":"End date of the flight. If not set the flight serve until the Line Item's end date or indefinitely if the Line Item does not have an end date.","format":"date"},"alternative_id":{"type":"string","description":"An alternative id to lookup the flight, if desired"},"active":{"type":"boolean","description":"Is the flight active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"line_item_id\": 1,\n            \"active\": true,\n            \"account_id\": 1,\n            \"create_date\": \"2018-04-24 08:21:09\",\n            \"update_date\": \"2018-04-24 08:21:09\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"flight_id\": 1,\n            \"flight_name\": \"Flight 1\",\n            \"start_date\": \"2018-04-24 00:00:00\",\n            \"end_date\": \"2018-04-24 23:59:59\",\n            \"budget\": 500,\n            \"buzz_key\": \"stinger\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"line_item_id":{"type":"integer","example":1,"default":0},"active":{"type":"boolean","example":true,"default":true},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2018-04-24 08:21:09"},"update_date":{"type":"string","example":"2018-04-24 08:21:09"},"alternative_id":{},"notes":{},"flight_id":{"type":"integer","example":1,"default":0},"flight_name":{"type":"string","example":"Flight 1"},"start_date":{"type":"string","example":"2018-04-24 00:00:00"},"end_date":{"type":"string","example":"2018-04-24 23:59:59"},"budget":{"type":"integer","example":500,"default":0},"buzz_key":{"type":"string","example":"stinger"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/line_item_flight\" -b cookies.txt -d '{\"flight_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"line_item_flight","description":"","operationId":"line_item_flight-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["line_item_id","start_date"],"properties":{"line_item_id":{"type":"integer","description":"Must be a valid Line Item","format":"int32"},"flight_name":{"type":"string","description":"Name of the flight. This is an optional field but can be useful since it will appear in aggregated reports."},"budget":{"type":"number","description":"Budget of the flight. Note the budget type is inherited from the Line Item and cannot be set separately for different flights. If omitted, the budget for the Line Item will apply across multiple flights. If the Line Item's pacing is of type `flight` this field is required.","format":"double"},"start_date":{"type":"string","description":"Start date of the flight","format":"date"},"end_date":{"type":"string","description":"End date of the flight. If not set the flight serve until the Line Item's end date or indefinitely if the Line Item does not have an end date.","format":"date"},"alternative_id":{"type":"string","description":"An alternative id to lookup the flight, if desired"},"notes":{"type":"string","description":"Notes about the flight, up to 255 chars"},"active":{"type":"boolean","description":"Is the flight active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"line_item_flight created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"line_item_flight created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/line_item_flight\" -b cookies.txt -d '{\"flight_name\":\"product launch\", \"line_item_id\":1, \"start_date\":\"12/31/2021\", \"end_date\":\"12/31/2022\",\"budget\":1000}'"}],"samples-languages":["curl"]}},"delete":{"summary":"line_item_flight","description":"","operationId":"line_item_flight-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["flight_id"],"properties":{"flight_id":{"type":"integer","description":"Unique ID of the flight","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"line_item_flight deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"line_item_flight deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/line_item_flight\" -b cookies.txt -d '{\"flight_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"line_item_flight","description":"","operationId":"line_item_flight-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["start_date"],"properties":{"flight_id":{"type":"integer","description":"The unique ID of the flight to be updated","format":"int32"},"flight_name":{"type":"string","description":"Name of the flight. This is an optional field but can be useful since it will appear in aggregated reports."},"budget":{"type":"number","description":"Budget of the flight. Note the budget type is inherited from the Line Item and cannot be set separately for different flights. If omitted, the budget for the Line Item will apply across multiple flights. If the Line Item's pacing is of type `flight` this field is required.","format":"double"},"start_date":{"type":"string","description":"Start date of the flight","format":"date"},"end_date":{"type":"string","description":"End date of the flight. If not set the flight serve until the Line Item's end date or indefinitely if the Line Item does not have an end date.","format":"date"},"alternative_id":{"type":"string","description":"An alternative id to lookup the flight, if desired"},"notes":{"type":"string","description":"Notes about the flight, up to 255 chars"},"active":{"type":"boolean","description":"Is the flight active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"line_item_flight updated with ID 1\"\n        }\n    ],\n    \"message\": \"line_item_flight update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"line_item_flight updated with ID 1"}}}},"message":{"type":"string","example":"line_item_flight update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/line_item_flight\" -b cookies.txt -d '{\"flight_id\":1, \"flight_name\":\"product launch\", \"line_item_id\":1, \"start_date\":\"12/31/2021\", \"end_date\":\"12/31/2022\",\"budget\":1000}'"}],"samples-languages":["curl"]}}},"/list_item":{"get":{"summary":"list_item","description":"","operationId":"list_item-get","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"list_item_id":{"type":"integer","description":"The unique ID of the list_item","format":"int32"},"list_id":{"type":"integer","description":"The unique ID of the list.","format":"int32"},"list_item":{"type":"string","description":"The item, passed as a string"},"list_item_name":{"type":"string","description":"Optional name for the list item"},"active":{"type":"boolean","description":"Whether the item is active","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"list_item_id\": 1,\n            \"list_id\": 1,\n            \"list_item\": \"www.foo.net\",\n            \"list_item_name\": null,\n            \"create_date\": \"2018-04-23 17:00:42\",\n            \"update_date\": \"2018-04-24 16:25:50\",\n            \"active\": true,\n            \"value\": 1,\n            \"pushed_to_server\": null,\n            \"account_id\": 1,\n            \"buzz_key\": \"stinger\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"list_item_id":{"type":"integer","example":1,"default":0},"list_id":{"type":"integer","example":1,"default":0},"list_item":{"type":"string","example":"www.foo.net"},"list_item_name":{},"create_date":{"type":"string","example":"2018-04-23 17:00:42"},"update_date":{"type":"string","example":"2018-04-24 16:25:50"},"active":{"type":"boolean","example":true,"default":true},"value":{"type":"integer","example":1,"default":0},"pushed_to_server":{},"account_id":{"type":"integer","example":1,"default":0},"buzz_key":{"type":"string","example":"stinger"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/list_item\" -b cookies.txt -d '{\"list_item_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"list_item","description":"","operationId":"list_item-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["list_item_id"],"properties":{"list_item_id":{"type":"integer","description":"Unique ID of the list_item","format":"int32"},"value":{"type":"number","description":"A numeric value assigned to the list item that can be used by a Bid Modifier","format":"double"},"list_item_name":{"type":"string","description":"Optional name for the list item"},"active":{"type":"boolean","description":"Whether the item is active","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"list_item update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"list_item update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/list_item\" -b cookies.txt -d '{\"list_item_id\":1, \"value\":0.5}'"}],"samples-languages":["curl"]}},"delete":{"summary":"list_item","description":"","operationId":"list_item-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"list_item_id":{"type":"string","description":"Unique ID of the list item to delete, or the special case `all` sent as a string"},"list_id":{"type":"integer","description":"The `list_id` to delete from coupled with `\"list_item_id\":\"all\"`","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"list_item deletion: 1 deleted successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"list_item deletion: 1 deleted successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"#Delete a single list_item\ncurl -X DELETE \"[host]/rest/list_item\" -b cookies.txt -d '{\"list_item_id\":1}'\n\n#Delete al list_items within a single list\ncurl -X DELETE \"[host]/rest/list_item\" -b cookies.txt -d '{\"list_item_id\":\"all\",\"list_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"list_item","description":"","operationId":"list_item-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["list_id","list_item"],"properties":{"list_id":{"type":"integer","description":"The unique ID of the list. List must be active.","format":"int32"},"list_item":{"type":"string","description":"The item, passed as a string for most list times, or a json object for lat/long custom_lists."},"value":{"type":"number","description":"A numeric value assigned to the list item that can be used by a Bid Modifier","format":"double"},"list_item_name":{"type":"string","description":"Optional name for the list item"},"active":{"type":"boolean","description":"Whether the item is active","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": {\n        \"id\": 1\n    },\n    \"message\": \"list_item created with ID = 1\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}},"message":{"type":"string","example":"list_item created with ID = 1"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"#list_item format for custom_list types other than precise geo \ncurl -X POST \"[host]/rest/list_item\" -b cookies.txt -d '{\"list_id\":1, \"list_item\":\"foo.bar.iphone.app\",\"value\":0.5}'\n\n#list_item format for precise geo (lat/long) list\ncurl -X POST \"[host]/rest/list_item\" -b cookies.txt -d '{\"list_id\":1, \"list_item\":{\"lat\":-89.0122,\"long\":78.92,\"radius_km\":0.5},\"list_item_name\":\"Starbucks on Main St\",\"value\":0.9}'"}],"samples-languages":["curl"]}}},"/list_item_bulk":{"post":{"summary":"list_item_bulk","description":"","operationId":"list_item_bulk","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["list_id","list_items"],"properties":{"list_id":{"type":"integer","description":"The unique ID of the list. List must be active.","format":"int32"},"list_items":{"type":"array","description":"An array of items and optional values in format `{\"list_item\":\"foo\",\"value\":1.2}`. Items are validated based on the type of the corresponding Custom List","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": {\n        \"id\": 60\n    },\n    \"message\": \"list_item creation: 2 created successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"object","properties":{"id":{"type":"integer","example":60,"default":0}}},"message":{"type":"string","example":"list_item creation: 2 created successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"#Bulk upload\ncurl -X POST \"[host]/rest/list_item_bulk\" -b cookies.txt -d '{\"list_id\":1, \"list_items\":[{\"list_item\":\"foo\",\"value\":1.2},{\"list_item\":\"bar\"}]}'\n\n#File upload using list ID in format /upload/LIST_ID\ncurl -X POST \"[host]/rest/list_item_bulk/upload/123\" -b cookies.txt -F 'list_item=@/local/path/foo.csv'"}],"samples-languages":["curl"]}}},"/native_offer":{"put":{"summary":"native_offer","description":"","operationId":"native_offer-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["native_offer_id","advertiser_id","native_offer_name"],"properties":{"native_offer_id":{"type":"integer","description":"ID of the object to be updated","format":"int32"},"advertiser_id":{"type":"integer","description":"Must be active","format":"int32"},"creative_template_id":{"type":"array","description":"A list of Creative Templates that should be used to validate the fields in this object","items":{"type":"integer","format":"int32"}},"native_offer_name":{"type":"string","description":"Name of the Native Offer"},"icon_asset_id":{"type":"integer","description":"The ID of a CreativeAsset for the `icon` field to be shown in the Creative.","format":"int32"},"logo_asset_id":{"type":"integer","description":"The ID of a CreativeAsset for the `logo` field to be shown in the Creative.","format":"int32"},"title_short":{"type":"string","description":"A title for the ad under 25 chars"},"title_long":{"type":"string","description":"A title for the ad under 50 chars long"},"description_short":{"type":"string","description":"A description for the ad under 90 chars long"},"description_long":{"type":"string","description":"A description for the ad under 200 chars long"},"call_to_action":{"type":"string","description":"Call to action under 15 chars long (e.g. \"click here\")"},"sponsored":{"type":"string","description":"The name of the advertiser for inclusion in the ad, under 50 chars long"},"store":{"type":"string","description":"The name of the app store, under 15 chars long (e.g. \"iTunes\")"},"likes":{"type":"integer","description":"Number of likes the product has on various social networks","format":"int32"},"downloads":{"type":"integer","description":"The number of downloads the product has","format":"int32"},"phone":{"type":"string","description":"A phone number, under 20 chars long"},"address":{"type":"string","description":"A physical address, up to 100 chars long"},"display_url":{"type":"string","description":"A URL to show in the ad. Will not be used as a click-through URL."},"star_rating":{"type":"integer","description":"A number between 0 and 5 reflecting the user rating of the product.","format":"int32"},"price":{"type":"number","description":"The price of the product being advertised","format":"double"},"sale_price":{"type":"number","description":"A discounted price of the product being advertised","format":"double"},"currency":{"type":"string","description":"Currency in which the product is priced, for display in the ad, has no effect on bidding"},"alternative_id":{"type":"string","description":"An alternative id to lookup the  Line Item, if desired"},"notes":{"type":"string","description":"Notes about the Line Item, up to 255 chars"},"active":{"type":"boolean","description":"Is the NativeOffer active","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"native_offer updated with ID 1\"\n        }\n    ],\n    \"message\": \"native_offer update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"native_offer updated with ID 1"}}}},"message":{"type":"string","example":"native_offer update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/native_offer\" -b cookies.txt -d '{\"native_offer_id\":1, \"native_offer_name\":\"new Offer\", \"advertiser_id\":1, creative_template_id\":[14,15], \"logo_asset_id\":12 \"title_short\":\"Great app from Beeswax\", \"description_short\":\"Using the great app will make you beautiful\", \"star_rating\":3, \"downloads\":150, \"price\":1.99, \"active\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"native_offer","description":"","operationId":"native_offer-get","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["native_offer_id","advertiser_id","native_offer_name"],"properties":{"native_offer_id":{"type":"integer","description":"ID of the object to be updated","format":"int32"},"advertiser_id":{"type":"integer","description":"Must be active","format":"int32"},"native_offer_name":{"type":"string","description":"Name of the Native Offer"},"icon_asset_id":{"type":"integer","description":"The ID of a CreativeAsset for the `icon` field to be shown in the Creative.","format":"int32"},"logo_asset_id":{"type":"integer","description":"The ID of a CreativeAsset for the `logo` field to be shown in the Creative.","format":"int32"},"alternative_id":{"type":"string","description":"An alternative id to lookup the  Line Item, if desired"},"active":{"type":"boolean","description":"Is the NativeOffer active"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"native_offer_id\": 1,\n            \"advertiser_id\": 13,\n            \"creative_template_id\": [\n                14,\n                15,\n                16,\n                17,\n                18,\n                19\n            ],\n            \"icon_asset_id\": 104,\n            \"logo_asset_id\": 105,\n            \"native_offer_name\": \"Native Test\",\n            \"title_short\": \"Beeswax Test\",\n            \"title_long\": null,\n            \"description_short\": \"Differentiate yourself from the pack with Beeswax\",\n            \"description_long\": null,\n            \"call_to_action\": \"Buy Now\",\n            \"sponsored\": \"Beeswax\",\n            \"store\": null,\n            \"likes\": null,\n            \"downloads\": null,\n            \"phone\": null,\n            \"address\": null,\n            \"display_url\": null,\n            \"star_rating\": 5,\n            \"price\": null,\n            \"sale_price\": null,\n            \"currency\": null,\n            \"account_id\": 1,\n            \"create_date\": \"2017-05-23 17:09:27\",\n            \"update_date\": \"2017-05-23 17:09:27\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stinger\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"native_offer_id":{"type":"integer","example":1,"default":0},"advertiser_id":{"type":"integer","example":13,"default":0},"creative_template_id":{"type":"array","items":{"type":"integer","example":14,"default":0}},"icon_asset_id":{"type":"integer","example":104,"default":0},"logo_asset_id":{"type":"integer","example":105,"default":0},"native_offer_name":{"type":"string","example":"Native Test"},"title_short":{"type":"string","example":"Beeswax Test"},"title_long":{},"description_short":{"type":"string","example":"Differentiate yourself from the pack with Beeswax"},"description_long":{},"call_to_action":{"type":"string","example":"Buy Now"},"sponsored":{"type":"string","example":"Beeswax"},"store":{},"likes":{},"downloads":{},"phone":{},"address":{},"display_url":{},"star_rating":{"type":"integer","example":5,"default":0},"price":{},"sale_price":{},"currency":{},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2017-05-23 17:09:27"},"update_date":{"type":"string","example":"2017-05-23 17:09:27"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stinger"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/native_offer\" -b cookies.txt -d '{\"native_offer_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"native_offer","description":"","operationId":"native_offer-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["advertiser_id","native_offer_name"],"properties":{"advertiser_id":{"type":"integer","description":"Must be active","format":"int32"},"creative_template_id":{"type":"array","description":"A list of Creative Templates that should be used to validate the fields in this object","items":{"type":"integer","format":"int32"}},"native_offer_name":{"type":"string","description":"Name of the Native Offer"},"icon_asset_id":{"type":"integer","description":"The ID of a CreativeAsset for the `icon` field to be shown in the Creative.","format":"int32"},"logo_asset_id":{"type":"integer","description":"The ID of a CreativeAsset for the `logo` field to be shown in the Creative.","format":"int32"},"title_short":{"type":"string","description":"A title for the ad under 25 chars"},"title_long":{"type":"string","description":"A title for the ad under 50 chars long"},"description_short":{"type":"string","description":"A description for the ad under 90 chars long"},"description_long":{"type":"string","description":"A description for the ad under 200 chars long"},"call_to_action":{"type":"string","description":"Call to action under 15 chars long (e.g. \"click here\")"},"sponsored":{"type":"string","description":"The name of the advertiser for inclusion in the ad, under 50 chars long"},"store":{"type":"string","description":"The name of the app store, under 15 chars long (e.g. \"iTunes\")"},"likes":{"type":"integer","description":"Number of likes the product has on various social networks","format":"int32"},"downloads":{"type":"integer","description":"The number of downloads the product has","format":"int32"},"phone":{"type":"string","description":"A phone number, under 20 chars long"},"address":{"type":"string","description":"A physical address, up to 100 chars long"},"display_url":{"type":"string","description":"A URL to show in the ad. Will not be used as a click-through URL."},"star_rating":{"type":"integer","description":"A number between 0 and 5 reflecting the user rating of the product.","format":"int32"},"price":{"type":"number","description":"The price of the product being advertised","format":"double"},"sale_price":{"type":"number","description":"A discounted price of the product being advertised","format":"double"},"currency":{"type":"string","description":"Currency in which the product is priced, for display in the ad, has no effect on bidding"},"alternative_id":{"type":"string","description":"An alternative id to lookup the  Line Item, if desired"},"notes":{"type":"string","description":"Notes about the Line Item, up to 255 chars"},"active":{"type":"boolean","description":"Is the NativeOffer active","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"native_offer created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"native_offer created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/native_offer\" -b cookies.txt -d '{\"native_offer_name\":\"new Offer\", \"advertiser_id\":1, creative_template_id\":[14,15], \"logo_asset_id\":12 \"title_short\":\"Great app from Beeswax\", \"description_short\":\"Using the great app will make you beautiful\", \"star_rating\":3, \"downloads\":150, \"price\":1.99, \"active\":1}'"}],"samples-languages":["curl"]}}},"/report_queue":{"post":{"summary":"report_queue","description":"","operationId":"report_queue-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["report_id","request_details"],"properties":{"report_name":{"type":"string","description":"Name for the report. <255 characters. Name is required if the `report_format` field is any value other than `none`"},"report_id":{"type":"integer","description":"ID for the report type to be used to generate the report. Each report includes a definition of available fields, metrics, and filters. A list of valid reports can be retrieved by make a request to `/view` with `\"view_name\":\"reports\"`","format":"int32"},"request_details":{"type":"object","description":"JSON description of reporting request.","required":["field"],"properties":{"field":{"type":"array","description":"Fields (sometimes called \"dimensions\") to include in the report.","items":{"type":"string"}},"filter":{"type":"array","description":"Fields and values to filter the results by (e.g. WHERE clause). Only fields associated with the report may be used for filtering. Example: `{\"advertiser_id\":1}`"},"metric":{"type":"array","description":"Metrics to included and summed in the report. Metrics may not be used for filtering or sorting. Only metrics associated with the report may be included.","items":{"type":"string"}},"offset":{"type":"integer","description":"Number of rows to offset results from the first results (e.g. for pagination through results)","default":0,"format":"int32"},"rows":{"type":"integer","description":"Number of rows to include in the report. If sending report results directly back from a GET request (i.e. `\"report_format\":\"none\"`) a 1,500 record limit is imposed. If the report results is saved in a file, (e.g. `\"report_format\":\"xls\"`) the limit is 30,000 records.","default":50,"format":"int32"},"sort_by":{"type":"array","description":"A field to sort the results by, along with the order (0=ascending). For example `\"advertiser_name\":0`"}}},"report_format":{"type":"string","description":"Format to return the report. Valid values include: `none`,`json`,`csv`,`xls`,`xlsx`. If not specified or set to `none` the report results will be returned by the API in the json response and the report will be limited to 1500 rows. If any format is specified other than `none` the report row limit is 15,000, and the resulting report will be saved for retrieval in a separate GET request.","default":"none"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"report_queue created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"report_queue created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/report_queue\" -b cookies.txt -d '{\"report_id\":1, \"report_name\":\"Daily report\", \"request_details\":{\"field\":[\"advertiser_id\"],\"metric\":[\"impression\",\"CPM\"],\"sort_by\":[{\"advertiser_id\":1}],\"rows\":100},\"report_format\":\"xls\"}'"}],"samples-languages":["curl"]}},"get":{"summary":"report_queue","description":"","operationId":"report_queue-get","parameters":[{"name":"report_queue_id","in":"query","description":"ID for the report","required":true,"schema":{"type":"integer","format":"int32"}}],"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"#Save the report into a local file\ncurl -X GET \"[host]/rest/report_queue\" -b cookies.txt -d '{\"report_queue_id\":1}' > report.xls"}],"samples-languages":["curl"]}}},"/report_save":{"delete":{"summary":"report_save","description":"","operationId":"report_save-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["report_save_id"],"properties":{"report_save_id":{"type":"integer","description":"Unique ID of the report_save","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"report_save deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"report_save deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/report_save\" -b cookies.txt -d '{\"report_save_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"report_save","description":"","operationId":"report_save-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["report_name","report_id","request_details"],"properties":{"report_name":{"type":"string","description":"Name for the report. <255 characters."},"report_id":{"type":"integer","description":"ID for the report type to be used to generate the report. Each report includes a definition of available fields, metrics, and filters. A list of valid reports can be retrieved by make a request to /view with `\"view_name\":\"reports\"`","format":"int32"},"request_details":{"type":"object","description":"JSON description of the requested report.","required":["field"],"properties":{"field":{"type":"array","description":"Fields (sometimes called \"dimensions\") to include in the report.","items":{"type":"string"}},"filter":{"type":"array","description":"Fields and values to filter the results by (e.g. WHERE clause). Only fields associated with the report may be used for filtering. Example: `{\"advertiser_id\":1}`"},"metric":{"type":"array","description":"Metrics to included and summed in the report. Metrics may not be used for filtering or sorting. Only metrics associated with the report may be included.","items":{"type":"string"}},"offset":{"type":"integer","description":"Number of rows to offset results from the first results (e.g. for pagination through results)","default":0,"format":"int32"},"rows":{"type":"integer","description":"Number of rows to include in the report. If sending report results directly back from a GET request (i.e. `\"report_format\":\"none\"`) a 1,500 record limit is imposed. If the report results is saved in a file, (e.g. `\"report_format\":\"xls\"`) the limit is 30,000 records.","default":50,"format":"int32"},"sort_by":{"type":"array","description":"A field to sort the results by, along with the order (0=ascending). For example `\"advertiser_name\":0`"}}},"report_format":{"type":"string","description":"Format to return the report. Valid values include: `none`,`json`,`csv`,`xls`,`xlsx`. If not specified or set to `none` the report results will be returned by the API in the json response and the report will be limited to 1500 rows. If any format is specified other than `none` the report row limit is 15,000, and the resulting report will be saved for retrieval in a separate GET request."},"user_id":{"type":"integer","description":"The User that created this report. By default the user ID of the requesting User will be used.","default":null,"format":"int32"},"frequency":{"type":"string","description":"Frequency that reports should be scheduled. Valid values include `daily`, `weekly` and `monthly`."},"email_to":{"type":"string","description":"Email addresses, separated by commas, up to 255 characters. If the report's `frequency` is set and this field is not set, the requesting user's email address will be added."},"email_cc":{"type":"string","description":"Email addresses to cc on scheduled reports"},"active":{"type":"boolean","description":"Whether saved report is still active. If a scheduled report is set to inactive it will no longer be sent."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"report_queue created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"report_queue created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/report_save\" -b cookies.txt -d '{\"report_id\":1, \"report_name\":\"Daily report\", \"frequency\":\"daily\",\"email_to\":\"foo@bar.com,bar@foo.com\", \"request_details\":{\"field\":[\"advertiser_id\"],\"metric\":[\"impression\",\"CPM\"],\"sort\":[{\"advertiser_id\":1}],\"rows\":100},\"report_format\":\"xls\"}'"}],"samples-languages":["curl"]}},"put":{"summary":"report_save","description":"","operationId":"report_save-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["report_save_id"],"properties":{"report_save_id":{"type":"integer","description":"Unique ID for the saved report","format":"int32"},"report_name":{"type":"string","description":"Name for the report. <255 characters."},"report_id":{"type":"integer","description":"ID for the report type to be used to generate the report. Each report includes a definition of available fields, metrics, and filters. A list of valid reports can be retrieved by make a request to /view with \"view_name\":\"reports\"","format":"int32"},"request_details":{"type":"array","description":"JSON description of fields to retrieve. If omitted, the entire definition of the report will be returned when this report is executed."},"report_format":{"type":"string","description":"Format to return the report. Valid values include: `none`,`json`,`csv`,`xls`,`xlsx`. If not specified or set to `none` the report results will be returned by the API in the json response and the report will be limited to 1500 rows. If any format is specified other than `none` the report row limit is 15,000, and the resulting report will be saved for retrieval in a separate GET request."},"user_id":{"type":"integer","description":"The User that created this report. By default the user ID of the requesting User will be used.","default":null,"format":"int32"},"frequency":{"type":"string","description":"Frequency that reports should be scheduled. Valid values include `daily`, `weekly` and `monthly`."},"email_to":{"type":"string","description":"Email addresses, separated by commas, up to 255 characters. If the report's frequency is set and this field is not set, the requesting user's email address will be added."},"email_cc":{"type":"string","description":"Email addresses to cc on scheduled reports"},"active":{"type":"boolean","description":"Whether saved report is still active. If a scheduled report is set to inactive it will no longer be sent."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"report_save updated with ID 1\"\n        }\n    ],\n    \"message\": \"report_save update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"report_save updated with ID 1"}}}},"message":{"type":"string","example":"report_save update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/report_save\" -b cookies.txt -d '{\"report_save_id\":1, \"report_name\":\"Daily report\", \"frequency\":\"daily\",\"email_to\":\"foo@bar.com,bar@foo.com\", \"request_details\":{\"field\":[\"advertiser_id\"],\"metric\":[\"impression\",\"CPM\"],\"sort\":[{\"advertiser_id\":1}],\"rows\":100},\"report_format\":\"xls\"}'"}],"samples-languages":["curl"]}},"get":{"summary":"report_save","description":"","operationId":"report_save-get","parameters":[{"name":"report_save_id","in":"query","description":"Unique ID for the saved report","schema":{"type":"integer","format":"int32"}},{"name":"report_name","in":"query","description":"Name for the report.","schema":{"type":"string"}},{"name":"report_id","in":"query","description":"ID for the report type","schema":{"type":"integer","format":"int32"}},{"name":"user_id","in":"query","description":"The User that created this report.","schema":{"type":"integer","format":"int32","default":null}},{"name":"frequency","in":"query","description":"Frequency that reports should be scheduled. Valid values include \"daily\", \"weekly\" and \"monthly\".","schema":{"type":"string"}},{"name":"active","in":"query","description":"Whether saved report is still active. If a scheduled report is set to inactive it will no longer be sent.","schema":{"type":"boolean"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"report_save_id\": 1,\n            \"account_id\": 1,\n            \"user_id\": 1,\n            \"report_name\": \"Test Inv report\",\n            \"report_id\": 2,\n            \"request_details\": {\n                \"field\": [\n                    \"campaign_id\"\n                ],\n                \"metric\": [\n                    \"impression\"\n                ],\n                \"filter\": [\n                    {\n                        \"campaign_id\": [\n                            1\n                        ]\n                    },\n                    {\n                        \"bid_date\": \"last_90_days\"\n                    }\n                ],\n                \"rows\": 1000\n            },\n            \"report_format\": \"none\",\n            \"frequency\": null,\n            \"email_to\": null,\n            \"email_cc\": null,\n            \"active\": 1,\n            \"create_date\": \"2015-10-22 17:40:11\",\n            \"update_date\": \"2015-10-22 17:40:52\",\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"report_save_id":{"type":"integer","example":1,"default":0},"account_id":{"type":"integer","example":1,"default":0},"user_id":{"type":"integer","example":1,"default":0},"report_name":{"type":"string","example":"Test Inv report"},"report_id":{"type":"integer","example":2,"default":0},"request_details":{"type":"object","properties":{"field":{"type":"array","items":{"type":"string","example":"campaign_id"}},"metric":{"type":"array","items":{"type":"string","example":"impression"}},"filter":{"type":"array","items":{"type":"object","properties":{"campaign_id":{"type":"array","items":{"type":"integer","example":1,"default":0}}}}},"rows":{"type":"integer","example":1000,"default":0}}},"report_format":{"type":"string","example":"none"},"frequency":{},"email_to":{},"email_cc":{},"active":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2015-10-22 17:40:11"},"update_date":{"type":"string","example":"2015-10-22 17:40:52"},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/report_save\" -b cookies.txt -d '{\"report_save_id\":1}'"}],"samples-languages":["curl"]}}},"/resend_user_email":{"post":{"summary":"resend_user_email","description":"Re-sends the welcome email to a new user","operationId":"resend_user_email","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"integer","description":"User ID","format":"int32"},"email":{"type":"string","description":"User Email"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": \"true\",\n    \"payload\": \"Email resent successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"string","example":"true"},"payload":{"type":"string","example":"Email resent successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"/rest/resend_user_email\" -d '{\"email\":\"elmo@sesame.com\"}'"}],"samples-languages":["curl"]}}},"/role":{"delete":{"summary":"role","description":"","operationId":"role-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["role_id"],"properties":{"role_id":{"type":"integer","description":"Unique ID of the role","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"role deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"role deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/role\" -b cookies.txt -d '{\"role_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"role","description":"","operationId":"role-get","parameters":[{"name":"role_id","in":"query","description":"Unique ID of the Role","schema":{"type":"integer","format":"int32"}},{"name":"role_name","in":"query","description":"Name of the Role (e.g. \"Administrator\"). <100 chars","schema":{"type":"string"}},{"name":"global","in":"query","description":"Whether the Role is global, across Accounts.","schema":{"type":"boolean","default":false}},{"name":"parent_role_id","in":"query","description":"This Role inherits permissions from another Role.","schema":{"type":"integer","format":"int32"}},{"name":"active","in":"query","description":"Whether Role is active.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"role_id\": 1,\n            \"global\": true,\n            \"role_name\": \"Administrator\",\n            \"parent_role_id\": 0,\n            \"account_id\": 1,\n            \"create_date\": \"2015-07-21 12:42:22\",\n            \"update_date\": \"2015-07-21 12:42:22\",\n            \"alternative_id\": null,\n            \"notes\": \"Full rights to all objects\",\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\",\n            \"permissions\": {\n                \"account\": 15,\n                \"account_contract\": 15,\n                \"account_setting\": 15,\n                \"activity_log\": 15,\n                \"advertiser\": 15,\n                \"alert\": 15,\n                \"campaign\": 15,\n                \"creative\": 15,\n                \"creative_asset\": 15,\n                \"creative_attribute\": 15,\n                \"creative_line_item\": 15,\n                \"creative_rule\": 15,\n                \"creative_template\": 15,\n                \"event\": 15,\n                \"event_assignment\": 15,\n                \"fee_log\": 15,\n                \"grafana\": 1,\n                \"line_item\": 15,\n                \"list\": 15,\n                \"list_item\": 15,\n                \"push_queue\": 15,\n                \"report_queue\": 15,\n                \"role\": 15,\n                \"search\": 1,\n                \"segment\": 15,\n                \"segment_category\": 15,\n                \"segment_category_association\": 15,\n                \"segment_sharing\": 15,\n                \"segment_upload\": 15,\n                \"site\": 15,\n                \"site_list\": 15,\n                \"static\": 1,\n                \"strategy\": 15,\n                \"targeting_module\": 15,\n                \"targeting_template\": 15,\n                \"user\": 15,\n                \"user_field\": 15,\n                \"vendor\": 15,\n                \"vendor_fee\": 15\n            }\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"role_id":{"type":"integer","example":1,"default":0},"global":{"type":"boolean","example":true,"default":true},"role_name":{"type":"string","example":"Administrator"},"parent_role_id":{"type":"integer","example":0,"default":0},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2015-07-21 12:42:22"},"update_date":{"type":"string","example":"2015-07-21 12:42:22"},"alternative_id":{},"notes":{"type":"string","example":"Full rights to all objects"},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"},"permissions":{"type":"object","properties":{"account":{"type":"integer","example":15,"default":0},"account_contract":{"type":"integer","example":15,"default":0},"account_setting":{"type":"integer","example":15,"default":0},"activity_log":{"type":"integer","example":15,"default":0},"advertiser":{"type":"integer","example":15,"default":0},"alert":{"type":"integer","example":15,"default":0},"campaign":{"type":"integer","example":15,"default":0},"creative":{"type":"integer","example":15,"default":0},"creative_asset":{"type":"integer","example":15,"default":0},"creative_attribute":{"type":"integer","example":15,"default":0},"creative_line_item":{"type":"integer","example":15,"default":0},"creative_rule":{"type":"integer","example":15,"default":0},"creative_template":{"type":"integer","example":15,"default":0},"event":{"type":"integer","example":15,"default":0},"event_assignment":{"type":"integer","example":15,"default":0},"fee_log":{"type":"integer","example":15,"default":0},"grafana":{"type":"integer","example":1,"default":0},"line_item":{"type":"integer","example":15,"default":0},"list":{"type":"integer","example":15,"default":0},"list_item":{"type":"integer","example":15,"default":0},"push_queue":{"type":"integer","example":15,"default":0},"report_queue":{"type":"integer","example":15,"default":0},"role":{"type":"integer","example":15,"default":0},"search":{"type":"integer","example":1,"default":0},"segment":{"type":"integer","example":15,"default":0},"segment_category":{"type":"integer","example":15,"default":0},"segment_category_association":{"type":"integer","example":15,"default":0},"segment_sharing":{"type":"integer","example":15,"default":0},"segment_upload":{"type":"integer","example":15,"default":0},"site":{"type":"integer","example":15,"default":0},"site_list":{"type":"integer","example":15,"default":0},"static":{"type":"integer","example":1,"default":0},"strategy":{"type":"integer","example":15,"default":0},"targeting_module":{"type":"integer","example":15,"default":0},"targeting_template":{"type":"integer","example":15,"default":0},"user":{"type":"integer","example":15,"default":0},"user_field":{"type":"integer","example":15,"default":0},"vendor":{"type":"integer","example":15,"default":0},"vendor_fee":{"type":"integer","example":15,"default":0}}}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/role\" -b cookies.txt -d '{\"role_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"role","description":"","operationId":"role-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["role_id"],"properties":{"role_id":{"type":"integer","description":"Unique ID of the Role","format":"int32"},"role_name":{"type":"string","description":"Name of the Role (e.g. \"Administrator\"). <100 chars"},"global":{"type":"boolean","description":"Whether the Role is global, across Accounts. Only Super Users can create or edit a global Role\t.","default":false},"parent_role_id":{"type":"integer","description":"This Role inherits permissions from another Role. New non-Global roles should inherit permissions from existing Global Roles. Only Global Roles should set this field to zero.","format":"int32"},"permissions":{"type":"array","description":"Array of permissions in the format `\"object_type\":int`. Object_types must be supported and valid. Integer values must be between zero (no rights) and 15 (all rights)."},"notes":{"type":"string","description":"Notes about the Role"},"active":{"type":"boolean","description":"Whether Role is active. if a Role is set to inactive, Buzz will not alter permissions for existing Users associated with that Role, but will prevent new Users from having that Role assigned."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"role updated with ID 1\"\n        }\n    ],\n    \"message\": \"role update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"role updated with ID 1"}}}},"message":{"type":"string","example":"role update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/role\" -b cookies.txt -d '{\"role_id\":1,\"role_name\":\"Manager\",\"global\":0, \"parent_role_id\":1, \"permissions\":{\"user\":15,\"account\":15,\"creative\":10}}'"}],"samples-languages":["curl"]}},"post":{"summary":"role","description":"","operationId":"role-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["role_name","parent_role_id","permissions"],"properties":{"role_name":{"type":"string","description":"Name of the Role (e.g. \"Administrator\"). <100 chars"},"global":{"type":"boolean","description":"Whether the Role is global, across Accounts. Only Super Users can create or edit a global Role\t.","default":false},"parent_role_id":{"type":"integer","description":"This Role inherits permissions from another Role. New non-Global roles should inherit permissions from existing Global Roles. Only Global Roles should set this field to zero.","format":"int32"},"permissions":{"type":"array","description":"Array of permissions in the format `\"object_type\":int`. Object_types must be supported and valid. Integer values must be between zero (no rights) and 15 (all rights)."},"notes":{"type":"string","description":"Notes about the Role"},"active":{"type":"boolean","description":"Whether Role is active. if a Role is set to inactive, Buzz will not alter permissions for existing Users associated with that Role, but will prevent new Users from having that Role assigned."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"role created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"role created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/role\" -b cookies.txt -d '{\"account_id\":1,\"role_name\":\"Manager\",\"global\":0, \"parent_role_id\":1, \"permissions\":{\"user\":15,\"account\":15,\"creative\":10}}'"}],"samples-languages":["curl"]}}},"/search":{"get":{"summary":"search","description":"","operationId":"search-get","parameters":[{"name":"object_id","in":"query","description":"The unique ID of the object that is being requested.","schema":{"type":"integer","format":"int32"}},{"name":"object_type","in":"query","description":"The type of object required. e.g. \"user\" or \"line_item\"","schema":{"type":"string"}},{"name":"object_name","in":"query","description":"The string to be searched for. For non-exact matches surround the query with % signs.","schema":{"type":"string"}}],"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"#Search for Advertisers with the name ford\ncurl -X GET \"[host]/rest/search\" -b cookies.txt -d '{\"object_type\":\"advertiser\", \"object_name\":\"%ford%\"}'\n\n#Search for any object with the name ford\ncurl -X GET \"[host]/rest/search\" -b cookies.txt -d '{\"object_name\":\"%ford%\"}'\n\n#Search for Advertiser ID 123\ncurl -X GET \"[host]/rest/search\" -b cookies.txt -d '{\"object_type\":\"advertiser\", \"object_id\":123}'"}],"samples-languages":["curl"]}}},"/segment_category":{"post":{"summary":"segment_category","description":"","operationId":"segment-4","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_category_name"],"properties":{"segment_category_name":{"type":"string","description":"Name of the Segment Category. <191 chars"},"parent_category_key":{"type":"string","description":"Must be an active Segment Category. If omitted or set to NULL, this category will live at the top of the hierarchy."},"advertiser_id":{"type":"integer","description":"Segment Categories may belong to the overall Account or to a single Advertiser.","format":"int32"},"alternative_id":{"type":"string","description":"Any text up to 200 characters to identify the category"},"notes":{"type":"string","description":"Up to 255 characters"},"active":{"type":"boolean","description":"Is the category active"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"segment_category created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_category created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/segment_category\" -b cookies.txt -d '{\"advertiser_id\":1, \"parent_category_key\":\"stingersbx-1\", \"segment_category_name\":\"My lists\"}'"}],"samples-languages":["curl"]}},"delete":{"summary":"segment_category","description":"","operationId":"segment_category-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_category_id"],"properties":{"segment_category_id":{"type":"integer","description":"Unique ID of the segment_category","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"segment_category deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_category deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/segment_category\" -b cookies.txt -d '{\"segment_category_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"segment_category","description":"","operationId":"segment_category-get","parameters":[{"name":"segment_category_id","in":"query","description":"Unique ID of the Segment Category","schema":{"type":"integer","format":"int32"}},{"name":"alternative_id","in":"query","description":"Any text up to 80 characters","schema":{"type":"string"}},{"name":"segment_category_key","in":"query","description":"An auto-generated key in the format `<BUZZ_KEY>-<segment_category_id>`","schema":{"type":"string"}},{"name":"segment_category_name","in":"query","description":"Name of the Segment Category. <191 chars","schema":{"type":"string"}},{"name":"parent_category_key","in":"query","description":"Must be an active Segment Category. If omitted or set to NULL, this category will live at the top of the hierarchy.","schema":{"type":"string"}},{"name":"advertiser_id","in":"query","description":"Segment Categories may belong to the overall Account or to a single Advertiser.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"segment_category_id\": 3,\n            \"segment_category_key\": \"stingersbx-1\",\n            \"advertiser_id\": 1,\n            \"parent_category_key\": null,\n            \"segment_category_name\": \"My lists\",\n            \"account_id\": 1,\n            \"create_date\": \"2016-03-30 13:23:59\",\n            \"update_date\": \"2016-03-30 13:23:59\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"segment_category_id":{"type":"integer","example":3,"default":0},"segment_category_key":{"type":"string","example":"stingersbx-1"},"advertiser_id":{"type":"integer","example":1,"default":0},"parent_category_key":{},"segment_category_name":{"type":"string","example":"My lists"},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-03-30 13:23:59"},"update_date":{"type":"string","example":"2016-03-30 13:23:59"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/segment_category\" -b cookies.txt -d '{\"segment_category_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"segment_category","description":"","operationId":"segment_category-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_category_id"],"properties":{"segment_category_id":{"type":"integer","description":"Unique ID of the Segment Category","format":"int32"},"segment_category_name":{"type":"string","description":"Name of the Segment Category. <191 chars"},"parent_category_key":{"type":"string","description":"Must be an active Segment Category. If omitted or set to NULL, this category will live at the top of the hierarchy."},"advertiser_id":{"type":"integer","description":"Segment Categories may belong to the overall Account or to a single Advertiser.","format":"int32"},"alternative_id":{"type":"string","description":"Any text up to 200 characters"},"notes":{"type":"string","description":"Up to 255 characters"},"active":{"type":"boolean"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"segment_category updated with ID 1\"\n        }\n    ],\n    \"message\": \"segment_category update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_category updated with ID 1"}}}},"message":{"type":"string","example":"segment_category update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/segment_category\" -b cookies.txt -d '{\"segment_category_id\":1, \"advertiser_id\":1, \"parent_category_key\":\"stingersbx-1\", \"segment_category_name\":\"My lists\"}'"}],"samples-languages":["curl"]}}},"/segment":{"get":{"summary":"segment","description":"","operationId":"segment-get","parameters":[{"name":"segment_id","in":"query","description":"Unique ID of the Segment","schema":{"type":"integer","format":"int32"}},{"name":"segment_key","in":"query","description":"An auto-generated key in the format `<BUZZ_KEY>-<segment_id>`. This key is used for sharing and targeting.","schema":{"type":"string"}},{"name":"segment_name","in":"query","description":"Name of the Segment. <191 chars","schema":{"type":"string"}},{"name":"alternative_id","in":"query","description":"Alternative ID","schema":{"type":"string","default":"0"}},{"name":"advertiser_id","in":"query","description":"Segments may belong to the overall Account or to a single Advertiser.","schema":{"type":"integer","format":"int32"}},{"name":"segment_description","in":"query","description":"Longer description of the segment","schema":{"type":"string"}},{"name":"active","in":"query","description":"Indicates a segment’s archival status — when set to `true`, the segment remains active and is available for selection in targeting, whereas when set to `false`, it is archived and hidden from the options.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"segment_id\": 1,\n            \"segment_key\": \"stingersbx-1\",\n            \"advertiser_id\": 1,\n            \"segment_name\": \"My users\",\n            \"cpm_cost\": 1.23,\n            \"segment_description\": \"This is a great segment because it converts!\",\n            \"ttl_days\": 45,\n            \"aggregate_excludes\": false,\n            \"account_id\": 1,          \n            \"create_date\": \"2015-07-27 11:50:32\",\n            \"update_date\": \"2016-03-30 13:18:26\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"segment_id":{"type":"integer","example":1,"default":0},"segment_key":{"type":"string","example":"stingersbx-1"},"advertiser_id":{"type":"integer","example":1,"default":0},"segment_name":{"type":"string","example":"My users"},"cpm_cost":{"type":"number","example":1.23,"default":0},"segment_description":{"type":"string","example":"This is a great segment because it converts!"},"ttl_days":{"type":"integer","example":45,"default":0},"aggregate_excludes":{"type":"boolean","example":false,"default":true},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2015-07-27 11:50:32"},"update_date":{"type":"string","example":"2016-03-30 13:18:26"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/segment\" -b cookies.txt -d '{\"segment_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"segment","description":"","operationId":"segment-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"integer","description":"Unique ID of the Segment","format":"int32"},"segment_name":{"type":"string","description":"Name of the Segment. <191 chars"},"alternative_id":{"type":"string","description":"Unlike other objects, the `alternative_id` for segments must be unique per account. This enables the use of the `alternative_id` as a segment identifier when using the `segment_upload` method by setting the `segment_key_type` field.","default":"0"},"advertiser_id":{"type":"integer","description":"Segments may belong to the overall Account or to a single Advertiser.","format":"int32"},"segment_description":{"type":"string","description":"Longer description of the segment"},"cpm_cost":{"type":"number","description":"Cost to use the segment","format":"double"},"aggregate_excludes":{"type":"boolean","description":"Should reporting include this segment when it is used as a negative target (\"NOT\")","default":false},"active":{"type":"boolean","description":"Indicates a segment’s archival status — when set to `true`, the segment remains active and is available for selection in targeting, whereas when set to `false`, it is archived and hidden from the options.","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"segment updated with ID 1\"\n        }\n    ],\n    \"message\": \"segment update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment updated with ID 1"}}}},"message":{"type":"string","example":"segment update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/segment\" -b cookies.txt -d '{\"segment_id\":1, \"advertiser_id\":1, \"segment_name\":\"My users\", \"segment_description\":\"This is a great segment because it converts!\",\"cpm_cost\":1.23}'"}],"samples-languages":["curl"]}},"post":{"summary":"segment","description":"","operationId":"segment-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_name"],"properties":{"segment_name":{"type":"string","description":"Name of the Segment. <191 chars"},"alternative_id":{"type":"string","description":"Unlike other objects, the `alternative_id` for segments must be unique per account. This enables the use of the `alternative_id` as a segment identifier when using the `segment_upload` method by setting the `segment_key_type` field.","default":"0"},"advertiser_id":{"type":"integer","description":"Segments may belong to the overall Account or to a single Advertiser.","format":"int32"},"segment_description":{"type":"string","description":"Longer description of the segment"},"cpm_cost":{"type":"number","description":"Cost to track for the segment","format":"double"},"ttl_days":{"type":"integer","description":"Number of days to keep users in the segment. Max 90. Cannot be changed once set.","default":30,"format":"int32"},"aggregate_excludes":{"type":"boolean","description":"Should reporting include this segment when it is used as a negative target (\"NOT\")","default":false},"active":{"type":"boolean","description":"Indicates a segment’s archival status — when set to `true`, the segment remains active and is available for selection in targeting, whereas when set to `false`, it is archived and hidden from the options.","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"segment created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/segment\" -b cookies.txt -d '{\"advertiser_id\":1, \"segment_name\":\"My users\", \"segment_description\":\"This is a great segment because it converts!\", \"cpm_cost\":1.23, \"ttl_days\":45,\"aggregate_excludes\":true}'"}],"samples-languages":["curl"]}}},"/segment_category_association":{"get":{"summary":"segment_category_association","description":"","operationId":"segment_category_association-get","parameters":[{"name":"segment_category_association_id","in":"query","description":"Unique ID of the Segment Category association","schema":{"type":"integer","format":"int32"}},{"name":"segment_category_key","in":"query","description":"The `segment_category_key` (not the `segment_category_id`!) from the Segment Category.","schema":{"type":"string"}},{"name":"segment_key","in":"query","description":"The `segment_key` (not the 1segment_id`!) from the Segment to be categorized. Must either belong to the Account of the user, or be shared with that user's Account.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"account_id\": 1,\n            \"segment_category_association_id\": 1,\n            \"segment_category_key\": \"stingersbx-3\",\n            \"segment_key\": \"stingersbx-1\",\n            \"create_date\": \"2016-03-30 13:50:56\",\n            \"update_date\": \"2016-03-30 13:50:56\",\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"integer","example":1,"default":0},"segment_category_association_id":{"type":"integer","example":1,"default":0},"segment_category_key":{"type":"string","example":"stingersbx-3"},"segment_key":{"type":"string","example":"stingersbx-1"},"create_date":{"type":"string","example":"2016-03-30 13:50:56"},"update_date":{"type":"string","example":"2016-03-30 13:50:56"},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/segment_category_association\" -b cookies.txt -d '{\"segment_category_association_id\": 1}'"}],"samples-languages":["curl"]}},"delete":{"summary":"segment_category_association","description":"","operationId":"segment_category_association-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_category_association_id"],"properties":{"segment_category_association_id":{"type":"integer","description":"Unique ID of the segment_category_association","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"segment_category_association deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_category_association deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/segment_category_association\" -b cookies.txt -d '{\"segment_category_association_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"segment_category_association","description":"","operationId":"segment_category_association-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_category_key","segment_key"],"properties":{"segment_category_key":{"type":"string","description":"The `segment_category_key` (not the `segment_category_id`!) from the Segment Category."},"segment_key":{"type":"string","description":"The `segment_key` (not `segment_id`!) from the Segment to be categorized. Must either belong to the Account of the user, or be shared with that user's Account."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"segment_category_association created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_category_association created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/segment_category_association\" -b cookies.txt -d '{\"segment_category_key\": \"stingersbx-3\", \"segment_key\":\"stingersbx-1\"}'"}],"samples-languages":["curl"]}}},"/segment_category_sharing":{"post":{"summary":"segment_category_sharing","description":"","operationId":"segment_category_sharing-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_category_key","shared_account_id"],"properties":{"segment_category_key":{"type":"string","description":"The `segment_category_key` (not `segment_category_id`!) from the SegmentCategory to be shared. Must either belong to the Account of the user, or be shared with that user's Account."},"shared_account_id":{"type":"integer","description":"The Account the SegmentCategory should be shared with","format":"int32"},"active":{"type":"boolean","description":"Is the sharing active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"segment_category_sharing created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_category_sharing created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/segment_category_sharing\" -b cookies.txt -d '{\"segment_category_key\":\"stingersbx-1\",\"shared_account_id\":23, \"active\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"segment_category_sharing","description":"","operationId":"segment_category_sharing-get","parameters":[{"name":"segment_category_sharing_id","in":"query","description":"Unique ID of the segment_category_sharing","schema":{"type":"integer","format":"int32"}},{"name":"segment_category_key","in":"query","description":"The `segment_category_key` (not `segment_category_id`!) from the SegmentCategory to be shared","schema":{"type":"string"}},{"name":"shared_account_id","in":"query","description":"The Account the SegmentCategory should be shared with","schema":{"type":"integer","format":"int32"}},{"name":"active","in":"query","description":"Is the sharing active?","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"segment_category_sharing_id\": 1,\n            \"shared_account_id\": 2,\n            \"segment_category_key\": \"stingertest-1\",\n            \"account_id\": 1,\n            \"create_date\": \"2016-03-30 13:58:39\",\n            \"update_date\": \"2016-03-30 13:58:39\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"segment_category_sharing_id":{"type":"integer","example":1,"default":0},"shared_account_id":{"type":"integer","example":2,"default":0},"segment_category_key":{"type":"string","example":"stingertest-1"},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-03-30 13:58:39"},"update_date":{"type":"string","example":"2016-03-30 13:58:39"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/segment_category_sharing\" -b cookies.txt -d '{\"segment_category_sharing_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"segment_category_sharing","description":"","operationId":"segment_category_sharing-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_category_sharing_id"],"properties":{"segment_category_sharing_id":{"type":"integer","description":"Unique ID of the segment_category_sharing object","format":"int32"},"active":{"type":"boolean","description":"Is the sharing active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"segment_category_sharing updated with ID 1\"\n        }\n    ],\n    \"message\": \"segment_category_sharing update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_category_sharing updated with ID 1"}}}},"message":{"type":"string","example":"segment_category_sharing update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/segment_category_sharing\" -b cookies.txt -d '{\"segment_category_sharing_id\":1, \"active\":1}'"}],"samples-languages":["curl"]}}},"/segment_category_lookup":{"get":{"summary":"segment_category_lookup","description":"The Segment Category Lookup object allows you to get Segment Categories that are shared with your Account. For example Bluekai or Integral Ad Science segment Categories. This object only accepts GET requests.","operationId":"segment_category_lookup","parameters":[{"name":"segment_category_id","in":"query","description":"Unique ID for the segment category","schema":{"type":"integer","format":"int32"}},{"name":"segment_category_key","in":"query","description":"Unique compound ID for the segment category, including both the Buzz Key and the ID","schema":{"type":"string"}},{"name":"segment_category_name","in":"query","description":"Name for the segment category","schema":{"type":"string"}},{"name":"source","in":"query","description":"Either `third-party` or `local`","schema":{"type":"string"}}],"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/segment_category_lookup\" -b cookies.txt -d '{\"source\":\"third-party\"}'"}],"samples-languages":["curl"]}}},"/segment_lookup":{"get":{"summary":"segment_lookup","description":"The Segment Lookup object allows you to get segments that are shared with your Account. For example Bluekai or Integral Ad Science segments. This object only accepts GET requests. See the Migration Note below.","operationId":"segment_lookup","parameters":[{"name":"segment_id","in":"query","description":"Unique ID for the segment","schema":{"type":"integer","format":"int32"}},{"name":"segment_key","in":"query","description":"Compound unique key including the Buzz Key and the segment_id","schema":{"type":"string"}},{"name":"segment_name","in":"query","description":"Name for the segment","schema":{"type":"string"}},{"name":"source","in":"query","description":"Either `third-party` or `local`. See description below.","schema":{"type":"string"}}],"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/segment_lookup\" -b cookies.txt -d '{\"source\":\"third-party\"}'"}],"samples-languages":["curl"]}}},"/segment_sharing":{"get":{"summary":"segment_sharing","description":"","operationId":"segment_sharing-get","parameters":[{"name":"segment_sharing_id","in":"query","description":"Unique ID of the segment sharing","schema":{"type":"integer","format":"int32"}},{"name":"segment_key","in":"query","description":"The `segment_key` (not `segment_id`!) from the Segment to be categorized. Must either belong to the Account of the user, or be shared with that user's Account.","schema":{"type":"string"}},{"name":"shared_account_id","in":"query","description":"The Account the Segment should be shared with","schema":{"type":"integer","format":"int32"}},{"name":"active","in":"query","description":"Is the sharing active?","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"segment_sharing_id\": 1,\n            \"shared_account_id\": 2,\n            \"segment_key\": \"stingertest-1\",\n            \"cpm_cost\": 1.23,\n            \"account_id\": 1,\n            \"create_date\": \"2016-03-30 13:58:39\",\n            \"update_date\": \"2016-03-30 13:58:39\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"segment_sharing_id":{"type":"integer","example":1,"default":0},"shared_account_id":{"type":"integer","example":2,"default":0},"segment_key":{"type":"string","example":"stingertest-1"},"cpm_cost":{"type":"number","example":1.23,"default":0},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2016-03-30 13:58:39"},"update_date":{"type":"string","example":"2016-03-30 13:58:39"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/segment_sharing\" -b cookies.txt -d '{\"segment_sharing_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"segment_sharing","description":"","operationId":"segment_sharing-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_key","shared_account_id"],"properties":{"segment_key":{"type":"string","description":"The `segment_key` (not `segment_id`!) from the Segment to be categorized. Must either belong to the Account of the user, or be shared with that user's Account."},"shared_account_id":{"type":"integer","description":"The Account the segment should be shared with","format":"int32"},"active":{"type":"boolean","description":"Is the sharing active?","default":false},"cpm_cost":{"type":"number","description":"Cost to use the Segment","format":"double"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"segment_sharing created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_sharing created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/segment_sharing\" -b cookies.txt -d '{\"segment_key\":\"stingersbx-1\",\"shared_account_id\":23, \"active\":1,\"cpm_cost\":1.23}'"}],"samples-languages":["curl"]}},"put":{"summary":"segment_sharing","description":"","operationId":"segment_sharing-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["segment_sharing_id"],"properties":{"segment_sharing_id":{"type":"integer","description":"Unique ID of the segment sharing","format":"int32"},"segment_key":{"type":"string","description":"The `segment_key` (not `segment_id`!) from the Segment to be categorized. Must either belong to the Account of the user, or be shared with that user's Account."},"shared_account_id":{"type":"integer","description":"The Account the segment should be shared with","format":"int32"},"active":{"type":"boolean","description":"Is the sharing active?","default":false},"cpm_cost":{"type":"number","description":"Cost to use the segment","format":"double"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"segment_sharing updated with ID 1\"\n        }\n    ],\n    \"message\": \"segment_sharing update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_sharing updated with ID 1"}}}},"message":{"type":"string","example":"segment_sharing update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/segment_sharing\" -b cookies.txt -d '{\"segment_sharing_id\":1, \"active\":1,\"cpm_cost\": 1.23}'"}],"samples-languages":["curl"]}}},"/segment_tag":{"get":{"summary":"segment_tag","description":"The Segment Tag object allows you to get a tag to use on your website or application. This object only accepts GET requests.","operationId":"segment_tag","parameters":[{"name":"segment_id","in":"query","description":"Unique ID for the segment","schema":{"type":"integer","format":"int32"}},{"name":"segment_name","in":"query","description":"Name for the segment","schema":{"type":"string"}},{"name":"advertiser_id","in":"query","description":"Unique ID for the advertiser","schema":{"type":"integer","format":"int32"}},{"name":"tag_type","in":"query","description":"The tag type to render, default is `js` for javascript tags.","schema":{"type":"string","default":"js"}},{"name":"format","in":"query","description":"The format to return the tags, default is `none`. Optional values can include `csv`, `xml`, `xls`, `xlsx` and `json` If not set or set to `none` the tags will be returned in the standard API response. If set, a file with the content will be streamed to the output.","schema":{"type":"string","default":"none"}}],"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/segment_tag\" -b cookies.txt -d '{\"segment_id\":1, \"tag_type\":\"js\", \"format\":\"none\"}'"}],"samples-languages":["curl"]}}},"/segment_update":{"post":{"summary":"segment_update","description":"","operationId":"segment_update","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["user_data"],"properties":{"user_data":{"type":"array","description":"JSON of the user-segment information to be added. See below for more details.","items":{"properties":{"user_id":{"type":"string","description":"User ID in format set by `segment_key_type` field"},"segments":{"type":"array","description":"List of segments (using `segment_key`) for this user to be added to. Segment keys may include an optional value, in format `<segment_key>:<value>`","default":[],"items":{"type":"string"}}},"type":"object"}},"continent":{"type":"string","description":"The destination continent data centers to upload the data. Only one continent may be specified per upload. If a segment is required across continents it must be uploaded twice. Options are `NAM`, `EMEA`, or `APAC`.","default":"NAM"},"segment_key_type":{"type":"string","description":"Indicates whether the user IDs in the uploaded file should be put into a segment defined by the segment_key or the alternative_id from the segment. Must be set to either `DEFAULT` or `ALTERNATIVE`.","default":"DEFAULT"},"user_id_type":{"type":"string","description":"Indicates the type of IDs being imported, as defined in the \"segment_user_type\" view. Valid types include `BEESWAX`, `CUSTOMER`, `IDFA`, `IDFA_MD5`, `IDFA_SHA1 `, `AD_ID`, `AD_ID_MD5`, `AD_ID_SHA1 `, `IP_ADDRESS`"},"operation_type":{"type":"string","description":"What action should be taken on these users. Commonly set to `ADD_SEGMENTS` or `REPLACE_ALL_SEGMENTS`","default":"ADD_SEGMENTS"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"The segment update has been submitted for processing\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"The segment update has been submitted for processing"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/segment_update\" -b cookies.txt -d '{\"segment_key_type\":\"DEFAULT\",\"user_data\":[{\"user_id\":1234,\"segments\":[\"stinger-1\",\"stinger-2:BAR\",\"stinger-3\"]},{\"user_id\":12344,\"segments\":[\"stinger-1\",\"stinger-2:BAR\",\"stinger-3\"]}],\"user_id_type\":\"IDFA\"}'"}],"samples-languages":["curl"]}}},"/segment_upload":{"post":{"summary":"segment_upload","description":"","operationId":"segment_upload-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["file_name","size_in_bytes"],"properties":{"file_name":{"type":"string","description":"The filename to be uploaded, including the extension. <255 chars, no spaces or special characters other than dashes and underscores."},"path_to_file":{"type":"string","description":"The location of the file on the server. If this field is populated, Buzz assumes the file was already uploaded and will not allow further uploads. If absent, Buzz will auto-fill this when the file is uploaded in a subsequent POST."},"size_in_bytes":{"type":"integer","description":"Size of the file to be uploaded, in bytes.","format":"int32"},"datacenter":{"type":"string","description":"Not currently used."},"file_format":{"type":"string","description":"The type of file format expected. Valid formats are stored in the `segment_file_format` table.","default":"DELIMITED"},"segment_file_list":{"type":"array","description":"When uploading multiple files of segment-user associations, a list of these files can be passed in a single POST. This will generally improve performance of the upload as well.","items":{"type":"string"}},"segment_key_type":{"type":"string","description":"Indicates whether the user IDs in the uploaded file should be put into a segment defined by the segment_key or the alternative_id from the segment. Must be set to either `DEFAULT` or `ALTERNATIVE`.","default":"DEFAULT"},"continent":{"type":"string","description":"The destination continent data centers to upload the data. Only one continent may be specified per upload. If a segment is required across continents it must be uploaded twice. Options are `NAM`, `EMEA`, or `APAC`.","default":"NAM"},"user_id_type":{"type":"string","description":"Indicates the type of IDs being imported, as defined in the \"segment_user_type\" view. Valid types include `BEESWAX`, `CUSTOMER`, `HEM`, `IDFA`, `IDFA_MD5`, `IDFA_SHA1 `, `AD_ID`, `AD_ID_MD5`, `AD_ID_SHA1 `, `IP_ADDRESS`, `OTHER_MOBILE_ID`"},"first_party_user_id_type":{"type":"string","description":"Indicates the type of the first-party IDs being imported (up to 191 characters). This field cannot be set alongside `user_id_type` in the same request. A valid value can be any type ID that exists for the customer."},"overwrite":{"type":"boolean","description":"DEPRECATED. When set the segments associated with a user will overwrite all other user-segment associations for the given user. Use the `operation_type` field instead.","default":false},"operation_type":{"type":"string","description":"What action should be taken on these users. Commonly set to `ADD_SEGMENTS` or `REPLACE_ALL_SEGMENTS`","default":"ADD_SEGMENTS"},"partner_handle":{"type":"string","description":"This field should be left null unless otherwise instructed. After POST the value will be set to the `buzz_key` of the account.","default":"custom value"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"segment_upload created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"segment_upload created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/segment_upload\" -b cookies.txt -d '{\"file_name\":\"user_data_sample.txt\",\"size_in_bytes\":412,\"account_id\":1,\"file_format\":\"DELIMITED\",\"segment_key_type\":\"ALTERNATIVE\",\"continent\":\"NAM\",\"user_id_type\":\"IDFA\"}'\n#\n# After the first POST, get the ID and add /upload/ID to the URL:\n#\ncurl -X POST \"[host]/rest/segment_upload/upload/1\" -b cookies.txt -F \"segment_file=@../user_data_sample.txt\"\n","name":"cURL example with single file upload"},{"language":"curl","code":"curl -X POST \"[host]/rest/segment_upload\" -b cookies.txt -d '{\"file_name\":null,\"size_in_bytes\":null,\"account_id\":1,\"file_format\":\"DELIMITED\",\"segment_key_type\":\"ALTERNATIVE\",\"continent\":\"NAM\",\"user_id_type\":\"IDFA\",\"segment_file_list\":[\"s3://beeswax-data/user-list/customer_name/folder/part-00000\",\"s3://beeswax-data/user-list/customer_name/folder/part-00001\"]}'","name":"cURL example with list of files"}],"samples-languages":["curl"]}},"get":{"summary":"segment_upload","description":"","operationId":"segment_upload-get","parameters":[{"name":"segment_upload_id","in":"query","description":"Unique ID for the segment_upload object","schema":{"type":"integer","format":"int32"}},{"name":"file_name","in":"query","description":"The filename uploaded, including the extension.","schema":{"type":"string"}},{"name":"upload_status","in":"query","description":"Status of the file upload. 0=No file uploaded; 1=File uploaded, pending process, 2= Processed, 3=Error, 4=In-progress.","schema":{"type":"integer","format":"int32"}},{"name":"upload_complete_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"partner_handle","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"segment_upload_id\": 1,\n            \"account_id\": 1,\n            \"file_name\": \"test_pollinator.dat\",\n            \"path_to_file\": \"buzz-user-lists/uploaded_files/stingertest/1/1_test_pollinator.dat\",\n            \"size_in_bytes\": 149,\n            \"segment_file_list\": null,\n            \"datacenter\": null,\n            \"file_format\": \"DELIMITED\",\n            \"segment_key_type\": \"ALTERNATIVE\",\n            \"continent\": \"NAM\",\n            \"overwrite\": false,\n            \"user_id_type\": \"BEESWAX\",\n            \"upload_message\": \"Success!\",\n            \"upload_status\": 2,\n\t\t\t\t\t\t\"partner_handle\": \"stingersbx\",\n            \"upload_complete_date\": \"2015-09-19 11:28:12\",\n            \"create_date\": \"2015-09-19 11:28:10\",\n            \"update_date\": \"2015-09-19 11:28:12\",\n            \"buzz_key\": \"stingersbx\"\n        }\n    ],\n}"}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/segment_upload\" -b cookies.txt -d '{\"segment_upload_id\":1}'"}],"samples-languages":["curl"]}}},"/strategy":{"get":{"summary":"strategy","description":"","operationId":"strategy-get","parameters":[{"name":"strategy_id","in":"query","description":"Unique id of the Strategy","schema":{"type":"integer","format":"int32"}},{"name":"line_item_type_id","in":"query","description":"Type of Line Item that uses this Strategy. (`0`=banner, `1`=video, `2`=native)","schema":{"type":"integer","format":"int32"}},{"name":"strategy_name","in":"query","description":"Name of the Strategy","schema":{"type":"string"}},{"name":"active","in":"query","description":"Is the Strategy active?","schema":{"type":"boolean"}},{"name":"default_strategy","in":"query","description":"Is this the default Strategy to use for all new Targeting Templates for this Line Item Type?","schema":{"type":"boolean","default":false}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"strategy_id\": 1,\n            \"line_item_type_id\": 0,\n            \"strategy_name\": \"System\",\n            \"strategy_description\": \"Banner stategy\",\n            \"default_strategy\": false,\n            \"active\": true,\n            \"create_date\": \"2018-02-07 13:43:37\",\n            \"update_date\": \"2018-02-07 13:43:37\",\n            \"targeting_modules\": {\n                \"content\": {\n                    \"targeting_name\": \"Content\",\n                    \"targeting_description\": \"Allows targeting by IAB category\",\n                    \"viewable\": true,\n                    \"targeting_verbs\": [\n                        \"include\",\n                        \"exclude\"\n                    ]\n                },\n                \"domain\": {\n                    \"targeting_name\": \"Domain\",\n                    \"targeting_description\": \"Allows targeting by a List of Domains or URLS associated with this Account\",\n                    \"viewable\": true,\n                    \"targeting_verbs\": [\n                        \"include\",\n                        \"exclude\"\n                    ]\n                },\n                \"geo\": {\n                    \"targeting_name\": \"Geo\",\n                    \"targeting_description\": \"Allows targeting by country, state, zip, postal code, DMA, and bandiwidth\",\n                    \"viewable\": true,\n                    \"targeting_verbs\": [\n                        \"include\",\n                        \"exclude\"\n                    ]\n                },\n                \"inventory\": {\n                    \"targeting_name\": \"Inventory\",\n                    \"targeting_description\": \"Allows targeting by source, site, publisher, etc\",\n                    \"viewable\": true,\n                    \"targeting_verbs\": [\n                        \"include\",\n                        \"exclude\"\n                    ]\n                },\n                \"ip_address\": {\n                    \"targeting_name\": \"IP Address\",\n                    \"targeting_description\": \"Allows targeting by individual IP address and ranges of IP addresses\",\n                    \"viewable\": true,\n                    \"targeting_verbs\": [\n                        \"include\",\n                        \"exclude\",\n                        \"include_range\",\n                        \"exclude_range\",\n                        \"boolean\"\n                    ]\n                },\n                \"mobile_app\": {\n                    \"targeting_name\": \"Mobile App\",\n                    \"targeting_description\": \"Targeting by mobile app, app category\",\n                    \"viewable\": true,\n                    \"targeting_verbs\": [\n                        \"include\",\n                        \"exclude\"\n                    ]\n                },\n                \"platform\": {\n                    \"targeting_name\": \"Platform\",\n                    \"targeting_description\": \"Allows targeting by browser, OS, etc\",\n                    \"viewable\": true,\n                    \"targeting_verbs\": [\n                        \"include\",\n                        \"exclude\"\n                    ]\n                },\n                \"segment\": {\n                    \"targeting_name\": \"Segment\",\n                    \"targeting_description\": \"Allows targeting by segments associated with this Account\",\n                    \"viewable\": true,\n                    \"targeting_verbs\": [\n                        \"include\",\n                        \"exclude\",\n                        \"boolean\",\n                        \"require\"\n                    ]\n                },\n                \"time\": {\n                    \"targeting_name\": \"Time\",\n                    \"targeting_description\": \"Allows targeting by day of week and time of day\",\n                    \"viewable\": true,\n                    \"targeting_verbs\": [\n                        \"include_range\",\n                        \"exclude_range\",\n                        \"boolean\"\n                    ]\n                }\n            }\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"strategy_id":{"type":"integer","example":1,"default":0},"line_item_type_id":{"type":"integer","example":0,"default":0},"strategy_name":{"type":"string","example":"System"},"strategy_description":{"type":"string","example":"Banner stategy"},"default_strategy":{"type":"boolean","example":false,"default":true},"active":{"type":"boolean","example":true,"default":true},"create_date":{"type":"string","example":"2018-02-07 13:43:37"},"update_date":{"type":"string","example":"2018-02-07 13:43:37"},"targeting_modules":{"type":"object","properties":{"content":{"type":"object","properties":{"targeting_name":{"type":"string","example":"Content"},"targeting_description":{"type":"string","example":"Allows targeting by IAB category"},"viewable":{"type":"boolean","example":true,"default":true},"targeting_verbs":{"type":"array","items":{"type":"string","example":"include"}}}},"domain":{"type":"object","properties":{"targeting_name":{"type":"string","example":"Domain"},"targeting_description":{"type":"string","example":"Allows targeting by a List of Domains or URLS associated with this Account"},"viewable":{"type":"boolean","example":true,"default":true},"targeting_verbs":{"type":"array","items":{"type":"string","example":"include"}}}},"geo":{"type":"object","properties":{"targeting_name":{"type":"string","example":"Geo"},"targeting_description":{"type":"string","example":"Allows targeting by country, state, zip, postal code, DMA, and bandiwidth"},"viewable":{"type":"boolean","example":true,"default":true},"targeting_verbs":{"type":"array","items":{"type":"string","example":"include"}}}},"inventory":{"type":"object","properties":{"targeting_name":{"type":"string","example":"Inventory"},"targeting_description":{"type":"string","example":"Allows targeting by source, site, publisher, etc"},"viewable":{"type":"boolean","example":true,"default":true},"targeting_verbs":{"type":"array","items":{"type":"string","example":"include"}}}},"ip_address":{"type":"object","properties":{"targeting_name":{"type":"string","example":"IP Address"},"targeting_description":{"type":"string","example":"Allows targeting by individual IP address and ranges of IP addresses"},"viewable":{"type":"boolean","example":true,"default":true},"targeting_verbs":{"type":"array","items":{"type":"string","example":"include"}}}},"mobile_app":{"type":"object","properties":{"targeting_name":{"type":"string","example":"Mobile App"},"targeting_description":{"type":"string","example":"Targeting by mobile app, app category"},"viewable":{"type":"boolean","example":true,"default":true},"targeting_verbs":{"type":"array","items":{"type":"string","example":"include"}}}},"platform":{"type":"object","properties":{"targeting_name":{"type":"string","example":"Platform"},"targeting_description":{"type":"string","example":"Allows targeting by browser, OS, etc"},"viewable":{"type":"boolean","example":true,"default":true},"targeting_verbs":{"type":"array","items":{"type":"string","example":"include"}}}},"segment":{"type":"object","properties":{"targeting_name":{"type":"string","example":"Segment"},"targeting_description":{"type":"string","example":"Allows targeting by segments associated with this Account"},"viewable":{"type":"boolean","example":true,"default":true},"targeting_verbs":{"type":"array","items":{"type":"string","example":"include"}}}},"time":{"type":"object","properties":{"targeting_name":{"type":"string","example":"Time"},"targeting_description":{"type":"string","example":"Allows targeting by day of week and time of day"},"viewable":{"type":"boolean","example":true,"default":true},"targeting_verbs":{"type":"array","items":{"type":"string","example":"include_range"}}}}}}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/strategy\" -b cookies.txt -d '{\"strategy_id\":1,\"active\":0}'"}],"samples-languages":["curl"]}}},"/targeting_template":{"delete":{"summary":"targeting_template","description":"","operationId":"targeting_template-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["targeting_template_id"],"properties":{"targeting_template_id":{"type":"integer","description":"Unique ID of the targeting_template","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"targeting_template deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"targeting_template deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/targeting_template\" -b cookies.txt -d '{\"targeting_template_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"targeting_template","description":"","operationId":"targeting_template-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"template_name":{"type":"string","description":"Name of the template. <100 chars"},"strategy_id":{"type":"integer","description":"Unique ID of the Strategy.","format":"int32"},"targeting":{"type":"array","description":"JSON representation of the targeting keys and values. See guide for more details."},"alternative_id":{"type":"string","description":"Alternative ID","default":"0"},"active":{"type":"boolean","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"targeting_template created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"targeting_template created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/targeting_template\" -b cookies.txt -d '{\"template_name\":\"new template\",\"strategy_id\":1,\"active\":1,\"targeting\":{\"time\":[{\"exclude_range\":{\"time_of_week\":[[100,200]]}}]}}'"}],"samples-languages":["curl"]}},"get":{"summary":"targeting_template","description":"","operationId":"targeting_template-get","parameters":[{"name":"targeting_template_id","in":"query","description":"Unique ID of the Targeting Template","schema":{"type":"integer","format":"int32"}},{"name":"template_name","in":"query","description":"Name of the template. <100 chars","schema":{"type":"string"}},{"name":"alternative_id","in":"query","description":"The alternative_id","schema":{"type":"string","default":"0"}},{"name":"strategy_id","in":"query","description":"Unique ID of the Strategy.","schema":{"type":"integer","format":"int32"}},{"name":"active","in":"query","schema":{"type":"boolean","default":false}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"targeting_template_id\": 1,\n            \"strategy_id\": 1,\n            \"template_name\": \"Line Item 1\",\n            \"targeting\": {\n                \"content\": [\n                    {\n                        \"include\": {\n                            \"content_category\": [\n                                \"IAB11\",\n                                \"IAB11_5\"\n                            ]\n                        }\n                    }\n                ]\n            },\n            \"alt_targeting\": {\n                \"content\": [\n                    {\n                        \"include\": {\n                            \"content_category\": [\n                                \"IAB11\",\n                                \"IAB11_5\"\n                            ]\n                        }\n                    }\n                ]\n            },\n            \"push_status\": 0,\n            \"push_update\": true,\n            \"account_id\": 1,\n            \"create_date\": \"2015-07-22 14:44:03\",\n            \"update_date\": \"2015-07-29 13:26:45\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"targeting_template_id":{"type":"integer","example":1,"default":0},"strategy_id":{"type":"integer","example":1,"default":0},"template_name":{"type":"string","example":"Line Item 1"},"targeting":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","properties":{"include":{"type":"object","properties":{"content_category":{"type":"array","items":{"type":"string","example":"IAB11"}}}}}}}}},"alt_targeting":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","properties":{"include":{"type":"object","properties":{"content_category":{"type":"array","items":{"type":"string","example":"IAB11"}}}}}}}}},"push_status":{"type":"integer","example":0,"default":0},"push_update":{"type":"boolean","example":true,"default":true},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2015-07-22 14:44:03"},"update_date":{"type":"string","example":"2015-07-29 13:26:45"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/targeting_template\" -b cookies.txt -d '{\"targeting_template_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"targeting_template","description":"","operationId":"targeting_template-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["targeting_template_id"],"properties":{"targeting_template_id":{"type":"integer","description":"Unique ID of the Targeting Template","format":"int32"},"template_name":{"type":"string","description":"Name of the template. <100 chars"},"strategy_id":{"type":"integer","description":"Unique ID of the Strategy.","format":"int32"},"targeting":{"type":"array","description":"JSON representation of the targeting keys and values. See documentation for more details."},"alternative_id":{"type":"string","description":"The alternative_id","default":"0"},"active":{"type":"boolean","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"targeting_template updated with ID 1\"\n        }\n    ],\n    \"message\": \"targeting_template update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"targeting_template updated with ID 1"}}}},"message":{"type":"string","example":"targeting_template update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/targeting_template\" -b cookies.txt -d '{\"targeting_template_id\":1, \"template_name\":\"new template\",\"strategy_id\":1,\"active\":1,\"targeting\":{\"time\":[{\"exclude_range\":{\"time_of_week\":[[100,200]]}}]}}'"}],"samples-languages":["curl"]}}},"/user":{"get":{"summary":"user","description":"","operationId":"user-get","parameters":[{"name":"user_id","in":"query","description":"Unique ID for the User","schema":{"type":"integer","format":"int32"}},{"name":"email","in":"query","description":"Must be a valid email, and must be unique per Buzz instance","schema":{"type":"string"}},{"name":"first_name","in":"query","description":"<20 chars","schema":{"type":"string"}},{"name":"last_name","in":"query","description":"<20 chars","schema":{"type":"string"}},{"name":"role_id","in":"query","description":"Role be valid and Active.","schema":{"type":"integer","format":"int32"}},{"name":"active","in":"query","description":"Is the User active?","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"user_id\": 2,\n            \"super_user\": true,\n            \"multi_account\": false,\n            \"email\": \"foo@info.com\",\n            \"login_token\": null,\n            \"first_name\": \"beeswax\",\n            \"last_name\": \"drone\",\n            \"role_id\": 6,\n            \"send_product_comms\": true,\n            \"password\": \"sha256:1000:QfUvhXIfZtOEnTsdssdsdsdCwZbgw:CAkCxTcgEGMQbnasaaasaWV7ABV1VS\",\n            \"account_id\": 1,\n            \"create_date\": null,\n            \"update_date\": \"2015-08-31 14:54:42\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"integer","example":2,"default":0},"super_user":{"type":"boolean","example":true,"default":true},"multi_account":{"type":"boolean","example":false,"default":true},"email":{"type":"string","example":"foo@info.com"},"login_token":{},"first_name":{"type":"string","example":"beeswax"},"last_name":{"type":"string","example":"drone"},"role_id":{"type":"integer","example":6,"default":0},"send_product_comms":{"type":"boolean","example":true,"default":true},"password":{"type":"string","example":"sha256:1000:QfUvhXIfZtOEnTsdssdsdsdCwZbgw:CAkCxTcgEGMQbnasaaasaWV7ABV1VS"},"account_id":{"type":"integer","example":1,"default":0},"create_date":{},"update_date":{"type":"string","example":"2015-08-31 14:54:42"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/user\" -b cookies.txt -d '{\"user_id\":1}'"}],"samples-languages":["curl"]}},"delete":{"summary":"user","description":"","operationId":"user-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"integer","description":"Unique ID of the User","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"user deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"user deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/user\" -b cookies.txt -d '{\"user_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"user","description":"","operationId":"user-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","first_name","last_name","role_id"],"properties":{"email":{"type":"string","description":"Must be a valid email, and must be unique per Buzz instance"},"first_name":{"type":"string","description":"<20 chars"},"last_name":{"type":"string","description":"<20 chars"},"role_id":{"type":"integer","description":"Role must be valid and Active.","format":"int32"},"notes":{"type":"string","description":"Any notes about the user"},"active":{"type":"boolean","description":"Is the User active? Cannot be set to 1 on POST unless you are a Super User.","default":false},"super_user":{"type":"boolean","description":"Is the user a Super User. Only Super Users can create other Super Users.","default":false},"multi_account":{"type":"boolean","description":"Is the user allowed to work across Accounts. Must be enabled on the Buzz instance. Only Super Users or other Multi Account users can set to true.","default":false},"send_product_comms":{"type":"boolean","description":"Should this user get product updates from Beeswax","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"user created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"user created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/user\" -b cookies.txt -d '{\"email\":\"foo@bar.com\", \"role_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"user","description":"","operationId":"user-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["user_id","first_name","last_name"],"properties":{"user_id":{"type":"integer","description":"Unique ID for the User","format":"int32"},"email":{"type":"string","description":"Must be a valid email, and must be unique per Buzz instance"},"first_name":{"type":"string","description":"<20 chars"},"last_name":{"type":"string","description":"<20 chars"},"role_id":{"type":"integer","description":"Role be valid and Active.","format":"int32"},"notes":{"type":"string","description":"Any notes about the user"},"active":{"type":"boolean","description":"Is the User active?","default":false},"super_user":{"type":"boolean","description":"Is the user a Super User. Only Super Users can create other Super Users.","default":false},"multi_account":{"type":"boolean","description":"Is the user allowed to work across Accounts. Must be enabled on the Buzz instance. Only other Super Users or Multi-Account Users may set.","default":false},"send_product_comms":{"type":"boolean","description":"Should this user get product updates from Beeswax","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"user updated with ID 1\"\n        }\n    ],\n    \"message\": \"user update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"user updated with ID 1"}}}},"message":{"type":"string","example":"user update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/user\" -b cookies.txt -d '{\"user_id\":1,\"email\":\"foo@bar.com\", \"role_id\":1}'"}],"samples-languages":["curl"]}}},"/user_lookup":{"get":{"summary":"user_lookup","description":"Allows you to GET key data about the current User (e.g. the User making the request).","operationId":"user_lookup","deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/user_lookup\" -b cookies.txt -d '{}'"}],"samples-languages":["curl"]}}},"/vendor":{"delete":{"summary":"vendor","description":"","operationId":"vendor-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["vendor_id"],"properties":{"vendor_id":{"type":"integer","description":"Unique ID of the Vendor","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"vendor deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"vendor deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/vendor\" -b cookies.txt -d '{\"vendor_id\":1}'"}],"samples-languages":["curl"]}},"get":{"summary":"vendor","description":"","operationId":"vendor-get","parameters":[{"name":"vendor_id","in":"query","description":"Unique ID for the vendor","schema":{"type":"integer","format":"int32"}},{"name":"vendor_name","in":"query","description":"Name of the vendors","schema":{"type":"string"}},{"name":"global","in":"query","description":"Is the Vendor global, meaning it is available to all Accounts on the system.","schema":{"type":"boolean","default":false}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"vendor_id\": 1,\n            \"vendor_name\": \"test vendor\",\n            \"fee_type\": null,\n            \"fee_amount\": null,\n            \"currency\": \"CAD\",\n            \"global\": false,\n            \"account_id\": 1,\n            \"create_date\": \"2015-11-16 18:57:32\",\n            \"update_date\": \"2015-11-16 18:57:32\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"vendor_id":{"type":"integer","example":1,"default":0},"vendor_name":{"type":"string","example":"test vendor"},"fee_type":{},"fee_amount":{},"currency":{"type":"string","example":"CAD"},"global":{"type":"boolean","example":false,"default":true},"account_id":{"type":"integer","example":1,"default":0},"create_date":{"type":"string","example":"2015-11-16 18:57:32"},"update_date":{"type":"string","example":"2015-11-16 18:57:32"},"alternative_id":{},"notes":{},"active":{"type":"boolean","example":true,"default":true},"buzz_key":{"type":"string","example":"stingersbx"}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/vendor\" -b cookies.txt -d '{\"vendor_id\":1}'"}],"samples-languages":["curl"]}},"put":{"summary":"vendor","description":"","operationId":"vendor-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["vendor_id"],"properties":{"vendor_id":{"type":"integer","description":"Unique ID for the vendor","format":"int32"},"vendor_name":{"type":"string","description":"Name of the vendor, <100 characters"},"fee_type":{"type":"string","description":"Type of fee, either `cpm` or `percent`"},"fee_amount":{"type":"number","description":"Default charge for this vendor. If the `fee_type` is set, the fee_amount must be set as well. Must be a positive number between 0 and 99.9.","format":"double"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"event updated with ID 1\"\n        }\n    ],\n    \"message\": \"event update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"event updated with ID 1"}}}},"message":{"type":"string","example":"event update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/vendor\" -b cookies.txt -d '{\"vendor_id\":1,\"vendor_name\":\"Beeswax\", \"fee_type\":\"cpm\", \"fee_amount\":1.23, \"global\":false}'"}],"samples-languages":["curl"]}},"post":{"summary":"vendor","description":"","operationId":"vendor-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["vendor_name"],"properties":{"vendor_name":{"type":"string","description":"Name of the vendor, <100 characters"},"fee_type":{"type":"string","description":"Type of fee, either `cpm` or `percent`"},"fee_amount":{"type":"number","description":"Default charge for this vendor. If the `fee_type` is set, the fee_amount must be set as well. Must be a positive number between 0 and 99.9.","format":"double"},"currency":{"type":"string","description":"Currency in which this vendor charges the fees.","default":"USD"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"vendor created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"vendor created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/vendor\" -b cookies.txt -d '{\"vendor_name\":\"Beeswax\", \"fee_type\":\"cpm\", \"fee_amount\":1.23, \"global\":false, \"currency\":\"CAD\"}'"}],"samples-languages":["curl"]}}},"/vendor_fee":{"get":{"summary":"vendor_fee","description":"","operationId":"vendor_fee-get","parameters":[{"name":"vendor_fee_id","in":"query","description":"Unique ID of the Vendor Fee","schema":{"type":"integer","format":"int32"}},{"name":"vendor_id","in":"query","description":"Unique ID of the Vendor","schema":{"type":"integer","format":"int32"}},{"name":"vendor_fee_name","in":"query","description":"Name of the vendor fee, <100 characters","schema":{"type":"string"}},{"name":"object_id","in":"query","description":"Unique ID for the object to be associated with this fee","schema":{"type":"integer","format":"int32"}},{"name":"object_type","in":"query","description":"String representation of the object to be associated. For example, \"campaign\"","schema":{"type":"string"}},{"name":"create_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"update_date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"vendor_fee_id\": 5,\n            \"vendor_id\": 1,\n            \"vendor_fee_name\": null,\n            \"object_id\": 1,\n            \"object_type\": \"campaign\",\n            \"fee_type\": \"cpm\",\n            \"fee_amount\": 1,\n            \"currency\": \"USD\",\n            \"account_id\": 1,\n            \"create_date\": \"2016-03-30 15:25:00\",\n            \"update_date\": \"2016-03-30 15:25:00\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stingersbx\"\n        }\n    ],\n}"}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/vendor_fee\" -b cookies.txt -d '{\"vendor_fee_id\":1}'"}],"samples-languages":["curl"]}},"delete":{"summary":"vendor_fee","description":"","operationId":"vendor_fee-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["vendor_fee_id"],"properties":{"vendor_fee_id":{"type":"integer","description":"Unique ID of the Vendor Fee","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"vendor_fee deleted with ID 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"vendor_fee deleted with ID 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X DELETE \"[host]/rest/vendor_fee\" -b cookies.txt -d '{\"vendor_fee_id\":1}'"}],"samples-languages":["curl"]}},"post":{"summary":"vendor_fee","description":"","operationId":"vendor_fee-post","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["vendor_id","object_id","object_type"],"properties":{"vendor_id":{"type":"integer","description":"Unique ID of the Vendor","format":"int32"},"vendor_fee_name":{"type":"string","description":"Name of the vendor fee, <100 characters"},"object_id":{"type":"integer","description":"Unique ID for the object to be associated with this fee","format":"int32"},"object_type":{"type":"string","description":"String representation of the object to be associated. For example, \"campaign\""},"fee_type":{"type":"string","description":"Type of fee, either `cpm` or `percent`"},"fee_amount":{"type":"number","description":"If the `fee_type` is set, the `fee_amount` must be set as well. Must be a positive number between 0 and 99.9.","format":"double"},"currency":{"type":"string","description":"Currency in which this fee should be charged. Can be different from Vendor, but will throw a WARNING.","default":"USD"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"vendor_fee created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"vendor_fee created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \"[host]/rest/vendor_fee\" -b cookies.txt -d '{\"vendor_id\":1, \"vendor_fee_name\":\"Beeswax Serving Fee\", \"fee_type\":\"cpm\", \"fee_amount\":12.25, \"object_id\":1, \"object_type\":\"campaign\"}'"}],"samples-languages":["curl"]}},"put":{"summary":"vendor_fee","description":"","operationId":"vendor_fee-put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["vendor_fee_Id"],"properties":{"vendor_fee_Id":{"type":"string","description":"Unique ID of the Vendor Fee"},"vendor_fee_name":{"type":"string","description":"Name of the vendor fee, <100 characters"},"fee_type":{"type":"string","description":"Type of fee, either `cpm` or `percent`"},"fee_amount":{"type":"number","description":"If the `fee_type` is set, the `fee_amount` must be set as well. Must be a positive number between 0 and 99.9.","format":"double"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"id\": 1,\n            \"success\": true,\n            \"message\": \"vendor_fee updated with ID 1\"\n        }\n    ],\n    \"message\": \"vendor_fee update: 1 updated successfully\"\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"vendor_fee updated with ID 1"}}}},"message":{"type":"string","example":"vendor_fee update: 1 updated successfully"}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X PUT \"[host]/rest/vendor_fee\" -b cookies.txt -d '{\"vendor_fee_id\":1, \"vendor_fee_name\":\"Beeswax Serving Fee\", \"fee_type\":\"cpm\", \"fee_amount\":12.25}'"}],"samples-languages":["curl"]}}},"/video_asset":{"post":{"summary":"video_asset","description":"","operationId":"video_asset","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["advertiser_id","creative_asset_name","size_in_bytes","video_encoding_profile","active"],"properties":{"advertiser_id":{"type":"integer","description":"Advertiser that owns the asset","format":"int32"},"creative_asset_name":{"type":"string","description":"Name of the Creative Asset, e.g. \"Blue Banner Ad\""},"size_in_bytes":{"type":"integer","description":"Number of bytes","default":0,"format":"int32"},"video_encoding_profile":{"type":"string","description":"Determines which formats and bitrates for transcoding. Options are `default`, `HD - Constant Bitrate`, and `HD - Variable Bitrate`.","default":"default"},"notes":{"type":"string","description":"Notes about the Creative Asset, up to 255 chars"},"active":{"type":"boolean","description":"Is it active?","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"message\": \"video_asset created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"message":{"type":"string","example":"video_asset created with ID = 1"},"payload":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"#Step 1, create the asset using POST\ncurl -X POST \"[host]/rest/video_asset\" -b cookies.txt -d '{\"creative_asset_name\":\"video.mp4\", \"size_in_bytes\":200500, \"advertiser_id\":1}'\n\n#Step 2, upload the file using the /upload/ID method \ncurl -X POST -F \"creative_content=@video.mp4\" \"[host]/rest/video_asset/upload/5\" -b cookies.txt"}],"samples-languages":["curl"]}}},"/view":{"get":{"summary":"view","description":"","operationId":"view-get","parameters":[{"name":"view_name","in":"query","description":"The view name.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"line_item_type_id\": 0,\n            \"line_item_type\": \"banner\",\n            \"sizeless\": false,\n            \"pixel_size\": 1\n        },\n        {\n            \"line_item_type_id\": 1,\n            \"line_item_type\": \"video\",\n            \"sizeless\": false,\n            \"pixel_size\": -1\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"line_item_type_id":{"type":"integer","example":0,"default":0},"line_item_type":{"type":"string","example":"banner"},"sizeless":{"type":"boolean","example":false,"default":true},"pixel_size":{"type":"integer","example":1,"default":0}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/view\" -b cookies.txt -d '{\"view_name\":\"line_item_types\"}'\n# You can also query field values\ncurl -X GET \"[host]/rest/view\" -b cookies.txt -d  '{\"view_name\":\"cities\",\"city_name\":\"Newark\"}'"}],"samples-languages":["curl"]}}},"/view_list":{"get":{"summary":"view_list","description":"The View List API method allows you to GET metadata about how a View and the fields within that View should be displayed in a UI. There is no write API for this data, it must be manually populated in SQL by an administrator. The primary use case for this API call is to display the data from a view in a user interface. Only GET requests are supported.","operationId":"view_list","parameters":[{"name":"view_name","in":"query","description":"The view's name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"text/plain":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"view_name\": \"line_item_types\",\n            \"object_type\": \"static\",\n            \"table_name\": \"line_item_types\",\n            \"primary_view\": true,\n            \"allow_writes\": false,\n            \"fields\": [\n                {\n                    \"view_name\": \"line_item_types\",\n                    \"field\": \"line_item_type_id\",\n                    \"field_order\": 1,\n                    \"field_name\": \"Line Item Type ID\",\n                    \"field_hint\": null,\n                    \"format\": null,\n                    \"link\": null,\n                    \"search_type\": \"int\",\n                    \"field_width\": null\n                },\n                {\n                    \"view_name\": \"line_item_types\",\n                    \"field\": \"line_item_type\",\n                    \"field_order\": 2,\n                    \"field_name\": \"Line Item Type\",\n                    \"field_hint\": null,\n                    \"format\": null,\n                    \"link\": null,\n                    \"search_type\": \"string\",\n                    \"field_width\": null\n                },\n                {\n                    \"view_name\": \"line_item_types\",\n                    \"field\": \"sizeless\",\n                    \"field_order\": 3,\n                    \"field_name\": null,\n                    \"field_hint\": null,\n                    \"format\": null,\n                    \"link\": null,\n                    \"search_type\": \"boolean\",\n                    \"field_width\": null\n                },\n                {\n                    \"view_name\": \"line_item_types\",\n                    \"field\": \"pixel_size\",\n                    \"field_order\": 4,\n                    \"field_name\": null,\n                    \"field_hint\": null,\n                    \"format\": null,\n                    \"link\": null,\n                    \"search_type\": \"int\",\n                    \"field_width\": null\n                }\n            ]\n        }\n    ]\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"payload":{"type":"array","items":{"type":"object","properties":{"view_name":{"type":"string","example":"line_item_types"},"object_type":{"type":"string","example":"static"},"table_name":{"type":"string","example":"line_item_types"},"primary_view":{"type":"boolean","example":true,"default":true},"allow_writes":{"type":"boolean","example":false,"default":true},"fields":{"type":"array","items":{"type":"object","properties":{"view_name":{"type":"string","example":"line_item_types"},"field":{"type":"string","example":"line_item_type_id"},"field_order":{"type":"integer","example":1,"default":0},"field_name":{"type":"string","example":"Line Item Type ID"},"field_hint":{},"format":{},"link":{},"search_type":{"type":"string","example":"int"},"field_width":{}}}}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl -X GET \"[host]/rest/view_list\" -b cookies.txt -d '{\"view_name\":\"line_item_type\"}'"}],"samples-languages":["curl"]}}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":true},"x-readme-fauxas":true}