{ "openapi": "3.0.0", "info": { "title": "AdButler API", "description": "# Introduction\nAdButler is designed to provide either the Publisher, Advertiser, or an Ad Network the ability to schedule and rotate ads with relevant targeting. AdButler is a powerful tool that ensures your ads are consistent, specific, and fast. It's easy to get started using the AdButler API because it is based on predictable, resource-oriented URLs. All API responses, including errors, return standard JSON. All errors are semantically mapped to HTTP response codes.\n\nYou are encouraged to explore the API during the development phase using the test mode API keys. Requests made with test mode credentials never use our ad serving infrastructure and, therefore, incur no cost. Once your product is ready for launch, just swap the test mode API key with the live mode API key. You cannot switch between key modes, just use the appropriate key.\n\n# What's New in Version 2.0\nBefore we go any further, we should say that none of these new changes will apply to the `/v1/` endpoints. Version 1 of the AdButler API is, and will stay, the same as it was in March of 2019. You can see the documentation of version 1 [here](https://www.adbutler.com/docs/api/v1/#api-reference); However, the v1 documentation will no longer be updated.\n\n## Terminology Changes\n\nWe’re making some important updates to the wording we use for key features and functions in the AdButler app and API.\n\nEvery type of ad or response that is serving to a zone will be called an “ad item”. This term will be used to represent all forms of display ads, VAST video ads, custom data responses, or programmatic 3rd party bid requests. See the table below for a complete outline of the changes being made.\n\n| V1 Endpoint | V2 Endpoint | Details |\n|---------------------|-----------------------|--------------------------------------------------------------------------------------------|\n| `/banners` | `/ad-items` | `/banners/image` is now `/ad-items/image`. The same goes for all of the types of ad-items. |\n| `/campaigns/banner` | `/campaigns/standard` | The object returned has also changed from `banner_campaign` to `standard_campaign` |\n| `/zones/banner` | `/zones/standard` | The object returned has also changed from `banner_zone` to `standard_zone` |\n| `/vast-banners` | `/vast-ad-items` | The object returned has also changed from `vast_banner` to `vast_ad_item` |\n\n# Rate Limits\nTo protect the stability and reliability of the API, rate limits are enforced on all endpoints. If you exceed the allowed number of requests, the API will return an HTTP `429 Too Many Requests` response.\n\nRate limits are applied per account on a per-minute basis:\n\n| Endpoint Group | Endpoints | Limit |\n|---|---|---|\n| Reporting | `/v2/reports`, `/v2/custom-reports`, `/v2/vast-reports`, `/v2/vast-custom-reports` | 60 requests / minute |\n| General | All other endpoints | 600 requests / minute |\n\nWhen you receive a `429` response, wait before retrying the request.", "contact": { "name": "AdButler Support", "email": "support@adbutler.com" }, "version": "2.0", "x-logo": { "url": "assets/images/logo.svg" } }, "servers": [ { "url": "https://api.adbutler.com/v2" } ], "paths": { "/ad-items": { "get": { "tags": [ "Ad Items (All)" ], "summary": "Get a List of All Ad Items", "description": "You can retrieve a list of all the ad items regardless of their type. You can use the `fields` query parameter to restrict the types of fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_list" } } } } } } }, "/ad-items/image/{ad_item_id}/companions/products": { "get": { "tags": [ "Ad Items / Companion Products" ], "summary": "Get a List of Companion Products for an Image Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_list" } } } } } }, "post": { "tags": [ "Ad Items / Companion Products" ], "summary": "Create a Companion Product for an Image Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_get" } } } } } } }, "/ad-items/image/{ad_item_id}/companions/products/{id}": { "get": { "tags": [ "Ad Items / Companion Products" ], "summary": "Get a Companion Product for an Image Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the companion product.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Ad Items / Companion Products" ], "summary": "Update a Companion Product for an Image Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the companion product.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Ad Items / Companion Products" ], "summary": "Delete a Companion Product for an Image Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the companion product.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/ad-items/native/{ad_item_id}/companions/products": { "get": { "tags": [ "Ad Items / Companion Products" ], "summary": "Get a List of Companion Products for a Native Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_list" } } } } } }, "post": { "tags": [ "Ad Items / Companion Products" ], "summary": "Create a Companion Product for a Native Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_get" } } } } } } }, "/ad-items/native/{ad_item_id}/companions/products/{id}": { "get": { "tags": [ "Ad Items / Companion Products" ], "summary": "Get a Companion Product for a Native Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the companion product.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Ad Items / Companion Products" ], "summary": "Update a Companion Product for a Native Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the companion product.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ad_item_companion_product_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Ad Items / Companion Products" ], "summary": "Delete a Companion Product for a Native Ad Item", "parameters": [ { "name": "ad_item_id", "in": "path", "description": "Identifier of the ad item.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the companion product.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/ad-items/custom-html": { "get": { "tags": [ "Ad Items / Custom HTML" ], "summary": "Get a List of Custom HTML Ad Items", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_html_ad_item_list" } } } } } }, "post": { "tags": [ "Ad Items / Custom HTML" ], "summary": "Create a Custom HTML Ad Item", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_html_ad_item_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_html_ad_item_get" } } } } } } }, "/ad-items/custom-html/{id}": { "get": { "tags": [ "Ad Items / Custom HTML" ], "summary": "Get a Single Custom HTML Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_html_ad_item_get" } } } } } }, "put": { "tags": [ "Ad Items / Custom HTML" ], "summary": "Update a Custom HTML Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_html_ad_item_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_html_ad_item_get" } } } } } }, "delete": { "tags": [ "Ad Items / Custom HTML" ], "summary": "Delete a Custom HTML Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/ad-items/custom-html/{id}/conversion-tag": { "get": { "tags": [ "Ad Items / Custom HTML" ], "summary": "Get Conversion Tag for Custom HTML Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to get a conversion tag for.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_html_ad_item_conversion_tag" } } } } } } }, "/ad-items/image": { "get": { "tags": [ "Ad Items / Image" ], "summary": "Get a List of Image Ad Items", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_ad_item_list" } } } } } }, "post": { "tags": [ "Ad Items / Image" ], "summary": "Create an Image Ad Item", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_ad_item_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_ad_item_get" } } } } } } }, "/ad-items/image/{id}": { "get": { "tags": [ "Ad Items / Image" ], "summary": "Get a Single Image Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_ad_item_get" } } } } } }, "put": { "tags": [ "Ad Items / Image" ], "summary": "Update an Image Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_ad_item_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_ad_item_get" } } } } } }, "delete": { "tags": [ "Ad Items / Image" ], "summary": "Delete an Image Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/ad-items/image/{id}/conversion-tag": { "get": { "tags": [ "Ad Items / Image" ], "summary": "Get Conversion Tag for Image Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to get a conversion tag for.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_ad_item_conversion_tag" } } } } } } }, "/ad-items/native": { "get": { "tags": [ "Ad Items / Native" ], "summary": "Get a List of Native Ad Items", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_ad_item_list" } } } } } }, "post": { "tags": [ "Ad Items / Native" ], "summary": "Create a Native Ad Item", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_ad_item_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_ad_item_get" } } } } } } }, "/ad-items/native/{id}": { "get": { "tags": [ "Ad Items / Native" ], "summary": "Get a Single Native Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_ad_item_get" } } } } } }, "put": { "tags": [ "Ad Items / Native" ], "summary": "Update a Native Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_ad_item_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_ad_item_get" } } } } } }, "delete": { "tags": [ "Ad Items / Native" ], "summary": "Delete an Native Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/ad-items/native/{id}/conversion-tag": { "get": { "tags": [ "Ad Items / Native" ], "summary": "Get Conversion Tag for Native Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to get a conversion tag for.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_ad_item_conversion_tag" } } } } } } }, "/ad-items/native/{id}/to-image": { "post": { "tags": [ "Ad Items / Native" ], "summary": "Convert Native Ad Item to Image", "description": "Schedules a task to convert a native ad item into an image creative. The generated image will be stored in the specified media group. Use the returned task URL to check the status of the conversion. **Note: This endpoint requires the Native Ad to Image feature to be enabled.**", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the native ad item to convert.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "media_group", "size" ], "properties": { "media_group": { "description": "The identifier (ID) of the media group to store the generated image in.", "type": "integer", "example": 87 }, "size": { "description": "The dimensions for the generated image in the format ``{width}x{height}``.", "type": "string", "example": "300x250" }, "name": { "description": "An optional name for the generated image. Maximum 255 characters.", "type": "string", "example": "Homepage Banner" } }, "type": "object" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "status": { "description": "The result of the scheduling request.", "type": "string", "example": "success" }, "task": { "description": "The identifier (ID) of the scheduled conversion task.", "type": "integer", "example": 456 }, "task_url": { "description": "The relative URL to check the status of the scheduled task.", "type": "string", "example": "/v2/scheduled-tasks/native-ad-to-image/456" } }, "type": "object" } }, "type": "object" } } } } } } }, "/ad-items/rich-media": { "get": { "tags": [ "Ad Items / Rich Media" ], "summary": "Get a List of Rich Media Ad Items", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rich_media_ad_item_list" } } } } } }, "post": { "tags": [ "Ad Items / Rich Media" ], "summary": "Create a Rich Media Ad Item", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rich_media_ad_item_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rich_media_ad_item_get" } } } } } } }, "/ad-items/rich-media/{id}": { "get": { "tags": [ "Ad Items / Rich Media" ], "summary": "Get a Single Rich Media Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rich_media_ad_item_get" } } } } } }, "put": { "tags": [ "Ad Items / Rich Media" ], "summary": "Update a Rich Media Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rich_media_ad_item_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rich_media_ad_item_get" } } } } } }, "delete": { "tags": [ "Ad Items / Rich Media" ], "summary": "Delete a Rich Media Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/ad-items/rich-media/{id}/conversion-tag": { "get": { "tags": [ "Ad Items / Rich Media" ], "summary": "Get Conversion Tag for Rich Media Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ad item you'd like to get a conversion tag for.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rich_media_ad_item_conversion_tag" } } } } } } }, "/adserve": { "get": { "tags": [ "AdServe" ], "summary": "Retrieve an ad", "description": "Developers can use this API to retrieve ads in JSON format.", "parameters": [ { "parameter": "adserve_id", "name": "ID", "in": "path", "description": "Your AdButler account ID.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "parameter": "adserve_set_id", "name": "setID", "in": "path", "description": "The **Zone** ID being requested.", "required": true, "schema": { "type": "integer" }, "example": "123456" }, { "parameter": "adserve_type", "name": "type", "in": "path", "description": "Has two possible values: **\"json\"** returns the most eligible ad, while **\"jsonr\"** returns a list of all eligible ads ordered from most to least eligible. \n \nFor more information, read [How to request for all eligible ads via API](https://www.adbutler.com/help/article/api-jsonr-all-ads).", "required": true, "schema": { "type": "string" }, "example": "json" }, { "parameter": "adserve_size", "name": "size", "in": "path", "description": "The ad size you expect to receive.", "schema": { "type": "string" }, "example": "300x200" }, { "parameter": "adserve_rf", "name": "rf", "in": "path", "description": "Pass this parameter `;rf=1` if you want to determine whether the ad has a destination URL to which the user will be redirected when the ad is clicked. If this parameter is present in the request, the response will contain the extra field `is_redirectable`.", "schema": { "type": "integer" }, "example": "1" }, { "parameter": "adserve_kw", "name": "kw", "in": "path", "description": "Required for **Keyword Targeting**. Allows you to pass keywords to AdButler, for use with keyword targeting. Pass a comma delimited string of keywords. For example `;kw=apples,pears`.", "schema": { "type": "string" }, "example": "apples,pears" }, { "parameter": "adserve_referrer", "name": "referrer", "in": "path", "description": "Required for **URL Targeting**. Our URL Targeting feature traditionally relies on the HTTP `referrer` header to know which page our ad requests were made on. However, if you're making server-side requests you can pass it to us directly in the ad request using the `;referrer=` parameter. The URL must be encoded when passing it in this way.", "schema": { "type": "string" }, "example": "https%3A%2F%2Fyoursite.com" }, { "parameter": "adserve_ip", "name": "ip", "in": "path", "description": "Required for **Geographic Targeting**. If you're doing server side ad requests, and you want to geographically target your campaigns, you can simply add the `ip=` query parameter into the request and provide the IPv4 address used for targeting.", "schema": { "type": "string" }, "example": "64.34.33.207" }, { "parameter": "adserve_ua", "name": "ua", "in": "path", "description": "Required for **Platform Targeting**. The user's User Agent string (URL encoded)", "schema": { "type": "string" }, "example": "Roku4640X%2FDVP-7.70%20(297.70E04154A)" }, { "parameter": "adserve_sw", "name": "sw", "in": "path", "description": "Required for **Platform Targeting**. The user's device's screen width.", "schema": { "type": "integer" }, "example": "1920" }, { "parameter": "adserve_sh", "name": "sh", "in": "path", "description": "Required for **Platform Targeting**. The user's device's screen height.", "schema": { "type": "integer" }, "example": "1080" }, { "parameter": "adserve_spr", "name": "spr", "in": "path", "description": "Required for **Platform Targeting**. The user's device's screen pixel ratio.", "schema": { "type": "integer" }, "example": "3" }, { "parameter": "adserve_pid", "name": "pid", "in": "path", "description": "Required for **Unique Delivery** or **Roadblocks**. The `pid` stands for **'pageID'** and is a random number that must be the same for any ad requested from the current page instance.", "schema": { "type": "integer" }, "example": "123456" }, { "parameter": "adserve_place", "name": "place", "in": "path", "description": "Required for **Unique Delivery**. Place represents the number of times a particular zone has been requested on a single page instance, this should be incremented each time the zone is re-requested. Starts from 0, 1, 2, and so on.", "schema": { "type": "integer" }, "example": "1" }, { "parameter": "_abdk", "name": "_abdk", "in": "path", "description": "When using **Data Keys**, use this parameter to pass in the key-value pairs.", "schema": { "type": "string" }, "example": "_abdk[bird]=duck;_abdk[bug]=ant" }, { "parameter": "defer_signing", "name": "defer_signing", "in": "path", "description": "When using **Beacon Signing Keys**, use this parameter to defer generating hashes and timestamps such that they can be signed later with a shared key.", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adserve_response_success" } } } } }, "security": [], "servers": [ { "url": "https://servedbyadbutler.com", "description": "AdButler's ad serving access URL." } ] }, "post": { "tags": [ "AdServe" ], "summary": "Retrieve an ad", "description": "Developers can use this API to retrieve ads in JSON format.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adserve_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adserve_response_success" } } } } }, "security": [], "servers": [ { "url": "https://servedbyadbutler.com", "description": "AdButler's ad serving access URL." } ] } }, "/advertisers": { "get": { "tags": [ "Advertisers" ], "summary": "Get a List of Advertisers", "description": "Returns a list of advertisers. If no advertisers were found, the data object will be empty. You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertiser_list" } } } } } }, "post": { "tags": [ "Advertisers" ], "summary": "Create an Advertiser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertiser_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertiser_get" } } } } } } }, "/advertisers/archived": { "get": { "tags": [ "Advertisers / Archived" ], "summary": "Get a List of Archived Advertisers", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_advertiser_list" } } } } } } }, "/advertisers/archived/{id}/unarchive": { "get": { "tags": [ "Advertisers / Archived" ], "summary": "Unarchive an Advertiser", "description": "Unarchives the resource and all resources that were previously archived with the resource.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the advertiser you'd like to unarchive", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "include_campaign_assignments", "in": "path", "description": "Whether or not to include related campaign assignments when unarchiving the resource. If an unarchived assignment references an invalid resource, the campaign assignment will not be unarchived and information about the invalid resource and references will be returned. The advertiser resource will still be unarchived.", "schema": { "type": "boolean" }, "example": false }, { "name": "include_placements", "in": "path", "description": "Whether or not to include related placements when unarchiving the resource. If an unarchived placement references an invalid resource, the placement will not be unarchived and information about the invalid resource and references will be returned. The advertiser resource will still be unarchived.", "schema": { "type": "boolean" }, "example": false } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unarchived_advertiser" } } } } } } }, "/advertisers/archived/{id}": { "get": { "tags": [ "Advertisers / Archived" ], "summary": "Get a Single Archived Advertiser", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the archived resource.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_advertiser_get" } } } } } } }, "/advertisers/{id}": { "get": { "tags": [ "Advertisers" ], "summary": "Get a Single Advertiser", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the advertiser you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertiser_get" } } } } } }, "put": { "tags": [ "Advertisers" ], "summary": "Update an Advertiser", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the advertiser you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertiser_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertiser_get" } } } } } }, "delete": { "tags": [ "Advertisers" ], "summary": "Delete an Advertiser", "description": "Permanently deletes an advertiser. __This operation cannot be undone__ so be very sure when deleting one. Successful deletion immediately stops serving any ads belonging to this advertiser and advertiser login will be disabled.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the advertiser you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/advertisers/{id}/archive": { "get": { "tags": [ "Advertisers" ], "summary": "Archive an Advertiser", "description": "Archives the resource and all direct descendants of this resource. Archived resources will be treated the same as deleted resources but can be restored through unarchiving.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the advertiser you'd like to archive.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_advertiser" } } } } } } }, "/beacon-signing-keys": { "get": { "tags": [ "Beacon Signing Keys" ], "summary": "Get a List of Keys", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/beacon_signing_keys_list" } } } } } }, "post": { "tags": [ "Beacon Signing Keys" ], "summary": "Create a beacon signing key", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/beacon_signing_keys_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/beacon_signing_keys_get" } } } } } } }, "/beacon-signing-keys/validate": { "post": { "tags": [ "Beacon Signing Keys" ], "summary": "Validation", "description": "Validation endpoint for testing a beacon URL that has been signed with a shared key.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/beacon_signing_keys_validation" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "$ref": "#/components/responses/request_parameter_error" } } } }, "/beacon-signing-keys/{id}": { "get": { "tags": [ "Beacon Signing Keys" ], "summary": "Get a single beacon signing key.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the beacon signing key you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/beacon_signing_keys_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Beacon Signing Keys" ], "summary": "Update a URL signing key", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the beacon signing key you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/beacon_signing_keys_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/beacon_signing_keys_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Beacon Signing Keys" ], "summary": "Delete a URL signing key.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the beacon signing key you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/bidders": { "get": { "tags": [ "Bidders" ], "summary": "Get a List of Bidders", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bidder_list" } } } } } }, "post": { "tags": [ "Bidders" ], "summary": "Create a Bidder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bidder_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bidder_get" } } } } } } }, "/bidders/{id}": { "get": { "tags": [ "Bidders" ], "summary": "Get a Single Bidder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the bidder you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bidder_get" } } } } } }, "put": { "tags": [ "Bidders" ], "summary": "Update a Bidder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the bidder you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bidder_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bidder_get" } } } } } }, "delete": { "tags": [ "Bidders" ], "summary": "Delete a Bidder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the bidder you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/campaigns": { "get": { "tags": [ "Campaigns (All)" ], "summary": "Get a List of All Campaigns", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "has_ad_items", "in": "query", "description": "When set to __true__, only campaigns with an existing campaign assignment will be returned.", "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/campaign_list" } } } } } } }, "/campaign-assignments": { "get": { "tags": [ "Campaign Assignments" ], "summary": "Get a list of Campaign Assignments", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaigns", "in": "query", "description": "Filter the campaign assignments by one or many campaign IDs.", "required": false, "schema": { "type": "string" }, "example": "958393,884973" }, { "name": "ad_items", "in": "query", "description": "Filter the campaign assignments by one or many ad item IDs.", "required": false, "schema": { "type": "string" }, "example": "10039387" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/campaign_assignment_list" } } } } } }, "post": { "tags": [ "Campaign Assignments" ], "summary": "Create a Campaign Assignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/campaign_assignment_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/campaign_assignment_get" } } } } } } }, "/campaign-assignments/{id}": { "get": { "tags": [ "Campaign Assignments" ], "summary": "Get a Single Campaign Assignment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the campaign assignment you want to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/campaign_assignment_get" } } } } } }, "put": { "tags": [ "Campaign Assignments" ], "summary": "Update a Campaign Assignment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the campaign assignmnet you want to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/campaign_assignment_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/campaign_assignment_get" } } } } } }, "delete": { "tags": [ "Campaign Assignments" ], "summary": "Delete a Campaign Assignment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the campaign assignment you want to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/campaigns/{id}/eligible-zones": { "get": { "tags": [ "Campaign Assignments" ], "summary": "Get eligible zones for a campaign", "description": "Returns zones that can be assigned to the given campaign. Each zone includes an `assigned` flag indicating whether the campaign is already assigned to that zone. Zones may be standard, email, or catalog.", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eligible_zone_list" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/campaigns/standard": { "get": { "tags": [ "Campaigns / Standard" ], "summary": "Get a List of Standard Campaigns", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "has_ad_items", "in": "query", "description": "When set to __true__, only campaigns with an existing campaign assignment will be returned.", "schema": { "type": "boolean" }, "example": false }, { "name": "advertiser", "in": "query", "description": "Filter the campaign list by one or many advertiser IDs.", "required": false, "schema": { "type": "string" }, "example": "56434,56001" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_campaign_list" } } } } } }, "post": { "tags": [ "Campaigns / Standard" ], "summary": "Create a Standard Campaign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_campaign" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_campaign_get" } } } } } } }, "/campaigns/standard/archived": { "get": { "tags": [ "Campaigns / Standard / Archived" ], "summary": "Get a List of Archived Standard Campaigns", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_standard_campaign_list" } } } } } } }, "/campaigns/standard/archived/{id}/unarchive": { "get": { "tags": [ "Campaigns / Standard / Archived" ], "summary": "Unarchive a Standard Campaign", "description": "Unarchives the resource and all resources that were previously archived with the resource.", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/unarchive_include_campaign_assignments" }, { "$ref": "#/components/parameters/unarchive_include_placements" }, { "$ref": "#/components/parameters/unarchive_pause_placements" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_campaign_unarchive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/campaigns/standard/archived/{id}": { "get": { "tags": [ "Campaigns / Standard / Archived" ], "summary": "Get an Archived Standard Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_standard_campaign_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Campaigns / Standard / Archived" ], "summary": "Delete an Archived Standard Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/campaigns/standard/{id}": { "get": { "tags": [ "Campaigns / Standard" ], "summary": "Get a Standard Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_campaign_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Campaigns / Standard" ], "summary": "Update a Standard Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_campaign" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_campaign_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Campaigns / Standard" ], "summary": "Delete a Standard Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/campaigns/standard/{id}/conversion-tag": { "get": { "tags": [ "Campaigns / Standard" ], "summary": "Retrieve Standard Campaign Conversion Tag", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversion_tag" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/campaigns/standard/{id}/archive": { "get": { "tags": [ "Campaigns / Standard" ], "summary": "Archive a Standard Campaign", "description": "Archives the resource and all direct descendants of this resource. Archived resources will be treated the same as deleted resources but can be restored through unarchiving.", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_campaign_archive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/campaigns/standard/{campaign_id}/catalog-ad-item-bulk-create": { "post": { "tags": [ "Ad Items / Catalog Item / Bulk" ], "summary": "Bulk Create Catalog Ad Items", "description": "Bulk creates catalog ad items and assigns them to a campaign. Catalog item identifiers must be unique within the campaign. You may not add the same catalog item more than once. Under the `created` field in the response will be a list of the ad item and campaign assignment resources which were created. The structure is generally represented as `ad item -> campaign assignment -> campaign`. For Product DB configurations, most of the fields won't be used, so the most notable fields are: ad_item.id - the unique id of the catalog ad item, ad_item.catalog_id - the catalog id for the product, ad_item.catalog_item_identifier - the identifier for a particular product, campaign_assignment.id - the unique id of the campaign assignment.", "parameters": [ { "name": "campaign_id", "in": "path", "description": "Identifier of the Standard Campaign.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_ad_item_bulk_create_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_ad_item_bulk_create_response" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "object": { "type": "string", "example": "error" }, "type": { "type": "string", "example": "ad_item_validation_error" }, "http_status": { "type": "integer", "example": 400 }, "message": { "type": "string", "example": "One or more ad items failed validation." }, "parameters": { "type": "array", "items": { "properties": { "index": { "type": "integer", "example": 0 }, "ad_item": { "properties": { "name": { "type": "string", "example": "SKU 84221824" }, "catalog_id": { "type": "integer", "example": 10000 }, "catalog_item_identifier": { "type": "string", "example": "84221824" } }, "type": "object" }, "parameters": { "type": "array", "items": { "properties": { "field": { "type": "string", "example": "catalog_id" }, "type": { "type": "string", "example": "required" }, "message": { "type": "string", "example": "The field 'catalog_id' must be defined." } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } } } } }, "/campaigns/standard/{campaign_id}/catalog-ad-item-bulk-delete": { "delete": { "tags": [ "Ad Items / Catalog Item / Bulk" ], "summary": "Bulk Delete Catalog Ad Items", "description": "Bulk deletes catalog ad items from a campaign. Ad items which are deleted are listed in the `deleted` field. Ad items which were ignored (already deleted, or don't exist) will be listed in the `skipped` field.", "parameters": [ { "name": "campaign_id", "in": "path", "description": "Identifier of the Standard Campaign.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_ad_item_bulk_delete_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_ad_item_bulk_delete_response" } } } } } } }, "/ad-items/catalog-item": { "post": { "tags": [ "Ad Items / Catalog Item" ], "summary": "Create a Catalog Ad Item", "description": "Create a catalog ad item. The `identifier_field` field value must be unique within the catalog.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_ad_item_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_ad_item_get" } } } } } } }, "/ad-items/catalog-item/{id}": { "get": { "tags": [ "Ad Items / Catalog Item" ], "summary": "Get a Single Catalog Ad Item", "description": "Retrieve a single catalog ad item. :ID is the identifier for a catalog ad item (eg client SKU, or whichever other unique identifier used).", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Catalog Ad Item (eg client SKU, or whichever other unique identifier used).", "required": true, "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_ad_item_get" } } } } } }, "put": { "tags": [ "Ad Items / Catalog Item" ], "summary": "Update a Catalog Ad Item", "description": "Update a catalog ad item. :ID is the id for this catalog ad item.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Catalog Ad Item.", "required": true, "schema": { "type": "string" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_ad_item_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_ad_item_get" } } } } } }, "delete": { "tags": [ "Ad Items / Catalog Item" ], "summary": "Delete a Catalog Ad Item", "description": "Remove a catalog ad item entirely. :ID is the identifier for a catalog ad item (eg client SKU, or whichever other unique identifier used).", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Catalog Ad Item you'd like to delete (eg client SKU, or whichever other unique identifier used).", "required": true, "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/zones/catalog": { "get": { "tags": [ "Zones / Catalog" ], "summary": "Get a List of Catalog Zones", "description": "Show a list of catalog zones.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_zone_list" } } } } } }, "post": { "tags": [ "Zones / Catalog" ], "summary": "Create a Catalog Zone", "description": "Create a catalog zone in a publisher.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_zone_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_zone_get" } } } } } } }, "/zones/catalog/{zone_id}": { "get": { "tags": [ "Zones / Catalog" ], "summary": "Get a Single Catalog Zone", "description": "Retrieve a single catalog zone details.", "parameters": [ { "name": "zone_id", "in": "path", "description": "Identifier of the Catalog Zone.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_zone_get" } } } } } }, "put": { "tags": [ "Zones / Catalog" ], "summary": "Update a Catalog Zone", "description": "Update the name of a catalog zone, you can also update the auction_type and advertiser_cost_type.", "parameters": [ { "name": "zone_id", "in": "path", "description": "Identifier of the Catalog Zone.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_zone_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog_zone_get" } } } } } }, "delete": { "tags": [ "Zones / Catalog" ], "summary": "Delete a Catalog Zone", "description": "Delete a catalog zone.", "parameters": [ { "name": "zone_id", "in": "path", "description": "Identifier of the Catalog Zone you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/zones/catalog/{zone_id}/tags": { "get": { "tags": [ "Zones / Catalog" ], "summary": "Get Catalog Zone Tags", "description": "IN PROGRESS - This response will contain the base ad request endpoint, though most likely you will want to add a frontend to it so that the client may customize the requests further.", "parameters": [ { "name": "zone_id", "in": "path", "description": "Identifier of the Catalog Zone.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation" } } } }, "/channel-zone-assignments": { "get": { "tags": [ "Channel Zone Assignments" ], "summary": "Get a List of Channel Zone Assignments", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "zones", "in": "query", "description": "Filter the channel zone assignments by one or many zone IDs.", "required": false, "schema": { "type": "string" }, "example": "596804,904334" }, { "name": "channels", "in": "query", "description": "Filter the channel zone assignments by one or many channel IDs.", "required": false, "schema": { "type": "string" }, "example": "6884" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_zone_assignment_list" } } } } } }, "post": { "tags": [ "Channel Zone Assignments" ], "summary": "Create a Channel Zone Assignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_zone_assignment_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_zone_assignment_get" } } } } } } }, "/channel-zone-assignments/{id}": { "get": { "tags": [ "Channel Zone Assignments" ], "summary": "Get a Single Channel Zone Assignment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the channel zone assignment you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_zone_assignment_get" } } } } } }, "delete": { "tags": [ "Channel Zone Assignments" ], "summary": "Delete a Channel Zone Assignment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the channel zone assignment you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/channels": { "get": { "tags": [ "Channels" ], "summary": "Get a List of Channels", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_list" } } } } } }, "post": { "tags": [ "Channels" ], "summary": "Create a Channel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_get" } } } } } } }, "/channels/archived": { "get": { "tags": [ "Channels / Archived" ], "summary": "Get a List of Archived Channels", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_channel_list" } } } } } } }, "/channels/archived/{id}": { "get": { "tags": [ "Channels / Archived" ], "summary": "Get an Archived Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_channel_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Channels / Archived" ], "summary": "Delete an Archived Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/channels/archived/{id}/unarchive": { "get": { "tags": [ "Channels / Archived" ], "summary": "Unarchive an Archived Channel", "description": "Unarchives the resource and all resources that were previously archived with the resource.", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/unarchive_include_zone_assignments" }, { "$ref": "#/components/parameters/unarchive_include_placements" }, { "$ref": "#/components/parameters/unarchive_pause_placements" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_unarchive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/channels/{id}": { "get": { "tags": [ "Channels" ], "summary": "Get a Single Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Channels" ], "summary": "Update a Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_put_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Channels" ], "summary": "Delete a Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/channels/{id}/archive": { "get": { "tags": [ "Channels" ], "summary": "Archive a Channel", "description": "Archives the resource and all direct descendants of this resource. Archived resources will be treated the same as [deleted resources](#tag/Channels/paths/~1channels~1{id}/delete) but can be restored through [unarchiving](#tag/Channels-Archived/paths/~1channels~1archived~1{id}~1unarchive/get).", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel_archive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Get a List of Contacts", "description": "Returns a list of contactss. If no contacts were found, the data object will be empty.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list" } } } } } }, "post": { "tags": [ "Contacts" ], "summary": "Create a Contact", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_get" } } } } } } }, "/contacts/{contact_id}": { "get": { "tags": [ "Contacts" ], "summary": "Get a Single Contact", "parameters": [ { "name": "contact_id", "in": "path", "description": "Identifier of the contact you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_get" } } } } } }, "put": { "tags": [ "Contacts" ], "summary": "Update a Contact", "parameters": [ { "name": "contact_id", "in": "path", "description": "Identifier of the contact you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_get" } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete a Contact", "parameters": [ { "name": "contact_id", "in": "path", "description": "Identifier of the contact you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/contacts/{contact_id}/report-configuration-schedules": { "get": { "tags": [ "Contacts" ], "summary": "List Report Configuration Schedules for a Contact", "parameters": [ { "name": "contact_id", "in": "path", "description": "Identifier of the contact you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list_report_schedules" } } } } } } }, "/contracts/{contract_id}/documents/{document_id}/replace-file": { "post": { "tags": [ "Contract Document Files" ], "summary": "Replace a Contract Document File", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "document_id", "in": "path", "description": "Identifier of the parent contract document.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/contract_document_replace_file_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_replace_file_get" } } } } } } }, "/contracts/{contract_id}/documents/{document_id}/file-revisions": { "get": { "tags": [ "Contract Document Files" ], "summary": "Get a List of File Revisions", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "document_id", "in": "path", "description": "Identifier of the parent contract document.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_file_revision_list" } } } } } } }, "/contracts/{contract_id}/documents/{document_id}/file-revisions/{revision_id}": { "get": { "tags": [ "Contract Document Files" ], "summary": "Get a Single File Revision", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "document_id", "in": "path", "description": "Identifier of the parent contract document.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "revision_id", "in": "path", "description": "Identifier of the contract document revision to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_file_revision_get" } } } } } } }, "/contracts/{contract_id}/documents/{document_id}/file-revisions/{revision_id}/download": { "get": { "tags": [ "Contract Document Files" ], "summary": "Download a File Revision", "description": "Use this endpoint to download a revision of a contract document", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "document_id", "in": "path", "description": "Identifier of the parent contract document.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "revision_id", "in": "path", "description": "Identifier of the contract document revision to download.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "If file exists, the file will be downloaded.", "content": { "application/pdf": {} } } } } }, "/contracts/{contract_id}/documents": { "get": { "tags": [ "Contract Documents" ], "summary": "Get a List of Contract Documents", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_list" } } } } } } }, "/contracts/{contract_id}/documents/": { "post": { "tags": [ "Contract Documents" ], "summary": "Create a Contract Document", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/contract_document_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_get" } } } } } } }, "/contracts/{contract_id}/documents/{document_id}": { "get": { "tags": [ "Contract Documents" ], "summary": "Get a Single Contract Document", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "document_id", "in": "path", "description": "Identifier of the contract document you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_get" } } } } } }, "put": { "tags": [ "Contract Documents" ], "summary": "Update a Contract Document", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "document_id", "in": "path", "description": "Identifier of the contract document you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_get" } } } } } }, "delete": { "tags": [ "Contract Documents" ], "summary": "Delete a Contract Document", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "document_id", "in": "path", "description": "Identifier of the contract document you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/contracts/{contract_id}/payments": { "get": { "tags": [ "Contract Payments" ], "summary": "Get a List of a Contract's Payments", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_payment_list" } } } } } }, "post": { "tags": [ "Contract Payments" ], "summary": "Create a Contract Payment", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_payment_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_payment_get" } } } } } } }, "/contracts/{contract_id}/payments/{payment_id}": { "get": { "tags": [ "Contract Payments" ], "summary": "Get a Single Contract Payment", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "payment_id", "in": "path", "description": "Identifier of the contract payment.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_payment_get" } } } } } }, "delete": { "tags": [ "Contract Payments" ], "summary": "Delete a Contract Payment", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "payment_id", "in": "path", "description": "Identifier of the contract payment.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/contracts/{contract_id}/signature-requests/{request_id}/recipients": { "get": { "tags": [ "Signature Request Recipients" ], "summary": "Get a List of a Signature Request's Recipients", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "request_id", "in": "path", "description": "Identifier of the parent contract signature request.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "status_filter", "name": "status", "in": "query", "description": "Filter by a list of recipient status states.", "schema": { "type": "boolean" }, "example": false } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_recipient_list" } } } } } } }, "/contracts/{contract_id}/signature-requests/{request_id}/recipients/{recipient_id}": { "get": { "tags": [ "Signature Request Recipients" ], "summary": "Get a Single Signature Request Recipient", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "request_id", "in": "path", "description": "Identifier of the parent contract signature request.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "recipient_id", "in": "path", "description": "Identifier of the recipient you want to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_recipient_get" } } } } } }, "put": { "tags": [ "Signature Request Recipients" ], "summary": "Update a Signature Request Recipient", "description": "Editing a signature request recipient can only be done for the contract's active signature request whose status is **\"SENT\"**. No changes can be made to a recipient who has already signed the contract or declined it.

If the contract is made from a template, recipients may or may not be able to be edited. As contract templates can take data from the recipients and put the data directly into the document being sent, editing these recipients would require the document to be deleted and recreated with the new recipient values. This is not something our system is set up to do automatically, so if a recipient must be changed the entire signature request must be cancelled and recreated with the correct recipient.", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "request_id", "in": "path", "description": "Identifier of the parent contract signature request.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "recipient_id", "in": "path", "description": "Identifier of the recipient you want to get.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_recipient_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_recipient_get" } } } } } }, "delete": { "tags": [ "Signature Request Recipients" ], "summary": "Delete a Signature Request Recipient", "description": "Deleting a signature request recipient can only be done for the contract's active signature request whose status is **\"SENT\"**. No changes can be made to a recipient who has already signed the contract or declined it.

If the contract is made from a template, recipients may or may not be able to be removed. As contract templates can take data from the recipients and put the data directly into the document being sent, editing these recipients would require the document to be deleted and recreated with the new recipient values. This is not something our system is set up to do automatically, so if a recipient must be changed the entire signature request must be cancelled and recreated with the correct recipient.", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "request_id", "in": "path", "description": "Identifier of the parent contract signature request.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "recipient_id", "in": "path", "description": "Identifier of the recipient you want to get.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/contracts/{contract_id}/signature-request": { "get": { "tags": [ "Signature Requests" ], "summary": "Get Contract's Active Signature Request", "description": "A quick way to get the contract's most recently sent signature request.", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_get" } } } } } } }, "/contracts/{contract_id}/signature-requests": { "get": { "tags": [ "Signature Requests" ], "summary": "Get a List of a Contract's Signature Requests", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "signing_service_filter", "name": "signing_service", "in": "query", "description": "Filter signature requests by the signing service type.", "schema": { "type": "string" }, "example": "" }, { "parameter": "status_filter", "name": "status", "in": "query", "description": "Filter by a list of status states.", "schema": { "type": "string" }, "example": false } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_list" } } } } } } }, "/contracts/{contract_id}/signature-requests/{request_id}": { "get": { "tags": [ "Signature Requests" ], "summary": "Get a Single Signature Request", "description": "A quick way to get the contract's most recently sent signature request.", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "request_id", "in": "path", "description": "Identifier of the contract signature request you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_get" } } } } } } }, "/contracts/{contract_id}/signature-requests/{request_id}/resend": { "post": { "tags": [ "Signature Requests" ], "summary": "Resend a Signature Request", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "request_id", "in": "path", "description": "Identifier of the contract signature request you'd like to resend.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": {}, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_get" } } } } } } }, "/contracts/{contract_id}/signature-requests/{request_id}/cancel": { "post": { "tags": [ "Signature Requests" ], "summary": "Cancel a Signature Request", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "request_id", "in": "path", "description": "Identifier of the contract signature request you'd like to cancel.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_cancel" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_signature_request_cancel" } } } } } } }, "/contract-templates": { "get": { "tags": [ "Contract Templates" ], "summary": "Get a List of a Contract Templates", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "signing_service_filter", "name": "signing_service", "in": "query", "description": "Filter contract templates by their signing service type.", "schema": { "type": "string" }, "example": "DOCUSIGN" }, { "parameter": "latest_filter", "name": "latest", "in": "query", "description": "If set to **true**, contract template list is given based on descending `created_at` fields (aka newest created to last created).", "schema": { "type": "boolean" }, "example": false } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_template_list" } } } } } }, "post": { "tags": [ "Contract Templates" ], "summary": "Create a Contract Template", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/contract_template_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_template_get" } } } } } } }, "/contract-templates/{contract_template_id}": { "get": { "tags": [ "Contract Templates" ], "summary": "Get a Single Contract Template", "parameters": [ { "name": "contract_template_id", "in": "path", "description": "Identifier of the contract template you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_template_get" } } } } } }, "delete": { "tags": [ "Contract Templates" ], "summary": "Delete a Contract Template", "parameters": [ { "name": "contract_template_id", "in": "path", "description": "Identifier of the contract template you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/contracts/{contract_id}/document-from-template": { "post": { "tags": [ "Contract Templates" ], "summary": "Create a Contract Document from a Template", "description": "Creating a document by using an existing template saves time when contracts are similar enough that one file can be used. The use of inputs that are inserted right into the document help to allow more generic contracts that can be filled in almost like a form. The pre-built tabs in the contract templates allow for easier signature requests as everything has already been set, and all that's needed is to send the document to the signers.", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the contract to add the document to.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_from_template" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_from_template_response" } } } } } } }, "/contracts/{contract_id}/documents/{document_id}/replace-file-from-template": { "post": { "tags": [ "Contract Templates" ], "summary": "Replace a Contract Document File from a Template", "description": "Creating a document by using an existing template saves time when contracts are similar enough that one file can be used. The use of inputs that are inserted right into the document help to allow more generic contracts that can be filled in almost like a form. The pre-built tabs in the contract templates allow for easier signature requests as everything has already been set, and all that's needed is to send the document to the signers.", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the parent contract.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "document_id", "in": "path", "description": "Identifier of the contract document to upload the replacement file to.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_file_from_template" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_document_file_from_template_response" } } } } } } }, "/contracts": { "get": { "tags": [ "Contracts" ], "summary": "Get a List of Contracts", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "advertiser_filter", "name": "advertiser", "in": "query", "description": "A list of advertiser IDs by which to filter the list of contracts returned. Formatted as a list of the IDs separated by commas. (e.g. __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" }, { "parameter": "has_signature_request_filter", "name": "has_signature_request", "in": "query", "description": "Show contracts based on their current signature request state. If set to __TRUE__, only contracts with an active signature request will be returned. If set to __FALSE__, only contracts without an active signature request will be returned.", "schema": { "type": "boolean" }, "example": false }, { "parameter": "expand", "name": "expand", "in": "query", "description": "Set field to `current_signature_request` to expand the field.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_list" } } } } } }, "post": { "tags": [ "Contracts" ], "summary": "Create a Contract", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_get" } } } } } } }, "/contracts/{contract_id}": { "get": { "tags": [ "Contracts" ], "summary": "Get a Single Contract", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the contract you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_get" } } } } } }, "put": { "tags": [ "Contracts" ], "summary": "Update a Contract", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the contract you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_get" } } } } } }, "delete": { "tags": [ "Contracts" ], "summary": "Delete a Contract", "parameters": [ { "name": "contract_id", "in": "path", "description": "Identifier of the contract you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/contracts/{contract_id}/assigned-campaigns": { "get": { "tags": [ "Contracts" ], "summary": "Get a List of Campaigns Assigned to Contract", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_assigned_campaigns" } } } } } } }, "/contracts/{id}/archive": { "post": { "tags": [ "Contracts" ], "summary": "Archive a Contract", "description": "Archives the resource and all direct descendants of this resource ([contract documents](#tag/Contract-Documents), [contract document files](#tag/Contract-Document-Files), and [contract payments](#tag/Contract-Payments)). Archived resources will be treated the same as deleted resources but can be restored through unarchiving.", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_archive_action" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/contracts/archived": { "get": { "tags": [ "Contracts / Archived" ], "summary": "Get a List of Archived Contracts", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_contract_list" } } } } } } }, "/contracts/archived/{id}": { "get": { "tags": [ "Contracts / Archived" ], "summary": "Get an Archived Contract", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_contract_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/contracts/archived/{id}/unarchive": { "post": { "tags": [ "Contracts / Archived" ], "summary": "Unarchive an Archived Contract", "description": "Unarchives the resource and all resources ([contract documents](#tag/Contract-Documents), [contract document files](#tag/Contract-Document-Files), and [contract payments](#tag/Contract-Payments)) that were previously archived with the resource.", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contract_unarchive_action" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/creatives/audio": { "get": { "tags": [ "Creatives / Audio" ], "summary": "Get a List of Audio Creatives", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/advertiser_creative_filter" }, { "$ref": "#/components/parameters/publisher_creative_filter" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_audio_list" } } } } } }, "post": { "tags": [ "Creatives / Audio" ], "summary": "Create an Audio Creative", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/creative_audio_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_audio_get" } } } } } } }, "/creatives/audio/{id}": { "get": { "tags": [ "Creatives / Audio" ], "summary": "Get a Single Audio Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_audio_get" } } } } } }, "put": { "tags": [ "Creatives / Audio" ], "summary": "Update an Audio Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_audio_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_audio_get" } } } } } }, "delete": { "tags": [ "Creatives / Audio" ], "summary": "Delete an Audio Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/creatives/audio/{id}/replace-file": { "post": { "tags": [ "Creatives / Audio" ], "summary": "Replace the File on an Audio Creative", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/creative_audio_file_replace" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_audio_get" } } } } } } }, "/creatives": { "get": { "tags": [ "Creatives (All)" ], "summary": "Get a List of All Creatives", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "creative_type_filter", "name": "type", "in": "query", "description": "Filter the results by a certain type of creative. Options are: `image`, `video`, `audio`, `rich_media`.", "schema": { "type": "string" }, "example": "" }, { "parameter": "creative_types_filter", "name": "types", "in": "query", "description": "Filter the results by multiple types of creatives. Must be formatted as a string list with any combination of: `image`, `video`, `audio`, `rich_media`.", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/advertiser_creative_filter" }, { "$ref": "#/components/parameters/publisher_creative_filter" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_image_list" } } } } } } }, "/creatives/image": { "get": { "tags": [ "Creatives / Image" ], "summary": "Get a List of Image Creatives", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/advertiser_creative_filter" }, { "$ref": "#/components/parameters/publisher_creative_filter" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_image_list" } } } } } }, "post": { "tags": [ "Creatives / Image" ], "summary": "Create an Image Creative", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/creative_image_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_image_get" } } } } } } }, "/creatives/image/{id}": { "get": { "tags": [ "Creatives / Image" ], "summary": "Get a Single Image Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_image_get" } } } } } }, "put": { "tags": [ "Creatives / Image" ], "summary": "Update an Image Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_image_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_image_get" } } } } } }, "delete": { "tags": [ "Creatives / Image" ], "summary": "Delete an Image Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/creatives/image/{id}/replace-file": { "post": { "tags": [ "Creatives / Image" ], "summary": "Replace the File on an Image Creative", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/creative_image_file_replace" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_image_get" } } } } } } }, "/creatives/rich-media": { "get": { "tags": [ "Creatives / Rich Media" ], "summary": "Get a List of Rich Media Creatives", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/advertiser_creative_filter" }, { "$ref": "#/components/parameters/publisher_creative_filter" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_rich_media_list" } } } } } }, "post": { "tags": [ "Creatives / Rich Media" ], "summary": "Create a Rich Media Creative", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/creative_rich_media_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_rich_media_get" } } } } } } }, "/creatives/rich-media/{id}": { "get": { "tags": [ "Creatives / Rich Media" ], "summary": "Get a Single Rich Media Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_rich_media_get" } } } } } }, "put": { "tags": [ "Creatives / Rich Media" ], "summary": "Update a Rich Media Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_rich_media_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_rich_media_get" } } } } } }, "delete": { "tags": [ "Creatives / Rich Media" ], "summary": "Delete a Rich Media Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/creatives/rich-media/{id}/replace-file": { "post": { "tags": [ "Creatives / Rich Media" ], "summary": "Replace the File on a Rich Media Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/creative_rich_media_file_replace" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_rich_media_get" } } } } } } }, "/creatives/video": { "get": { "tags": [ "Creatives / Video" ], "summary": "Get a List of Video Creatives", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/advertiser_creative_filter" }, { "$ref": "#/components/parameters/publisher_creative_filter" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_video_list" } } } } } }, "post": { "tags": [ "Creatives / Video" ], "summary": "Create a Video Creative", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/creative_video_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_video_get" } } } } } } }, "/creatives/video/{id}": { "get": { "tags": [ "Creatives / Video" ], "summary": "Get a Single Video Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_video_get" } } } } } }, "put": { "tags": [ "Creatives / Video" ], "summary": "Update a Video Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_video_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_video_get" } } } } } }, "delete": { "tags": [ "Creatives / Video" ], "summary": "Delete a Video Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/creatives/video/{id}/replace-file": { "post": { "tags": [ "Creatives / Video" ], "summary": "Replace the File on a Video Creative", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/creative_video_file_replace" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/creative_video_get" } } } } } } }, "/data-key-targets": { "get": { "tags": [ "Data Key Targets" ], "summary": "Get a List of Data Key Targets", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_target_list" } } } } } }, "post": { "tags": [ "Data Key Targets" ], "summary": "Create a Data Key Target", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_target_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_target_get" } } } } } } }, "/data-key-targets/{id}": { "get": { "tags": [ "Data Key Targets" ], "summary": "Get a Single Data Key Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Data Key Target you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_target_get" } } } } } }, "put": { "tags": [ "Data Key Targets" ], "summary": "Update a Data Key Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Data Key Target you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_target_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_target_get" } } } } } }, "delete": { "tags": [ "Data Key Targets" ], "summary": "Delete a Data Key Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Data Key Target you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/data-keys": { "get": { "tags": [ "Data Keys" ], "summary": "Get a List of Data Keys", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_list" } } } } } }, "post": { "tags": [ "Data Keys" ], "summary": "Create a Data Key", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_get" } } } } } } }, "/data-keys/{id}": { "get": { "tags": [ "Data Keys" ], "summary": "Get a Single Data Key", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Data Key you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_get" } } } } } }, "put": { "tags": [ "Data Keys" ], "summary": "Update a Data Key", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Data Key you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_key_get" } } } } } }, "delete": { "tags": [ "Data Keys" ], "summary": "Delete a Data Key", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the Data Key you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/data-lists/{id}/bulk-upload-replace": { "post": { "tags": [ "Data Lists / Bulk Upload" ], "summary": "Bulk upload list data to replace existing data list", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the data list you want to replace.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/data_list_bulk_upload" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_list_bulk_upload_replace_result" } } } } } } }, "/data-lists/{id}/bulk-upload-add": { "post": { "tags": [ "Data Lists / Bulk Upload" ], "summary": "Bulk upload list data to add to existing data list", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the data list you want to add to.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/data_list_bulk_upload" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_list_bulk_upload_add_result" } } } } } } }, "/data-lists/{id}/bulk-upload-remove": { "post": { "tags": [ "Data Lists / Bulk Upload" ], "summary": "Bulk upload list data to remove from existing data list", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the data list you want to remove from.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/data_list_bulk_upload" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_list_bulk_upload_remove_result" } } } } } } }, "/data-targets": { "get": { "tags": [ "Data Lists" ], "summary": "Get a List of Data Lists", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_list_list" } } } } } } }, "/data-lists": { "post": { "tags": [ "Data Lists" ], "summary": "Create a Data List", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_list_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_list_get" } } } } } } }, "/data-lists/{id}": { "get": { "tags": [ "Data Lists" ], "summary": "Get a Single Data List", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the data list you want to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_list_get" } } } } } }, "put": { "tags": [ "Data Lists" ], "summary": "Update a Data List", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the data list you want to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_list_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/data_list_get" } } } } } }, "delete": { "tags": [ "Data Lists" ], "summary": "Delete a Data List", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the data list you want to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/day-parting": { "get": { "tags": [ "Day Parting" ], "summary": "Get a list of Day Parting configurations", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "is_template", "name": "is_template", "in": "query", "description": "Filter by the `is_template` field. If set to **true**, only day parting configurations that are templates will be returned. If set to **false**, only day parting configurations that are not templates will be returned. Do not include in query to return all day parting configurations.", "schema": { "type": "boolean" }, "example": false } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/day_parting_list" } } } } } }, "post": { "tags": [ "Day Parting" ], "summary": "Create a Day Parting configuration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/day_parting_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/day_parting_get" } } } } } } }, "/day-parting/{id}": { "get": { "tags": [ "Day Parting" ], "summary": "Get a single Day Parting configuration.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the day parting config you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/day_parting_get" } } } } } }, "put": { "tags": [ "Day Parting" ], "summary": "Update a Day Parting configuration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the day parting config you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/day_parting_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/day_parting_get" } } } } } }, "delete": { "tags": [ "Day Parting" ], "summary": "Delete a Day Parting configuration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the day parting config you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/demand-endpoints": { "get": { "tags": [ "Demand Endpoints" ], "summary": "Get a List of Demand Endpoints", "description": "Returns a list of demand endpoints. If no demand endpoints were found, the data object will be empty. You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_endpoint_list" } } } } } }, "post": { "tags": [ "Demand Endpoints" ], "summary": "Create a Demand Endpoint", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_endpoint_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_endpoint_get" } } } } } } }, "/demand-endpoints/{id}": { "get": { "tags": [ "Demand Endpoints" ], "summary": "Get a Single Demand Endpoint", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the demand endpoint you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_endpoint_get" } } } } } }, "put": { "tags": [ "Demand Endpoints" ], "summary": "Update a Demand Endpoint", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the demand endpoint you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_endpoint_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_endpoint_get" } } } } } }, "delete": { "tags": [ "Demand Endpoints" ], "summary": "Delete a Demand Endpoint", "description": "Permanently deletes a demand endpoint. __This operation cannot be undone__ so be very sure when deleting one. Successful deletion immediately stops serving any bid requests from being sent ", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the publisher you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/demand-sources": { "get": { "tags": [ "Demand Sources" ], "summary": "Get a List of Demand Sources", "description": "Returns a list of demand sources. If no demand sources were found, the data object will be empty. You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_source_list" } } } } } }, "post": { "tags": [ "Demand Sources" ], "summary": "Create a Demand Source", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_source_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_source_get" } } } } } } }, "/demand-sources/{id}": { "get": { "tags": [ "Demand Sources" ], "summary": "Get a Single Demand Source", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the demand source you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_source_get" } } } } } }, "put": { "tags": [ "Demand Sources" ], "summary": "Update a Demand Source", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the demand source you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_source_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_source_get" } } } } } }, "delete": { "tags": [ "Demand Sources" ], "summary": "Delete a Demand Source", "description": "Permanently deletes a demand source. __This operation cannot be undone__ so be very sure when deleting one. Successful deletion immediately stops serving any bid requests from being sent ", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the publisher you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/reports/report-configurations/schedules": { "get": { "tags": [ "Display Report Configuration Schedules" ], "summary": "Get a List of all Display Report Configuration Schedules", "description": "Returns a list of a report configuration schedules. If no schedules were found, the data object will be empty.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "report_configuration_filter", "name": "report_config", "in": "query", "description": "A list of report configuration IDs by which to filter the list of report configuration schedules returned. Formatted as a list of the IDs separated by commas. (e.g. __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_schedule_list_all" } } } } } } }, "/reports/report-configurations/{report_configuration_id}/schedules": { "get": { "tags": [ "Display Report Configuration Schedules" ], "summary": "Get a List of a Display Report Configuration's Schedules", "description": "Returns a list of a report configuration's schedules. If no schedules were found, the data object will be empty.", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_schedule_list_by_report" } } } } } }, "post": { "tags": [ "Display Report Configuration Schedules" ], "summary": "Create a Report Configuration", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_schedule_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_schedule_get" } } } } } } }, "/reports/report-configurations/{report_configuration_id}/schedules/{schedule_id}": { "get": { "tags": [ "Display Report Configuration Schedules" ], "summary": "Get a Single Report Configuration", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "schedule_id", "in": "path", "description": "Identifier of the display report configuration schedule you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_schedule_get" } } } } } }, "put": { "tags": [ "Display Report Configuration Schedules" ], "summary": "Update a Report Configuration", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "schedule_id", "in": "path", "description": "Identifier of the display report configuration schedule you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_schedule_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_schedule_get" } } } } } }, "delete": { "tags": [ "Display Report Configuration Schedules" ], "summary": "Delete a Report Configuration", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "schedule_id", "in": "path", "description": "Identifier of the display report configuration schedule you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/reports/report-configurations/{report_configuration_id}/schedules/{schedule_id}/generated": { "get": { "tags": [ "Display Report Configuration Schedules" ], "summary": "Get a List of Schedule's Generated Reports", "description": "Returns a list of a report configuration schedule's generated reports. If no generated reports were found, the data object will be empty.", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "schedule_id", "in": "path", "description": "Identifier of the parent report configuration schedule.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_generated_get_list_by_schedule" } } } } } } }, "/reports/report-configurations/{report_configuration_id}/schedules/{schedule_id}/generated/{generated_id}": { "get": { "tags": [ "Display Report Configuration Schedules" ], "summary": "Get a Schedule's Generated Report", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "schedule_id", "in": "path", "description": "Identifier of the display report configuration schedule.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "generated_id", "in": "path", "description": "Identifier of the generated report configuration you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_generated_get" } } } } } } }, "/reports/report-configurations/{report_configuration_id}/schedules/{schedule_id}/revoke-historical-access": { "post": { "tags": [ "Display Report Configuration Schedules" ], "summary": "Remove Recipient Access to Generated Reports", "description": "Removes a recipient's access to all generated reports for a specific schedule. This __will not__ remove the recipients from the schedule itself, that must be performed in a separate request to edit the schedule. __This action cannot be undone__.", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "schedule_id", "in": "path", "description": "Identifier of the display report configuration schedule you want to change.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_schedule_revoke_access_action" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_schedule_revoke_access_response" } } } } } } }, "/reports/report-configurations": { "get": { "tags": [ "Display Report Configurations" ], "summary": "Get a List of Display Report Configurations", "description": "Returns a list of report configurations. If no configurations were found, the data object will be empty.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_list" } } } } } }, "post": { "tags": [ "Display Report Configurations" ], "summary": "Create a Report Configuration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_get" } } } } } } }, "/reports/report-configurations/{report_configuration_id}": { "get": { "tags": [ "Display Report Configurations" ], "summary": "Get a Single Report Configuration", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the display report configuration you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_get" } } } } } }, "put": { "tags": [ "Display Report Configurations" ], "summary": "Update a Report Configuration", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the display report configuration you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_get" } } } } } }, "delete": { "tags": [ "Display Report Configurations" ], "summary": "Delete a Report Configuration", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the display report configuration you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/reports/report-configurations/generated": { "get": { "tags": [ "Display Report Configurations" ], "summary": "Get All Generated Reports", "description": "Returns a list of all generated reports. This is an admin endpoint to help monitor the data being sent out from your account. If no generated reports were found, the data object will be empty.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_generated_get_list_all" } } } } } } }, "/reports/report-configurations/{report_configuration_id}/generated": { "get": { "tags": [ "Display Report Configurations" ], "summary": "Get a List of a Report Configuration's Generated Reports", "description": "Returns a list of a report configuration's generated reports. If no generated reports were found, the data object will be empty.", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "schedule", "in": "query", "description": "Submit this parameter to filter the generated reports by a list of schedule IDs.The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_generated_get_list_by_report_config" } } } } } } }, "/reports/report-configurations/{report_configuration_id}/generated/{generated_id}": { "get": { "tags": [ "Display Report Configurations" ], "summary": "Get a Generated Report", "parameters": [ { "name": "report_configuration_id", "in": "path", "description": "Identifier of the parent report configuration.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "generated_id", "in": "path", "description": "Identifier of the generated report configuration you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_report_config_generated_get" } } } } } } }, "/drafts/ad-items": { "get": { "tags": [ "Drafts / Ad Items (All)" ], "summary": "Get a List of All Draft Ad Items", "description": "Returns draft ad items of all types. You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft ad items by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_ad_item_list" } } } } } } }, "/drafts/ad-items/{id}": { "get": { "tags": [ "Drafts / Ad Items (All)" ], "summary": "Get a Draft Ad Item", "description": "Returns a single draft ad item of any type by its ID.", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/draft_image_ad_item_get" }, { "$ref": "#/components/schemas/draft_rich_media_ad_item_get" }, { "$ref": "#/components/schemas/draft_custom_html_ad_item_get" }, { "$ref": "#/components/schemas/draft_native_ad_item_get" }, { "$ref": "#/components/schemas/draft_catalog_ad_item_get" } ] } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/ad-items/catalog": { "get": { "tags": [ "Drafts / Ad Items / Catalog" ], "summary": "Get a List of Draft Catalog Ad Items", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft ad items by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_catalog_ad_item_list" } } } } } }, "post": { "tags": [ "Drafts / Ad Items / Catalog" ], "summary": "Create a Draft Catalog Ad Item", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_catalog_ad_item_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_catalog_ad_item_get" } } } } } } }, "/drafts/ad-items/catalog/{id}": { "get": { "tags": [ "Drafts / Ad Items / Catalog" ], "summary": "Get a Draft Catalog Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_catalog_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Ad Items / Catalog" ], "summary": "Update a Draft Catalog Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_catalog_ad_item_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_catalog_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Ad Items / Catalog" ], "summary": "Delete a Draft Catalog Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/ad-item-companion-products": { "get": { "tags": [ "Drafts / Ad Item Companion Products" ], "summary": "Get a List of Draft Ad Item Companion Products", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft companion products by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "ad_item_draft_id", "in": "query", "description": "Filter draft companion products by a single draft ad item ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_ad_item_companion_product_list" } } } } } }, "post": { "tags": [ "Drafts / Ad Item Companion Products" ], "summary": "Create a Draft Ad Item Companion Product", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_ad_item_companion_product_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_ad_item_companion_product_get" } } } } } } }, "/drafts/ad-item-companion-products/{id}": { "get": { "tags": [ "Drafts / Ad Item Companion Products" ], "summary": "Get a Draft Ad Item Companion Product", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_ad_item_companion_product_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Ad Item Companion Products" ], "summary": "Update a Draft Ad Item Companion Product", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_ad_item_companion_product_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_ad_item_companion_product_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Ad Item Companion Products" ], "summary": "Delete a Draft Ad Item Companion Product", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/ad-items/custom-html": { "get": { "tags": [ "Drafts / Ad Items / Custom HTML" ], "summary": "Get a List of Draft Custom HTML Ad Items", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft ad items by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_custom_html_ad_item_list" } } } } } }, "post": { "tags": [ "Drafts / Ad Items / Custom HTML" ], "summary": "Create a Draft Custom HTML Ad Item", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_custom_html_ad_item_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_custom_html_ad_item_get" } } } } } } }, "/drafts/ad-items/custom-html/{id}": { "get": { "tags": [ "Drafts / Ad Items / Custom HTML" ], "summary": "Get a Draft Custom HTML Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_custom_html_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Ad Items / Custom HTML" ], "summary": "Update a Draft Custom HTML Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_custom_html_ad_item_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_custom_html_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Ad Items / Custom HTML" ], "summary": "Delete a Draft Custom HTML Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/ad-items/image": { "get": { "tags": [ "Drafts / Ad Items / Image" ], "summary": "Get a List of Draft Image Ad Items", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft ad items by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_image_ad_item_list" } } } } } }, "post": { "tags": [ "Drafts / Ad Items / Image" ], "summary": "Create a Draft Image Ad Item", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_image_ad_item_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_image_ad_item_get" } } } } } } }, "/drafts/ad-items/image/{id}": { "get": { "tags": [ "Drafts / Ad Items / Image" ], "summary": "Get a Draft Image Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_image_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Ad Items / Image" ], "summary": "Update a Draft Image Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_image_ad_item_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_image_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Ad Items / Image" ], "summary": "Delete a Draft Image Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/ad-items/native": { "get": { "tags": [ "Drafts / Ad Items / Native" ], "summary": "Get a List of Draft Native Ad Items", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft ad items by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_native_ad_item_list" } } } } } }, "post": { "tags": [ "Drafts / Ad Items / Native" ], "summary": "Create a Draft Native Ad Item", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_native_ad_item_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_native_ad_item_get" } } } } } } }, "/drafts/ad-items/native/{id}": { "get": { "tags": [ "Drafts / Ad Items / Native" ], "summary": "Get a Draft Native Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_native_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Ad Items / Native" ], "summary": "Update a Draft Native Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_native_ad_item_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_native_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Ad Items / Native" ], "summary": "Delete a Draft Native Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/ad-items/rich-media": { "get": { "tags": [ "Drafts / Ad Items / Rich Media" ], "summary": "Get a List of Draft Rich Media Ad Items", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft ad items by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_rich_media_ad_item_list" } } } } } }, "post": { "tags": [ "Drafts / Ad Items / Rich Media" ], "summary": "Create a Draft Rich Media Ad Item", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_rich_media_ad_item_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_rich_media_ad_item_get" } } } } } } }, "/drafts/ad-items/rich-media/{id}": { "get": { "tags": [ "Drafts / Ad Items / Rich Media" ], "summary": "Get a Draft Rich Media Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_rich_media_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Ad Items / Rich Media" ], "summary": "Update a Draft Rich Media Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_rich_media_ad_item_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_rich_media_ad_item_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Ad Items / Rich Media" ], "summary": "Delete a Draft Rich Media Ad Item", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/campaign-assignments": { "get": { "tags": [ "Drafts / Campaign Assignments" ], "summary": "Get a List of Draft Campaign Assignments", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft campaign assignments by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_campaign_assignment_list" } } } } } }, "post": { "tags": [ "Drafts / Campaign Assignments" ], "summary": "Create a Draft Campaign Assignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_campaign_assignment_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_campaign_assignment_get" } } } } } } }, "/drafts/campaign-assignments/{id}": { "get": { "tags": [ "Drafts / Campaign Assignments" ], "summary": "Get a Draft Campaign Assignment", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_campaign_assignment_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Campaign Assignments" ], "summary": "Update a Draft Campaign Assignment", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_campaign_assignment_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_campaign_assignment_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Campaign Assignments" ], "summary": "Delete a Draft Campaign Assignment", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/campaigns/standard": { "get": { "tags": [ "Drafts / Campaigns / Standard" ], "summary": "Get a List of Draft Standard Campaigns", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false }, { "name": "advertiser", "in": "query", "description": "Filter draft campaigns by one or many advertiser IDs.", "required": false, "schema": { "type": "string" }, "example": "56434,56001" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_standard_campaign_list" } } } } } }, "post": { "tags": [ "Drafts / Campaigns / Standard" ], "summary": "Create a Draft Standard Campaign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_standard_campaign_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_standard_campaign_get" } } } } } } }, "/drafts/campaigns/standard/{id}": { "get": { "tags": [ "Drafts / Campaigns / Standard" ], "summary": "Get a Draft Standard Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_standard_campaign_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Campaigns / Standard" ], "summary": "Update a Draft Standard Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_standard_campaign_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_standard_campaign_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Campaigns / Standard" ], "summary": "Delete a Draft Standard Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/campaigns/standard/{id}/save": { "post": { "tags": [ "Drafts / Campaigns / Standard" ], "summary": "Save a Draft Standard Campaign", "description": "Validates and converts a draft campaign and all its children (draft ad items, placements, schedules, and campaign assignments) into real resources. If validation passes, all real resources are created and the drafts are marked as converted. If any validation errors exist, no resources are created and a grouped error response is returned.", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_conversion_success" } } } }, "400": { "description": "validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_conversion_error" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" }, "405": { "description": "draft has already been converted", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "This draft has already been converted." } }, "type": "object" } } } } } } }, "/drafts/placements": { "get": { "tags": [ "Drafts / Placements" ], "summary": "Get a List of Draft Placements", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft placements by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_placement_list" } } } } } }, "post": { "tags": [ "Drafts / Placements" ], "summary": "Create a Draft Placement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_placement_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_placement_get" } } } } } } }, "/drafts/placements/{id}": { "get": { "tags": [ "Drafts / Placements" ], "summary": "Get a Draft Placement", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_placement_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Placements" ], "summary": "Update a Draft Placement", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_placement_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_placement_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Placements" ], "summary": "Delete a Draft Placement", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/drafts/schedules": { "get": { "tags": [ "Drafts / Schedules" ], "summary": "Get a List of Draft Schedules", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "campaign_draft_id", "in": "query", "description": "Filter draft schedules by a single draft campaign ID.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "asset_created", "in": "query", "description": "Filter drafts by conversion status. When __true__, only converted drafts are returned. When __false__, only unconverted drafts are returned.", "required": false, "schema": { "type": "boolean" }, "example": false } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_schedule_list" } } } } } }, "post": { "tags": [ "Drafts / Schedules" ], "summary": "Create a Draft Schedule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_schedule_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_schedule_get" } } } } } } }, "/drafts/schedules/{id}": { "get": { "tags": [ "Drafts / Schedules" ], "summary": "Get a Draft Schedule", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_schedule_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Drafts / Schedules" ], "summary": "Update a Draft Schedule", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_schedule_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/draft_schedule_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Drafts / Schedules" ], "summary": "Delete a Draft Schedule", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/connections/sftp": { "get": { "tags": [ "Event Log Backups SFTP Connections" ], "summary": "Get a List of All SFTP Connections", "description": "You can retrieve a list of all the sftp connections. You can use the `fields` query parameter to restrict the types of fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connections_sftp_list" } } } } } } }, "/connections/sftp/": { "post": { "tags": [ "Event Log Backups SFTP Connections" ], "summary": "Create a SFTP Connection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_sftp_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_sftp_get" } } } } } } }, "/connections/sftp/{sftp_connection_id}": { "get": { "tags": [ "Event Log Backups SFTP Connections" ], "summary": "Get a Single SFTP Connection", "parameters": [ { "name": "sftp_connection_id", "in": "path", "description": "Identifier of the sftp connection you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_sftp_get" } } } } } }, "put": { "tags": [ "Event Log Backups SFTP Connections" ], "summary": "Update a SFTP Connection", "parameters": [ { "name": "sftp_connection_id", "in": "path", "description": "Identifier of the sftp connection you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_sftp_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_sftp_get" } } } } } }, "delete": { "tags": [ "Event Log Backups SFTP Connections" ], "summary": "Delete a SFTP Connection", "parameters": [ { "name": "sftp_connection_id", "in": "path", "description": "Identifier of the sftp connection you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/connections/sftp/test": { "post": { "tags": [ "Event Log Backups SFTP Connections" ], "summary": "Test a SFTP Connection", "description": "Send an existing connection or all details of a connection to test if a connection can be made. A connection and new connection details can be sent together, and the new details will be used in the test.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_sftp_test_request" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_sftp_test_response" } } } } } } }, "/event-logs/upload-configuration/": { "get": { "tags": [ "Event Log Backups Upload Configurations" ], "summary": "Get a List of All Upload Configurations", "description": "You can retrieve a list of all the upload configurations. You can use the `fields` query parameter to restrict the types of fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_configuration_list" } } } } } }, "post": { "tags": [ "Event Log Backups Upload Configurations" ], "summary": "Create an Upload Configuration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_configuration_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_configuration_get" } } } } } } }, "/event-logs/upload-configuration/{upload_configuration_id}": { "get": { "tags": [ "Event Log Backups Upload Configurations" ], "summary": "Get a Single Upload Configuration", "parameters": [ { "name": "upload_configuration_id", "in": "path", "description": "Identifier of the upload configuration you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_configuration_get" } } } } } }, "put": { "tags": [ "Event Log Backups Upload Configurations" ], "summary": "Update an Upload Configuration", "parameters": [ { "name": "upload_configuration_id", "in": "path", "description": "Identifier of the upload configuration you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_configuration_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upload_configuration_get" } } } } } }, "delete": { "tags": [ "Event Log Backups Upload Configurations" ], "summary": "Delete an Upload Configuration", "parameters": [ { "name": "upload_configuration_id", "in": "path", "description": "Identifier of the upload configuration you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/event-logs/upload-log/": { "get": { "tags": [ "Event Log Backups Upload Logs" ], "summary": "Get a List of All Upload Logs", "description": "You can retrieve a list of all the upload logs. You can use the `fields` query parameter to restrict the types of fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_log_upload_log_list" } } } } } } }, "/event-logs/upload-log/{upload_log_id}": { "get": { "tags": [ "Event Log Backups Upload Logs" ], "summary": "Get a Single Upload Log", "parameters": [ { "name": "upload_log_id", "in": "path", "description": "Identifier of the upload log you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_log_upload_log_get" } } } } } } }, "/event-logs": { "get": { "tags": [ "Retrieve Event Logs" ], "summary": "Retrieve Event Logs", "description": "Retrieve event log information collected from your ad serving, such as impressions, clicks, and conversions. You can filter the statistics to retrieve using the parameters below.", "parameters": [ { "name": "log_type", "in": "query", "description": "The type of event log you wish to view. The value must be one of **display_impressions**, **display_clicks**, **display_conversions**, **display_blanks**, **vast_impressions**, **vast_clicks**, **vast_actions**, **vast_interactions** or **vast_blanks**.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "from", "in": "query", "description": "The start date of the range to retrieve event logs for. The value must be in YYYY-MM-DD format.", "required": false, "schema": { "type": "string", "format": "date" }, "example": "" }, { "name": "to", "in": "query", "description": "The end date of the range to retrieve event logs for. The value must be in YYYY-MM-DD format.", "required": false, "schema": { "type": "string", "format": "date" }, "example": "" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_logs" } } } } } } }, "/geo-targets": { "get": { "tags": [ "Geo Targets" ], "summary": "Get a List of Geo Targets", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/geo_target_list" } } } } } }, "post": { "tags": [ "Geo Targets" ], "summary": "Create a Geo Target", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/geo_target_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/geo_target_get" } } } } } } }, "/geo-targets/{id}": { "get": { "tags": [ "Geo Targets" ], "summary": "Get a Single Geo Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the geo target you want to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/geo_target_get" } } } } } }, "put": { "tags": [ "Geo Targets" ], "summary": "Update a Geo Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the geo target you want to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/geo_target_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/geo_target_get" } } } } } }, "delete": { "tags": [ "Geo Targets" ], "summary": "Delete a Geo Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the geo target you want to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/list-targets": { "get": { "tags": [ "List Targets" ], "summary": "Get a List of List Targets", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_target_list" } } } } } }, "post": { "tags": [ "List Targets" ], "summary": "Create a List Target", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_target_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_target_get" } } } } } } }, "/list-targets/{id}": { "get": { "tags": [ "List Targets" ], "summary": "Get a Single List Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the list target you want to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_target_get" } } } } } }, "put": { "tags": [ "List Targets" ], "summary": "Update a List Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the list target you want to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_target_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_target_get" } } } } } }, "delete": { "tags": [ "List Targets" ], "summary": "Delete a List Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the list target you want to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/list-targets/{id}/remove-usages": { "post": { "tags": [ "List Targets" ], "summary": "Remove Usages of a List Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the list target you want to remove usages for.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list_target_remove_usages" } } } } } } }, "/live-website-preview": { "get": { "tags": [ "Live Website Preview" ], "summary": "Retrieve Live Website Preview URL", "description": "Get preview URL that lets you check how your page will look like under different dates, times, and locations.", "parameters": [ { "name": "website_url", "in": "query", "description": "Specify the URL of the page you want to preview.", "required": true, "schema": { "type": "string" }, "example": "https://adbutler.com/" }, { "name": "preview_at", "in": "query", "description": "A valid ISO 8601 formatted date denoting the date and time of the preview. For example: __2020-01-01T00:00:00+00:00__. This field lets you specify a custom date and time when the live website preview starts.", "schema": { "type": "string", "format": "date-time" }, "example": "" }, { "name": "location[city]", "in": "query", "description": "This field lets you filter the preview by city. This field can only exist when a valid location[country] and location[region] fields are provided.", "schema": { "type": "string" }, "example": "Vancouver" }, { "name": "location[region]", "in": "query", "description": "This field lets you filter the preview by region. This field can only exist when a valid location[country] field is provided.", "schema": { "type": "string" }, "example": "British Columbia" }, { "name": "location[country]", "in": "query", "description": "This field lets you filter the preview by country.", "schema": { "type": "string" }, "example": "Canada" }, { "name": "advertiser", "in": "query", "description": "This field lets you filter the preview based on the advertiser id provided.", "schema": { "type": "integer" }, "example": "1234" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/live_website_preview_get" } } } } } } }, "/managers": { "get": { "tags": [ "Managers" ], "summary": "Get a List of Managers", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manager_list" } } } } } }, "post": { "tags": [ "Managers" ], "summary": "Create a Manager", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manager_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manager_get" } } } } } } }, "/managers/{id}": { "get": { "tags": [ "Managers" ], "summary": "Get a Single Manager", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the manager you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manager_get" } } } } } }, "put": { "tags": [ "Managers" ], "summary": "Update a Manager", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the manager you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manager_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manager_get" } } } } } }, "delete": { "tags": [ "Managers" ], "summary": "Delete a Manager", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the manager you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/manual-tracking-links": { "get": { "tags": [ "Manual Tracking Links" ], "summary": "Generate Manual Tracking Links for an Ad Item", "parameters": [ { "name": "placement", "in": "path", "description": "The placement ID that contains the ad item for which you want tracking links.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "ad_item", "in": "path", "description": "The ID of the ad item for which you want tracking links. `ad_item` is a required field if the desired ad item is in a campaign.", "required": false, "schema": { "type": "integer" }, "example": "" }, { "name": "type", "in": "path", "description": "Specifies the type of tracking links to generate and can be any of the following values: __\"impression\"__, __\"click_redirect\"__, __\"click_callback\"__. You can specify multiple values by separating them with a comma (e.g. `type=\"impression,click_callback\"`). Omitting `type` will return all of them in the response.", "required": false, "schema": { "type": "string" }, "example": "" }, { "name": "protocol", "in": "path", "description": "Whether to use http or https protocol for your tracking links. Accepted values are __\"http\"__ or __\"https\"__.", "required": false, "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manual_tracking_link_get" } } } } } } }, "/media-groups": { "get": { "tags": [ "Media Groups" ], "summary": "Get a List of Media Groups", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media_group_list" } } } } } }, "post": { "tags": [ "Media Groups" ], "summary": "Create a Media Group", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media_group_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media_group_get" } } } } } } }, "/media-groups/{id}": { "get": { "tags": [ "Media Groups" ], "summary": "Get a Single Media Group", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media_group you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media_group_get" } } } } } }, "put": { "tags": [ "Media Groups" ], "summary": "Update a Media Group", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media_group you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media_group_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/media_group_get" } } } } } }, "delete": { "tags": [ "Media Groups" ], "summary": "Delete a Media Group", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media_group you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/templates/native": { "get": { "tags": [ "Native Templates" ], "summary": "Get a List of Native Templates", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_template_list" } } } } } }, "post": { "tags": [ "Native Templates" ], "summary": "Create a Native Template", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_template_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_template_get" } } } } } } }, "/templates/native/{id}": { "get": { "tags": [ "Native Templates" ], "summary": "Get a Single Native Template", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_template_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Native Templates" ], "summary": "Update a Native Template", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_template_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/native_template_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Native Templates" ], "summary": "Delete a Native Template", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/templates/ortb-native/{ortb_native_template_id}/assets/data": { "get": { "tags": [ "ORTB Native Templates / Assets / Data" ], "summary": "Get a list of ORTB Native Data Assets", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_data_asset_list" } } } } } }, "post": { "tags": [ "ORTB Native Templates / Assets / Data" ], "summary": "Create an ORTB Native Data Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_data_asset_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_data_asset_get" } } } } } } }, "/templates/ortb-native/{ortb_native_template_id}/assets/data/{id}": { "get": { "tags": [ "ORTB Native Templates / Assets / Data" ], "summary": "Get a single ORTB Native Data Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Data Asset you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_data_asset_get" } } } } } }, "put": { "tags": [ "ORTB Native Templates / Assets / Data" ], "summary": "Update an ORTB Native Data Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Data Asset you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_data_asset_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_data_asset_get" } } } } } }, "delete": { "tags": [ "ORTB Native Templates / Assets / Data" ], "summary": "Delete an ORTB Native Data Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Data Asset you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/templates/ortb-native/{ortb_native_template_id}/assets/image": { "get": { "tags": [ "ORTB Native Templates / Assets / Image" ], "summary": "Get a list of ORTB Native Image Assets", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_image_asset_list" } } } } } }, "post": { "tags": [ "ORTB Native Templates / Assets / Image" ], "summary": "Create an ORTB Native Image Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_image_asset_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_image_asset_get" } } } } } } }, "/templates/ortb-native/{ortb_native_template_id}/assets/image/{id}": { "get": { "tags": [ "ORTB Native Templates / Assets / Image" ], "summary": "Get a single ORTB Native Image Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Image Asset you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_image_asset_get" } } } } } }, "put": { "tags": [ "ORTB Native Templates / Assets / Image" ], "summary": "Update an ORTB Native Image Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Image Asset you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_image_asset_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_image_asset_get" } } } } } }, "delete": { "tags": [ "ORTB Native Templates / Assets / Image" ], "summary": "Delete an ORTB Native Image Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Image Asset you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/templates/ortb-native": { "get": { "tags": [ "ORTB Native Templates" ], "summary": "Get a list of ORTB Native Templates", "parameters": [ { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_template_list" } } } } } }, "post": { "tags": [ "ORTB Native Templates" ], "summary": "Create an ORTB Native Template", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_template_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_template_get" } } } } } } }, "/templates/ortb-native/{id}": { "get": { "tags": [ "ORTB Native Templates" ], "summary": "Get a single ORTB Native Template", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Template you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_template_get" } } } } } }, "put": { "tags": [ "ORTB Native Templates" ], "summary": "Update an ORTB Native Template", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Template you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_template_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_template_get" } } } } } }, "delete": { "tags": [ "ORTB Native Templates" ], "summary": "Delete an ORTB Native Template", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Template you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/templates/ortb-native/{ortb_native_template_id}/assets/title": { "get": { "tags": [ "ORTB Native Templates / Assets / Title" ], "summary": "Get a list of ORTB Native Title Assets", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_title_asset_list" } } } } } }, "post": { "tags": [ "ORTB Native Templates / Assets / Title" ], "summary": "Create an ORTB Native Title Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_title_asset_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_title_asset_get" } } } } } } }, "/templates/ortb-native/{ortb_native_template_id}/assets/title/{id}": { "get": { "tags": [ "ORTB Native Templates / Assets / Title" ], "summary": "Get a single ORTB Native Title Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Title Asset you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_title_asset_get" } } } } } }, "put": { "tags": [ "ORTB Native Templates / Assets / Title" ], "summary": "Update an ORTB Native Title Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Title Asset you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_title_asset_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_title_asset_get" } } } } } }, "delete": { "tags": [ "ORTB Native Templates / Assets / Title" ], "summary": "Delete an ORTB Native Title Asset", "parameters": [ { "name": "ortb_native_template_id", "in": "path", "description": "Identifier of the ORTB Native Template.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Title Asset you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/placements": { "get": { "tags": [ "Placements" ], "summary": "Get a list of Placements", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "zone", "in": "query", "description": "Filter the placements by a single zone ID. Note: this filter is ignored if the `id` filter is used.", "required": false, "schema": { "type": "integer" }, "example": "56342" }, { "name": "ad_item", "in": "query", "description": "Filter the placements by a single ad item ID. Note: this filter is ignored if the `id` filter is used.", "required": false, "schema": { "type": "integer" }, "example": "88759422" }, { "name": "campaign", "in": "query", "description": "Filter the placements by a single campaign ID. Note: this filter is ignored if the `id` filter is used.", "required": false, "schema": { "type": "integer" }, "example": "99230" }, { "name": "bidder", "in": "query", "description": "Filter the placements by a single bidder ID. Note: this filter is ignored if the `id` filter is used.", "required": false, "schema": { "type": "integer" }, "example": "23261" }, { "name": "channel", "in": "query", "description": "Filter the placements by a single channel ID. Note: this filter is ignored if the `id` filter is used.", "required": false, "schema": { "type": "integer" }, "example": "18884" }, { "name": "type", "in": "query", "description": "Filter the placements by the type of advertisement. Valid options are: __campaign__, __ad_item__, __channel__, and __bidder__. Note: this filter is ignored if the `id` filter is used.", "required": false, "schema": { "type": "integer" }, "example": "campaign" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_list" } } } } } }, "post": { "tags": [ "Placements" ], "summary": "Create a Placement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_get" } } } } } } }, "/placements/{id}": { "get": { "tags": [ "Placements" ], "summary": "Get a Single Placement", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the placement you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_get" } } } } } }, "put": { "tags": [ "Placements" ], "summary": "Update a Placement", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the placement you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_get" } } } } } }, "delete": { "tags": [ "Placements" ], "summary": "Delete a Placement", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the placement you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/placements/{id}/conversion-tag": { "get": { "tags": [ "Placements" ], "summary": "Retrieve Placement Conversion Tag", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the placement you'd like to get a conversion tag for.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_conversion_tag" } } } } } } }, "/platform-targets": { "get": { "tags": [ "Platform Targets" ], "summary": "Get a List of Platform Targets", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_target_list" } } } } } }, "post": { "tags": [ "Platform Targets" ], "summary": "Create a Platform Target", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_target_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_target_get" } } } } } } }, "/platform-targets/{id}": { "get": { "tags": [ "Platform Targets" ], "summary": "Get a Single Platform Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the platform target you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_target_get" } } } } } }, "put": { "tags": [ "Platform Targets" ], "summary": "Update a Platform Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the platform target you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_target_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/platform_target_get" } } } } } }, "delete": { "tags": [ "Platform Targets" ], "summary": "Delete a Platform Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the platform target you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/pmp-deals": { "get": { "tags": [ "PMP Deals" ], "summary": "Get a list of PMP Deals", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pmp_deal_list" } } } } } }, "post": { "tags": [ "PMP Deals" ], "summary": "Create a PMP Deal.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pmp_deal_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pmp_deal_get" } } } } } } }, "/pmp-deals/{id}": { "get": { "tags": [ "PMP Deals" ], "summary": "Get a single PMP Deal.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the PMP Deal you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pmp_deal_get" } } } } } }, "put": { "tags": [ "PMP Deals" ], "summary": "Update a PMP Deal", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the PMP Deal you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pmp_deal_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pmp_deal_get" } } } } } }, "delete": { "tags": [ "PMP Deals" ], "summary": "Delete a PMP Deal", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the PMP Deal you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/postal-code-targets": { "get": { "tags": [ "Postal Code Targets" ], "summary": "Get a List of Postal Code Targets", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postal_code_target_list" } } } } } }, "post": { "tags": [ "Postal Code Targets" ], "summary": "Create a Postal Code Target", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postal_code_target_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postal_code_target_get" } } } } } } }, "/postal-code-targets/{id}": { "get": { "tags": [ "Postal Code Targets" ], "summary": "Get a Single Postal Code Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the postal code target you want to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postal_code_target_get" } } } } } }, "put": { "tags": [ "Postal Code Targets" ], "summary": "Update a Postal Code Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the postal code target you want to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postal_code_target_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postal_code_target_get" } } } } } }, "delete": { "tags": [ "Postal Code Targets" ], "summary": "Delete a Postal Code Target", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the postal code target you want to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/publishers/{publisher_id}/product-db/catalogs/{catalog_id}/items/search": { "get": { "tags": [ "Product DB / Catalog Items" ], "summary": "Search Product Catalog Items", "description": "Search for catalog items to help sellers choose which to promote. Recommend searching with `seller_id` + another field when creating an interface for a seller (advertiser) to find products when creating a promotion. It will limit results to the particular seller. Searching by `identifier` will find a unique product in the catalog. Searching by `GTIN` can often yield larger groups of products to promote.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "catalog_id", "in": "path", "description": "Identifier of the Product Catalog.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "seller_id", "in": "query", "description": "The seller's id", "schema": { "type": "string" }, "example": "" }, { "name": "search_text", "in": "query", "description": "Text to search product titles and brands with", "schema": { "type": "string" }, "example": "" }, { "name": "identifier", "in": "query", "description": "The catalog identifier to search for (eg. a SKU)", "schema": { "type": "string" }, "example": "" }, { "name": "gtin", "in": "query", "description": "A GTIN value to search for (eg a UPC)", "schema": { "type": "string" }, "example": "" }, { "name": "page", "in": "query", "description": "The page in which to return results from (1-N)", "schema": { "type": "integer", "minimum": 1 }, "example": "" }, { "name": "limit", "in": "query", "description": "The number of results per page to return (1-100)", "schema": { "type": "integer", "maximum": 100, "minimum": 1 }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_item_search" } } } } } } }, "/publishers/{publisher_id}/product-db/catalogs/{catalog_id}/items": { "post": { "tags": [ "Product DB / Catalog Items" ], "summary": "Create a Product Catalog Item", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "catalog_id", "in": "path", "description": "Identifier of the Product Catalog.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_item_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_item_get" } } } } } } }, "/publishers/{publisher_id}/product-db/catalogs/{catalog_id}/items/{identifier}": { "get": { "tags": [ "Product DB / Catalog Items" ], "summary": "Get a Single Product Catalog Item", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "catalog_id", "in": "path", "description": "Identifier of the Product Catalog.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "identifier", "in": "path", "description": "The unique identifier defined for this catalog item.", "required": true, "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_item_get" } } } } } }, "put": { "tags": [ "Product DB / Catalog Items" ], "summary": "Update a Product Catalog Item", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "catalog_id", "in": "path", "description": "Identifier of the Product Catalog.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "identifier", "in": "path", "description": "The unique identifier defined for this catalog item.", "required": true, "schema": { "type": "string" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_item_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_item_get" } } } } } } }, "/publishers/{publisher_id}/product-db/catalogs/{catalog_id}/items/bulk-upload": { "post": { "tags": [ "Product DB / Catalog Items / Bulk Upload" ], "summary": "Bulk Upload a Catalog CSV", "description": "Bulk upload a catalog CSV with column names that match the fields submitted to a catalog. Submitting a bulk upload moves the catalog into an IMPORT state, thus preventing modification of the catalog itself, or any catalog items until the import is complete. Subsequent bulk uploads behave much like bulk add & update combined - new items will be added, existing items will be updated. No items will be deleted.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "catalog_id", "in": "path", "description": "Identifier of the Product Catalog.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/product_catalog_bulk_upload" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_bulk_upload_result" } } } } } } }, "/publishers/{publisher_id}/product-db/catalogs": { "get": { "tags": [ "Product DB / Catalog" ], "summary": "Get a List of Product Catalogs", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_list" } } } } } }, "post": { "tags": [ "Product DB / Catalog" ], "summary": "Create a Product Catalog", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_get" } } } } } } }, "/publishers/{publisher_id}/product-db/catalogs/{catalog_id}": { "get": { "tags": [ "Product DB / Catalog" ], "summary": "Get a Single Product Catalog", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "catalog_id", "in": "path", "description": "Identifier of the Product Catalog.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_get" } } } } } }, "put": { "tags": [ "Product DB / Catalog" ], "summary": "Update a Product Catalog", "description": "Update a catalog to change fields, or key field values. You may not change the key fields (any field ending with `_field`) once the catalog leaves the SETUP state (eg. while it's in IMPORT state, or ACTIVE state). You may change the `field_list` values as long as you aren't removing any key fields.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "catalog_id", "in": "path", "description": "Identifier of the Product Catalog.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_catalog_get" } } } } } } }, "/publishers/{publisher_id}/product-db/source-targets": { "get": { "tags": [ "Product DB / Publisher Source Targets" ], "summary": "Get a List of Publisher Source Targets", "description": "Show a list of Publisher Source Targets.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_target_list" } } } } } }, "post": { "tags": [ "Product DB / Publisher Source Targets" ], "summary": "Create a Publisher Source Target", "description": "Create a Publisher Source Target.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_target_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_target_get" } } } } } } }, "/publishers/{publisher_id}/product-db/source-targets/{source_target_id}": { "get": { "tags": [ "Product DB / Publisher Source Targets" ], "summary": "Get a Single Publisher Source Target", "description": "Retrieve a single Publisher Source Target's details.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "source_target_id", "in": "path", "description": "Identifier of the Publisher Source Target.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_target_get" } } } } } }, "put": { "tags": [ "Product DB / Publisher Source Targets" ], "summary": "Update a Publisher Source Target", "description": "Update a Publisher Source Target.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "source_target_id", "in": "path", "description": "Identifier of the Publisher Source Target.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_target_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_target_get" } } } } } }, "delete": { "tags": [ "Product DB / Publisher Source Targets" ], "summary": "Delete a Publisher Source Target", "description": "Delete a Publisher Source Target.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "source_target_id", "in": "path", "description": "Identifier of the Publisher Source Target you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/publishers/{publisher_id}/product-db/sources": { "get": { "tags": [ "Product DB / Publisher Sources" ], "summary": "Get a List of Publisher Sources", "description": "Show a list of Publisher Sources.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_list" } } } } } }, "post": { "tags": [ "Product DB / Publisher Sources" ], "summary": "Create a Publisher Source", "description": "Create a Publisher Source.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_get" } } } } } } }, "/publishers/{publisher_id}/product-db/sources/bulk": { "post": { "tags": [ "Product DB / Publisher Sources" ], "summary": "Bulk Create Publisher Sources", "description": "Bulk creates publisher sources for a single publisher. Uses an array of source like the single create above.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_bulk_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_list" } } } } } } }, "/publishers/{publisher_id}/product-db/sources/{source_id}": { "get": { "tags": [ "Product DB / Publisher Sources" ], "summary": "Get a Single Publisher Source", "description": "Retrieve a single Publisher Source's details.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "source_id", "in": "path", "description": "Identifier of the Publisher Source.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_get" } } } } } }, "put": { "tags": [ "Product DB / Publisher Sources" ], "summary": "Update a Publisher Source", "description": "Update a Publisher Source.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "source_id", "in": "path", "description": "Identifier of the Publisher Source.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_db_publisher_source_get" } } } } } }, "delete": { "tags": [ "Product DB / Publisher Sources" ], "summary": "Delete a Publisher Source", "description": "Delete a Publisher Source.", "parameters": [ { "name": "publisher_id", "in": "path", "description": "Identifier of the Publisher.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "source_id", "in": "path", "description": "Identifier of the Publisher Source you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/publishers": { "get": { "tags": [ "Publishers" ], "summary": "Get a List of Publishers", "description": "Returns a list of publishers. If no publishers were found, the data object will be empty. You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publisher_list" } } } } } }, "post": { "tags": [ "Publishers" ], "summary": "Create a Publisher", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publisher_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publisher_get" } } } } } } }, "/publishers/archived": { "get": { "tags": [ "Publishers / Archived" ], "summary": "Get a List of Archived Publishers", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_publisher_list" } } } } } } }, "/publishers/archived/{id}/unarchive": { "get": { "tags": [ "Publishers / Archived" ], "summary": "Unarchive a Publisher", "description": "Unarchives the resource and all resources that were previously archived with the resource.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the publisher you'd like to unarchive", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "include_campaign_assignments", "in": "path", "description": "Whether or not to include related campaign assignments when unarchiving the resource. If an unarchived assignment references an invalid resource, the campaign assignment will not be unarchived and information about the invalid resource and references will be returned. The publisher resource will still be unarchived.", "schema": { "type": "boolean" }, "example": false }, { "name": "include_placements", "in": "path", "description": "Whether or not to include related placements when unarchiving the resource. If an unarchived placement references an invalid resource, the placement will not be unarchived and information about the invalid resource and references will be returned. The publisher resource will still be unarchived.", "schema": { "type": "boolean" }, "example": false } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unarchived_publisher" } } } } } } }, "/publishers/archived/{id}": { "get": { "tags": [ "Publishers / Archived" ], "summary": "Get a Single Archived Publisher", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the archived resource.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_publisher_get" } } } } } } }, "/publishers/{id}": { "get": { "tags": [ "Publishers" ], "summary": "Get a Single Publisher", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the publisher you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publisher_get" } } } } } }, "put": { "tags": [ "Publishers" ], "summary": "Update a Publisher", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the publisher you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publisher_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publisher_get" } } } } } }, "delete": { "tags": [ "Publishers" ], "summary": "Delete a Publisher", "description": "Permanently deletes a publisher. __This operation cannot be undone__. Successful deletion immediately stops serving any ads belonging to this publisher and publisher login will be disabled.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the publisher you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/publishers/{id}/archive": { "get": { "tags": [ "Publishers" ], "summary": "Archive a Publisher", "description": "Archives the resource and all direct descendants of this resource. Archived resources will be treated the same as deleted resources but can be restored through unarchiving.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the publisher you'd like to archive.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_publisher" } } } } } } }, "/reports": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Reports", "description": "Retrieve an overview of information collected from your ad serving, which can be filtered using the parameters below.", "parameters": [ { "name": "type", "in": "query", "description": "Specifies the focus of the statistics you are interested in viewing. The value must be one of __overview__, __publisher__, __advertiser__, __zone__, __campaign__, __ad-item__, __textad__, __popup__, __geo-target__, or __channel__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "period", "in": "query", "description": "The range of time you are interested in viewing. The value must be one of __day__, __week__, __month__, or __year__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified.", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "summary", "in": "query", "description": "Whether to show a summary (__true__) or not (__false__). Defaults to __true__.", "schema": { "type": "boolean" }, "example": false }, { "name": "details", "in": "query", "description": "Whether to show details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "breakdown", "in": "query", "description": "Whether to show breakdown of placements in summary and details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "advanced_conversion_data", "in": "query", "description": "Whether to show the advanced conversion columns `conversion_value` and `conversion_quantity`. These values will be 0 unless the Advanced Conversion Reporting feature is enabled. Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "financials", "in": "query", "description": "Whether to show financial data (__true__) or not (__false__). When true, the field `financials` will be included in the response. Defaults to __true__.", "schema": { "type": "boolean" }, "example": false }, { "name": "publishers", "in": "query", "description": "Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "zones", "in": "query", "description": "Submit this parameter to filter your report by a list of zone IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "advertisers", "in": "query", "description": "Submit this parameter to filter your report by a list of advertiser IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "campaigns", "in": "query", "description": "Submit this parameter to filter your report by a list of campaign IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "ad-items", "in": "query", "description": "Submit this parameter to filter your report by a list of ad item IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "textads", "in": "query", "description": "Submit this parameter to filter your report by a list of text ad IDs. The IDs must be submitted as a comma-separated list.", "deprecated": true, "schema": { "type": "string" }, "example": "" }, { "name": "popups", "in": "query", "description": "Submit this parameter to filter your report by a list of popup IDs. The IDs must be submitted as a comma-separated list.", "deprecated": true, "schema": { "type": "string" }, "example": "" }, { "name": "exclude_publisher_ad_items", "in": "query", "description": "When set to __true__, ad items that exist directly within zones are excluded from the report. Ad items connected to campaigns will still be included. Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "exclude_campaign_ad_items", "in": "query", "description": "When set to __true__, ad items that exist within campaigns are excluded from the report. Ad items connected to zones will still be included. Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "exclude_channel_stats", "in": "query", "description": "When set to __true__, any ads that were served using a channel will have their stats excluded. Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "require_channel_stats", "in": "query", "description": "When set to __true__, any ads that were served outside of a channel will have their stats excluded. Defaults to __false__.", "schema": { "type": "boolean" }, "example": false } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_example_get" } } } } } } }, "/reports/demand-source": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Demand Source Stats", "description": "Retrieve an overview of your programmatic demand sources, which can be filtered using the parameters below.", "parameters": [ { "name": "type", "in": "query", "description": "Specifies the focus of the statistics you are interested in viewing. The value must be one of __overview__, __publisher__, __zone__, __demand_source__, or __endpoint__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "period", "in": "query", "description": "The range of time you are interested in viewing. The value must be one of __day__, __week__, __month__, or __year__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified.", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "summary", "in": "query", "description": "Whether to show a summary (__true__) or not (__false__). Defaults to __true__.", "schema": { "type": "boolean" }, "example": false }, { "name": "details", "in": "query", "description": "Whether to show details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "breakdown", "in": "query", "description": "Whether to show breakdown of placements in summary and details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "publishers", "in": "query", "description": "Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "zones", "in": "query", "description": "Submit this parameter to filter your report by a list of zone IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "vastZones", "in": "query", "description": "Submit this parameter to filter your report by a list of VAST zone IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "endpoints", "in": "query", "description": "Submit this parameter to filter your report by a list of Demand Endpoint IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/demand_source_example_get" } } } } } } }, "/reports/auction-placements": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Auction Placement Stats", "description": "Retrieve an overview of placements that participated in auctions, which can be filtered using the parameters below.", "parameters": [ { "name": "type", "in": "query", "description": "Specifies the focus of the statistics you are interested in viewing. The value must be one of __overview__, __publisher__, __zone__, or __placement__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "period", "in": "query", "description": "The range of time you are interested in viewing. The value must be one of __day__, __week__, __month__, or __year__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified.", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "summary", "in": "query", "description": "Whether to show a summary (__true__) or not (__false__). Defaults to __true__.", "schema": { "type": "boolean" }, "example": false }, { "name": "details", "in": "query", "description": "Whether to show details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "breakdown", "in": "query", "description": "Whether to show breakdown of placements in summary and details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "publishers", "in": "query", "description": "Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "zones", "in": "query", "description": "Submit this parameter to filter your report by a list of zone IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "advertisers", "in": "query", "description": "Submit this parameter to filter your report by a list of advertiser IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "campaigns", "in": "query", "description": "Submit this parameter to filter your report by a list of campaign IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "placements", "in": "query", "description": "Submit this parameter to filter your report by a list of placement IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "ad-items", "in": "query", "description": "Submit this parameter to filter your report by a list of ad item IDs __that are directly assigned to a zone__. Ad items that are assigned to a campaign will be ignored in the filter process. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auction_placements_example_get" } } } } } } }, "/reports/conversion-details": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Conversion Details", "description": "If you are tracking conversions, this endpoint can be a great way to get a more detailed breakdown of how they are performing. You can get reports on conversions for specific zones, campaigns, and date ranges.", "parameters": [ { "name": "filter_type", "in": "query", "description": "Describes how you would like to filter the report, either by __zone__, __campaign__, __ad-item__, or __placement__. Leave this field blank if you don't want to filter.", "schema": { "type": "string" }, "example": "" }, { "name": "filter_ids", "in": "query", "description": "A comma-separated list of IDs to filter the report by. The parameter `filter_type` must be defined, and the IDs given for `filter_ids` must be either zoneIDs or campaignIDs to match the `filter_type` chosen.", "schema": { "type": "string" }, "example": "" }, { "name": "vast", "in": "query", "description": "Whether to return click details for VAST ads (__true__) or display ads (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified.", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "limit", "in": "query", "description": "A non-negative integer that indicates the number of records you'd like returned in the response.", "schema": { "type": "integer" }, "example": "" }, { "name": "offset", "in": "query", "description": "A non-negative integer that indicates how many records to skip when compiling the response.", "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversion_details_example_get" } } } } } } }, "/reports/click-details": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Click Details", "description": "This endpoint will allow you to get detailed breakdown of clicks in your account. Please note that we only keep the latest 3 months of click-through data.", "parameters": [ { "name": "filter_type", "in": "query", "description": "Describes how you would like to filter the report, either by __zone__ or by __campaign__. Leave this field blank if you don't want to filter.", "schema": { "type": "string" }, "example": "" }, { "name": "filter_ids", "in": "query", "description": "A comma-separated list of IDs to filter the report by. The parameter `filter_type` must be defined, and the IDs given for `filter_ids` must be either zoneIDs or campaignIDs to match the `filter_type` chosen.", "schema": { "type": "string" }, "example": "" }, { "name": "custom_filter_params", "in": "query", "description": "If your account is set up to use Custom Parameters, you can filter your clicks based on those parameters. This field is a comma-separated list of custom parameters you'd like to filter this report by.", "schema": { "type": "string" }, "example": "" }, { "name": "vast", "in": "query", "description": "Whether to return click details for VAST ads (__true__) or display ads (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __last-7-days__, __last-14-days__, __last-30-days__, or __last-3-months__.

Either a `preset` or a valid `to` and `from` must be specified.", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "limit", "in": "query", "description": "A non-negative integer that indicates the number of records you'd like returned in the response.", "schema": { "type": "integer" }, "example": "" }, { "name": "offset", "in": "query", "description": "A non-negative integer that indicates how many records to skip when compiling the response.", "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/click_details_example_get" } } } } } } }, "/reports/geo-summary-report": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Geographic Summary Stats", "description": "Retrieve a geographic breakdown by country for various types of views in your account.", "parameters": [ { "name": "type", "in": "query", "description": "Specifies the focus of the statistics you are interested in viewing. The value must be one of __overview__, __publisher__, __advertiser__, __zone__, __campaign__, or __ad-item__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified.", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "publishers", "in": "query", "description": "Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "zones", "in": "query", "description": "Submit this parameter to filter your report by a list of zone IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "advertisers", "in": "query", "description": "Submit this parameter to filter your report by a list of advertiser IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "campaigns", "in": "query", "description": "Submit this parameter to filter your report by a list of campaign IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "ad-items", "in": "query", "description": "Submit this parameter to filter your report by a list of ad item IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "textads", "in": "query", "description": "Submit this parameter to filter your report by a list of text ad IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "popups", "in": "query", "description": "Submit this parameter to filter your report by a list of popup IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/geo_summary_example_get" } } } } } } }, "/reports/display-platform-estimate": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Display Platform Stats", "description": "Retrieve the estimated platform statistics of the specified zones. The platform statistics are comprised of the average impressions per browser and operating system. The impressions are averaged either over 30 days or 7 days, whichever one provides the highest result.\n\nThe response includes the total averages for desktop, mobile, and tablet users. The individual averages for each browser and operating system are separated into desktop and mobile platforms.", "parameters": [ { "name": "zone_ids", "in": "query", "description": "Specify the display zone IDs for which the platform stats is to be calculated.", "required": true, "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_platform_stats_get" } } } } } } }, "/reports/vast-platform-estimate": { "get": { "tags": [ "Reports" ], "summary": "Retrieve VAST Platform Stats", "description": "Retrieve the estimated platform statistics of the specified VAST zones. The platform statistics are comprised of the average impressions per browser and operating system. The impressions are averaged either over 30 days or 7 days, whichever one provides the highest result.\n\nThe response includes the total averages for desktop, mobile, and tablet users. The individual averages for each browser and operating system are separated into desktop and mobile platforms.", "parameters": [ { "name": "zone_ids", "in": "query", "description": "Specify the VAST zone IDs for which the platform stats is to be calculated.", "required": true, "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_platform_stats_get" } } } } } } }, "/reports/placement-forecast": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Placement Forecast Stats", "description": "Retrieve the estimated daily impressions of a proposed placement within the given future date range. Aside from the date, you must also provide the theoretical placement's assignment details, such as serve method, delivery pacing, weight, and targets. The resulting forecast will consider the presence of any other placements within the provided date range.", "parameters": [ { "name": "zone_id", "in": "query", "description": "Specify the zone ID for the proposed placement for which the forecast is to be calculated.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "priority", "in": "query", "description": "How a placement will be preferred over over others in a zone. The possible values in descending order are __\"sponsorship\"__, __\"standard\"__, __\"network\"__, __\"bulk\"__ and __\"house\"__.", "required": true, "schema": { "type": "string" }, "example": "standard" }, { "name": "delivery_pacing", "in": "query", "description": "The pace of the proposed placement. It can either be __\"default\"__ or __\"smooth\"__. Default delivery delivers the impressions as quickly as possible. Smooth delivery will evenly serve ads based on the placement's lifetime dates and quotas. __NOTE:__ placements with `serve_method` set to __\"auction\"__ will always be delivered using the __\"default\"__ method regardless of this field's value. ", "required": true, "schema": { "type": "string" }, "example": "default" }, { "name": "serve_method", "in": "query", "description": "Whether the placement is served using a weight-based (__\"weight\"__) or auction-based (__\"auction\"__) system. Defaults to __\"weight\"__. Auction-based placements are served based on their CPM and schedule. Weight-based placements are served based on their weight and schedule. These placements can still have a CPM associated with them, but the CPM does not affect serving and is only used for reporting. __NOTE:__ the serve method cannot be changed. The 'serve_method' is required if the 'delivery_pacing' is set to __\"default\"__", "schema": { "type": "string" }, "example": "" }, { "name": "weight", "in": "query", "description": "An integer used to compute the probability of serving a particular placement. AdButler uses the weight values of the placements assigned to a zone to determine their distribution ratio. The higher the number, the higher the weight.\n\nFor example, you have two campaigns, A and B. Campaign A has a weight of 1, while Campaign B has a weight of 20. If all their other settings are the same, Campaign A will have a 1 in 21 odds of being served, while Campaign B will have a 20 in 21 odds of being served. Defaults to __1__.", "schema": { "type": "integer" }, "example": "1" }, { "name": "cpm", "in": "query", "description": "Cost per 1,000 impressions. This field is required if `serve_method` is set to __\"auction\"__.", "schema": { "type": "float" }, "example": "10" }, { "name": "start_date", "in": "query", "description": "A valid ISO 8601 formatted date denoting the inclusive start of the `period`. This field along with the `end_date` field lets you specify a custom date and time interval within which the forecast needs to be calculated.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2020-01-01T00:00:00+00:00" }, { "name": "end_date", "in": "query", "description": "A valid ISO 8601 formatted date denoting the exclusive end of the `period`. This field along with the `start_date` field lets you specify a custom date and time interval within which the forecast needs to be calculated.", "required": true, "schema": { "type": "string", "format": "date-time" }, "example": "2020-02-01T00:00:00+00:00" }, { "name": "quota_lifetime", "in": "query", "description": "The targeted number of impressions or clicks to deliver for a placement with a quota-based expiration method, where the ad or campaign will stop being served once the quota for __\"views\"__ or __\"clicks\"__ is met. AdButler will calculate the remaining inventory based on this value. This field is required if `delivery_pacing` is set to __\"smooth\"__.", "schema": { "type": "integer" }, "example": "10000" }, { "name": "quota_daily", "in": "query", "description": "An optional daily limit for a placement's impressions or clicks.", "schema": { "type": "integer" }, "example": "5000" }, { "name": "geo_target", "in": "query", "description": "The geotarget identifier (ID). Required if you want to enable geographic targeting, which forces ads to be served only to users in a particular location. Defaults to __\"null\"__, which means geographic targeting is not in effect.", "schema": { "type": "integer" }, "example": "123456" }, { "name": "platform_target", "in": "query", "description": "The platform target identifier (ID). Required if you want to enable platform targeting, which forces ads to be delivered only to users with particular devices, browsers, or operating systems. Defaults to __\"null\"__, which means platform targeting is not in effect.", "schema": { "type": "integer" }, "example": "null" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/placement_forecasting_get" } } } } } } }, "/reports/forecast/display": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Display Forecast Stats", "description": "Retrieve a forecast of daily projected impressions for a proposed placement in a display zone over a future date range. The forecast accounts for existing competing placements, targeting, and delivery settings.", "parameters": [ { "name": "zone_id", "in": "query", "description": "The ID of the display zone for which the forecast is to be calculated.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "priority", "in": "query", "description": "The priority of the proposed placement. Controls which placements are served over others. Must be one of __house__, __bulk__, __network__, __standard__, or __sponsorship__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "delivery_pacing", "in": "query", "description": "The delivery pacing of the proposed placement. Must be __default__ or __smooth__. Default delivery serves impressions as quickly as possible. Smooth delivery will evenly serve ads based on the placement's lifetime dates and quotas. __NOTE:__ Smooth delivery requires the Smooth Delivery feature to be enabled.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "serve_method", "in": "query", "description": "Whether the proposed placement is served using a weight-based (__weight__) or auction-based (__auction__) system. Must be one of __weight__ or __auction__. Required when `delivery_pacing` is __default__. __NOTE:__ Auction-based serving requires the Serve Method Option feature to be enabled.", "schema": { "type": "string" }, "example": "" }, { "name": "weight", "in": "query", "description": "A positive integer used to compute the probability of serving the proposed placement relative to others. Only applicable when `serve_method` is __weight__. Defaults to __1__.", "schema": { "type": "integer" }, "example": "" }, { "name": "cpm", "in": "query", "description": "Cost per 1,000 impressions. Required when `serve_method` is __auction__.", "schema": { "type": "number", "format": "float" }, "example": "" }, { "name": "start_date", "in": "query", "description": "The start date of the forecast window, in __YYYY-MM-DD__ format (e.g. __2026-04-15__). Must be a future date.", "required": true, "schema": { "type": "string", "format": "date" }, "example": "" }, { "name": "end_date", "in": "query", "description": "The end date of the forecast window, in __YYYY-MM-DD__ format (e.g. __2026-04-30__). Must be after `start_date`.", "required": true, "schema": { "type": "string", "format": "date" }, "example": "" }, { "name": "quota_lifetime", "in": "query", "description": "The maximum number of impressions to serve over the lifetime of the proposed placement. Required when `delivery_pacing` is __smooth__.", "schema": { "type": "integer" }, "example": "" }, { "name": "quota_daily", "in": "query", "description": "The maximum number of impressions to serve per day for the proposed placement.", "schema": { "type": "integer" }, "example": "" }, { "name": "geo_target", "in": "query", "description": "The ID of a geographic target to apply to the proposed placement. Defaults to __null__ (no geographic targeting). Requires the Geo Targeting feature to be enabled.", "schema": { "type": "integer" }, "example": "" }, { "name": "platform_target", "in": "query", "description": "The ID of a platform target to apply to the proposed placement. Defaults to __null__ (no platform targeting). Requires the Platform Targeting feature to be enabled.", "schema": { "type": "integer" }, "example": "" }, { "name": "data_key_target", "in": "query", "description": "A JSON-encoded string representing the data key targeting configuration for the proposed placement. Defaults to __null__ (no data key targeting). Requires the Data Key Targeting feature to be enabled.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_forecast_get" } } } } } } }, "/reports/forecast/display/channel": { "get": { "tags": [ "Reports" ], "summary": "Retrieve Display Channel Forecast Stats", "description": "Retrieve a forecast of daily projected impressions for a proposed placement across all zones in a display channel over a future date range. The forecast aggregates results from each zone in the channel and accounts for existing competing placements, targeting, and delivery settings. Requires the Channels feature to be enabled.", "parameters": [ { "name": "channel_id", "in": "query", "description": "The ID of the display channel for which the forecast is to be calculated.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "priority", "in": "query", "description": "The priority of the proposed placement. Controls which placements are served over others. Must be one of __house__, __bulk__, __network__, __standard__, or __sponsorship__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "delivery_pacing", "in": "query", "description": "The delivery pacing of the proposed placement. Must be __default__ or __smooth__. Default delivery serves impressions as quickly as possible. Smooth delivery will evenly serve ads based on the placement's lifetime dates and quotas. __NOTE:__ Smooth delivery requires the Smooth Delivery feature to be enabled.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "serve_method", "in": "query", "description": "Whether the proposed placement is served using a weight-based (__weight__) or auction-based (__auction__) system. Must be one of __weight__ or __auction__. Required when `delivery_pacing` is __default__. __NOTE:__ Auction-based serving requires the Serve Method Option feature to be enabled.", "schema": { "type": "string" }, "example": "" }, { "name": "weight", "in": "query", "description": "A positive integer used to compute the probability of serving the proposed placement relative to others. Only applicable when `serve_method` is __weight__. Defaults to __1__.", "schema": { "type": "integer" }, "example": "" }, { "name": "cpm", "in": "query", "description": "Cost per 1,000 impressions. Required when `serve_method` is __auction__.", "schema": { "type": "number", "format": "float" }, "example": "" }, { "name": "start_date", "in": "query", "description": "The start date of the forecast window, in __YYYY-MM-DD__ format (e.g. __2026-04-15__). Must be a future date.", "required": true, "schema": { "type": "string", "format": "date" }, "example": "" }, { "name": "end_date", "in": "query", "description": "The end date of the forecast window, in __YYYY-MM-DD__ format (e.g. __2026-04-30__). Must be after `start_date`.", "required": true, "schema": { "type": "string", "format": "date" }, "example": "" }, { "name": "quota_lifetime", "in": "query", "description": "The maximum number of impressions to serve over the lifetime of the proposed placement. Required when `delivery_pacing` is __smooth__.", "schema": { "type": "integer" }, "example": "" }, { "name": "quota_daily", "in": "query", "description": "The maximum number of impressions to serve per day for the proposed placement.", "schema": { "type": "integer" }, "example": "" }, { "name": "geo_target", "in": "query", "description": "The ID of a geographic target to apply to the proposed placement. Defaults to __null__ (no geographic targeting). Requires the Geo Targeting feature to be enabled.", "schema": { "type": "integer" }, "example": "" }, { "name": "platform_target", "in": "query", "description": "The ID of a platform target to apply to the proposed placement. Defaults to __null__ (no platform targeting). Requires the Platform Targeting feature to be enabled.", "schema": { "type": "integer" }, "example": "" }, { "name": "data_key_target", "in": "query", "description": "A JSON-encoded string representing the data key targeting configuration for the proposed placement. Defaults to __null__ (no data key targeting). Requires the Data Key Targeting feature to be enabled.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/display_channel_forecast_get" } } } } } } }, "/reports/forecast/vast": { "get": { "tags": [ "Reports" ], "summary": "Retrieve VAST Forecast Stats", "description": "Retrieve a forecast of daily projected impressions for a proposed placement in a VAST zone over a future date range. The forecast accounts for existing competing placements, targeting, and delivery settings.", "parameters": [ { "name": "zone_id", "in": "query", "description": "The ID of the VAST zone for which the forecast is to be calculated.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "priority", "in": "query", "description": "The priority of the proposed placement. Controls which placements are served over others. Must be one of __house__, __bulk__, __network__, __standard__, or __sponsorship__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "delivery_pacing", "in": "query", "description": "The delivery pacing of the proposed placement. Must be __default__ or __smooth__. Default delivery serves impressions as quickly as possible. Smooth delivery will evenly serve ads based on the placement's lifetime dates and quotas. __NOTE:__ Smooth delivery requires the Smooth Delivery feature to be enabled.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "serve_method", "in": "query", "description": "Whether the proposed placement is served using a weight-based (__weight__) or auction-based (__auction__) system. Must be one of __weight__ or __auction__. Required when `delivery_pacing` is __default__. __NOTE:__ Auction-based serving requires the Serve Method Option feature to be enabled.", "schema": { "type": "string" }, "example": "" }, { "name": "weight", "in": "query", "description": "A positive integer used to compute the probability of serving the proposed placement relative to others. Only applicable when `serve_method` is __weight__. Defaults to __1__.", "schema": { "type": "integer" }, "example": "" }, { "name": "cpm", "in": "query", "description": "Cost per 1,000 impressions. Required when `serve_method` is __auction__.", "schema": { "type": "number", "format": "float" }, "example": "" }, { "name": "start_date", "in": "query", "description": "The start date of the forecast window, in __YYYY-MM-DD__ format (e.g. __2026-04-15__). Must be a future date.", "required": true, "schema": { "type": "string", "format": "date" }, "example": "" }, { "name": "end_date", "in": "query", "description": "The end date of the forecast window, in __YYYY-MM-DD__ format (e.g. __2026-04-30__). Must be after `start_date`.", "required": true, "schema": { "type": "string", "format": "date" }, "example": "" }, { "name": "quota_lifetime", "in": "query", "description": "The maximum number of impressions to serve over the lifetime of the proposed placement. Required when `delivery_pacing` is __smooth__.", "schema": { "type": "integer" }, "example": "" }, { "name": "quota_daily", "in": "query", "description": "The maximum number of impressions to serve per day for the proposed placement.", "schema": { "type": "integer" }, "example": "" }, { "name": "geo_target", "in": "query", "description": "The ID of a geographic target to apply to the proposed placement. Defaults to __null__ (no geographic targeting). Requires the Geo Targeting feature to be enabled.", "schema": { "type": "integer" }, "example": "" }, { "name": "platform_target", "in": "query", "description": "The ID of a platform target to apply to the proposed placement. Defaults to __null__ (no platform targeting). Requires the Platform Targeting feature to be enabled.", "schema": { "type": "integer" }, "example": "" }, { "name": "data_key_target", "in": "query", "description": "A JSON-encoded string representing the data key targeting configuration for the proposed placement. Defaults to __null__ (no data key targeting). Requires the Data Key Targeting feature to be enabled.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_forecast_get" } } } } } } }, "/reports/forecast/vast/channel": { "get": { "tags": [ "Reports" ], "summary": "Retrieve VAST Channel Forecast Stats", "description": "Retrieve a forecast of daily projected impressions for a proposed placement across all zones in a VAST channel over a future date range. The forecast aggregates results from each zone in the channel and accounts for existing competing placements, targeting, and delivery settings. Requires the VAST and Channels features to be enabled.", "parameters": [ { "name": "channel_id", "in": "query", "description": "The ID of the VAST channel for which the forecast is to be calculated.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "priority", "in": "query", "description": "The priority of the proposed placement. Controls which placements are served over others. Must be one of __house__, __bulk__, __network__, __standard__, or __sponsorship__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "delivery_pacing", "in": "query", "description": "The delivery pacing of the proposed placement. Must be __default__ or __smooth__. Default delivery serves impressions as quickly as possible. Smooth delivery will evenly serve ads based on the placement's lifetime dates and quotas. __NOTE:__ Smooth delivery requires the Smooth Delivery feature to be enabled.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "serve_method", "in": "query", "description": "Whether the proposed placement is served using a weight-based (__weight__) or auction-based (__auction__) system. Must be one of __weight__ or __auction__. Required when `delivery_pacing` is __default__. __NOTE:__ Auction-based serving requires the Serve Method Option feature to be enabled.", "schema": { "type": "string" }, "example": "" }, { "name": "weight", "in": "query", "description": "A positive integer used to compute the probability of serving the proposed placement relative to others. Only applicable when `serve_method` is __weight__. Defaults to __1__.", "schema": { "type": "integer" }, "example": "" }, { "name": "cpm", "in": "query", "description": "Cost per 1,000 impressions. Required when `serve_method` is __auction__.", "schema": { "type": "number", "format": "float" }, "example": "" }, { "name": "start_date", "in": "query", "description": "The start date of the forecast window, in __YYYY-MM-DD__ format (e.g. __2026-04-15__). Must be a future date.", "required": true, "schema": { "type": "string", "format": "date" }, "example": "" }, { "name": "end_date", "in": "query", "description": "The end date of the forecast window, in __YYYY-MM-DD__ format (e.g. __2026-04-30__). Must be after `start_date`.", "required": true, "schema": { "type": "string", "format": "date" }, "example": "" }, { "name": "quota_lifetime", "in": "query", "description": "The maximum number of impressions to serve over the lifetime of the proposed placement. Required when `delivery_pacing` is __smooth__.", "schema": { "type": "integer" }, "example": "" }, { "name": "quota_daily", "in": "query", "description": "The maximum number of impressions to serve per day for the proposed placement.", "schema": { "type": "integer" }, "example": "" }, { "name": "geo_target", "in": "query", "description": "The ID of a geographic target to apply to the proposed placement. Defaults to __null__ (no geographic targeting). Requires the Geo Targeting feature to be enabled.", "schema": { "type": "integer" }, "example": "" }, { "name": "platform_target", "in": "query", "description": "The ID of a platform target to apply to the proposed placement. Defaults to __null__ (no platform targeting). Requires the Platform Targeting feature to be enabled.", "schema": { "type": "integer" }, "example": "" }, { "name": "data_key_target", "in": "query", "description": "A JSON-encoded string representing the data key targeting configuration for the proposed placement. Defaults to __null__ (no data key targeting). Requires the Data Key Targeting feature to be enabled.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_forecast_get" } } } } } } }, "/roles": { "get": { "tags": [ "Roles" ], "summary": "Get a List of Roles", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role_list" } } } } } }, "post": { "tags": [ "Roles" ], "summary": "Create a Role", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role_get" } } } } } } }, "/roles/{id}": { "get": { "tags": [ "Roles" ], "summary": "Get a Single Role", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the role you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role_get" } } } } } }, "put": { "tags": [ "Roles" ], "summary": "Update a Role", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the role you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role_get" } } } } } }, "delete": { "tags": [ "Roles" ], "summary": "Delete a Role", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the role you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/schedules": { "get": { "tags": [ "Schedules" ], "summary": "Get a List of Schedules", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_list" } } } } } }, "post": { "tags": [ "Schedules" ], "summary": "Create a Schedule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_get" } } } } } } }, "/schedules/{id}": { "get": { "tags": [ "Schedules" ], "summary": "Get a Single Schedule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the schedule you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_get" } } } } } }, "put": { "tags": [ "Schedules" ], "summary": "Update a Schedule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the schedule you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule_get" } } } } } }, "delete": { "tags": [ "Schedules" ], "summary": "Delete a Schedule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the schedule you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/trusted-redirect-domains": { "get": { "tags": [ "Trusted Redirect Domains" ], "summary": "Get a list of trusted redirect domains", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_redirect_domains_list" } } } } } }, "post": { "tags": [ "Trusted Redirect Domains" ], "summary": "Create a trusted redirect domain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_redirect_domains_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_redirect_domains_get" } } } } } } }, "/trusted-redirect-domains/{id}": { "get": { "tags": [ "Trusted Redirect Domains" ], "summary": "Get a trusted redirect domain", "parameters": [ { "name": "id", "in": "path", "description": "The id of a trusted redirect domain", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_redirect_domains_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Trusted Redirect Domains" ], "summary": "Update a trusted redirect domain", "parameters": [ { "name": "id", "in": "path", "description": "The id of a trusted redirect domain", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_redirect_domains_put" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_redirect_domains_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Trusted Redirect Domains" ], "summary": "Delete a trusted redirect domain", "parameters": [ { "name": "id", "in": "path", "description": "The id of a trusted redirect domain", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/user-dbs/{user_db_id}/users/{user_id}/{list_attribute_name}/add": { "post": { "tags": [ "User DBs / Users / User List Attribute" ], "summary": "Add values to the user attribute list values", "parameters": [ { "name": "user_db_id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "user_id", "in": "path", "description": "Identifier of the User ID.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "list_attribute_name", "in": "path", "description": "Name of the user attribute that is a list type.", "required": true, "schema": { "type": "string" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_attribute_list_value_add" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_attribute_list_value_get" } } } } } } }, "/user-dbs/{user_db_id}/users/{user_id}/{list_attribute_name}/remove": { "post": { "tags": [ "User DBs / Users / User List Attribute" ], "summary": "Remove the values from the user attribute list values", "parameters": [ { "name": "user_db_id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "user_id", "in": "path", "description": "Identifier of the User ID.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "list_attribute_name", "in": "path", "description": "Name of the user attribute that is a list type.", "required": true, "schema": { "type": "string" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_attribute_list_value_remove" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_attribute_list_value_get" } } } } } } }, "/user-dbs/{id}/user-attributes": { "get": { "tags": [ "User DBs / User Attributes" ], "summary": "Get a list of user attributes", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_attributes_list" } } } } } }, "post": { "tags": [ "User DBs / User Attributes" ], "summary": "Create a user attribute", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_attribute_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_attribute_get" } } } } } } }, "/user-dbs/{id}/user-attributes/{attribute-id}": { "get": { "tags": [ "User DBs / User Attributes" ], "summary": "Get a single user attribute", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "attribute-id", "in": "path", "description": "Identifier of the attribute.", "required": true, "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_attribute_get" } } } } } }, "put": { "tags": [ "User DBs / User Attributes" ], "summary": "Update a single user attribute", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "attribute-id", "in": "path", "description": "Identifier of the attribute.", "required": true, "schema": { "type": "string" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_attribute_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_attribute_get" } } } } } }, "delete": { "tags": [ "User DBs / User Attributes" ], "summary": "Update a single user attribute", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "attribute-id", "in": "path", "description": "Identifier of the attribute.", "required": true, "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/user-dbs/{id}/audiences": { "get": { "tags": [ "User DBs / Audiences" ], "summary": "Get a list of audiences.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_audience_list" } } } } } }, "post": { "tags": [ "User DBs / Audiences" ], "summary": "Create an audience.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_audience_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_audience_get" } } } } } } }, "/user-dbs/{id}/audiences/{audience-id}": { "get": { "tags": [ "User DBs / Audiences" ], "summary": "Get a single audience", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "audience-id", "in": "path", "description": "Identifier of the audience.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_audience_get" } } } } } }, "put": { "tags": [ "User DBs / Audiences" ], "summary": "Update a single audience", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "audience-id", "in": "path", "description": "Identifier of the audience.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_audience_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_audience_get" } } } } } }, "delete": { "tags": [ "User DBs / Audiences" ], "summary": "Delete a single audience", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "audience-id", "in": "path", "description": "Identifier of the audience.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/user-dbs/{id}/bulk-upload-replace": { "post": { "tags": [ "User DBs / Bulk Upload" ], "summary": "Bulk upload user data to a User DB", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/user_db_bulk_upload_replace" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_bulk_upload_replace_result" } } } } } } }, "/user-dbs/{user-db-id}/users": { "post": { "tags": [ "User DBs / Users" ], "summary": "Create a user.", "parameters": [ { "name": "user-db-id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_get" } } } } } } }, "/user-dbs/{user-db-id}/users/{user-id}": { "get": { "tags": [ "User DBs / Users" ], "summary": "Get a single user", "parameters": [ { "name": "user-db-id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "user-id", "in": "path", "description": "Identifier of the user.", "required": true, "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_get" } } } } } } }, "/user-dbs/{user-db-id}/audiences/{user-id}": { "put": { "tags": [ "User DBs / Users" ], "summary": "Update a single user", "parameters": [ { "name": "user-db-id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "user-id", "in": "path", "description": "Identifier of the user.", "required": true, "schema": { "type": "string" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_user_get" } } } } } } }, "/user-dbs": { "get": { "tags": [ "User DBs" ], "summary": "Get a list of User DBs", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_list" } } } } } }, "post": { "tags": [ "User DBs" ], "summary": "Create a User DB", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_get" } } } } } } }, "/user-dbs/{id}": { "get": { "tags": [ "User DBs" ], "summary": "Get a single User DB", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the User DB.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user_db_get" } } } } } } }, "/vast-ad-items": { "get": { "tags": [ "VAST Ad Items" ], "summary": "Get a list of VAST Ad Items", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_ad_item_list" } } } } } }, "post": { "tags": [ "VAST Ad Items" ], "summary": "Create a VAST Ad Item.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_ad_item_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_ad_item_get" } } } } } } }, "/vast-ad-items/{id}": { "get": { "tags": [ "VAST Ad Items" ], "summary": "Get a single VAST Ad Item.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST ad item you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_ad_item_get" } } } } } }, "put": { "tags": [ "VAST Ad Items" ], "summary": "Update a VAST Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST ad item you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_ad_item_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_ad_item_get" } } } } } }, "delete": { "tags": [ "VAST Ad Items" ], "summary": "Delete a VAST Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST ad item you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-ad-items/{id}/conversion-tag": { "get": { "tags": [ "VAST Ad Items" ], "summary": "Retrieve Conversion Tag (VAST ad item).", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST ad item you'd like to get a conversion tag for.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_ad_item_conversion_tag" } } } } } } }, "/vast-campaign-assignments": { "get": { "tags": [ "VAST Campaign Assignments" ], "summary": "Get a List of VAST Campaign Assignments", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "vast_campaign_assignment_ad_item_filter", "name": "ad_item", "in": "query", "description": "Filter the results to only show campaign assignments connected to the specified ad item(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" }, { "parameter": "vast_campaign_assignment_campaign_filter", "name": "campaign", "in": "query", "description": "Filter the results to only show campaign assignments connected to the specified campaign(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_assignment_list" } } } } } }, "post": { "tags": [ "VAST Campaign Assignments" ], "summary": "Create a VAST Campaign Assignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_assignment_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_assignment_get" } } } } } } }, "/vast-campaign-assignments/{id}": { "get": { "tags": [ "VAST Campaign Assignments" ], "summary": "Get a Single VAST Campaign Assignment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the campaign assignment you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_assignment_get" } } } } } }, "put": { "tags": [ "VAST Campaign Assignments" ], "summary": "Update a VAST Campaign Assignment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the campaign assignmnet you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_assignment_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_assignment_get" } } } } } }, "delete": { "tags": [ "VAST Campaign Assignments" ], "summary": "Delete a VAST Campaign Assignment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the campaign assignment you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-campaigns": { "get": { "tags": [ "VAST Campaigns" ], "summary": "Get a List of VAST Campaigns", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "vast_campaign_advertiser_filter", "name": "advertiser", "in": "query", "description": "Filter the results to only show campaigns connected to the specified advertiser(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_list" } } } } } }, "post": { "tags": [ "VAST Campaigns" ], "summary": "Create a VAST Campaign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_get" } } } } } } }, "/vast-campaigns/archived": { "get": { "tags": [ "VAST Campaigns / Archived" ], "summary": "Get a List of Archived VAST Campaigns", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_vast_campaign_list" } } } } } } }, "/vast-campaigns/archived/{id}/unarchive": { "get": { "tags": [ "VAST Campaigns / Archived" ], "summary": "Unarchive a VAST Campaign", "description": "Unarchives the resource and all resources that were previously archived with the resource.", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/unarchive_include_campaign_assignments" }, { "$ref": "#/components/parameters/unarchive_include_placements" }, { "$ref": "#/components/parameters/unarchive_pause_placements" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_unarchive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-campaigns/archived/{id}": { "get": { "tags": [ "VAST Campaigns / Archived" ], "summary": "Get an Archived VAST Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_vast_campaign_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "VAST Campaigns / Archived" ], "summary": "Delete an Archived VAST Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-campaigns/{id}": { "get": { "tags": [ "VAST Campaigns" ], "summary": "Get a VAST Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "VAST Campaigns" ], "summary": "Update a VAST Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "VAST Campaigns" ], "summary": "Delete a VAST Campaign", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-campaigns/{id}/conversion-tag": { "get": { "tags": [ "VAST Campaigns" ], "summary": "Retrieve VAST Campaign Conversion Tag", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversion_tag" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-campaigns/{id}/archive": { "get": { "tags": [ "VAST Campaigns" ], "summary": "Archive a VAST Campaign", "description": "Archives the resource and all direct descendants of this resource. Archived resources will be treated the same as deleted resources but can be restored through unarchiving.", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_campaign_archive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-channel-zone-assignments": { "get": { "tags": [ "VAST Channel Zone Assignments" ], "summary": "Get a list of VAST Channel Zone Assignments", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_zone_assignment_list" } } } } } }, "post": { "tags": [ "VAST Channel Zone Assignments" ], "summary": "Create a VAST Channel Zone Assignment.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_zone_assignment_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_zone_assignment_get" } } } } } } }, "/vast-channel-zone-assignments/{id}": { "get": { "tags": [ "VAST Channel Zone Assignments" ], "summary": "Get a single VAST Channel Zone Assignment.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the channel zone assignment you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_zone_assignment_get" } } } } } }, "delete": { "tags": [ "VAST Channel Zone Assignments" ], "summary": "Delete a VAST Channel Zone Assignment.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the channel zone assignment you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-channels": { "get": { "tags": [ "VAST Channels" ], "summary": "Get a List of VAST Channels", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_list" } } } } } }, "post": { "tags": [ "VAST Channels" ], "summary": "Create a VAST Channel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_get" } } } } } } }, "/vast-channels/archived": { "get": { "tags": [ "VAST Channels / Archived" ], "summary": "Get a List of Archived VAST Channels", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_vast_channel_list" } } } } } } }, "/vast-channels/archived/{id}": { "get": { "tags": [ "VAST Channels / Archived" ], "summary": "Get an Archived VAST Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_vast_channel_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "VAST Channels / Archived" ], "summary": "Delete an Archived Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-channels/archived/{id}/unarchive": { "get": { "tags": [ "VAST Channels / Archived" ], "summary": "Unarchive an Archived Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/unarchive_include_zone_assignments" }, { "$ref": "#/components/parameters/unarchive_include_placements" }, { "$ref": "#/components/parameters/unarchive_pause_placements" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_unarchive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-channels/{id}": { "get": { "tags": [ "VAST Channels" ], "summary": "Get a Single VAST Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "VAST Channels" ], "summary": "Update a VAST Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "VAST Channels" ], "summary": "Delete a VAST Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-channels/{id}/archive": { "get": { "tags": [ "VAST Channels" ], "summary": "Archive a VAST Channel", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_channel_archive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-companions": { "get": { "tags": [ "VAST Companions" ], "summary": "Get a list of VAST Companions", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "companion_vast_ad_filter", "name": "vast_ad_id", "in": "query", "description": "Filter the results to only show companions connected to the specified VAST ad item.", "deprecated": true, "schema": { "type": "integer" }, "example": "" }, { "parameter": "companion_vast_ad_items_filter", "name": "ad_item", "in": "query", "description": "Filter the results to only show companions connected to the specified VAST ad item(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_companion_list" } } } } } }, "post": { "tags": [ "VAST Companions" ], "summary": "Create a VAST Companion.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_companion_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_companion_get" } } } } } } }, "/vast-companions/{id}": { "get": { "tags": [ "VAST Companions" ], "summary": "Get a single VAST Companion.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the companion you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_companion_get" } } } } } }, "put": { "tags": [ "VAST Companions" ], "summary": "Update a VAST Companion", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the companion you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_companion_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_companion_get" } } } } } }, "delete": { "tags": [ "VAST Companions" ], "summary": "Delete a VAST Companion.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the companion you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-media": { "get": { "tags": [ "VAST Media (All)" ], "summary": "Get a list of all VAST Media", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "media_vast_ad_filter", "name": "ad_item", "in": "query", "description": "Filter the results to only show media connected to the specified VAST ad item(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_list" } } } } } } }, "/vast-media/linear": { "get": { "tags": [ "VAST Media / Linear" ], "summary": "Get a list of Linear Media", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "linear_media_vast_ad_filter", "name": "ad_item", "in": "query", "description": "Filter the results to only show media connected to the specified VAST ad item(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_linear_list" } } } } } }, "post": { "tags": [ "VAST Media / Linear" ], "summary": "Create a Linear Media.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_linear_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_linear_get" } } } } } } }, "/vast-media/linear/{id}": { "get": { "tags": [ "VAST Media / Linear" ], "summary": "Get a single Linear Media.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_linear_get" } } } } } }, "put": { "tags": [ "VAST Media / Linear" ], "summary": "Update a Linear Media", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_linear_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_linear_get" } } } } } }, "delete": { "tags": [ "VAST Media / Linear" ], "summary": "Delete a Linear Media.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-media/non-linear": { "get": { "tags": [ "VAST Media / Non-Linear" ], "summary": "Get a list of Non-Linear Media", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "non_linear_media_vast_ad_filter", "name": "ad_item", "in": "query", "description": "Filter the results to only show media connected to the specified VAST ad item(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_non_linear_list" } } } } } }, "post": { "tags": [ "VAST Media / Non-Linear" ], "summary": "Create a Non-Linear Media.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_non_linear_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_non_linear_get" } } } } } } }, "/vast-media/non-linear/{id}": { "get": { "tags": [ "VAST Media / Non-Linear" ], "summary": "Get a single Non-Linear Media.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_non_linear_get" } } } } } }, "put": { "tags": [ "VAST Media / Non-Linear" ], "summary": "Update a Non-Linear Media", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_non_linear_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_media_non_linear_get" } } } } } }, "delete": { "tags": [ "VAST Media / Non-Linear" ], "summary": "Delete a Non-Linear Media.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-placements": { "get": { "tags": [ "VAST Placements" ], "summary": "Get a list of VAST Placements", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "vast_placement_ad_item_filter", "name": "ad_item", "in": "query", "description": "Filter the results to only show placements connected to the specified ad item(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" }, { "parameter": "vast_placement_campaign_filter", "name": "campaign", "in": "query", "description": "Filter the results to only show placements connected to the specified campaign(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" }, { "parameter": "vast_placement_zone_filter", "name": "zone", "in": "query", "description": "Filter the results to only show placements connected to the specified zone(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" }, { "parameter": "vast_placement_channel_filter", "name": "channel", "in": "query", "description": "Filter the results to only show placements connected to the specified channel(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_placement_list" } } } } } }, "post": { "tags": [ "VAST Placements" ], "summary": "Create a VAST Placement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_placement_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_placement_get" } } } } } } }, "/vast-placements/{id}": { "get": { "tags": [ "VAST Placements" ], "summary": "Get a Single VAST Placement", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST placement you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_placement_get" } } } } } }, "put": { "tags": [ "VAST Placements" ], "summary": "Update a VAST Placement", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST placement you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_placement_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_placement_get" } } } } } }, "delete": { "tags": [ "VAST Placements" ], "summary": "Delete a VAST Placement", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST placement you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-placements/{id}/conversion-tag": { "get": { "tags": [ "VAST Placements" ], "summary": "Retrieve VAST Placement Conversion Tag", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST placement you'd like to get a conversion tag for.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_placement_conversion_tag" } } } } } } }, "/vast-reports": { "get": { "tags": [ "VAST 2 Reports" ], "summary": "Retrieve VAST Reports", "description": "Retrieve an overview of information collected from your ad serving, which can be filtered using the parameters below.", "parameters": [ { "name": "type", "in": "query", "description": "Specifies the focus of the statistics you are interested in viewing. The value must be one of __overview__, __publisher__, __advertiser__, __zone__, __campaign__, or __ad-item__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "period", "in": "query", "description": "The range of time you are interested in viewing. The value must be one of __day__, __week__, __month__, or __year__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified.

", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "summary", "in": "query", "description": "Whether to show a summary (__true__) or not (__false__). Defaults to __true__.", "schema": { "type": "boolean" }, "example": false }, { "name": "details", "in": "query", "description": "Whether to show details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "breakdown", "in": "query", "description": "Whether to show breakdown of placements in summary and details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "financials", "in": "query", "description": "Whether to show financial data (__true__) or not (__false__). When true, you will see additional fields like `cost`, `payout`, `revenue`, `e_cpm`, `e_cpc`, and `e_cpa` in the response. Defaults to __true__.", "schema": { "type": "boolean" }, "example": false }, { "name": "publishers", "in": "query", "description": "Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "zones", "in": "query", "description": "Submit this parameter to filter your report by a list of zone IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "advertisers", "in": "query", "description": "Submit this parameter to filter your report by a list of advertiser IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "campaigns", "in": "query", "description": "Submit this parameter to filter your report by a list of campaign IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "ad-items", "in": "query", "description": "Submit this parameter to filter your report by a list of ad item IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_report_example_get" } } } } } } }, "/vast-reports/auction-placements": { "get": { "tags": [ "VAST 2 Reports" ], "summary": "Retrieve VAST Auction Placement Stats", "description": "Retrieve an overview of placements that participated in auctions, which can be filtered using the parameters below.", "parameters": [ { "name": "type", "in": "query", "description": "Specifies the focus of the statistics you are interested in viewing. The value must be one of __overview__, __publisher__, __zone__, or __placement__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "period", "in": "query", "description": "The range of time you are interested in viewing. The value must be one of __day__, __week__, __month__, or __year__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified.

", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "summary", "in": "query", "description": "Whether to show a summary (__true__) or not (__false__). Defaults to __true__.", "schema": { "type": "boolean" }, "example": false }, { "name": "details", "in": "query", "description": "Whether to show details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "breakdown", "in": "query", "description": "Whether to show breakdown of placements in summary and details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "publishers", "in": "query", "description": "Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "zones", "in": "query", "description": "Submit this parameter to filter your report by a list of VAST zone IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "advertisers", "in": "query", "description": "Submit this parameter to filter your report by a list of advertiser IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "campaigns", "in": "query", "description": "Submit this parameter to filter your report by a list of VAST campaign IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "placements", "in": "query", "description": "Submit this parameter to filter your report by a list of VAST placement IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "ad-items", "in": "query", "description": "Submit this parameter to filter your report by a list of VAST ad item IDs __that are directly assigned to a zone__. Ad items that are assigned to a campaign will be ignored in the filter process. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_auction_placements_example_get" } } } } } } }, "/vast-reports/geo-summary-report": { "get": { "tags": [ "VAST 2 Reports" ], "summary": "Retrieve VAST Geographic Summary Stats", "description": "Retrieve a geographic breakdown for VAST traffic by country for various types of views in your account.", "parameters": [ { "name": "type", "in": "query", "description": "Specifies the focus of the statistics you are interested in viewing. The value must be one of __overview__, __publisher__, __advertiser__, __zone__, __campaign__, or __ad-item__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified.

", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "publishers", "in": "query", "description": "Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "zones", "in": "query", "description": "Submit this parameter to filter your report by a list of zone IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "advertisers", "in": "query", "description": "Submit this parameter to filter your report by a list of advertiser IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "campaigns", "in": "query", "description": "Submit this parameter to filter your report by a list of campaign IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "ad-items", "in": "query", "description": "Submit this parameter to filter your report by a list of ad item IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_geo_summary_example_get" } } } } } } }, "/vast-schedules": { "get": { "tags": [ "VAST Schedules" ], "summary": "Get a List of VAST Schedules", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_schedule_list" } } } } } }, "post": { "tags": [ "VAST Schedules" ], "summary": "Create a VAST Schedule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_schedule_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_schedule_get" } } } } } } }, "/vast-schedules/{id}": { "get": { "tags": [ "VAST Schedules" ], "summary": "Get a Single VAST Schedule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the schedule you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_schedule_get" } } } } } }, "put": { "tags": [ "VAST Schedules" ], "summary": "Update a VAST Schedule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the schedule you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_schedule_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_schedule_get" } } } } } }, "delete": { "tags": [ "VAST Schedules" ], "summary": "Delete a VAST Schedule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the schedule you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-tracking": { "get": { "tags": [ "VAST Tracking" ], "summary": "Get a list of VAST Tracking Links", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "tracking_vast_ad_filter", "name": "ad_item", "in": "query", "description": "Filter the results to only show tracking links connected to the specified VAST ad item(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_tracking_list" } } } } } }, "post": { "tags": [ "VAST Tracking" ], "summary": "Create a VAST Tracking Link.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_tracking_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_tracking_get" } } } } } } }, "/vast-tracking/{id}": { "get": { "tags": [ "VAST Tracking" ], "summary": "Get a single VAST Tracking Link.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the vast tracking link you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_tracking_get" } } } } } }, "put": { "tags": [ "VAST Tracking" ], "summary": "Update a VAST Tracking Link", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the vast tracking link you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_tracking_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_tracking_get" } } } } } }, "delete": { "tags": [ "VAST Tracking" ], "summary": "Delete a VAST Tracking Link", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the vast tracking link you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-zones": { "get": { "tags": [ "VAST Zones" ], "summary": "Get a List of VAST Zones", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "parameter": "vast_zone_publisher_filter", "name": "publisher", "in": "query", "description": "Filter the results to only show zones connected to the specified publisher(s). Formatted as a list of the IDs separated by commas. (For example: __\"1134,1153,1138,1176\"__)", "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_zone_list" } } } } } }, "post": { "tags": [ "VAST Zones" ], "summary": "Create a VAST Zone", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_zone" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_zone_get" } } } } } } }, "/vast-zones/archived": { "get": { "tags": [ "VAST Zones / Archived" ], "summary": "Get a List of Archived VAST Zones", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_vast_zone_list" } } } } } } }, "/vast-zones/archived/{id}/unarchive": { "get": { "tags": [ "VAST Zones / Archived" ], "summary": "Unarchive a VAST Zone", "description": "Unarchives the resource and all resources that were previously archived with the resource.", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/unarchive_include_placements" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_zone_unarchive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-zones/archived/{id}": { "get": { "tags": [ "VAST Zones / Archived" ], "summary": "Get an Archived VAST Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_vast_zone_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-zones/{id}": { "get": { "tags": [ "VAST Zones" ], "summary": "Get a Single VAST Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_zone_get" } } } } } }, "put": { "tags": [ "VAST Zones" ], "summary": "Update a VAST Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_zone" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_zone_get" } } } } } }, "delete": { "tags": [ "VAST Zones" ], "summary": "Delete a VAST Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast-zones/{id}/tags": { "get": { "tags": [ "VAST Zones" ], "summary": "Retrieve VAST Zone Tag", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "name": "protocol", "in": "query", "description": "Lets you specify a protocol for retrieving the URLs in the response. Possible values are **https** and **http**. If no value is given, the retrieved URLs will use http://. Affects all tag types.", "schema": { "type": "string" }, "example": "https" }, { "name": "ortb", "in": "query", "description": "Lets you specify a tag as an ORTB tag, which will add `&type=ortb` onto the VAST tag URL when the field is set to `true`. Affects all tag types.", "schema": { "type": "string" }, "example": "false" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_tag_vast_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast-zones/{id}/conversion-tag": { "get": { "tags": [ "VAST Zones" ], "summary": "Retrieve VAST Zone Conversion Tag", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/conversion_tag" }, { "properties": { "url": { "description": "The relative URL of the current conversion tag resource.", "type": "string", "example": "/v2/vast-zones/1234/conversion-tag" } }, "type": "object" } ] } } } } } } }, "/vast-zones/{id}/archive": { "get": { "tags": [ "VAST Zones" ], "summary": "Archive a VAST Zone", "description": "Archives the resource and all direct descendants of this resource. Archived resources will be treated the same as deleted resources but can be restored through unarchiving.", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast_zone_archive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/vast/ads": { "get": { "tags": [ "VAST 4.2 Ad Items" ], "summary": "Get a list of VAST 4.2 Ad Items.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_ad_item_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Ad Items" ], "summary": "Create a VAST 4.2 Ad Item.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_ad_item_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_ad_item_get" } } } } } } }, "/vast/ads/{id}": { "get": { "tags": [ "VAST 4.2 Ad Items" ], "summary": "Get a single VAST 4.2 Ad Item.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST ad item you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_ad_item_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Ad Items" ], "summary": "Update a VAST 4.2 Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST ad item you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_ad_item_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_ad_item_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Ad Items" ], "summary": "Delete a VAST 4.2 Ad Item", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the VAST ad item you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/campaign-assignments": { "get": { "tags": [ "VAST 4.2 Campaign Assignments" ], "summary": "Get a list of Campaign Assignments.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_campaign_assignment_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Campaign Assignments" ], "summary": "Create a Campaign Assignment.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_campaign_assignment_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_campaign_assignment_get" } } } } } } }, "/vast/campaign-assignments/{id}": { "get": { "tags": [ "VAST 4.2 Campaign Assignments" ], "summary": "Get a single Campaign Assignment.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the campaign assignment you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_campaign_assignment_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Campaign Assignments" ], "summary": "Update a Campaign Assignment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the campaign assignment you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_campaign_assignment_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_campaign_assignment_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Campaign Assignments" ], "summary": "Delete a Campaign Assignment.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the campaign assignment you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/closed-caption-files": { "get": { "tags": [ "VAST 4.2 Closed Caption Files" ], "summary": "Get a list of VAST 4.2 Closed Caption Files.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_closed_caption_file_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Closed Caption Files" ], "summary": "Create a VAST 4.2 Closed Caption File.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_closed_caption_file_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_closed_caption_file_get" } } } } } } }, "/vast/closed-caption-files/{id}": { "get": { "tags": [ "VAST 4.2 Closed Caption Files" ], "summary": "Get a single VAST 4.2 Closed Caption File.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the cc file you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_closed_caption_file_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Closed Caption Files" ], "summary": "Update a VAST 4.2 Closed Caption File", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the cc file you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_closed_caption_file_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_closed_caption_file_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Closed Caption Files" ], "summary": "Delete a VAST 4.2 Closed Caption File", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the cc file you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/companions": { "get": { "tags": [ "VAST 4.2 Companions" ], "summary": "Get a list of VAST Companions.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_companion_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Companions" ], "summary": "Create a VAST Companion.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_companion_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_companion_get" } } } } } } }, "/vast/companions/{id}": { "get": { "tags": [ "VAST 4.2 Companions" ], "summary": "Get a single VAST Companion.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the companion you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_companion_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Companions" ], "summary": "Update a VAST Companion", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the companion you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_companion_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_companion_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Companions" ], "summary": "Delete a VAST Companion.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the companion you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/creatives": { "get": { "tags": [ "VAST 4.2 Creatives" ], "summary": "Get a list of Creatives.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_creative_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Creatives" ], "summary": "Create a Creative.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_creative_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_creative_get" } } } } } } }, "/vast/creatives/{id}": { "get": { "tags": [ "VAST 4.2 Creatives" ], "summary": "Get a single Creative.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_creative_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Creatives" ], "summary": "Update a Creative", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_creative_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_creative_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Creatives" ], "summary": "Delete a Creative.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the creative you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/icon-click-fallback-images": { "get": { "tags": [ "VAST 4.2 Icon Click Fallback Images" ], "summary": "Get a list of Fallback Images.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_click_fallback_image_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Icon Click Fallback Images" ], "summary": "Create a Fallback Image.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_click_fallback_image_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_click_fallback_image_get" } } } } } } }, "/vast/icon-click-fallback-images/{id}": { "get": { "tags": [ "VAST 4.2 Icon Click Fallback Images" ], "summary": "Get a single Fallback Image.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the fallback image you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_click_fallback_image_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Icon Click Fallback Images" ], "summary": "Update a Fallback Image", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the fallback image you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_click_fallback_image_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_click_fallback_image_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Icon Click Fallback Images" ], "summary": "Delete a Fallback Image.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the fallback image you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/icons": { "get": { "tags": [ "VAST 4.2 Icons" ], "summary": "Get a list of VAST 4.2 Icons.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Icons" ], "summary": "Create a VAST 4.2 Icon.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_get" } } } } } } }, "/vast/icons/{id}": { "get": { "tags": [ "VAST 4.2 Icons" ], "summary": "Get a single VAST 4.2 Icon.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the icon you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Icons" ], "summary": "Update a VAST 4.2 Icon", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the icon you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_icon_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Icons" ], "summary": "Delete a VAST 4.2 Icon", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the icon you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/interactive-creative-files": { "get": { "tags": [ "VAST 4.2 Interactive Creative Files" ], "summary": "Get a list of VAST 4.2 Interactive Creative Files.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_interactive_creative_file_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Interactive Creative Files" ], "summary": "Create a VAST 4.2 Interactive Creative File.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_interactive_creative_file_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_interactive_creative_file_get" } } } } } } }, "/vast/interactive-creative-files/{id}": { "get": { "tags": [ "VAST 4.2 Interactive Creative Files" ], "summary": "Get a single VAST 4.2 Interactive Creative File.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the interactive creative file you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_interactive_creative_file_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Interactive Creative Files" ], "summary": "Update a VAST 4.2 Interactive Creative File", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the interactive creative file you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_interactive_creative_file_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_interactive_creative_file_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Interactive Creative Files" ], "summary": "Delete a VAST 4.2 Interactive Creative File", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the interactive creative file you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/linears": { "get": { "tags": [ "VAST 4.2 Linears" ], "summary": "Get a list of Linear Media.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_linear_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Linears" ], "summary": "Create a Linear Media.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_linear_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_linear_get" } } } } } } }, "/vast/linears/{id}": { "get": { "tags": [ "VAST 4.2 Linears" ], "summary": "Get a single Linear Media.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the linear you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_linear_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Linears" ], "summary": "Update a Linear Media", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the linear you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_linear_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_linear_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Linears" ], "summary": "Delete a Linear Media.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the linear you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/media-files": { "get": { "tags": [ "VAST 4.2 Media Files" ], "summary": "Get a list of Media Files.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_media_file_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Media Files" ], "summary": "Create a Media File.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_media_file_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_media_file_get" } } } } } } }, "/vast/media-files/{id}": { "get": { "tags": [ "VAST 4.2 Media Files" ], "summary": "Get a single Media File.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media file you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_media_file_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Media Files" ], "summary": "Update a Media File", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media file you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_media_file_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_media_file_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Media Files" ], "summary": "Delete a Media File.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the media file you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/mezzanines": { "get": { "tags": [ "VAST 4.2 Mezzanines" ], "summary": "Get a list of Mezzanines.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_mezzanine_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Mezzanines" ], "summary": "Create a Mezzanine.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_mezzanine_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_mezzanine_get" } } } } } } }, "/vast/mezzanines/{id}": { "get": { "tags": [ "VAST 4.2 Mezzanines" ], "summary": "Get a single Mezzanine.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the mezzanine you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_mezzanine_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Mezzanines" ], "summary": "Update a Mezzanine", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the mezzanine you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_mezzanine_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_mezzanine_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Mezzanines" ], "summary": "Delete a Mezzanine.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the mezzanine you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/non-linears": { "get": { "tags": [ "VAST 4.2 Non-Linears" ], "summary": "Get a list of Non-Linear Media.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_non_linear_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Non-Linears" ], "summary": "Create a Non-Linear Media.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_non_linear_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_non_linear_get" } } } } } } }, "/vast/non-linears/{id}": { "get": { "tags": [ "VAST 4.2 Non-Linears" ], "summary": "Get a single Non-Linear Media.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the non-linear you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_non_linear_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Non-Linears" ], "summary": "Update a Non-Linear Media", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the non-linear you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_non_linear_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_non_linear_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Non-Linears" ], "summary": "Delete a Non-Linear Media.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the non-linear you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/placements": { "get": { "tags": [ "VAST 4.2 Placements" ], "summary": "Get a list of Placements.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_placement_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Placements" ], "summary": "Create a Placement.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_placement_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_placement_get" } } } } } } }, "/vast/placements/{id}": { "get": { "tags": [ "VAST 4.2 Placements" ], "summary": "Get a single Placement.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the placement you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_placement_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Placements" ], "summary": "Update a Placement", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the placement you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_placement_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_placement_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Placements" ], "summary": "Delete a Placement.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the placement you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/reports": { "get": { "tags": [ "VAST 4.2 Reports" ], "summary": "Retrieve VAST 4.2 Reports", "description": "Retrieve an overview of information collected from your ad serving, which can be filtered using the parameters below.", "parameters": [ { "name": "type", "in": "query", "description": "Specifies the focus of the statistics you are interested in viewing. The value must be one of __overview__, __publisher__, __advertiser__, __zone__, __campaign__, or __ad-item__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "period", "in": "query", "description": "The range of time you are interested in viewing. The value must be one of __day__, __week__, __month__, or __year__.", "required": true, "schema": { "type": "string" }, "example": "" }, { "name": "preset", "in": "query", "description": "Frequently used time frames for reporting statistics are bundled as \"presets\". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified.

", "schema": { "type": "string" }, "example": "" }, { "name": "timezone", "in": "query", "description": "Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

", "schema": { "type": "string" }, "example": "" }, { "$ref": "#/components/parameters/report_date_from" }, { "$ref": "#/components/parameters/report_date_to" }, { "name": "summary", "in": "query", "description": "Whether to show a summary (__true__) or not (__false__). Defaults to __true__.", "schema": { "type": "boolean" }, "example": false }, { "name": "details", "in": "query", "description": "Whether to show details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "breakdown", "in": "query", "description": "Whether to show breakdown of placements in summary and details (__true__) or not (__false__). Defaults to __false__.", "schema": { "type": "boolean" }, "example": false }, { "name": "financials", "in": "query", "description": "Whether to show financial data (__true__) or not (__false__). When true, you will see additional fields like `cost`, `payout`, `revenue`, `e_cpm`, `e_cpc`, and `e_cpa` in the response. Defaults to __true__.", "schema": { "type": "boolean" }, "example": false }, { "name": "publishers", "in": "query", "description": "Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "zones", "in": "query", "description": "Submit this parameter to filter your report by a list of zone IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "advertisers", "in": "query", "description": "Submit this parameter to filter your report by a list of advertiser IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "campaigns", "in": "query", "description": "Submit this parameter to filter your report by a list of campaign IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" }, { "name": "ad-items", "in": "query", "description": "Submit this parameter to filter your report by a list of ad item IDs. The IDs must be submitted as a comma-separated list.", "schema": { "type": "string" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_report_example_get" } } } } } } }, "/vast/resources": { "get": { "tags": [ "VAST 4.2 Resources" ], "summary": "Get a list of Resources.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_resource_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Resources" ], "summary": "Create a Resource.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_resource_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_resource_get" } } } } } } }, "/vast/resources/{id}": { "get": { "tags": [ "VAST 4.2 Resources" ], "summary": "Get a single Resource.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the resource you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_resource_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Resources" ], "summary": "Update a Resource", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the resource you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_resource_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_resource_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Resources" ], "summary": "Delete a Resource.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the resource you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/vast/universal-ad-ids": { "get": { "tags": [ "VAST 4.2 Universal Ad IDs" ], "summary": "Get a list of Universal Ad IDs.", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_universal_ad_id_list" } } } } } }, "post": { "tags": [ "VAST 4.2 Universal Ad IDs" ], "summary": "Create a Universal Ad ID.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_universal_ad_id_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_universal_ad_id_get" } } } } } } }, "/vast/universal-ad-ids/{id}": { "get": { "tags": [ "VAST 4.2 Universal Ad IDs" ], "summary": "Get a single Universal Ad ID.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the universal ad id you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_universal_ad_id_get" } } } } } }, "put": { "tags": [ "VAST 4.2 Universal Ad IDs" ], "summary": "Update a Universal Ad ID", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the universal ad id you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_universal_ad_id_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vast4_universal_ad_id_get" } } } } } }, "delete": { "tags": [ "VAST 4.2 Universal Ad IDs" ], "summary": "Delete a Universal Ad ID.", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the universal ad id you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } }, "/zones": { "get": { "tags": [ "Zones (All)" ], "summary": "Get a List of All Zones", "description": "You can retrieve a list of all the zones regardless of their type. You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" }, { "name": "publisher", "in": "query", "description": "Filter the zones by one or many publisher IDs.", "required": false, "schema": { "type": "string" }, "example": "18994,77786" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_list" } } } } } } }, "/zones/standard/tags/bulk": { "post": { "tags": [ "Zones / Standard" ], "summary": "Generate Bulk Zone Tags", "description": "Returns a single `head_tag` script and an array of `zone_tags` for multiple standard zones in one request. Use this to embed many zone tags (e.g. multiple ad slots) with one API call. Each zone may appear only once in the request; use the `quantity` parameter for multiple instances of the same zone. All zones must use the same `protocol`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk_zone_tags_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk_zone_tags_response" } } } }, "400": { "$ref": "#/components/responses/request_parameter_error" } } } }, "/zones/email": { "get": { "tags": [ "Zones / Email" ], "summary": "Get a List of Email Zones", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_zone_list" } } } } } }, "post": { "tags": [ "Zones / Email" ], "summary": "Create an Email Zone", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_zone" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_zone_get" } } } } } } }, "/zones/email/{id}": { "get": { "tags": [ "Zones / Email" ], "summary": "Get a Single Email Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_zone_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Zones / Email" ], "summary": "Update an Email Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_zone" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_zone_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Zones / Email" ], "summary": "Delete an Email Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/email/{id}/tags": { "get": { "tags": [ "Zones / Email" ], "summary": "Retrieve Email Zone Tag", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "name": "protocol", "in": "query", "description": "Lets you specify a protocol for retrieving the URLs in the response. Possible values are **https** and **http**. If no value is given, the retrieved URLs will use http://. Affects all tag types.", "schema": { "type": "string" }, "example": "https" }, { "name": "uid", "in": "query", "description": "Lets you specify the email unique identifier macro (EUID). \n \nMake sure that the macro actually generates a unique ID for each of your recipients. Many email ad serving problems stem from recipients being given the same EUID. For more information, read [Email ads and the EUID](https://www.adbutler.com/help/article/email-ad-euid-newsletter).", "schema": { "type": "string" }, "example": "A7334J6" }, { "name": "click", "in": "query", "description": "Lets you specify an unescaped 3rd party click macro for use in other ad servers.", "schema": { "type": "string" }, "example": "%%CLICK_URL_ESC%%" }, { "name": "place", "in": "query", "description": "Lets you specify the unique index to represent which ad in a unique delivery set should be displayed.", "schema": { "type": "integer" }, "example": "4" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_tag_email_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/email/{id}/conversion-tag": { "get": { "tags": [ "Zones / Email" ], "summary": "Retrieve Email Zone Conversion Tag", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/conversion_tag" }, { "properties": { "url": { "description": "The relative URL of the current conversion tag resource.", "type": "string", "example": "/v2/zones/email/26548/conversion-tag" } }, "type": "object" } ] } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/email/{id}/archive": { "get": { "tags": [ "Zones / Email" ], "summary": "Archive an Email Zone", "description": "Archives the resource and all direct descendants of this resource. Archived resources will be treated the same as deleted resources but can be restored through unarchiving.", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_zone_archive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/email/archived": { "get": { "tags": [ "Zones / Email / Archived" ], "summary": "Get a List of Archived Email Zones", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_email_zone_list" } } } } } } }, "/zones/email/archived/{id}/unarchive": { "get": { "tags": [ "Zones / Email / Archived" ], "summary": "Unarchive an Email Zone", "description": "Unarchives the resource and all resources that were previously archived with the resource.", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/unarchive_include_placements" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_zone_unarchive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/email/archived/{id}": { "get": { "tags": [ "Zones / Email / Archived" ], "summary": "Get an Archived Email Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_email_zone_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/standard": { "get": { "tags": [ "Zones / Standard" ], "summary": "Get a List of Standard Zones", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_zone_list" } } } } } }, "post": { "tags": [ "Zones / Standard" ], "summary": "Create a Standard Zone", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_zone_post" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_zone_get" } } } } } } }, "/zones/standard/{id}": { "get": { "tags": [ "Zones / Standard" ], "summary": "Get a Single Standard Zone", "description": "Retrieve the zone tags for a zone. ", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_zone_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "put": { "tags": [ "Zones / Standard" ], "summary": "Update a Standard Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_zone" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_zone_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } }, "delete": { "tags": [ "Zones / Standard" ], "summary": "Delete a Standard Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/standard/{id}/tags": { "get": { "tags": [ "Zones / Standard" ], "summary": "Retrieve Standard Zone Tag", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "name": "protocol", "in": "query", "description": "Lets you specify a protocol for retrieving the URLs in the response. Possible values are **https** and **http**. If no value is given, the retrieved URLs will use http://.", "schema": { "type": "string" }, "example": "https" }, { "name": "type", "in": "query", "description": "Lets you specify the types of tags you want to be included in the response. Possible values are **async**, **async-beta**, **js**, **iframe**, **image**, **json**, **iframe-no-js**, **ortb**, and **amp**. \n \nFor more information, read [Types of zone tags](https://www.adbutler.com/help/article/types-of-zone-tag). ", "schema": { "type": "string" }, "example": "async,iframe-no-js" }, { "name": "click", "in": "query", "description": "Lets you specify an unescaped 3rd party click macro for use in other ad servers. Affects the following tag types: __async__, __async-beta__, __js__, __iframe__, __image__, __json__, and __iframe-no-js__.", "schema": { "type": "string" }, "example": "%%CLICK_URL_ESC%%" }, { "name": "fallback", "in": "query", "description": "Whether or not to include noscript tags for older browsers. These may not track properly. Set to __\"true\"__ to include fallback. Affects the following tag types: __async__, __async-beta__, __js__, __iframe__, __image__, and __iframe-no-js__.", "schema": { "type": "string" }, "example": "false" }, { "name": "extra", "in": "query", "description": "Extra data to pass along to destination URLs on click. Affects the following tag types: __async__, __async-beta__, __js__, __iframe__, __image__, __json__, and __iframe-no-js__.", "schema": { "type": "string" }, "example": "?fromAdbutler=1" }, { "name": "ortb_version", "in": "query", "description": "Lets you specify the version of ORTB to use. Current supported versions are __2.3__ and __2.5__. Defaults to __2.5__ when not set. Only applies to the __ortb__ tag type.", "schema": { "type": "string" }, "example": "2.5" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_tag_standard_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/standard/{id}/conversion-tag": { "get": { "tags": [ "Zones / Standard" ], "summary": "Retrieve Standard Zone Conversion Tag", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/conversion_tag" }, { "properties": { "url": { "description": "The relative URL of the current conversion tag resource.", "type": "string", "example": "/v2/zones/standard/26548/conversion-tag" } }, "type": "object" } ] } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/standard/{id}/archive": { "get": { "tags": [ "Zones / Standard" ], "summary": "Archive a Standard Zone", "description": "Archives the resource and all direct descendants of this resource. Archived resources will be treated the same as deleted resources but can be restored through unarchiving.", "parameters": [ { "$ref": "#/components/parameters/path_id" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_zone_archive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/standard/archived": { "get": { "tags": [ "Zones / Standard / Archived" ], "summary": "Get a List of Archived Standard Zones", "description": "You can use the `fields` query parameter to restrict the fields to be retrieved.", "parameters": [ { "$ref": "#/components/parameters/list_limit" }, { "$ref": "#/components/parameters/list_offset" }, { "$ref": "#/components/parameters/list_ids" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_standard_zone_list" } } } } } } }, "/zones/standard/archived/{id}/unarchive": { "get": { "tags": [ "Zones / Standard / Archived" ], "summary": "Unarchive a Standard Zone", "description": "Unarchives the resource and all resources that were previously archived with the resource.", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/unarchive_include_placements" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standard_zone_unarchive_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/standard/archived/{id}": { "get": { "tags": [ "Zones / Standard / Archived" ], "summary": "Get an Archived Standard Zone", "parameters": [ { "$ref": "#/components/parameters/path_id" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archived_standard_zone_get" } } } }, "404": { "$ref": "#/components/responses/resource_does_not_exist" } } } }, "/zones/standard/{zone_id}/ortb-native-ads": { "get": { "tags": [ "Zones / Standard / ORTB Native Ads" ], "summary": "Get a list of ORTB Native Ads", "parameters": [ { "name": "zone_id", "in": "path", "description": "Identifier of the Zone you'd like to get ORTB Native Ads for.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_ad_list" } } } } } }, "post": { "tags": [ "Zones / Standard / ORTB Native Ads" ], "summary": "Create an ORTB Native Ad", "parameters": [ { "name": "zone_id", "in": "path", "description": "Identifier of the Zone you'd like to create an ORTB Native Ad for.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_ad_post" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_ad_get" } } } } } } }, "/zones/standard/{zone_id}/ortb-native-ads/{id}": { "get": { "tags": [ "Zones / Standard / ORTB Native Ads" ], "summary": "Get a single ORTB Native Ad.", "parameters": [ { "name": "zone_id", "in": "path", "description": "Identifier of the Zone you'd like to get ORTB Native Ads for.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Ad you'd like to get.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_ad_get" } } } } } }, "put": { "tags": [ "Zones / Standard / ORTB Native Ads" ], "summary": "Update an ORTB Native Ad", "parameters": [ { "name": "zone_id", "in": "path", "description": "Identifier of the Zone you'd like to update an ORTB Native Ad for.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Ad you'd like to update.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_ad_put" } } } }, "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ortb_native_ad_get" } } } } } }, "delete": { "tags": [ "Zones / Standard / ORTB Native Ads" ], "summary": "Delete an ORTB Native Ad", "parameters": [ { "name": "zone_id", "in": "path", "description": "Identifier of the Zone you'd like to delete an ORTB Native Ad for.", "required": true, "schema": { "type": "integer" }, "example": "" }, { "name": "id", "in": "path", "description": "Identifier of the ORTB Native Ad you'd like to delete.", "required": true, "schema": { "type": "integer" }, "example": "" } ], "responses": { "default": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted" } } } } } } } }, "components": { "schemas": { "ad_item_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/ad-items" }, "data": { "type": "array", "items": { "discriminator": { "propertyName": "object", "mapping": { "image_ad_item": "#/components/schemas/image_ad_item_get", "rich_media_ad_item": "#/components/schemas/rich_media_ad_item_get", "custom_html_ad_item": "#/components/schemas/custom_html_ad_item_get", "native_ad_item": "#/components/schemas/native_ad_item_get", "catalog_ad_item": "#/components/schemas/catalog_ad_item_get" } }, "oneOf": [ { "$ref": "#/components/schemas/image_ad_item_get" }, { "$ref": "#/components/schemas/rich_media_ad_item_get" }, { "$ref": "#/components/schemas/custom_html_ad_item_get" }, { "$ref": "#/components/schemas/native_ad_item_get" }, { "$ref": "#/components/schemas/catalog_ad_item_get" } ] } } }, "type": "object" } ] }, "ad_item_created_last_modified": { "properties": { "created_date": { "description": "The date and time when this ad item was created.", "type": "string", "format": "date-time", "example": "2019-04-26 14:55:31" }, "last_modified": { "description": "The date and time the ad item was last modified.", "type": "string", "format": "date-time", "example": "2019-04-26 14:55:39" } }, "type": "object" }, "ad_item_shared_fields": { "properties": { "name": { "description": "The name of the ad item. We recommend using a naming convention that is descriptive, consistent, and clear.", "type": "string", "example": "Example Ad Item" }, "height": { "description": "The height of the ad item in pixels. Defaults to __0__ when no height given. If `width` is set to a value greater than 0, a height must also be set to a non-zero value. A width and height both set to __0__ signify a \"dynamic ad\". [Read more about dynamic ads](https://www.adbutler.com/blog/article/ad-tech-glossary-digital-advertising-terms-jargon-to-know#Dynamic-Creative).", "type": "integer", "example": 400 }, "width": { "description": "The width of the ad item in pixels. Defaults to __0__ when no width given. If `height` is set to a value greater than 0, a width must also be set to a non-zero value. A width and height both set to __0__ signify a \"dynamic ad\". [Read more about dynamic ads](https://www.adbutler.com/blog/article/ad-tech-glossary-digital-advertising-terms-jargon-to-know#Dynamic-Creative).", "type": "integer", "example": 650 }, "location": { "description": "The destination URL to which the user will be redirected when they click on the ad item. A __null__ value denotes no redirection.", "type": "string", "example": "https://adbutler.com" }, "tracking_pixel": { "description": "An optional third party tracking pixel served with the ad for monitoring impressions. A __null__ value means no tracking pixel was added. Use `tracking_pixels` if you want to add multiple tracking pixels.\n \n \n__NOTE__: Essentials subscribers do not have access to third-party pixel tracking and therefore must set this field's value to __null__. ", "type": "string", "example": "https://url.com" }, "tracking_pixels": { "description": "List of tracking pixels. An empty array means that no tracking pixels were added. \n \nTo create a tracking pixel, enter an object that only has the `url` field. An `id` for the new tracking pixel will be sent in the response. \n \nTo update a tracking pixel, enter an object with the tracking pixel's `id` and the new `url` for the tracking pixel. \n \nTo delete a tracking pixel, enter an object with the tracking pixel `id` and set `url` to __null__.", "type": "array", "items": { "$ref": "#/components/schemas/tracking_pixel" }, "example": [ { "id": 27419, "url": "https://url1.com" }, { "id": 27420, "url": "https://url2.com" } ] }, "metadata": { "description": "An object containing any number of [metadata](https://www.adbutler.com/help/article/add-edit-metadata) keys and values. Keys and values must be strings.", "type": "object", "example": { "mobile_only": "false", "TNR": "15" } }, "trusted_redirect_domains": { "description": "An array containing any number of trusted redirect domains. Values must always be valid domains, e.g. `example.com`, `*.example.com`, or custom protocols like `tel:342682346`.\n\n**NOTE:** This only applies to ad items which will be used in a zone with a 3rd party click macro implementation.", "type": "object", "example": [ "example.com", "*.example.com", "tel:342682346" ] }, "is_self_serve": { "description": "Whether or not this ad item is from Self-Serve.", "type": "boolean", "readOnly": true, "example": false } }, "type": "object" }, "tracking_pixel": { "properties": { "id": { "description": "The identifier (ID) of the tracking pixel.", "type": "integer" }, "url": { "description": "The url of the tracking pixel.", "type": "string" } }, "type": "object" }, "image_ad_item_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/ad-items/image" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/image_ad_item_get" } } }, "type": "object" } ] }, "image_ad_item": { "properties": { "creative": { "description": "The image creative identifier (ID). Only one of `creative` or `creative_url` can be given in a POST, but one must be given. To swap an ad item to use `creative_url` instead of `creative` in a PUT, set `creative` to __null__.", "type": "string", "example": null }, "creative_url": { "description": "A URL leading to an image file (PNG, JPEG, or GIF). Only one of `creative` or `creative_url` can be given in a POST, but one must be given. To swap an ad item to use `creative` instead of `creative_url` in a PUT, set `creative_url` to __null__.", "type": "string", "example": "https://servedbyadbutler.com/default_banner.gif" }, "html_alt_text": { "description": "Textual description of the image creative intended to be used by Assistive Technologies or if the image fails to load.", "type": "string", "example": "The AdButler Logo" }, "html_target": { "description": "The window/frame in which the destination URL should load when clicked. Leave this field as __null__ to open in the same tab. Another common option is __\"\\_blank\"__ for a new window or tab, but many options are available.", "type": "string", "example": "_blank" }, "html_content_below": { "description": "The HTML content that will appear below the ad item.", "type": "string", "example": "" } }, "type": "object" }, "image_ad_item_get": { "properties": { "object": { "description": "A string denoting the current resource being requested or affected.", "type": "string", "example": "image_ad_item" }, "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/ad-items/image/675265899" }, "id": { "description": "The current resource identifier (ID).", "type": "integer", "example": 675265899 } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/image_ad_item" }, { "$ref": "#/components/schemas/ad_item_created_last_modified" } ] }, "image_ad_item_post": { "required": [ "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/image_ad_item" } ] }, "image_ad_item_put": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/image_ad_item" } ] }, "image_ad_item_conversion_tag": { "properties": { "url": { "description": "The relative URL of the current conversion tag resource.", "type": "string", "example": "/v2/ad-items/image/675265899/conversion-tag" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/conversion_tag" } ] }, "rich_media_ad_item_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/ad-items/rich-media" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/rich_media_ad_item_get" } } }, "type": "object" } ] }, "rich_media_ad_item": { "properties": { "creative": { "description": "The rich media creative identifier (ID).", "type": "integer", "example": 552564 }, "html_content_below": { "description": "The HTML content that will appear below the ad item.", "type": "string", "example": "" }, "expand_horizontal_direction": { "description": "Whether to allow the rich media ad item to expand in the horizontal direction. The value can be __\"none\"__, __\"left\"__, or __\"right\"__. Defaults to __\"none\"__.", "type": "string", "example": "right" }, "expand_vertical_direction": { "description": "Whether to allow the rich media ad item to expand in the vertical direction. The value can be __\"none\"__, __\"up\"__, or __\"down\"__. Defaults to __\"none\"__.", "type": "string", "example": "up" } }, "type": "object" }, "rich_media_ad_item_get": { "properties": { "object": { "description": "A string denoting the current resource being requested or affected.", "type": "string", "example": "rich_media_ad_item" }, "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/ad-items/rich-media/745558692" }, "id": { "description": "The current resource identifier (ID).", "type": "integer", "example": 745558692 } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/rich_media_ad_item" }, { "$ref": "#/components/schemas/ad_item_created_last_modified" } ] }, "rich_media_ad_item_post": { "required": [ "name", "creative" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/rich_media_ad_item" } ] }, "rich_media_ad_item_put": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/rich_media_ad_item" } ] }, "rich_media_ad_item_conversion_tag": { "properties": { "url": { "description": "The relative URL of the current conversion tag resource.", "type": "string", "example": "/v2/ad-items/rich-media/745558692/conversion-tag" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/conversion_tag" } ] }, "custom_html_ad_item_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/ad-items/custom-html" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/custom_html_ad_item_get" } } }, "type": "object" } ] }, "custom_html_ad_item": { "properties": { "custom_html": { "description": "The HTML content of the ad item.", "type": "string", "example": "
...
" }, "html_content_below": { "description": "The HTML content that will appear below the ad item.", "type": "string", "example": "" }, "expand_horizontal_direction": { "description": "Whether to allow the rich media ad item to expand in the horizontal direction. The value can be __\"none\"__, __\"left\"__, or __\"right\"__. Defaults to __\"none\"__.", "type": "string", "example": "left" }, "expand_vertical_direction": { "description": "Whether to allow the rich media ad item to expand in the vertical direction. The value can be __\"none\"__, __\"up\"__, or __\"down\"__. Defaults to __\"none\"__.", "type": "string", "example": "none" } }, "type": "object" }, "custom_html_ad_item_get": { "properties": { "object": { "description": "A string denoting the current resource being requested or affected.", "type": "string", "example": "custom_html_ad_item" }, "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/ad-items/custom-html/985124765" }, "id": { "description": "The current resource identifier (ID).", "type": "integer", "example": 985124765 } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/custom_html_ad_item" }, { "$ref": "#/components/schemas/ad_item_created_last_modified" } ] }, "custom_html_ad_item_post": { "required": [ "name", "custom_html" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/custom_html_ad_item" } ] }, "custom_html_ad_item_put": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/custom_html_ad_item" } ] }, "custom_html_ad_item_conversion_tag": { "properties": { "url": { "description": "The relative URL of the current conversion tag resource.", "type": "string", "example": "/v2/ad-items/custom-html/985124765/conversion-tag" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/conversion_tag" } ] }, "native_ad_item_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/ad-items/native" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/native_ad_item_get" } } }, "type": "object" } ] }, "native_ad_item": { "properties": { "template": { "description": "The identifier (ID) of the native template to use as a template for this ad.", "type": "integer", "example": 5668 }, "variables": { "description": "The variables required for the chosen native template in the `template` field. These variables contain the data to be put into the `raw_html` of the chosen native template in place of their respective placeholders. The keys in this object should be integers formatted as strings that refer to the variable ID from the native template that they reference. \n \n*NOTE: Variable values can only be strings. If a variable is optional, its value can be set to **null**.*", "type": "object", "example": { "6885": "A Product Name", "6886": "24.99", "6887": "https://adbutler.com", "6888": "blue" } } }, "type": "object" }, "native_ad_item_get": { "properties": { "object": { "description": "A string denoting the current resource being requested or affected.", "type": "string", "example": "native_ad_item" }, "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/ad-items/native/811245371" }, "id": { "description": "The current resource identifier (ID).", "type": "integer", "example": 811245371 } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/native_ad_item" }, { "$ref": "#/components/schemas/ad_item_created_last_modified" } ] }, "native_ad_item_post": { "required": [ "name", "template", "variables" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/native_ad_item" } ] }, "native_ad_item_put": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_shared_fields" }, { "$ref": "#/components/schemas/native_ad_item" } ] }, "native_ad_item_conversion_tag": { "properties": { "url": { "description": "The relative URL of the current conversion tag resource.", "type": "string", "example": "/v2/ad-items/native/811245371/conversion-tag" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/conversion_tag" } ] }, "ad_item_companion_product": { "properties": { "catalog": { "description": "The ID of the product DB catalog.", "type": "integer", "example": 10001 }, "product_identifier": { "description": "The product identifier (SKU) within the catalog.", "type": "string", "example": "SKU-1001" } }, "type": "object" }, "ad_item_companion_product_list": { "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ad_item_companion_product_get" } } }, "type": "object" } ] }, "ad_item_companion_product_get": { "allOf": [ { "$ref": "#/components/schemas/resource_get" }, { "properties": { "object": { "type": "string", "example": "ad_item_companion_product" }, "self": { "type": "string", "example": "/v2/ad-items/image/1234/companions/products/5678" } }, "type": "object" }, { "$ref": "#/components/schemas/ad_item_companion_product" } ] }, "ad_item_companion_product_post": { "required": [ "catalog", "product_identifier" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_companion_product" } ] }, "ad_item_companion_product_put": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ad_item_companion_product" } ] }, "adserve_placement_list": { "properties": { "placement_1": { "description": "A list of valid placements.", "type": "array", "items": { "$ref": "#/components/schemas/adserve_placement" } } }, "type": "object" }, "adserve_placement": { "properties": { "banner_id": { "description": "The resource identifier (ID) for the ad item (ad items used to be called banners, hence the property name).", "type": "integer", "example": 123456 }, "width": { "description": "Width of the image, as set in the ad item details.", "type": "integer", "example": 300 }, "height": { "description": "Height of the image, as set in the ad item details.", "type": "integer", "example": 200 }, "alt_text": { "description": "The `alt` text tied to the image. Used to describe the ad item for people employing a screen reader.", "type": "integer", "example": 0 }, "accompanied_html": { "description": "HTML that is typically included directly below the ad item.", "type": "string", "example": "" }, "target": { "description": "How the ad item will direct the user if it's clicked.", "type": "string", "example": "_blank" }, "tracking_pixel": { "description": "The URL of an impression tracking pixel.", "type": "string", "example": "" }, "body": { "description": "Contains the raw HTML needed for Rich Media, Custom HTML, and native ad items.", "type": "string", "example": "" }, "redirect_url": { "description": "The URL for the clickable link leading to the destination URL.", "type": "string", "example": "https://ads.domain.com/redirect.spark?MID=..." }, "refresh_url": { "description": "For **auto refresh** zones, this is the URL to use when reloading the zone.", "type": "string", "example": "" }, "refresh_time": { "description": "Number of seconds delay before the zone should auto refresh.", "type": "integer", "example": 10 }, "image_url": { "description": "The URL for the ad item image.", "type": "string", "example": "https://ads.domain.com/getad.img/;libID=..." }, "accupixel_url": { "description": "The **Accupixel** callback URL. Must be called by your application before AdButler will record an impression. For more information on **Accupixel**, read our [help documentation](https://www.adbutler.com/help/article/adbutler-stats-accupixel). ", "type": "string", "example": "https://ads.domain.com/adserve/;ID=..." }, "is_redirectable": { "description": "Optional property that displays when `;rf=1`. When set to **true**, the ad's destination URL is redirectable. Its default is **false**.", "type": "boolean", "example": false }, "eligible_url": { "description": "If **Viewability** is enabled, this URL should be requested via GET when the ad is rendered. This indicates to AdButler that the ad has been rendered and could potentially be 'viewable'. If **Accupixel** is enabled, you must perform this request **after** the Accupixel request. For more information on Viewability, read our [help documentation](https://www.adbutler.com/help/article/adbutler-viewability).", "type": "string", "example": "https://ads.domain.com/adserve/;MID=XXXX;type=eligibleimpression;..." }, "viewable_url": { "description": "If **Viewability** is enabled, this URL should be requested via GET when the ad is considered 'viewable', meaning at least 50% of the ad has been in the user's viewport for at least one consecutive second.", "type": "string", "example": "https://ads.domain.com/adserve/;MID=XXXX;type=viewableimpression;..." } }, "type": "object" }, "adserve_post": { "required": [ "ID", "setID", "type" ], "properties": { "ID": { "description": "Your AdButler account ID.", "type": "integer", "example": 11111 }, "setID": { "description": "The zone ID being requested.", "type": "integer", "example": 123456 }, "type": { "description": "Has two possible values: **\"json\"** returns the most eligible ad, while **\"jsonr\"** returns a list of all eligible ads ordered from most to least eligible. \n \nFor more information, read [How to request for all eligible ads via API](https://www.adbutler.com/help/article/api-jsonr-all-ads).", "type": "string", "example": "json" }, "size": { "description": "The ad size you expect to receive.", "type": "string", "example": "300x200" }, "rf": { "description": "Pass the parameter `;rf=1` if you want to determine whether the ad has a destination URL to which the user will be redirected. If this parameter is present in the request, the response will contain the extra field `is_redirectable`.", "type": "integer", "example": 1 }, "kw": { "description": "Required for **Keyword Targeting**. Allows you to pass keywords to AdButler, for use with keyword targeting. Pass an array of keyword strings.", "type": "array", "items": { "type": "string" } }, "referrer": { "description": "Required for **URL Targeting**. Our URL Targeting feature traditionally relies on the HTTP `referrer` header to know which page our ad requests were made on. However, if you're making server-side requests you can pass it to us directly in the ad request using the `;referrer=` parameter.", "type": "string", "example": "https://example.com" }, "ip": { "description": "Required for **Geographic Targeting**. If you're doing server side ad requests, and you want to geographically target your campaigns, you can simply add the `ip=` query parameter into the request and provide the IPv4 address used for targeting.", "type": "string", "example": "192.169.0.1" }, "ua": { "description": "Required for **Platform Targeting**. The user's User Agent string.", "type": "string", "example": "Roku4640X/DVP-7.70 (297.70E04154A)" }, "sw": { "description": "Required for **Platform Targeting**. The user's device's screen width.", "type": "integer", "example": 1920 }, "sh": { "description": "Required for **Platform Targeting**. The user's device's screen height.", "type": "integer", "example": 1080 }, "spr": { "description": "Required for **Platform Targeting**. The user's device's screen pixel ratio.", "type": "integer", "example": 3 }, "pid": { "description": "Required for **Unique Delivery** or **Roadblocks**. The `pid` stands for 'pageID' and is a random number that must be the same for any ad requested from the current page instance.", "type": "integer", "example": 123456 }, "place": { "description": "Required for **Unique Delivery**. Place represents the number of times a particular zone has been requested on a single page instance, this should be incremented each time the zone is re-requested. Starts from 0, 1, 2, and so on.", "type": "integer", "example": 1 }, "user_freq": { "description": "Required for **User Frquency Capping**. An array of placement data representing how many times a given placement has been displayed to the user, and it's expiry information.", "type": "array", "items": { "$ref": "#/components/schemas/adserve_post_user_freq" } }, "_abdk_json": { "description": "When using **Data Keys**, use this parameter to pass all the key-value pairs as an object.", "type": "object", "example": { "bird": "duck", "bug": "ant" } }, "defer_signing": { "description": "When using **Beacon Signing Keys**, use this parameter to defer generating hashes and timestamps such that they can be signed later with a shared key.", "type": "boolean", "example": false } }, "type": "object" }, "adserve_post_user_freq": { "properties": { "placement_id": { "description": "The placement id being counted.", "type": "integer", "example": 11111111 }, "start": { "description": "The start datetime in integer format", "type": "integer", "example": 1604465307 }, "expiry": { "description": "The expiration datetime in integer format.", "type": "integer", "example": 1606193307 }, "views": { "description": "The number of times this placement has been displayed to this user, during this expiry period.", "type": "integer", "example": 2 } }, "type": "object" }, "adserve_response_success": { "properties": { "status": { "description": "Indication of successful operation.", "type": "string", "example": "SUCCESS" }, "placements": { "type": "array", "items": { "$ref": "#/components/schemas/adserve_placement_list" } } }, "type": "object" }, "advertiser_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/advertisers" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/advertiser_get" } } }, "type": "object" } ] }, "advertiser": { "properties": { "can_change_password": { "description": "Whether to allow this advertiser to change their own password.", "type": "boolean", "example": false }, "can_add_ad_items": { "description": "Whether to allow this advertiser to submit advertisements for scheduling in the zones you own.", "type": "boolean", "example": false }, "email": { "description": "A valid email owned by the advertiser that allows them to log in to the advertiser portal. When set to the default (nobody@adbutler.com), the advertiser will not have access to the advertiser portal.", "type": "string", "example": "advertiser@adbutler.com" }, "name": { "description": "Name of the advertiser.", "type": "string", "example": "Example Advertiser" }, "metadata": { "description": "An object containing any number of [metadata](https://www.adbutler.com/help/article/add-edit-metadata) keys and values. Keys and values must be strings.", "type": "object", "example": { "btf": "true", "mobile_only": "false" } } }, "type": "object" }, "advertiser_base_get": { "properties": { "object": { "description": "A string denoting the current resource being requested or affected.", "type": "string", "example": "advertiser" }, "id": { "description": "The current resource identifier (ID).", "type": "integer", "example": 5195 }, "has_password": { "description": "A field indicating if the password is set.", "type": "boolean", "example": false }, "self_serve_customer": { "description": "The identifier (ID) of a related Self-Serve Customer resource.", "type": "integer", "example": 100795 } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/advertiser" } ] }, "advertiser_get": { "properties": { "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/advertisers/5195" }, "parent": { "description": "Where the advertiser was created, and if it should display as an option in the menu. Allowed values: __marketplace__ and __admin__, defaults to __admin__. __NOTE:__ setting this field to \"marketplace\" is only allowed if you pay for the Self-Serve feature.", "type": "string", "example": "admin" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/advertiser_base_get" } ] }, "advertiser_post": { "required": [ "name" ], "properties": { "password": { "description": "The password of the optional user account tied to this advertiser. The given password must be 8 or more characters and contain at least one uppercase character, lowercase character, and number. Password managers and special characters are recommended. If left blank on advertiser creation, a random password will be generated. This field will never be returned in any responses.", "type": "string", "example": "**********" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/advertiser" } ] }, "advertiser_put": { "properties": { "password": { "description": "The password of the optional user account tied to this advertiser. The given password must be 8 or more characters and contain at least one uppercase character, lowercase character, and number. Password managers and special characters are recommended. If left blank on advertiser creation, a random password will be generated. This field will never be returned in any responses.", "type": "string", "example": "**********" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/advertiser" } ] }, "archived_advertiser": { "properties": { "object": { "description": "The resource type that was archived.", "type": "string", "example": "archive" }, "url": { "description": "The relative archive URL of the current resource.", "type": "string", "example": "/v2/advertisers/5049/archive" }, "data": { "properties": { "archived_resources": { "type": "array", "items": { "$ref": "#/components/schemas/archived_advertiser_resource" } } }, "type": "object" } }, "type": "object" }, "archived_advertiser_get": { "properties": { "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/advertisers/archived/5195" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/advertiser_base_get" }, { "$ref": "#/components/schemas/archived_details" } ] }, "archived_advertiser_list": { "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/advertisers/archived" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/archived_advertiser_get" } } }, "type": "object" } ] }, "unarchived_advertiser": { "properties": { "object": { "description": "The resource type that was archived.", "type": "string", "example": "unarchive" }, "url": { "description": "The relative archive URL of the current resource.", "type": "string", "example": "/v2/advertisers/archived/5049/unarchive" }, "data": { "properties": { "unarchived_resources": { "type": "array", "items": { "$ref": "#/components/schemas/archived_advertiser_resource" } } }, "type": "object" } }, "type": "object" }, "archived_advertiser_resource": { "properties": { "object": { "type": "string", "example": "advertiser" }, "id": { "type": "integer", "example": 5049 } }, "type": "object" }, "audience_member_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/audience-members" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/audience_member_get" } } }, "type": "object" } ] }, "audience_member": { "properties": { "external_user_id": { "description": "The user ID of the audience member.", "type": "string", "example": "1234-abcd-4321" }, "full_name": { "description": "The full name of the audience member.", "type": "string", "example": "Person Smith" } }, "type": "object" }, "audience_member_get": { "properties": { "object": { "description": "A string denoting the current resource being requested or affected.", "type": "string", "example": "audience_member" }, "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/audience-members/1234" }, "id": { "description": "The current resource identifier(ID).", "type": "integer", "example": 1234 } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/audience_member" } ] }, "audience_member_post": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/audience_member" } ] }, "audience_member_put": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/audience_member" } ] }, "audience_segment_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/audience-segments" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/audience_segment_get" } } }, "type": "object" } ] }, "audience_segment": { "properties": { "name": { "description": "The name of the audience segment.", "type": "string", "example": "Example Segment" }, "description": { "description": "An optional description of the audience segment.", "type": "string", "example": "Example segment for targeting." } }, "type": "object" }, "audience_segment_get": { "properties": { "object": { "description": "A string denoting the current resource being requested or affected.", "type": "string", "example": "audience_segment" }, "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/audience-segments/1234" }, "id": { "description": "The current resource identifier(ID).", "type": "integer", "example": 1234 } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/audience_segment" } ] }, "audience_segment_post": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/audience_segment" } ] }, "audience_segment_put": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/audience_segment" } ] }, "beacon_signing_keys_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/beacon-signing-keys" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/beacon_signing_keys_get" } } }, "type": "object" } ] }, "beacon_signing_key": { "properties": { "key_name": { "description": "Name of the beacon signing key.", "type": "string", "example": "Example Key Name" }, "key_value": { "description": "Value of the beacon signing key.", "type": "string", "example": "8b3ae4901bd11de076bc36697f7b6f9af20f3a9f" }, "algorithm": { "description": "Algorithm to be used when signing beacons with this key. At the moment, SHA1 is the only supported algorithm. ", "type": "string", "example": "sha1" } }, "type": "object" }, "beacon_signing_keys_get": { "properties": { "object": { "description": "A string denoting the current resource being requested or affected.", "type": "string", "example": "beacon_signing_key" }, "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/beacon_signing_key/1234" }, "id": { "description": "The current resource identifier (ID).", "type": "integer", "example": 1234 } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/beacon_signing_key" } ] }, "beacon_signing_keys_post": { "required": [ "key_name" ], "properties": { "key_name": { "description": "Name of the beacon signing key.", "type": "string", "example": "Example Key Name" } }, "type": "object" }, "beacon_signing_keys_put": { "required": [ "key_name" ], "properties": { "key_name": { "description": "Name of the beacon signing key.", "type": "string", "example": "Example Key Name" } }, "type": "object" }, "beacon_signing_keys_validation": { "required": [ "url" ], "properties": { "url": { "description": "The full beacon URL that has been signed with a beacon signing key.", "type": "string", "example": "https://servedbyadbutler.com/adserve/;MID=12345;type=viewableimpression;placementID=12345;setID=12345;channelID=0;CID=123;BID=12345;TAID=0;place=0;psrtype=api;referrer=;mt=1234567890;hc_id=123;hc=dd3c915dd44c01939f09101914ca935c723b9094" } }, "type": "object" }, "bidder_list": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/list" }, { "properties": { "url": { "description": "The URL of the current resource list.", "type": "string", "example": "/v2/bidders" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/bidder_get" } } }, "type": "object" } ] }, "bidder": { "properties": { "bidder_code": { "description": "The unique token of the bidding parter that this bidder will represent. See the up-to-date list of bidder codes.", "type": "string", "example": "adbutler" }, "name": { "description": "A descriptive name of the bidder.", "type": "string", "example": "AdButler Bidder" }, "parameters": { "description": "The custom parameters of the chosen bidding partner. We have included AdButler's parameters as an example, but other bidders will ask for different parameters. Find required bidder parameters here.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/bidder_parameter_example" } ] } }, "type": "object" }, "bidder_get": { "properties": { "object": { "description": "A string denoting the current resource being requested or affected.", "type": "string", "example": "bidder" }, "id": { "description": "The current resource identifier(ID).", "type": "integer", "example": 6899 }, "self": { "description": "The relative URL of the current resource being requested or affected.", "type": "string", "example": "/v2/bidders/6899" }, "created_date": { "description": "The date and time when the bidder was created.", "type": "string", "format": "date-time", "example": "2019-03-27 18:43:52" } }, "type": "object", "allOf": [ { "$ref": "#/components/schemas/bidder" } ] }, "bidder_post": { "required": [ "bidder_code", "name", "parameters" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/bidder" } ] }, "bidder_put": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/bidder" } ] }, "bidder_parameter_example": { "properties": { "accountID": { "description": "One of AdButler's bidder parameters. Required for an AdButler bidder.", "type": "string", "example": "123456789" }, "keyword": { "description": "One of AdButler's bidder parameters.", "type": "string", "example": "cats,kittens" }, "maxCPM": { "description": "One of AdButler's bidder parameters.", "type": "string", "example": "3.0" }, "minCPM": { "description": "One of AdButler's bidder parameters.", "type": "string", "example": "1.0" }, "zoneID": { "description": "One of AdButler's bidder parameters. Required for an AdButler bidder.", "type": "string", "example": "5658" } }, "type": "object" }, "bulk_zone_tags_zone_item": { "description": "One zone entry in the bulk request. Each `zone_id` may appear only once; use `quantity` for multiple instances of the same zone.", "required": [ "zone_id", "quantity", "type", "protocol" ], "properties": { "zone_id": { "description": "The standard zone identifier (ID).", "type": "integer", "example": 12345 }, "quantity": { "description": "Number of tag blocks to generate for this zone (e.g. for multiple ad slots).", "type": "integer", "example": 3 }, "type": { "description": "Tag type. Only **async** and **async-beta** are supported for bulk.", "type": "string", "enum": [ "async", "async-beta" ], "example": "async" }, "protocol": { "description": "Protocol for tag URLs. Required. All zones in the request must use the same value.", "type": "string", "enum": [ "http", "https" ], "example": "https" }, "click": { "description": "Optional third-party click macro for use in other ad servers.", "type": "string", "example": "https://example.com/click" }, "fallback": { "description": "Set to **true** to include noscript fallback tags. Affects async tag types.", "type": "boolean", "example": false }, "extra": { "description": "Extra query string to append to destination URLs on click.", "type": "string", "example": "?fromAdbutler=1" }, "ortb_version": { "description": "ORTB version. Supported: **2.3**, **2.5**. Defaults to **2.5**. Only applies to ORTB tag type.", "type": "string", "example": "2.5" }, "consent_management": { "description": "Enable consent management.", "type": "boolean", "example": true }, "force_height": { "description": "Force height behavior.", "type": "boolean", "example": true }, "css_classes": { "description": "CSS class(es) to apply to the tag container.", "type": "string", "example": "ad-class" }, "custom_div_id": { "description": "Custom div ID for the zone container. Letters, numbers, and underscores only; cannot start or end with underscore. Max 100 characters.", "type": "string", "example": "my_zone_1" } }, "type": "object" }, "bulk_zone_tags_post": { "required": [ "zones" ], "properties": { "zones": { "description": "Array of zone entries. Each `zone_id` must appear only once; use `quantity` for multiple instances.", "type": "array", "items": { "$ref": "#/components/schemas/bulk_zone_tags_zone_item" } } }, "type": "object" }, "bulk_zone_tags_response": { "properties": { "object": { "description": "Resource type.", "type": "string", "example": "bulk_zone_tags" }, "data": { "description": "POST /zones/standard/tags/bulk returns a single `head_tag` (script to include in page head) and a `zone_tags` array (one tag block per zone instance).", "properties": { "head_tag": { "description": "Script tag to include once in the page ``. Load this before the zone tags.", "type": "string", "example": "