--- servers: - url: https://console.springserve.com/api/v1 description: >- SpringServe console. Added by API Evangelist from the published documentation (springserve.atlassian.net/wiki/spaces/SSD/pages/1573617663/API+-+Getting+Started, "Base Url https://console.springserve.com/"); the document Magnite serves declares no servers[] block because the Swagger UI infers the host from window.location. - url: https://console.clearline.magnite.com/api/v1 description: >- ClearLine console. The identical contract is served from ClearLine's own host; base URL published at springserve.atlassian.net/wiki/spaces/CLD/pages/3649929217/Clearline+API+SDK. x-servers-added-by: https://apievangelist.com — not present in the upstream document; see openapi/_original/ for the verbatim spec. openapi: 3.1.2 info: title: SpringServe UI API version: 1.0.0 description: "> **_NOTE:_** This document covers the v1 API (`/api/v1`). You can find additional documentation on the v1 API (`/api/v1`) on the \n[Magnite Help Center](https://help.magnite.com/), which is broken into sections for endpoints relevant to \n[SpringServe](https://help.magnite.com/help/api-documentation) and [Clearline](https://help.magnite.com/help/api-documentation-06dd4d3). \nYou can also find V1 swagger documentation by selecting ‘SpringServe API V1’ from the dropdown at the top right corner \nof this page. Please note we are in the process of creating V1 endpoints for all existing V0 endpoints, but while that work \nis in progress not all endpoints will be supported on V1. We advise reviewing both swagger pages to determine what \nis supported in each version.\n\n# Authentication\nWhen using this API documentation server, by default it will authenticate API calls using cookie-based authentication against the selected server. If you are properly logged into the SpringServe server and your session is still active, then the API calls should automatically authenticate. \n\nOutside of this API documentation server you should use either Token Based or Bearer authentication. You may also these authentication methods on this server as well,\n which will take precedence over any cookie/session based authentication.\n### Token Based Authentication\nUse the [POST /api/v1/auth](#/Auth/auth_post) endpoint to generate an API token that is then passed in the `Authorization: ` header\n\n### Bearer Authentication\nUse the [POST /api/v1/auth](#/Auth/auth_post) endpoint to authenticate and get a bearer token that is then passed in the `Authorization: Bearer ` header\n\n# Active Account Context\nA given request always runs in the context of currently active account for the authenticated user making the request. The active account can be determined via\nthe [GET /api/v1/accounts/current](#/Accounts/accounts_current_get) endpoint and updated via [POST /api/v1/accounts/{id}/set_current](#/Accounts/accounts_id_set_current_post).\nThe active account can also be overridden for an authenticated request by passing the `x-auth-context` header.\n\n# Common List Resource Functionality\n\n## List Resource Requests\nVirtually all List endpoints (e.g. `GET /api/v1/demand_tags`) support the following via request query parameters:\n* Pagination via the `page` (first page is page `1`) and `per` (how many results per page, default is `50`, max is `1000`) query parameters.\n* Searching via the `search` query param\n* Sorting via the comma-delimited `sort` query param - e.g. `sort=name,-id` would sort by name ascending, then by id descending. By default,\nonly first-level (directly on the entity, not on associations) attributes are sortable. Some endpoints expose additional/custom orderable fields, \nwhich are documented with that endpoint.\n* Filtering via the query param `=` e.g. `id=3` for every first-level (not on associations) attribute on the entity. Some\n endpoints expose additional filters which are called out in the documentation for that endpoint. You can also add an optional operator to the filter via the format `::=`, \n e.g. `id::gt=3` to filter for ids greater than 3 or `updated_at::lte=2025-01-01` to filter for updated_at less than or equal to 2025-01-01. \n The following operators are supported:\n * `::gt` - greater than\n * `::gte` - greater than or equal to\n * `::lt` - less than\n * `::lte` - less than or equal to\n * `::in` - in the comma-delimited list of values\n * `::null` - attribute is null (`true` or `1`) or not null (`false` or `0`)\n* Inclusion of associated resources via the comma-delimited `includes` attribute. The common List Result body has `includable_fields` metadata\n that tells you which associations are includable. \ If not specified, a logical default set of associations are included. You may pass\n `includes=` as a blank entry to not include any associations, which can speed up API results if the associated data is not needed.\n* Inclusion of additional data (e.g. quickstats) via the `additional_data` query param. Possible values come from the `additional_data_fields`\narray on a list response.\n\n## List Resource Responses\nVirtually all List endoints have the same result format:\n* `count` - how many results are in this response\n* `total_count` - how many results are their across all pages of results\n* `current_page` - the current page of results (first page is `1`)\n* `total_pages` - how many total pages of results there are\n* `includable_fields` - assocations of the current resource that `can` be included in the result via the `include` query param. Note: this is not necessarily what is included\nin the current result, but rather what is possible to request.\n* `additional_data_fields` - additional data, beyond normal associations, that can be included on the result (e.g. quickstats) via the `additional_data` query param.\n* `results` - The array of resource results \n\n# Common Show Resource Functionality\nMost endpoints to retrieve a single resource, e.g. `GET /api/v1/demand_tags` allow to include associated resources on the result via the same `includes` query\nparamater as the List requests. See the List response the resource for which associations are includable.\n" paths: "/api/v1/account_partner_segments": post: summary: Create requestBody: content: application/json: examples: account_partner_segment_create_simple: "$ref": "#/components/examples/account_partner_segment_create_simple" account_partner_segment_create_full: "$ref": "#/components/examples/account_partner_segment_create_full" schema: type: object required: true responses: '201': description: Created a new account partner segment content: application/json: schema: type: object '200': description: Returned an existing account partner segment content: application/json: schema: type: object tags: - Account Partner Segments operationId: account_partner_segments_post "/api/v1/accounts": get: summary: Index description: List all Accounts parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_get post: summary: Create requestBody: content: application/json: examples: publisher_simple: "$ref": "#/components/examples/account_publisher_create_simple" publisher_full: "$ref": "#/components/examples/account_publisher_create_full" dsp_main_simple: "$ref": "#/components/examples/account_dsp_main_create_simple" dsp_main_full: "$ref": "#/components/examples/account_dsp_main_create_full" dsp_sub_simple: "$ref": "#/components/examples/account_dsp_sub_create_simple" dsp_sub_full: "$ref": "#/components/examples/account_dsp_sub_create_full" clearline_sub_simple: "$ref": "#/components/examples/account_clearline_sub_create_simple" clearline_sub_full: "$ref": "#/components/examples/account_clearline_sub_create_full" curator_main_simple: "$ref": "#/components/examples/account_curator_main_create_simple" curator_main_full: "$ref": "#/components/examples/account_curator_main_create_full" curator_sub_simple: "$ref": "#/components/examples/account_curator_sub_create_simple" curator_sub_full: "$ref": "#/components/examples/account_curator_sub_create_full" external_bidder_simple: "$ref": "#/components/examples/account_external_bidder_create_simple" external_bidder_full: "$ref": "#/components/examples/account_external_bidder_create_full" schema: type: object required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_post "/api/v1/app_bundle_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: app_bundle in: query description: Filter using big-list api schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_get post: summary: Create requestBody: content: application/json: examples: simple: "$ref": "#/components/examples/app_bundle_list_create_simple" full: "$ref": "#/components/examples/app_bundle_list_create_full" schema: type: object required: false responses: '201': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_post "/api/v1/app_name_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: app_name in: query description: Filter using big-list api schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_get post: summary: Create requestBody: content: application/json: examples: simple: "$ref": "#/components/examples/app_name_list_create_simple" full: "$ref": "#/components/examples/app_name_list_create_full" schema: type: object required: true responses: '201': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_post "/api/v1/audio_creatives": get: tags: - Creatives Audio summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/AudioCreativeIndexResponse" operationId: audio_creatives_get post: tags: - Creatives Audio summary: Create requestBody: content: multipart/form-data: schema: type: object required: - creative - demand_partner_id properties: creative: type: string format: binary description: Audio file to upload demand_partner_id: type: number description: ID of the demand partner (required) name: type: string description: Name of the creative (optional) is_active: type: boolean default: true description: Whether the creative is active (optional, defaults to true) application/json: schema: "$ref": "#/components/schemas/AudioCreativeCreateData" examples: simple: "$ref": "#/components/examples/audio_creative_create_simple" full: "$ref": "#/components/examples/audio_creative_create_full" responses: '201': description: Successfully created content: application/json: schema: "$ref": "#/components/schemas/AudioCreativeResponse" operationId: audio_creatives_post "/api/v1/auth": post: summary: Authenticate and get a SpringServe API token description: The returned API token should be used as the contents of the HTTP `Authorization` header in other authenticated API requests. tags: - Auth security: [] parameters: [] responses: '200': description: successful content: application/json: schema: type: object properties: token: type: string description: The token to use in the Authorization header on future requests expiration: type: string description: The expiration timestamp of this token '400': description: bad request - invalid credentials content: application/json: schema: type: object requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: email: type: string example: user@magnite.com password: type: string format: password examples: - some_secret_password required: - email - password operationId: auth_post "/api/v1/bills": get: summary: Index tags: - Bills parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: array items: oneOf: - "$ref": "#/components/schemas/Bill" operationId: bills_get post: summary: Create tags: - Bills requestBody: content: application/json: schema: type: object examples: bill_create_simple: "$ref": "#/components/examples/bill_create_simple" bill_create_full: "$ref": "#/components/examples/bill_create_full" required: true responses: '201': description: Successfully created a new bill content: application/json: schema: "$ref": "#/components/schemas/Bill" '422': description: Unprocessable request content: application/json: schema: type: object properties: status: type: integer error: type: string examples: - error: Name can't be blank errors: name: - can't be blank operationId: bills_post "/api/v1/changelogs": get: summary: Index description: List changelogs. Query parameters time (recommended), change_type, and user filter results. Available for ClearLine account types. parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: time in: query schema: "$ref": "#/components/schemas/ChangelogsTimeFilter" - name: user in: query description: "Filter by user email, or special keywords: 'Optimization Only', 'Exclude Optimization', 'SpringCleaning Only', \n'Exclude SpringCleaning', 'DirectConnect Only', 'Exclude DirectConnect', 'DataMigration Only', 'Exclude DataMigration',\n'Exclude System Updates', 'High Volume Users Only' and 'Exclude High Volume Users'\n" schema: type: string - name: change_type in: query schema: type: string enum: - created - updated - deleted - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Changelogs operationId: changelogs_get "/api/v1/city_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - City Lists operationId: city_lists_get post: summary: Create requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/CityListCreateRequest" - type: object properties: city_codes: type: array items: type: number examples: - - 2988507 - 2643743 required: - city_codes examples: city_list_create_simple: "$ref": "#/components/examples/city_list_create_simple" city_list_create_full: "$ref": "#/components/examples/city_list_create_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/CityListCreateRequest" - type: object properties: csv_file: type: string format: binary required: - csv_file responses: '201': description: Successfully created City List content: application/json: schema: "$ref": "#/components/schemas/CityListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/CityListErrorResponse" tags: - City Lists operationId: city_lists_post "/api/v1/content_categories": get: summary: List all content categories used by contextual signaling description: Unpaginated list of content categories ordered by content_category_id responses: '200': description: successful content: application/json: schema: type: array items: type: object properties: content_category_id: type: string description: Contextual signaling category id example: '123' name: type: string example: Sports required: - content_category_id - name tags: - Content Categories operationId: content_categories_get "/api/v1/country_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Country Lists operationId: country_lists_get post: summary: Create requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/CountryListCreateRequest" - type: object properties: country_codes: type: array items: type: string examples: - - AL - AD required: - country_codes examples: country_list_create_simple: "$ref": "#/components/examples/country_list_create_simple" country_list_create_full: "$ref": "#/components/examples/country_list_create_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/CountryListCreateRequest" - type: object properties: csv_file: type: string format: binary required: - csv_file responses: '201': description: Successfully created Country List content: application/json: schema: "$ref": "#/components/schemas/CountryListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/CountryListErrorResponse" tags: - Country Lists operationId: country_lists_post "/api/v1/creatives": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam - "$ref": "#/components/parameters/additionalDataParam" - name: date_range in: query schema: "$ref": "./ref/quickstats.yaml#/components/schemas/dateRange" - name: currency in: query schema: "$ref": "./ref/concerns/currency.yaml#/components/schemas/CurrencyList" responses: '200': description: '' content: application/json: schema: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: oneOf: - "$ref": ref/concerns/audio_creative.yaml#/components/schemas/AudioCreative - "$ref": ref/concerns/video_creative.yaml#/components/schemas/VideoCreative - "$ref": ref/concerns/tag_creative.yaml#/components/schemas/TagCreative - "$ref": ref/concerns/tile_creative.yaml#/components/schemas/TileCreative - "$ref": ref/concerns/filepath_creative.yaml#/components/schemas/FilepathCreative tags: - Creatives operationId: creatives_get "/api/v1/curated_marketplaces": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Curated Marketplaces operationId: curated_marketplaces_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/curated_marketplace_create_simple" full: "$ref": "#/components/examples/curated_marketplace_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Curated Marketplaces operationId: curated_marketplaces_post "/api/v1/currencies": get: summary: List all currencies description: not paginated/filtered etc. Just list of all currencies in the map responses: '200': description: '' content: application/json: schema: type: object tags: - Currencies operationId: currencies_get "/api/v1/deal_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: deal_id in: query description: Filter deal lists that contain the specified deal ID schema: type: integer - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/deal_list_create_simple" full: "$ref": "#/components/examples/deal_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_post "/api/v1/demand_labels": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/additionalDataParam - "$ref": ref/params.yaml#/components/parameters/idsParam - name: date_range in: query description: Quickstats interval label (applies when `additional_data` contains `quickstats`). Defaults to Today. schema: "$ref": "./ref/quickstats.yaml#/components/schemas/dateRange" - name: currency in: query description: Quickstats currency (applies when `additional_data` contains `quickstats`). Defaults to USD. schema: "$ref": "./ref/concerns/currency.yaml#/components/schemas/CurrencyList" responses: '200': description: Paginated list of demand labels content: application/json: schema: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: "$ref": "#/components/schemas/DemandLabel" tags: - Demand Labels operationId: demand_labels_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/demand_label_create_simple" full: "$ref": "#/components/examples/demand_label_create_full" required: true responses: '201': description: Successfully created a new demand label content: application/json: schema: "$ref": "#/components/schemas/DemandLabel" '422': description: Unprocessable request content: application/json: schema: type: object properties: status: type: integer error: type: string examples: - error: Name can't be blank errors: name: - can't be blank tags: - Demand Labels operationId: demand_labels_post "/api/v1/demand_tags": get: summary: Index description: List all Demand Tags parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam - "$ref": "#/components/parameters/additionalDataParam" - name: date_range in: query schema: "$ref": "./ref/quickstats.yaml#/components/schemas/dateRange" - name: currency in: query schema: "$ref": "./ref/concerns/currency.yaml#/components/schemas/CurrencyList" - name: demand_label_id in: query description: | Narrow results to demand tags linked to this demand label through demand_labelers (parity with the legacy demand tags index label filter). Invalid or zero values yield an empty result set. schema: type: integer - name: demand_tag_status in: query description: | Filter by demand tag status (legacy index parity). Values: active, inactive, new, reactivated. Unknown values return an empty result set. DSP sub-accounts only support active and inactive; other values return 400. schema: type: string enum: - active - inactive - new - reactivated - name: demand_type in: query description: | Filter by demand type slug (legacy demand class filter). Values include managed, dc, hb, creative, house_ad, line_item, programmatic_guaranteed, direct_io, direct_io_line_item. Unknown values return an empty result set. schema: type: string - name: supply_environment in: query description: | Filter by supply environment on the demand tag. Use `any` for legacy "Any" (direct-connect environment or unset). Named `supply_environment` to avoid clashing with the default column equality filter on `environment`. schema: type: string - name: ad_server in: query description: | Filter by ad server bucket (legacy index parity): springserve, other, a header-bidding platform key, or a VAST URL match string from configured ad servers. schema: type: string responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/DemandTagIndexResponse" tags: - Demand Tags operationId: demand_tags_get post: summary: Create requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/DemandTagCreateRequest" examples: tag_simple: "$ref": "#/components/examples/demand_tag_tag_create_simple" tag_full: "$ref": "#/components/examples/demand_tag_tag_create_full" bidder_simple: "$ref": "#/components/examples/demand_tag_bidder_create_simple" bidder_full: "$ref": "#/components/examples/demand_tag_bidder_create_full" line_item_simple: "$ref": "#/components/examples/demand_tag_line_item_create_simple" line_item_full: "$ref": "#/components/examples/demand_tag_line_item_create_full" house_ad_simple: "$ref": "#/components/examples/demand_tag_house_ad_create_simple" house_ad_full: "$ref": "#/components/examples/demand_tag_house_ad_create_full" dsp_sub_line_item_simple: "$ref": "#/components/examples/demand_tag_dsp_sub_line_item_create_simple" dsp_sub_line_item_full: "$ref": "#/components/examples/demand_tag_dsp_sub_line_item_create_full" marketplace_deal_simple: "$ref": "#/components/examples/demand_tag_marketplace_deal_create_simple" marketplace_deal_full: "$ref": "#/components/examples/demand_tag_marketplace_deal_create_full" direct_io_line_item_simple: "$ref": "#/components/examples/demand_tag_direct_io_line_item_create_simple" direct_io_line_item_full: "$ref": "#/components/examples/demand_tag_direct_io_line_item_create_full" required: true responses: '201': description: '' content: application/json: schema: "$ref": "#/components/schemas/DemandTagResponse" '422': "$ref": ref/errors.yaml#/components/responses/validationError tags: - Demand Tags operationId: demand_tags_post "/api/v1/domain_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: domain description: search for the given domain in the lists in: query schema: type: string - name: domain_exact_match description: If the domain filter must be an exact match in: query schema: type: boolean - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_get post: summary: Create requestBody: content: application/json: examples: simple: "$ref": "#/components/examples/domain_list_create_simple" full: "$ref": "#/components/examples/domain_list_create_full" enabled_demand_partners_expansion: "$ref": "#/components/examples/domain_list_create_enabled_demand_partners_expansion" another_account: "$ref": "#/components/examples/domain_list_create_another_account" schema: type: object required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_post "/api/v1/filepath_creatives": get: tags: - Creatives Filepaths summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/FilepathCreativeIndexResponse" operationId: filepath_creatives_get post: tags: - Creatives Filepaths summary: Create requestBody: content: application/json: schema: "$ref": "#/components/schemas/FilepathCreativeCreateData" examples: create_simple: "$ref": "#/components/examples/filepath_creative_create_simple" create_full: "$ref": "#/components/examples/filepath_creative_create_full" required: true responses: '201': description: Successfully created content: application/json: schema: "$ref": "#/components/schemas/FilepathCreativeResponse" operationId: filepath_creatives_post "/api/v1/geo_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: array items: oneOf: - "$ref": "#/components/schemas/GeoList" tags: - Geo Lists operationId: geo_lists_get "/api/v1/global_fcap_pixels": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Global Fcap Pixels operationId: global_fcap_pixels_get post: summary: Create requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/GlobalFcapPixel" examples: simple: "$ref": "#/components/examples/global_fcap_pixel_create_simple" full: "$ref": "#/components/examples/global_fcap_pixel_create_full" responses: '201': description: Created content: application/json: schema: allOf: - "$ref": "#/components/schemas/GlobalFcapPixelResponseFields" - "$ref": "#/components/schemas/GlobalFcapPixel" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/UnsupportedContentErrorResponse" tags: - Global Fcap Pixels operationId: global_fcap_pixels_post "/api/v1/hb_bid_maps": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/HbBidMapsIndexResponse" tags: - Hb Bid Maps operationId: hb_bid_maps_get post: summary: Create requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/HbBidMapCreateRequest" - type: object properties: hb_bid_map_entries: type: array items: allOf: - "$ref": "#/components/schemas/HbBidMapEntry" - type: object properties: id: readOnly: true examples: hb_bid_map_create_simple: "$ref": "#/components/examples/hb_bid_map_create_simple" hb_bid_map_create_full: "$ref": "#/components/examples/hb_bid_map_create_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/HbBidMapCreateRequest" - type: object properties: csv_file: type: string format: binary responses: '201': description: Created content: application/json: schema: allOf: - "$ref": "#/components/schemas/HbBidMapResponseFields" - "$ref": "#/components/schemas/HbBidMap" - "$ref": "#/components/schemas/HbBidMapEntryArray" '422': "$ref": ref/errors.yaml#/components/responses/validationError tags: - Hb Bid Maps operationId: hb_bid_maps_post "/api/v1/header_bidding_platforms": get: summary: List Header Bidding Platforms description: This is not a paginated/filtered list, but rather returns all results responses: '200': description: '' content: application/json: schema: type: object tags: - Header Bidding Platforms operationId: header_bidding_platforms_get "/api/v1/isp_lists": get: tags: - ISP Lists summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_get post: tags: - ISP Lists summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/isp_list_create_simple" full: "$ref": "#/components/examples/isp_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object operationId: isp_lists_post "/api/v1/metro_area_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Metro Area Lists operationId: metro_area_lists_get post: summary: Create requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/MetroAreaListCreateRequest" - type: object properties: metro_area_codes: type: array items: type: number examples: - - 2008 - 2028 - 2038 required: - metro_area_codes examples: simple: "$ref": "#/components/examples/metro_area_list_create_simple" full: "$ref": "#/components/examples/metro_area_list_create_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/MetroAreaListCreateRequest" - type: object properties: csv_file: type: string format: binary required: - csv_file responses: '201': description: Successfully created Metro Area List content: application/json: schema: "$ref": "#/components/schemas/MetroAreaListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/MetroAreaListErrorResponse" tags: - Metro Area Lists operationId: metro_area_lists_post "/api/v1/partner_segments": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: account_partner_segment_is_active in: query schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": "#/components/parameters/additionalDataPartnerSegmentParam" - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/PartnerSegmentIndexResponse" tags: - Partner Segments operationId: partner_segments_get "/api/v1/permissions": get: summary: List system-wide permissions description: List system-wide permissions that are not necessarily specific to a single resource type responses: '200': description: '' content: application/json: schema: type: object tags: - Permissions operationId: permissions_get "/api/v1/postal_code_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Postal Code Lists operationId: postal_code_lists_get post: summary: Create requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/PostalCodeListCreateRequest" - type: object properties: postal_codes: type: array items: type: string examples: - - '10001' - GB:SW1A - FR:75001 required: - postal_codes examples: simple: "$ref": "#/components/examples/postal_code_list_create_simple" full: "$ref": "#/components/examples/postal_code_list_create_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/PostalCodeListCreateRequest" - type: object properties: csv_file: type: string format: binary required: - csv_file required: true responses: '201': description: '' content: application/json: schema: "$ref": "#/components/schemas/PostalCodeListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/PostalCodeListErrorResponse" tags: - Postal Code Lists operationId: postal_code_lists_post "/api/v1/report": post: summary: Alias for POST /api/v1/reports requestBody: content: application/json: schema: anyOf: - "$ref": "./ref/reports.yaml#/components/schemas/reportParameters" - type: object properties: async: type: boolean csv: type: boolean sort: type: array items: type: string examples: simple: "$ref": "#/components/examples/report_create_simple" full: "$ref": "#/components/examples/report_create_full" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Report operationId: report_post "/api/v1/reports": post: summary: Create requestBody: content: application/json: schema: anyOf: - "$ref": "./ref/reports.yaml#/components/schemas/reportParameters" - type: object properties: async: type: boolean csv: type: boolean sort: type: array items: type: string examples: simple: "$ref": "#/components/examples/report_create_simple" full: "$ref": "#/components/examples/report_create_full" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Reports operationId: reports_post "/api/v1/scanned_creative_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/scanned_creative_list_create_simple" full: "$ref": "#/components/examples/scanned_creative_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_post "/api/v1/scheduled_reports": get: tags: - Scheduled Reports summary: Index parameters: - in: query name: id schema: type: array items: type: integer - in: query name: page schema: type: integer - in: query name: per schema: type: integer - in: query name: sort schema: type: array items: type: string - in: query name: account_id schema: type: array items: type: integer - in: query name: user_account_id schema: type: array items: type: integer - in: query name: user_id schema: type: array items: type: integer - in: query name: is_active schema: type: array items: type: boolean - in: query name: search schema: type: string responses: '200': description: '' content: application/json: schema: type: object operationId: scheduled_reports_get post: tags: - Scheduled Reports summary: Create requestBody: content: application/json: schema: "$ref": "#/components/schemas/scheduledReport" examples: simple: "$ref": "#/components/examples/scheduled_report_create_simple" full: "$ref": "#/components/examples/scheduled_report_create_full" responses: '201': "$ref": "#/components/responses/scheduledReport" '422': "$ref": ref/errors.yaml#/components/responses/validationError operationId: scheduled_reports_post "/api/v1/search": get: summary: Universal description: Universal Search across all entity types parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" responses: '200': description: '' content: application/json: schema: type: object tags: - Search operationId: search_get "/api/v1/session": get: summary: Get current user session description: Gets current user session id, account id, and session information responses: '200': description: Success content: application/json: schema: type: object properties: session_id: type: string '401': description: Not authorized content: application/json: schema: type: object properties: error: type: string tags: - Session operationId: session_get delete: summary: Delete current user session description: Delete current user session, logging them out from SpringServe UI responses: '204': description: No content '401': description: Not authorized content: application/json: schema: type: object properties: error: type: string tags: - Session operationId: session_delete "/api/v1/state_lists": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - State Lists operationId: state_lists_get post: summary: Create requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/StateListCreateRequest" - type: object properties: state_codes: type: array items: type: string description: The state codes to include in the state list. examples: - - US-CA - US-NY examples: state_list_create_simple: "$ref": "#/components/examples/state_list_create_simple" state_list_create_full: "$ref": "#/components/examples/state_list_create_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/StateListCreateRequest" - type: object properties: csv_file: type: string format: binary required: - csv_file responses: '201': description: Successfully created State List content: application/json: schema: "$ref": "#/components/schemas/StateListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/StateListErrorResponse" tags: - State Lists operationId: state_lists_post "/api/v1/supply_labels": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/SupplyLabelIndexResponse" tags: - Supply Labels operationId: supply_labels_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_label_create_simple" full: "$ref": "#/components/examples/supply_label_create_full" required: true responses: '201': description: Successfully created a new supply label content: application/json: schema: "$ref": "#/components/schemas/SupplyLabel" '422': "$ref": ref/errors.yaml#/components/responses/validationError tags: - Supply Labels operationId: supply_labels_post "/api/v1/supply_name_lists": get: tags: - Supply Name Lists summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_get post: tags: - Supply Name Lists summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_name_list_create_simple" full: "$ref": "#/components/examples/supply_name_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object operationId: supply_name_lists_post "/api/v1/supply_tags": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: curator_fees.curator_fee_publishers.publisher in: query schema: type: string - name: curator_fees.curator_fee_publishers.inventory_source in: query schema: type: string - name: curator_fees.curator_fee_publishers.ad_source_ids in: query schema: type: array items: type: number - name: marketplace_buyers.inventory_source in: query schema: type: string - name: marketplace_buyers.dsp_id in: query schema: type: string - name: optimization_is_active in: query schema: type: string - name: optimization_version in: query schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Supply Tags operationId: supply_tags_get "/api/v1/tag_creatives": get: tags: - Creatives Tag summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/TagCreativeIndexResponse" operationId: tag_creatives_get post: tags: - Creatives Tag summary: Create requestBody: content: application/json: schema: "$ref": "#/components/schemas/TagCreativeCreateData" examples: simple: "$ref": "#/components/examples/tag_creative_create_simple" full: "$ref": "#/components/examples/tag_creative_create_full" required: true responses: '201': description: Successfully created content: application/json: schema: "$ref": "#/components/schemas/TagCreativeResponse" operationId: tag_creatives_post "/api/v1/tile_creatives": get: tags: - Creatives Tile summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/TileCreativeIndexResponse" operationId: tile_creatives_get post: tags: - Creatives Tile summary: Create requestBody: content: multipart/form-data: schema: "$ref": "#/components/schemas/TileCreativeMultipartData" encoding: creatives: style: form explode: true application/json: schema: "$ref": "#/components/schemas/TileCreativeCreateData" examples: clickable_image_simple: "$ref": "#/components/examples/tile_creative_clickable_image_create_simple" clickable_image_full: "$ref": "#/components/examples/tile_creative_clickable_image_create_full" clickable_video_simple: "$ref": "#/components/examples/tile_creative_clickable_video_create_simple" clickable_video_full: "$ref": "#/components/examples/tile_creative_clickable_video_create_full" multimedia_simple: "$ref": "#/components/examples/tile_creative_multimedia_create_simple" multimedia_full: "$ref": "#/components/examples/tile_creative_multimedia_create_full" custom_simple: "$ref": "#/components/examples/tile_creative_custom_create_simple" custom_full: "$ref": "#/components/examples/tile_creative_custom_create_full" responses: '201': description: Successfully created content: application/json: schema: "$ref": "#/components/schemas/TileCreativeResponse" operationId: tile_creatives_post "/api/v1/timezones": get: summary: List all timezones from ActiveSupport::TimeZone description: Just a list of objects with timezone and name responses: '200': description: '' content: application/json: schema: type: object tags: - Timezones operationId: timezones_get "/api/v1/user_accounts": get: summary: Index description: | For sorting in addition to regular attributes, you can also sort by `client_object_type_partner` and `client_object_type_label` which are whether `client_object_type='partner'` or `client_object_type='label'` respectively. parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: partner_name description: filter based on supply partner or demand partner name in: query schema: type: string - name: label_name description: filter based on supply label or demand label name in: query schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - User Accounts operationId: user_accounts_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/user_account_create_simple" full: "$ref": "#/components/examples/user_account_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - User Accounts operationId: user_accounts_post "/api/v1/vendors": get: summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Vendors operationId: vendors_get "/api/v1/video_creatives": get: tags: - Creatives Video summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/VideoCreativeIndexResponse" operationId: video_creatives_get post: tags: - Creatives Video summary: Create requestBody: content: multipart/form-data: schema: type: object required: - creative - demand_partner_id properties: creative: type: string format: binary description: Video file to upload demand_partner_id: type: number description: ID of the demand partner (required) name: type: string description: Name of the creative (optional) is_active: type: boolean default: true description: Whether the creative is active (optional, defaults to true) application/json: schema: "$ref": "#/components/schemas/VideoCreativeCreateData" examples: simple: "$ref": "#/components/examples/video_creative_create_simple" full: "$ref": "#/components/examples/video_creative_create_full" responses: '201': description: Successfully created content: application/json: schema: "$ref": "#/components/schemas/VideoCreativeResponse" operationId: video_creatives_post "/api/v1/account_partner_segments/{id}": patch: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: account_partner_segment_update_simple: "$ref": "#/components/examples/account_partner_segment_update_simple" account_partner_segment_update_full: "$ref": "#/components/examples/account_partner_segment_update_full" schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Account Partner Segments operationId: account_partner_segments_id_patch "/api/v1/accounts/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_get patch: summary: Update requestBody: content: application/json: examples: simple: "$ref": "#/components/examples/account_update_simple" full: "$ref": "#/components/examples/account_update_full" schema: type: object required: false responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_patch "/api/v1/app_bundle_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: simple: "$ref": "#/components/examples/app_bundle_list_update_simple" full: "$ref": "#/components/examples/app_bundle_list_update_full" schema: type: object required: false responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - App Bundle Lists operationId: app_bundle_lists_id_delete "/api/v1/app_name_lists/{id}": parameters: - name: id in: path required: true schema: type: number get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_get patch: summary: Update requestBody: content: application/json: examples: simple: "$ref": "#/components/examples/app_name_list_update_simple" full: "$ref": "#/components/examples/app_name_list_update_full" schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_patch delete: summary: Delete responses: '204': description: No content tags: - App Name Lists operationId: app_name_lists_id_delete "/api/v1/audio_creatives/{id}": get: tags: - Creatives Audio summary: Show parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/AudioCreativeResponse" operationId: audio_creatives_id_get patch: tags: - Creatives Audio summary: Update parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam requestBody: content: application/json: schema: "$ref": "#/components/schemas/AudioCreativeUpdateData" examples: simple: "$ref": "#/components/examples/audio_creative_update_simple" full: "$ref": "#/components/examples/audio_creative_update_full" required: false responses: '200': description: Successfully updated content: application/json: schema: "$ref": "#/components/schemas/AudioCreativeResponse" operationId: audio_creatives_id_patch delete: tags: - Creatives Audio summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content '422': "$ref": ref/errors.yaml#/components/responses/validationError operationId: audio_creatives_id_delete "/api/v1/bills/{id}": get: summary: Show tags: - Bills parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/Bill" operationId: bills_id_get patch: summary: Update tags: - Bills parameters: - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object examples: bill_update_simple: "$ref": "#/components/examples/bill_update_simple" bill_update_full: "$ref": "#/components/examples/bill_update_full" required: true responses: '200': description: Successfully updated a bill content: application/json: schema: "$ref": "#/components/schemas/Bill" '422': description: Unprocessable request content: application/json: schema: type: object properties: status: type: integer error: type: string examples: - error: Name can't be blank errors: name: - can't be blank operationId: bills_id_patch delete: summary: Delete tags: - Bills parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content operationId: bills_id_delete "/api/v1/changelogs/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Changelogs operationId: changelogs_id_get "/api/v1/city_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - City Lists operationId: city_lists_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/CityListUpdateRequest" - type: object properties: city_codes: type: array items: type: number description: List of city codes. Can be used only when list_action parameter is provided. examples: - - 2988507 - 2643743 examples: city_list_update_simple: "$ref": "#/components/examples/city_list_update_simple" city_list_update_full: "$ref": "#/components/examples/city_list_update_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/CityListUpdateRequest" - type: object properties: csv_file: type: string format: binary x-accept: text/csv description: CSV file with city codes. Can be used only when the list_action parameter is provided. responses: '200': description: Updated City List successfully content: application/json: schema: "$ref": "#/components/schemas/CityListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/CityListErrorResponse" tags: - City Lists operationId: city_lists_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - City Lists operationId: city_lists_id_delete "/api/v1/country_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Country Lists operationId: country_lists_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/CountryListUpdateRequest" - type: object properties: country_codes: type: array items: type: string description: List of country codes. Can be used only when the list_action parameter is provided. examples: - - UA - US examples: country_list_update_simple: "$ref": "#/components/examples/country_list_update_simple" country_list_update_full: "$ref": "#/components/examples/country_list_update_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/CountryListUpdateRequest" - type: object properties: csv_file: type: string format: binary description: CSV file with country codes. Can be used only when the list_action parameter is provided. responses: '200': description: Updated Country List successfully content: application/json: schema: "$ref": "#/components/schemas/CountryListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/CountryListErrorResponse" tags: - Country Lists operationId: country_lists_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Country Lists operationId: country_lists_id_delete "/api/v1/creatives/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": "#/components/parameters/additionalDataParam" responses: '200': description: '' content: application/json: schema: oneOf: - "$ref": ref/concerns/audio_creative.yaml#/components/schemas/AudioCreative - "$ref": ref/concerns/video_creative.yaml#/components/schemas/VideoCreative - "$ref": ref/concerns/tag_creative.yaml#/components/schemas/TagCreative - "$ref": ref/concerns/tile_creative.yaml#/components/schemas/TileCreative - "$ref": ref/concerns/filepath_creative.yaml#/components/schemas/FilepathCreative tags: - Creatives operationId: creatives_id_get delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Creatives operationId: creatives_id_delete "/api/v1/curated_marketplaces/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Curated Marketplaces operationId: curated_marketplaces_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/curated_marketplace_update_simple" full: "$ref": "#/components/examples/curated_marketplace_update_full" required: false responses: '200': description: '' content: application/json: schema: type: object tags: - Curated Marketplaces operationId: curated_marketplaces_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Curated Marketplaces operationId: curated_marketplaces_id_delete "/api/v1/deal_lists/{deal_list_id}": get: summary: Show parameters: - name: deal_list_id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_deal_list_id_get patch: summary: Update parameters: - name: deal_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/deal_list_update_simple" full: "$ref": "#/components/examples/deal_list_update_full" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_deal_list_id_patch delete: summary: Delete parameters: - name: deal_list_id in: path required: true schema: type: string responses: '204': description: No content '422': "$ref": ref/errors.yaml#/components/responses/validationError tags: - Deal Lists operationId: deal_lists_deal_list_id_delete "/api/v1/demand_labels/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/additionalDataParam - name: date_range in: query description: Quickstats interval label (applies when `additional_data` contains `quickstats`). Defaults to Today. schema: "$ref": "./ref/quickstats.yaml#/components/schemas/dateRange" - name: currency in: query description: Quickstats currency (applies when `additional_data` contains `quickstats`). Defaults to USD. schema: "$ref": "./ref/concerns/currency.yaml#/components/schemas/CurrencyList" responses: '200': description: Demand label content: application/json: schema: "$ref": "#/components/schemas/DemandLabel" tags: - Demand Labels operationId: demand_labels_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/demand_label_update_simple" full: "$ref": "#/components/examples/demand_label_update_full" required: true responses: '200': description: Successfully updated a demand label content: application/json: schema: "$ref": "#/components/schemas/DemandLabel" '422': description: Unprocessable request content: application/json: schema: type: object properties: status: type: integer error: type: string examples: - error: Name can't be blank errors: name: - can't be blank tags: - Demand Labels operationId: demand_labels_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Demand Labels operationId: demand_labels_id_delete "/api/v1/demand_partners/{id}": parameters: - name: id in: path required: true description: Unique identifier for the Demand Partner. schema: type: string "/api/v1/demand_tags/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": "#/components/parameters/additionalDataParam" - name: date_range in: query schema: "$ref": "./ref/quickstats.yaml#/components/schemas/dateRange" - name: currency in: query schema: "$ref": "./ref/concerns/currency.yaml#/components/schemas/CurrencyList" responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/DemandTagResponse" '404': "$ref": ref/errors.yaml#/components/responses/notFoundError tags: - Demand Tags operationId: demand_tags_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: advanced_floor_rules: type: array items: type: object properties: id: type: integer dimension: type: string enum: - adomain - duration - country - iab_tier_1 - iab_tier_2 values: type: array items: type: string floor_price: type: number examples: simple: "$ref": "#/components/examples/demand_tag_update_simple" full: "$ref": "#/components/examples/demand_tag_update_full" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Demand Tags operationId: demand_tags_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: example: name: V1 API Updated name schema: type: object required: true responses: '204': description: No content tags: - Demand Tags operationId: demand_tags_id_delete "/api/v1/domain_lists/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_get patch: summary: Update requestBody: content: application/json: examples: simple: "$ref": "#/components/examples/domain_list_update_simple" full: "$ref": "#/components/examples/domain_list_update_full" schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_patch delete: summary: Delete responses: '204': description: No content tags: - Domain Lists operationId: domain_lists_id_delete "/api/v1/filepath_creatives/{id}": get: tags: - Creatives Filepaths summary: Show parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/FilepathCreativeResponse" operationId: filepath_creatives_id_get patch: tags: - Creatives Filepaths summary: Update parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam requestBody: content: application/json: schema: "$ref": "#/components/schemas/FilepathCreativeUpdateData" examples: update_simple: "$ref": "#/components/examples/filepath_creative_update_simple" update_full: "$ref": "#/components/examples/filepath_creative_update_full" required: false responses: '200': description: Successfully updated content: application/json: schema: "$ref": "#/components/schemas/FilepathCreativeResponse" operationId: filepath_creatives_id_patch delete: tags: - Creatives Filepaths summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content '422': "$ref": ref/errors.yaml#/components/responses/validationError operationId: filepath_creatives_id_delete "/api/v1/global_fcap_pixels/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Global Fcap Pixels operationId: global_fcap_pixels_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: number requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/GlobalFcapPixelUpdateRequest" examples: simple: "$ref": "#/components/examples/global_fcap_pixel_update_simple" full: "$ref": "#/components/examples/global_fcap_pixel_update_full" responses: '200': description: Updated content: application/json: schema: allOf: - "$ref": "#/components/schemas/GlobalFcapPixelResponseFields" - "$ref": "#/components/schemas/GlobalFcapPixel" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/UnsupportedContentErrorResponse" tags: - Global Fcap Pixels operationId: global_fcap_pixels_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Global Fcap Pixels operationId: global_fcap_pixels_id_delete "/api/v1/hb_bid_maps/{id}": parameters: - name: id in: path required: true schema: type: number get: summary: Show responses: '200': description: '' content: application/json: schema: allOf: - "$ref": "#/components/schemas/HbBidMap" - "$ref": "#/components/schemas/HbBidMapResponseFields" tags: - Hb Bid Maps operationId: hb_bid_maps_id_get patch: summary: Update requestBody: required: true content: application/json: schema: allOf: - "$ref": "#/components/schemas/HbBidMapUpdateRequest" - type: object properties: hb_bid_map_entries: type: array description: Array of bid map entries. Can be used only when the list_action parameter is provided. items: "$ref": "#/components/schemas/HbBidMapEntry" examples: hb_bid_map_update_simple: "$ref": "#/components/examples/hb_bid_map_update_simple" hb_bid_map_update_full: "$ref": "#/components/examples/hb_bid_map_update_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/HbBidMapUpdateRequest" - type: object properties: csv_file: type: string format: binary description: 'CSV file with bid map entries. Can be used only when the list_action parameter is provided. File contains values: bid_floor, parameter_value and id if list_action is remove.' responses: '200': description: Updated content: application/json: schema: allOf: - "$ref": "#/components/schemas/HbBidMapResponseFields" - "$ref": "#/components/schemas/HbBidMap" - "$ref": "#/components/schemas/HbBidMapEntryArray" '422': "$ref": ref/errors.yaml#/components/responses/validationError tags: - Hb Bid Maps operationId: hb_bid_maps_id_patch delete: summary: Delete responses: '204': description: No content tags: - Hb Bid Maps operationId: hb_bid_maps_id_delete "/api/v1/isp_lists/{id}": get: tags: - ISP Lists summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_get patch: tags: - ISP Lists summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/isp_list_update_simple" full: "$ref": "#/components/examples/isp_list_update_full" required: false responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_patch delete: tags: - ISP Lists summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content operationId: isp_lists_id_delete "/api/v1/metro_area_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Metro Area Lists operationId: metro_area_lists_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/MetroAreaListUpdateRequest" - type: object properties: metro_area_codes: type: array items: type: number description: List of metro area (Comscore Market) IDs. Can be used only when the list_action parameter is provided. examples: - - 2008 - 2028 - 2038 examples: simple: "$ref": "#/components/examples/metro_area_list_update_simple" full: "$ref": "#/components/examples/metro_area_list_update_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/MetroAreaListUpdateRequest" - type: object properties: csv_file: type: string format: binary description: CSV file with metro area IDs. Can be used only when the list_action parameter is provided. responses: '200': description: Updated Metro Area List successfully content: application/json: schema: "$ref": "#/components/schemas/MetroAreaListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/MetroAreaListErrorResponse" tags: - Metro Area Lists operationId: metro_area_lists_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Metro Area Lists operationId: metro_area_lists_id_delete "/api/v1/packages/{id}": parameters: - name: id in: path required: true schema: type: string "/api/v1/partner_segments/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show parameters: - "$ref": "#/components/parameters/additionalDataPartnerSegmentParam" - "$ref": ref/params.yaml#/components/parameters/includeParam responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/PartnerSegment" tags: - Partner Segments operationId: partner_segments_id_get patch: summary: Update requestBody: content: application/json: schema: type: object properties: is_active: type: boolean examples: partner_segment_update_simple: "$ref": "#/components/examples/partner_segment_update_simple" partner_segment_update_full: "$ref": "#/components/examples/partner_segment_update_full" responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/PartnerSegment" tags: - Partner Segments operationId: partner_segments_id_patch delete: summary: Delete responses: '204': description: No content tags: - Partner Segments operationId: partner_segments_id_delete "/api/v1/polygon_lists/{id}": parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/additionalDataParam "/api/v1/postal_code_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/PostalCodeListResponse" tags: - Postal Code Lists operationId: postal_code_lists_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/PostalCodeListUpdateRequest" - type: object properties: postal_codes: type: array items: type: string description: List of postal codes. Can be used only when the list_action parameter is provided. examples: - - '10001' - GB:SW1A - FR:75001 examples: simple: "$ref": "#/components/examples/postal_code_list_update_simple" full: "$ref": "#/components/examples/postal_code_list_update_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/PostalCodeListUpdateRequest" - type: object properties: csv_file: type: string format: binary description: CSV file with postal codes. Can be used only when the list_action parameter is provided. responses: '200': description: Updated Postal Code List successfully content: application/json: schema: "$ref": "#/components/schemas/PostalCodeListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/PostalCodeListErrorResponse" tags: - Postal Code Lists operationId: postal_code_lists_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Postal Code Lists operationId: postal_code_lists_id_delete "/api/v1/reports/{id}": get: summary: Get Report parameters: - name: id in: path schema: type: string required: true - name: sort in: query schema: type: string - name: limit in: query schema: type: string - name: page in: query schema: type: string - name: source in: query schema: type: string description: The source of the report request responses: '200': description: '' content: application/json: schema: type: object tags: - Reports operationId: reports_id_get "/api/v1/scanned_creative_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/scanned_creative_list_update_simple" full: "$ref": "#/components/examples/scanned_creative_list_update_full" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_delete "/api/v1/scheduled_reports/{id}": get: tags: - Scheduled Reports summary: Show parameters: - in: path name: id required: true schema: type: integer responses: '200': "$ref": "#/components/responses/scheduledReport" '404': "$ref": ref/errors.yaml#/components/responses/notFoundError operationId: scheduled_reports_id_get patch: tags: - Scheduled Reports summary: Update parameters: - in: path name: id required: true schema: type: integer requestBody: content: application/json: schema: "$ref": "#/components/schemas/scheduledReport" examples: simple: "$ref": "#/components/examples/scheduled_report_update_simple" full: "$ref": "#/components/examples/scheduled_report_update_full" responses: '200': "$ref": "#/components/responses/scheduledReport" operationId: scheduled_reports_id_patch delete: tags: - Scheduled Reports summary: Delete parameters: - in: path name: id required: true schema: type: integer responses: '204': description: No content operationId: scheduled_reports_id_delete "/api/v1/search/{entity}": get: summary: Search within a given type of entity parameters: - name: entity in: path required: true schema: type: string enum: - account_managers - ad_servers - advertiser_domain_lists - app_bundle_lists - app_name_lists - audiences - bid_modifiers - bid_platforms - campaign_codes - campaign_secondary_codes - cities - city_lists - city_names - clearline_deals - clearline_rtd_signals - countries - country_lists - creative_codes - creative_secondary_codes - creative_languages - creatives - curator_fee_publishers - deal_id_lists - deal_ids - deal_lists - deals - delivery_modifiers - demand_codes - demand_labels - demand_partner_codes - demand_partner_secondary_codes - demand_tag_secondary_codes - metro_areas - metro_area_lists - domain_lists - established_direct_connect_accounts - external_deal_ids - foreign_deal_codes - foreign_deal_ids - foreign_deal_names - global_fcap_pixels - iab_category_tier1_lists - iab_category_tier2_lists - ip_lists - isps - isp_lists - keys - keyword_lists - marketplace_buyer_buyer_seats - marketplace_buyer_dsps - parameter_lists - partner_segment_codes - partner_segments - polygon_lists - postal_code_lists - predefined_key_values - publisher_id_lists - scanned_creative_lists - segments - state_lists - states - streaming_publishers - streaming_seller_seat_lists - streaming_seller_seats - supply_tag_codes - supply_partner_codes - supply_router_codes - supply_labels - supply_partners - supply_routers - vendors - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - "$ref": "#/components/parameters/is_active" - "$ref": "#/components/parameters/account_id" - name: demand_partner_permission_ids description: Filter based on the demand partner(s) selected for the given objects. Only supported for app_bundle_lists, app_name_lists, city_lists, country_lists, deal_lists, deals, metro_area_lists, global_fcap_pixels, ip_lists, postal_code_lists, publisher_id_lists, segments, state_lists, and streaming_seller_seat_lists. in: query schema: oneOf: - type: integer - type: array items: type: integer responses: '200': description: '' content: application/json: schema: type: object tags: - Search operationId: search_entity_get "/api/v1/showcases/{id}": parameters: - name: id in: path required: true schema: type: integer "/api/v1/state_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - State Lists operationId: state_lists_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: allOf: - "$ref": "#/components/schemas/StateListUpdateRequest" - type: object properties: state_codes: type: array items: type: string description: The state codes to include in the state list. Can only be used when list_action parameter is provided. examples: - - CA-ON - GB-ENG examples: state_list_update_simple: "$ref": "#/components/examples/state_list_update_simple" state_list_update_full: "$ref": "#/components/examples/state_list_update_full" multipart/form-data: schema: allOf: - "$ref": "#/components/schemas/StateListUpdateRequest" - type: object properties: csv_file: type: string format: binary x-accept: text/csv description: The CSV file containing state codes to include in the state list. Can only be used when list_action parameter is provided. responses: '200': description: Successfully updated State List content: application/json: schema: "$ref": "#/components/schemas/StateListResponse" '422': description: Unprocessable Content content: application/json: schema: "$ref": "#/components/schemas/StateListErrorResponse" tags: - State Lists operationId: state_lists_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - State Lists operationId: state_lists_id_delete "/api/v1/supply_labels/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/SupplyLabel" tags: - Supply Labels operationId: supply_labels_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_label_update_simple" full: "$ref": "#/components/examples/supply_label_update_full" required: true responses: '200': description: Successfully updated a supply label content: application/json: schema: "$ref": "#/components/schemas/SupplyLabel" '422': "$ref": ref/errors.yaml#/components/responses/validationError tags: - Supply Labels operationId: supply_labels_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Supply Labels operationId: supply_labels_id_delete "/api/v1/supply_name_lists/{id}": get: tags: - Supply Name Lists summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_get patch: tags: - Supply Name Lists summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_name_list_update_simple" full: "$ref": "#/components/examples/supply_name_list_update_full" required: false responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_patch delete: tags: - Supply Name Lists summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content operationId: supply_name_lists_id_delete "/api/v1/supply_tags/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Supply Tags operationId: supply_tags_id_get "/api/v1/tag_creatives/{id}": get: tags: - Creatives Tag summary: Show parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/TagCreativeResponse" operationId: tag_creatives_id_get patch: tags: - Creatives Tag summary: Update parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam requestBody: content: application/json: schema: "$ref": "#/components/schemas/TagCreativeUpdateData" examples: simple: "$ref": "#/components/examples/tag_creative_update_simple" full: "$ref": "#/components/examples/tag_creative_update_full" required: false responses: '200': description: Successfully updated content: application/json: schema: "$ref": "#/components/schemas/TagCreativeResponse" operationId: tag_creatives_id_patch delete: tags: - Creatives Tag summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content '422': "$ref": ref/errors.yaml#/components/responses/validationError operationId: tag_creatives_id_delete "/api/v1/tile_creatives/{id}": get: tags: - Creatives Tile summary: Show parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/TileCreativeResponse" operationId: tile_creatives_id_get patch: tags: - Creatives Tile summary: Update parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam requestBody: content: application/json: schema: "$ref": "#/components/schemas/TileCreativeUpdateData" examples: simple: "$ref": "#/components/examples/tile_creative_update_simple" full: "$ref": "#/components/examples/tile_creative_update_full" responses: '200': description: Successfully updated content: application/json: schema: "$ref": "#/components/schemas/TileCreativeResponse" operationId: tile_creatives_id_patch delete: tags: - Creatives Tile summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content '422': "$ref": ref/errors.yaml#/components/responses/validationError operationId: tile_creatives_id_delete "/api/v1/user_accounts/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam responses: '200': description: '' content: application/json: schema: type: object tags: - User Accounts operationId: user_accounts_id_get patch: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/user_account_update_simple" full: "$ref": "#/components/examples/user_account_update_full" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - User Accounts operationId: user_accounts_id_patch delete: summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - User Accounts operationId: user_accounts_id_delete "/api/v1/vendors/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Vendors operationId: vendors_id_get "/api/v1/video_creatives/{id}": get: tags: - Creatives Video summary: Show parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam responses: '200': description: Successful response content: application/json: schema: "$ref": "#/components/schemas/VideoCreativeResponse" operationId: video_creatives_id_get patch: tags: - Creatives Video summary: Update parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam requestBody: content: application/json: schema: "$ref": "#/components/schemas/VideoCreativeUpdateData" examples: simple: "$ref": "#/components/examples/video_creative_update_simple" full: "$ref": "#/components/examples/video_creative_update_full" required: true responses: '200': description: Successfully updated content: application/json: schema: "$ref": "#/components/schemas/VideoCreativeResponse" operationId: video_creatives_id_patch delete: tags: - Creatives Video summary: Delete parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content '422': "$ref": ref/errors.yaml#/components/responses/validationError operationId: video_creatives_id_delete "/api/v1/white_labels/{id}": parameters: - name: id in: path required: true schema: type: string "/api/v1/account_partner_segments/bulk_update": post: summary: Bulk Update requestBody: content: application/json: examples: account_partner_segment_bulk_update_single: "$ref": "#/components/examples/account_partner_segment_bulk_update_single" account_partner_segment_bulk_update_multiple: "$ref": "#/components/examples/account_partner_segment_bulk_update_multiple" schema: type: object required: true responses: '200': description: Bulk update completed content: application/json: schema: type: object properties: message: type: string description: Status message describing the bulk update results examples: - message: 'Successfully updated 5 Account Partner Segments: 251, 1789, 2024, 2026, 2848' tags: - Account Partner Segments operationId: account_partner_segments_bulk_update_same_attributes_post "/api/v1/accounts/current": get: summary: Get the currently active account for the authenticated user responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_current_get "/api/v1/accounts/displayable": get: summary: Get the accounts that the current user can select as their current account context responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_displayable_get "/api/v1/accounts/meta": get: summary: Meta responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_meta_get "/api/v1/accounts/new": get: summary: Get the defaults for a new account given an optional preset parameters: - name: preset in: query schema: type: string examples: - publisher required: false responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_new_get "/api/v1/accounts/permissions": get: summary: Permissions Collection responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_permissions_get "/api/v1/app_bundle_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_permissions_get "/api/v1/app_name_lists/bulk_update": post: summary: Bulk Update requestBody: content: application/json: examples: single: "$ref": "#/components/examples/app_name_list_bulk_update_single" multiple: "$ref": "#/components/examples/app_name_list_bulk_update_multiple" schema: type: object required: true responses: '200': description: Bulk update completed content: application/json: schema: type: object properties: message: type: string description: Status message describing the bulk update results examples: - message: 'Successfully updated 2 App Name Lists: 1, 2' tags: - App Name Lists operationId: app_name_lists_bulk_update_same_attributes_post "/api/v1/app_name_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_permissions_get "/api/v1/audiences/targeted": get: summary: Get paginated list of active targeted audiences description: Returns audiences that have active targeting associations parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: targeter_type in: query description: | Type of targeter. Must be provided together with `targeter_id`. Currently only `DemandTag` is supported. required: false schema: type: string enum: - DemandTag - name: targeter_id in: query description: 'ID of the targeter. Must be provided together with `targeter_type`. ' required: false schema: type: integer - name: maui_id in: query description: Equality filter on the audience MAUI ID. required: false schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Audiences operationId: audiences_targeted_get "/api/v1/auth0/login": post: summary: Authenticate and get user and account info description: Authenticate the user, and if valid, return basic info about the user, along with accounts they can access tags: - Auth security: [] parameters: [] responses: '200': description: successful content: application/json: schema: type: object '400': description: bad request - invalid credentials content: application/json: schema: type: object requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: email: type: string examples: - user@magnite.com password: type: string format: password examples: - some_secret_password required: - email - password operationId: auth0_login_post "/api/v1/bills/permissions": get: summary: Collection Permissions tags: - Bills responses: '200': description: '' content: application/json: schema: type: object operationId: bills_permissions_get "/api/v1/changelogs/user_emails": get: summary: User Emails description: Get the list of User Emails to show for filtering changelogs by user responses: '200': description: '' content: application/json: schema: type: object tags: - Changelogs operationId: changelogs_user_emails_get "/api/v1/changelogs/versioned_types_for_current_account": get: summary: versioned_types for the Current Account description: Returns which versioned_types (and their display names) are applicable for the current account context responses: '200': description: '' content: application/json: schema: type: object tags: - Changelogs operationId: changelogs_versioned_types_for_current_account_get "/api/v1/city_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - City Lists operationId: city_lists_permissions_get "/api/v1/country_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Country Lists operationId: country_lists_permissions_get "/api/v1/creatives/bulk_update": post: summary: Bulk Update description: Update multiple creatives with the same attributes in a single request. requestBody: content: application/json: schema: oneOf: - "$ref": "#/components/schemas/Status" - "$ref": "#/components/schemas/Country" - "$ref": "#/components/schemas/Region" - "$ref": "#/components/schemas/City" - "$ref": "#/components/schemas/PostalCode" - "$ref": "#/components/schemas/MetroArea" - "$ref": "#/components/schemas/Device" - "$ref": "#/components/schemas/OS" - "$ref": "#/components/schemas/Browser" - "$ref": "#/components/schemas/Brand" examples: Status: value: object_ids: - 1 - 2 is_active: true Country: value: object_ids: - 1 - 2 country_source: values country_codes: - US - CA country_white_list: 'true' Region: value: object_ids: - 1 - 2 state_source: values state_codes: - US-AL state_white_list: 'false' City: value: object_ids: - 1 - 2 city_source: values city_codes: - 4314295 - 2643743 city_white_list: 'true' PostalCode: value: object_ids: - 1 - 2 postal_code_source: list postal_code_list_ids: - 4 - 6 postal_code_white_list: 'true' Metro Area: value: object_ids: - 1 - 2 metro_area_source: values metro_area_codes: - 2168 - 2153 metro_area_white_list: 'true' Device: value: object_ids: - 1 - 2 all_user_agent_devices: false user_agent_devices: - CTV OS: value: object_ids: - 1 - 2 all_user_agent_operating_systems: false user_agent_operating_systems: - iOS Browser: value: object_ids: - 1 - 2 all_user_agent_browsers: false user_agent_browsers: - Chrome - Firefox Brand: value: object_ids: - 1 - 2 all_user_agent_brand_names: true required: true responses: '200': description: Bulk update completed content: application/json: schema: type: object properties: message: type: string description: Status message describing the bulk update results examples: - message: 'Successfully updated 2 Creatives: 1, 2' '404': description: Not found. It indicates that the requested resource or required parameter was not found. content: application/json: schema: type: object properties: error: type: string examples: - error: Object not found tags: - Creatives operationId: creatives_bulk_update_same_attributes_post "/api/v1/curated_marketplaces/global": get: summary: Show curated_marketplaces across all accounts description: Show minimal information (id, name, is_active) about all curated_marketplaces across all accounts responses: '200': description: '' content: application/json: schema: type: object tags: - Curated Marketplaces operationId: curated_marketplaces_global_get "/api/v1/curated_marketplaces/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Curated Marketplaces operationId: curated_marketplaces_permissions_get "/api/v1/dashboards/account_summary": get: summary: Account Summary parameters: - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_account_summary_get "/api/v1/dashboards/bidder_accounts": get: summary: Top 10 Bidder Accounts parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string - name: forecast_date_range in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_bidder_accounts_get "/api/v1/dashboards/bidder_accounts_open_market": get: summary: Top 10 Bidder Accounts Open Market Copy parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string - name: forecast_date_range in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_bidder_accounts_open_market_get "/api/v1/dashboards/campaign_performance": get: summary: Campaign Performance parameters: - name: id in: query schema: type: string - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_campaign_performance_get "/api/v1/dashboards/campaigns": get: summary: Top 10 Campaigns parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string - name: forecast_date_range in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_campaigns_get "/api/v1/dashboards/comparative_day_performance": get: summary: Comparative Day Performance parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_comparative_day_performance_get "/api/v1/dashboards/creative_performance": get: summary: Creative Performance parameters: - name: id in: query schema: type: string - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: currency in: query schema: type: string - name: line_items in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_creative_performance_get "/api/v1/dashboards/day_performance": get: summary: Day Performance parameters: - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_day_performance_get "/api/v1/dashboards/deals": get: summary: Top 10 Deals parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string - name: forecast_date_range in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_deals_get "/api/v1/dashboards/demand_deals": get: summary: Top 10 Demand Deals parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string - name: forecast_date_range in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_demand_deals_get "/api/v1/dashboards/demand_partners": get: summary: Top 10 Demand Partners parameters: - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_demand_partners_get "/api/v1/dashboards/demand_tags": get: summary: Top 10 Demand Tags parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string - name: forecast_date_range in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_demand_tags_get "/api/v1/dashboards/external_bidder_performance": get: summary: External Bidder Performance parameters: - name: bidder_account_id in: query schema: type: string - name: id in: query schema: type: string - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: currency in: query schema: type: string - name: ortb_report in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_external_bidder_performance_get "/api/v1/dashboards/five_minute_performance": get: summary: Five Minute Performance parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_five_minute_performance_get "/api/v1/dashboards/hour_performance": get: summary: Hour Performance parameters: - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_hour_performance_get "/api/v1/dashboards/label_performance": get: summary: Label Performance parameters: - name: label_type in: query schema: type: string - name: id in: query schema: type: string - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_label_performance_get "/api/v1/dashboards/magnite_streaming_performance": get: summary: Magnite SpringServe Performance parameters: - name: tag_type in: query schema: type: string - name: supply_tag_id in: query schema: type: string - name: id in: query schema: type: string - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: currency in: query schema: type: string - name: ortb_report in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_magnite_streaming_performance_get "/api/v1/dashboards/minute_performance": get: summary: Minute Performance parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_minute_performance_get "/api/v1/dashboards/open_market_supply_tags": get: summary: Top 10 Open Market Supply Tags parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string - name: forecast_date_range in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_open_market_supply_tags_get "/api/v1/dashboards/partner_performance": get: summary: Partner Performance parameters: - name: partner_type in: query schema: type: string - name: id in: query schema: type: string - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_partner_performance_get "/api/v1/dashboards/publishers": get: summary: Top 10 Publishers parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string - name: forecast_date_range in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_publishers_get "/api/v1/dashboards/quality_report": get: summary: Quality Report parameters: - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_quality_report_get "/api/v1/dashboards/router_performance": get: summary: Router Performance parameters: - name: pod in: query schema: type: string - name: id in: query schema: type: string - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: currency in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_router_performance_get "/api/v1/dashboards/supply_partners": get: summary: Top 10 Supply Partners parameters: - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_supply_partners_get "/api/v1/dashboards/supply_routers": get: summary: Top 10 Supply Routers parameters: - name: date_range in: query schema: type: string - name: forecast_date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_supply_routers_get "/api/v1/dashboards/supply_tags": get: summary: Top 10 Supply Tags parameters: - name: date_range in: query schema: type: string - name: dashboard_type in: query schema: type: string - name: currency in: query schema: type: string - name: metric in: query schema: type: string - name: forecast_date_range in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_supply_tags_get "/api/v1/dashboards/tag_performance": get: summary: Tag Performance parameters: - name: date_range in: query schema: "$ref": "./ref/reports.yaml#/components/schemas/dateRange" - name: forecast_date_range in: query schema: type: string - name: interval in: query required: false schema: type: string enum: - all - minute - fiveMinute - hour - day - comparison default: all - name: tag_type in: query schema: type: string enum: - demand - supply default: demand - name: currency in: query schema: "$ref": "./ref/concerns/currency.yaml#/components/schemas/CurrencyList" required: false - name: id in: query schema: type: string required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Dashboards operationId: dashboards_tag_performance_get "/api/v1/deal_lists/bulk_update": post: summary: Bulk Update requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/deal_list_bulk_update_single" multiple: "$ref": "#/components/examples/deal_list_bulk_update_multiple" required: true responses: '200': description: Bulk update completed content: application/json: schema: type: object properties: message: type: string description: Status message describing the bulk update results examples: - message: 'Successfully updated 2 Deal Lists: 2, 3' tags: - Deal Lists operationId: deal_lists_bulk_update_same_attributes_post "/api/v1/deal_lists/permissions": get: summary: Permissions Collection responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_permissions_get "/api/v1/demand_labels/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Demand Labels operationId: demand_labels_permissions_get "/api/v1/demand_tags/bulk_update": post: summary: Update Multiple Demand Tags description: Update multiple demand tags with the same attributes in a single request. Returns different status codes based on success/failure ratio. requestBody: required: true content: application/json: schema: type: array items: allOf: - type: object required: - object_ids examples: single: "$ref": "#/components/examples/demand_tag_bulk_update_same_single" multiple: "$ref": "#/components/examples/demand_tag_bulk_update_same_multiple" responses: '200': description: Bulk update completed content: application/json: schema: type: object properties: message: type: string description: Status message describing the bulk update results examples: - message: 'Successfully updated 2 Demand Tags: 2, 3' '400': description: Bad request - invalid request body content: application/json: schema: type: object properties: status: type: integer error: type: string examples: - status: 400 error: Bad Request tags: - Demand Tags operationId: demand_tags_bulk_update_same_attributes_post "/api/v1/demand_tags/download": get: summary: Download CSV description: Download a CSV file with demand tag information for the specified demand tag IDs parameters: - name: ids in: query description: Comma-separated list of demand tag IDs, or array of demand tag IDs required: true schema: oneOf: - type: string - type: array items: type: integer - name: filename in: query description: Optional custom filename for the CSV download required: false schema: type: string responses: '200': description: CSV file download content: text/csv: schema: type: string format: binary application/json: schema: type: object '400': description: Bad Request - No demand tag IDs provided content: application/json: schema: type: object '401': description: Unauthorized content: application/json: schema: type: object tags: - Demand Tags operationId: demand_tags_download_get "/api/v1/demand_tags/macro_suggester": post: summary: Suggest VAST endpoint macros description: Returns a macro-filled VAST endpoint URL and resolved ad_server_id for demand tag endpoint settings. Does not create or update a demand tag. requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/MacroSuggesterRequest" examples: simple: "$ref": "#/components/examples/demand_tag_macro_suggester_simple" full: "$ref": "#/components/examples/demand_tag_macro_suggester_full" responses: '200': description: Suggested VAST URL and ad server id content: application/json: schema: "$ref": "#/components/schemas/MacroSuggesterResponse" tags: - Demand Tags operationId: demand_tags_macro_suggester_post "/api/v1/demand_tags/new": get: summary: Get defaults for a new Demand Tag description: Returns the default values for a new Demand Tag. parameters: - name: demand_partner_id in: query required: false schema: type: integer format: int64 description: Optional param to add demand_partner_id on the new Demand Tag defaults. - name: campaign_id in: query required: false schema: type: integer format: int64 description: Optional param to add campaign_id on the new Default Tag defaults. Also populates demand_partner_id from the campaign if demand_partner_id is omitted. - "$ref": ref/params.yaml#/components/parameters/includeParam responses: '200': description: Demand Tag defaults content: application/json: schema: "$ref": "#/components/schemas/DemandTagResponse" tags: - Demand Tags operationId: demand_tags_new_get "/api/v1/demand_tags/permissions": get: summary: Permissions Collection responses: '200': description: '' content: application/json: schema: type: object tags: - Demand Tags operationId: demand_tags_permissions_get "/api/v1/domain_lists/bulk_update": post: summary: Bulk Update requestBody: content: application/json: examples: simple: "$ref": "#/components/examples/domain_list_bulk_update_simple" full: "$ref": "#/components/examples/domain_list_bulk_update_full" schema: type: object required: true responses: '200': description: Bulk update completed content: application/json: schema: type: object properties: message: type: string description: Status message describing the bulk update results tags: - Domain Lists operationId: domain_lists_bulk_update_same_attributes_post "/api/v1/domain_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_permissions_get "/api/v1/geo_lists/bulk_update": post: summary: Bulk Update requestBody: content: application/json: schema: type: object required: - object_ids properties: object_ids: type: array items: type: integer active: type: boolean examples: single: "$ref": "#/components/examples/geo_list_bulk_update_single" multiple: "$ref": "#/components/examples/geo_list_bulk_update_multiple" required: true responses: '200': description: Bulk update completed content: application/json: schema: type: object properties: message: type: string description: Status message describing the bulk update results examples: - message: 'Successfully updated 2 Geo Lists: 2, 3' tags: - Geo Lists operationId: geo_lists_bulk_update_same_attributes_post "/api/v1/geo_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Geo Lists operationId: geo_lists_permissions_get "/api/v1/global_fcap_pixels/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Global Fcap Pixels operationId: global_fcap_pixels_permissions_get "/api/v1/hb_bid_maps/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: "$ref": ref/permissions.yaml#/components/schemas/Permissions tags: - Hb Bid Maps operationId: hb_bid_maps_permissions_get "/api/v1/header_bidding_platforms/restricted": get: summary: List restricted Header Bidding Platforms description: This is not a paginated/filtered list, but rather returns all results responses: '200': description: '' content: application/json: schema: type: object tags: - Header Bidding Platforms operationId: header_bidding_platforms_restricted_get "/api/v1/isp_lists/permissions": get: summary: Collection Permissions tags: - ISP Lists responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_permissions_get "/api/v1/metro_area_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Metro Area Lists operationId: metro_area_lists_permissions_get "/api/v1/notifications/account": get: summary: Get account notifications description: Get notifications for current account of current user responses: '200': description: '' content: application/json: schema: type: object tags: - Notifications operationId: notifications_account_get "/api/v1/notifications/user": get: summary: Get users notification description: Get notifications for current user parameters: - name: include_read in: query required: false schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Notifications operationId: notifications_user_get "/api/v1/partner_segments/bulk_create": post: summary: Bulk Create requestBody: content: application/json: examples: partner_segment_bulk_create_single: "$ref": "#/components/examples/partner_segment_bulk_create_single" partner_segment_bulk_create_multiple: "$ref": "#/components/examples/partner_segment_bulk_create_multiple" schema: type: object required: true responses: '200': description: '' content: application/json: example: created: 1 updated: 0 errors: 0 error_messages: [] already_created: 0 schema: type: array items: oneOf: - "$ref": "#/components/schemas/PartnerSegment" tags: - Partner Segments operationId: partner_segments_bulk_create_post "/api/v1/partner_segments/bulk_delete": delete: summary: Bulk Delete requestBody: content: application/json: example: partner_segment_ids: - 1 - 7 schema: type: object required: false responses: '200': description: '' content: application/json: schema: type: object tags: - Partner Segments operationId: partner_segments_bulk_delete_delete "/api/v1/partner_segments/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Partner Segments operationId: partner_segments_permissions_get "/api/v1/partner_segments/targeted": get: summary: Get paginated list of active targeted partner segments for the active account description: Returns partner segments targeted by any of the listed object types parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: targeter_type in: query description: Type of targeting object. Must be provided together with `targeter_id`. required: false schema: type: string enum: - DemandTag - SupplyTag - Campaign - DemandPartner - name: targeter_id in: query description: ID of the targeting object. Must be provided together with `targeter_type`. required: false schema: type: integer - name: id in: query description: Equality filter on partner segment id. required: false schema: type: integer - name: code in: query description: Equality filter on partner segment code required: false schema: type: string - name: description in: query description: Equality filter on partner segment description required: false schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Partner Segments operationId: partner_segments_targeted_get "/api/v1/permissions/apps": get: summary: List component permissions description: 'List permissions for SpringServe components: supply, demand, targeting etc.' responses: '200': description: '' content: application/json: schema: type: object tags: - Permissions operationId: permissions_apps_get "/api/v1/postal_code_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Postal Code Lists operationId: postal_code_lists_permissions_get "/api/v1/reports/templates": get: tags: - Report Templates summary: Index parameters: - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': description: '' content: application/json: schema: type: object operationId: reports_templates_get post: tags: - Report Templates summary: Create requestBody: content: application/json: schema: "$ref": "#/components/schemas/reportTemplate" examples: report_template_create_simple: "$ref": "#/components/examples/report_template_create_simple" report_template_create_full: "$ref": "#/components/examples/report_template_create_full" required: true responses: '201': "$ref": "#/components/responses/reportTemplate" '422': description: '' content: application/json: schema: anyOf: - "$ref": "#/components/schemas/reportParameterError" - "$ref": ref/errors.yaml#/components/schemas/validationError operationId: reports_templates_post "/api/v1/run_as/available_users": get: summary: Available Users for Run As. Run in the context of the true user description: Lists the users that the current user can run as parameters: - name: search in: query description: Search term to filter users by email required: false schema: type: string responses: '200': description: '' content: application/json: example: - id: 1 email: user1@example.com name: User One - id: 2 email: user2@example.com name: User Two schema: type: object tags: - Run As operationId: run_as_available_users_get "/api/v1/run_as/permission": get: summary: Can Run As User. Run in the context of the true user. description: Check if the current user can run as another user responses: '200': description: '' content: application/json: example: can_run_as: true schema: type: object tags: - Run As operationId: run_as_permission_get "/api/v1/run_as/start": post: summary: Run As User. Run in the context of the true user. requestBody: content: application/json: schema: type: object required: - email properties: email: type: string format: email examples: internal_user: "$ref": "#/components/examples/run_as_start_internal_user" external_user: "$ref": "#/components/examples/run_as_start_external_user" required: true responses: '200': description: Successfully started a run as session content: application/json: example: message: Running As user Other User 1 (1234) schema: type: object '404': description: Requested user not found content: application/json: example: error: Object not found '403': description: Not authorized to run as this user content: application/json: example: error: You are not authorized to access this page. tags: - Run As operationId: run_as_start_post "/api/v1/run_as/stop": post: summary: Stop Running As User responses: '200': description: Successfully stopped a run as session content: application/json: example: message: Stopped Running as otherUser@magnite.com (1234) schema: type: object tags: - Run As operationId: run_as_stop_post "/api/v1/scanned_creative_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_permissions_get "/api/v1/scheduled_reports/bulk_update": put: summary: Bulk Update requestBody: content: application/json: examples: single: "$ref": "#/components/examples/scheduled_report_bulk_update_single" multiple: "$ref": "#/components/examples/scheduled_report_bulk_update_multiple" schema: type: object required: true responses: '200': description: Bulk update completed content: application/json: schema: type: object properties: message: type: string description: Status message describing the bulk update results examples: - message: 'Successfully updated 1 Scheduled Report: 1' tags: - Scheduled Reports operationId: scheduled_reports_bulk_update_same_attributes_put "/api/v1/search/account_managers": get: summary: Search for account managers parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - name: partner_type in: query description: filter by supply or demand partner account managers schema: type: string enum: - supply - demand responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/V1SearchResponse" tags: - Search operationId: search_account_managers_get "/api/v1/search/ad_servers": get: summary: Search for ad servers description: Typeahead for VAST ad servers. Database rows include id for macro suggester; SpringServe, Other, and header-bidding platforms return id null. parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" responses: '200': description: Matching ad server options content: application/json: schema: type: array items: "$ref": "#/components/schemas/AdServerSearchResult" tags: - Search operationId: search_ad_servers_get "/api/v1/search/campaigns": get: summary: Search for demand tags parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - "$ref": "#/components/parameters/is_active" - name: demand_partner_id in: query schema: type: number - name: exclude_open_market in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" - type: object properties: type: type: string is_active: type: boolean direct_connection: type: string tags: - Search operationId: search_campaigns_get "/api/v1/search/deal_lists": get: summary: Search for supply partners parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - "$ref": "#/components/parameters/is_active" - name: exclude_empty_list in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" - type: object properties: type: type: string is_active: type: boolean tags: - Search operationId: search_deal_lists_get "/api/v1/search/demand_partners": get: summary: Search for demand partners parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - "$ref": "#/components/parameters/is_active" - name: supply_tag_id in: query description: filter by Demand Partners associated with Demand Tags that are in Demand Tag Priorities for the specified Supply Tag schema: type: number - name: managed in: query description: filter by Managed (i.e. not Direct Connect) Demand Partners schema: type: boolean - name: direct_connect in: query description: filter by Direct Connect Demand Partners schema: type: boolean - name: exclude_open_market in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" - type: object properties: type: type: string is_active: type: string tags: - Search operationId: search_demand_partners_get "/api/v1/search/demand_tags": get: summary: Search for demand tags parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - "$ref": "#/components/parameters/is_active" - name: format in: query schema: type: string enum: - audio - tile - video - name: exclude_open_market in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" - type: object properties: type: type: string is_active: type: boolean direct_connection: type: string tags: - Search operationId: search_demand_tags_get "/api/v1/search/displayable_accounts": get: summary: Search for displayable accounts parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - "$ref": "#/components/parameters/is_active" - name: platform_type in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" - type: object properties: type: type: string is_active: type: boolean tags: - Search operationId: search_displayable_accounts_get "/api/v1/search/iab_category": get: summary: Search for iab categories parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - name: tier in: query schema: type: number enum: - 1 - 2 responses: '200': description: '' content: application/json: schema: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" - type: object properties: type: type: string value: type: string tags: - Search operationId: search_iab_category_get "/api/v1/search/key_keys": get: summary: Search for Keys parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - name: definition_type in: query schema: type: string enum: - free - predefined responses: '200': description: '' content: application/json: schema: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" - type: object properties: type: type: string value: type: string definition_type: type: string tags: - Search operationId: search_key_keys_get "/api/v1/search/supply_partners": get: summary: Search for supply partners parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - "$ref": "#/components/parameters/is_active" - name: direct_io_publishers_only in: query schema: type: boolean - name: managed in: query description: filter by Managed (i.e. not Direct Connect) Supply Partners schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" - type: object properties: type: type: string tags: - Search operationId: search_supply_partners_get "/api/v1/search/supply_tags": get: summary: Search for supply tags parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - "$ref": "#/components/parameters/is_active" - name: format in: query schema: type: string enum: - audio - tile - video - name: waterfall_management in: query schema: type: string enum: - campaign - campaign_side - demand_tag responses: '200': description: '' content: application/json: schema: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" - type: object properties: type: type: string is_active: type: boolean custom_data: type: object properties: slot_orders: type: array items: type: string slot_numbers: type: array nullable: true tags: - Search operationId: search_supply_tags_get "/api/v1/search/user_accounts": get: summary: Search for user accounts parameters: - "$ref": "#/components/parameters/q" - "$ref": "#/components/parameters/limit" - "$ref": "#/components/parameters/with_deleted" - name: is_demand_forecast_creator in: query description: filter by User Accounts that are associated with Demand Forecasts schema: type: boolean - name: is_clearline_forecast_creator in: query description: filter by User Accounts that are associated with Clearline Forecasts schema: type: boolean - name: is_csv_report_creator in: query description: filter by User Accounts that are associated with CSV Reports schema: type: boolean - name: is_scheduled_report_creator in: query description: filter by User Accounts that are associated with Scheduled Reports schema: type: boolean - name: is_report_template_creator in: query description: filter by User Accounts that are associated with Report Templates schema: type: boolean responses: '200': description: '' content: application/json: schema: "$ref": "#/components/schemas/V1SearchResponse" tags: - Search operationId: search_user_accounts_get "/api/v1/state_lists/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - State Lists operationId: state_lists_permissions_get "/api/v1/supply_labels/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Supply Labels operationId: supply_labels_permissions_get "/api/v1/supply_name_lists/permissions": get: summary: Collection Permissions tags: - Supply Name Lists responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_permissions_get "/api/v1/supply_routers/download": get: summary: Download CSV description: Download a CSV file with supply router information for the specified router IDs parameters: - name: ids in: query description: Comma-separated list of router IDs, or array of router IDs required: true schema: oneOf: - type: string - type: array items: type: integer - name: filename in: query description: Optional custom filename for the CSV download required: false schema: type: string responses: '200': description: CSV file download content: text/csv: schema: type: string format: binary application/json: schema: type: object '400': description: Bad Request - No router IDs provided content: application/json: schema: type: object '401': description: Unauthorized content: application/json: schema: type: object tags: - Supply Routers operationId: supply_routers_download_get "/api/v1/supply_tags/download": get: summary: Download CSV description: Download a CSV file with supply tag information for the specified supply tag IDs parameters: - name: ids in: query description: Comma-separated list of supply tag IDs, or array of supply tag IDs required: true schema: oneOf: - type: string - type: array items: type: integer - name: filename in: query description: Optional custom filename for the CSV download required: false schema: type: string responses: '200': description: CSV file download content: text/csv: schema: type: string format: binary application/json: schema: type: object '400': description: Bad Request - No supply tag IDs provided content: application/json: schema: type: object '401': description: Unauthorized content: application/json: schema: type: object tags: - Supply Tags operationId: supply_tags_download_get "/api/v1/supply_tags/permissions": get: summary: Collection Permissions responses: '200': description: '' content: application/json: schema: type: object tags: - Supply Tags operationId: supply_tags_permissions_get "/api/v1/system_settings/permissions": get: summary: Permissions Collection responses: '200': description: '' content: application/json: schema: "$ref": ref/permissions.yaml#/components/schemas/Permissions tags: - System Settings operationId: system_settings_permissions_get "/api/v1/user_accounts/bulk_update": post: summary: Bulk Update one or more attributes requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/user_account_bulk_update_single" multiple: "$ref": "#/components/examples/user_account_bulk_update_multiple" required: true responses: '200': description: Bulk update completed content: application/json: schema: type: object properties: message: type: string description: Status message describing the bulk update results examples: - message: 'Successfully updated 2 User Accounts: 16, 17' tags: - User Accounts operationId: user_accounts_bulk_update_same_attributes_post "/api/v1/user_accounts/meta": get: summary: Meta responses: '200': description: '' content: application/json: schema: type: object tags: - User Accounts operationId: user_accounts_meta_get "/api/v1/user_accounts/permissions": get: summary: Permissions Collection responses: '200': description: '' content: application/json: schema: type: object tags: - User Accounts operationId: user_accounts_permissions_get "/api/v1/users/account_managers": get: summary: Account Managers description: Get the list of users that can be account managers, which is the query `all_accounts_access=true or super_admin=true` responses: '200': description: '' content: application/json: schema: type: object tags: - Users operationId: users_account_managers_get "/api/v1/users/current": get: summary: Current user description: Get information on current user responses: '200': description: '' content: application/json: schema: type: object tags: - Users operationId: users_current_get patch: summary: Update current user description: Update current user requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/user_update_current_simple" full: "$ref": "#/components/examples/user_update_current_full" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Users operationId: users_current_patch "/api/v1/users/permissions": get: summary: Permissions Collection responses: '200': description: '' content: application/json: schema: type: object tags: - Users operationId: users_permissions_get "/api/v1/accounts/{account_id}/white_label": get: tags: - White Labels summary: Show for Account parameters: - name: account_id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object operationId: accounts_account_id_white_label_get "/api/v1/accounts/{id}/bulk_connect_curators": post: summary: Bulk DC Accounts (Curator) parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: connect_one: "$ref": "#/components/examples/account_bulk_connect_curators_one" connect_many: "$ref": "#/components/examples/account_bulk_connect_curators_many" schema: type: object required: false responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_bulk_connect_curators_post "/api/v1/accounts/{id}/bulk_connect_dsps": post: summary: Bulk DC Accounts (DSP) parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: connect_one: "$ref": "#/components/examples/account_bulk_connect_dsps_one" connect_many: "$ref": "#/components/examples/account_bulk_connect_dsps_many" schema: type: object required: false responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_bulk_connect_dsps_post "/api/v1/accounts/{id}/bulk_set_dc_visibility": post: summary: Bulk DC Accounts parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: single: "$ref": "#/components/examples/account_bulk_set_dc_visibility_one" multiple: "$ref": "#/components/examples/account_bulk_set_dc_visibility_many" schema: type: object required: false responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_bulk_set_dc_visibility_post "/api/v1/accounts/{id}/curator_dc_accounts": get: summary: DC Accounts (Curator) parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_curator_dc_accounts_get "/api/v1/accounts/{id}/dc_accounts": get: summary: DC Accounts parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_dc_accounts_get "/api/v1/accounts/{id}/dsp_dc_accounts": get: summary: DC Accounts (DSP) parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_dsp_dc_accounts_get "/api/v1/accounts/{id}/salesforce_sync": get: summary: Salesforce Sync parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_salesforce_sync_get "/api/v1/accounts/{id}/set_current": post: summary: Set Current description: Set the active account for the authenticated user to the specified account id parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_set_current_post "/api/v1/accounts/{id}/used_partner_segment_vendors": get: summary: Used Partner Segment Vendors parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_used_partner_segment_vendors_get "/api/v1/app_bundle_lists/{id}/app_bundles": get: summary: Get the App Bundles in an App Bundle List parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_app_bundles_get "/api/v1/app_bundle_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_permissions_get "/api/v1/app_name_lists/{id}/app_names": get: summary: Get all App Names in the list parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_app_names_get "/api/v1/app_name_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_permissions_get "/api/v1/bills/{id}/permissions": get: summary: Permissions Member tags: - Bills parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object operationId: bills_id_permissions_get "/api/v1/city_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - City Lists operationId: city_lists_id_permissions_get "/api/v1/country_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Country Lists operationId: country_lists_id_permissions_get "/api/v1/curated_marketplaces/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Curated Marketplaces operationId: curated_marketplaces_id_permissions_get "/api/v1/deal_lists/{deal_list_id}/deals": get: summary: Deals parameters: - name: deal_list_id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_deal_list_id_deals_get "/api/v1/deal_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_id_permissions_get "/api/v1/demand_labels/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Demand Labels operationId: demand_labels_id_permissions_get "/api/v1/demand_tags/{id}/creatives_summary": get: summary: Creatives Summary description: "Get reporting data for a campaign with comparison metrics. Returns raw numeric values with percentage changes \nfor all metrics. When forecast_date_range is provided, also returns forecast_summary\nand combined_summary.\n" parameters: - name: id in: path required: true schema: type: string description: Demand Tag ID - "$ref": ref/params.yaml#/components/parameters/quickstatsDateRangeParam - "$ref": ref/params.yaml#/components/parameters/quickstatsForecastDateRangeParam - "$ref": ref/params.yaml#/components/parameters/quickstatsCurrencyParam responses: '200': "$ref": ref/quickstats.yaml#/components/responses/QuickstatsSummaryResponse tags: - Demand Tags operationId: demand_tags_id_creatives_summary_get "/api/v1/demand_tags/{id}/duplicate": get: summary: Duplicate Demand Tag description: Returns the default values for a new Demand Tag, copied from an existing Demand Tag parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam responses: '200': description: Demand Tag defaults, copied from an existing Demand Tag content: application/json: schema: "$ref": "#/components/schemas/DemandTagResponse" '404': "$ref": ref/errors.yaml#/components/responses/notFoundError tags: - Demand Tags operationId: demand_tags_id_duplicate_get "/api/v1/demand_tags/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Demand Tags operationId: demand_tags_id_permissions_get "/api/v1/domain_lists/{id}/domains": get: summary: Domains parameters: - name: id in: path required: true schema: type: string - name: preview in: query description: If true, returns only a truncated preview of the domains (first ~80KB read from storage) instead of the full list schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_domains_get "/api/v1/domain_lists/{id}/duplicate": parameters: - name: id in: path required: true schema: type: string get: summary: Duplicate Domain List description: Returns a non-persisted preview of a duplicate of the domain list. responses: '200': description: Domain List defaults, copied from an existing Domain List content: application/json: schema: type: object properties: name: type: string description: type: string is_active: type: boolean demand_partner_permission_ids: type: array items: type: integer '404': "$ref": ref/errors.yaml#/components/responses/notFoundError tags: - Domain Lists operationId: domain_lists_id_duplicate_get post: summary: Create Domain List Duplicate description: 'Persists a new domain list from the submitted basic info and copies the original''s domains into the new list. When demand partner expansion is enabled, demand_partner_permission_ids is required. ' requestBody: content: application/json: schema: "$ref": "#/components/schemas/DomainListDuplicateRequest" examples: enabled_demand_partners_expansion: "$ref": "#/components/examples/domain_list_duplicate_enabled_demand_partners_expansion" disabled_demand_partners_expansion: "$ref": "#/components/examples/domain_list_duplicate_disabled_demand_partners_expansion" another_account: "$ref": "#/components/examples/domain_list_duplicate_another_account" required: true responses: '201': description: '' content: application/json: schema: type: object '404': "$ref": ref/errors.yaml#/components/responses/notFoundError '422': description: Validation error content: application/json: schema: type: object properties: error: type: string tags: - Domain Lists operationId: domain_lists_id_duplicate_post "/api/v1/domain_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_permissions_get "/api/v1/domain_lists/{id}/{resource_type}": get: summary: Get added targeting resources for list association description: Returns targeting resources (Supply Partners, Demand Partners, Campaigns, etc.) that are associated with a specific domain list. parameters: - name: id in: path required: true description: ID of the domain list schema: type: integer - name: resource_type in: path required: true description: Type of targeting resource to fetch schema: "$ref": ref/types.yaml#/components/schemas/ResourceType - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': "$ref": ref/concerns/targeting_resources.yaml#/components/responses/AvailableResourcesResponse tags: - Domain Lists operationId: domain_lists_id_resource_type_get post: summary: Add domain list targeting for resources description: | Associates resources identified by `object_ids` with the specified domain list. All resources in the request must use the same `is_allowlist` mode. Resources with existing list associations must already use a compatible allowlist mode. parameters: - name: id in: path required: true description: ID of the domain list schema: type: integer - name: resource_type in: path required: true description: Type of targeting resource to add to the list schema: "$ref": ref/types.yaml#/components/schemas/ResourceType requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/TargetingResourceBatchUpdateRequest" examples: single: "$ref": "#/components/examples/domain_list_resource_add_single" multiple: "$ref": "#/components/examples/domain_list_resource_add_multiple" responses: '200': "$ref": "#/components/responses/TargetingResourceBatchResponse" tags: - Domain Lists operationId: domain_lists_id_resource_type_post "/api/v1/geo_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Geo Lists operationId: geo_lists_id_permissions_get "/api/v1/global_fcap_pixels/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Global Fcap Pixels operationId: global_fcap_pixels_id_permissions_get "/api/v1/hb_bid_maps/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: "$ref": ref/permissions.yaml#/components/schemas/PermissionsWithoutCreate tags: - Hb Bid Maps operationId: hb_bid_maps_id_permissions_get "/api/v1/isp_lists/{id}/isp_names": get: tags: - ISP Lists summary: ISP Names parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_isp_names_get "/api/v1/isp_lists/{id}/permissions": get: summary: Permissions Member tags: - ISP Lists parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_permissions_get "/api/v1/metro_area_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Metro Area Lists operationId: metro_area_lists_id_permissions_get "/api/v1/partner_segments/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Partner Segments operationId: partner_segments_id_permissions_get "/api/v1/postal_code_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Postal Code Lists operationId: postal_code_lists_id_permissions_get "/api/v1/scanned_creative_lists/{id}/creatives": get: summary: Creatives parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_creatives_get "/api/v1/scanned_creative_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_permissions_get "/api/v1/showcases/{showcase_id}/packages": parameters: - name: showcase_id in: path required: true schema: type: integer "/api/v1/state_lists/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - State Lists operationId: state_lists_id_permissions_get "/api/v1/supply_labels/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Supply Labels operationId: supply_labels_id_permissions_get "/api/v1/supply_name_lists/{id}/permissions": get: summary: Permissions Member tags: - Supply Name Lists parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_permissions_get "/api/v1/supply_name_lists/{id}/supply_names": get: tags: - Supply Name Lists summary: Supply Names parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_supply_names_get "/api/v1/supply_tags/{id}/demand_tag_priorities": get: summary: Demand Tag Priorities parameters: - name: id in: path required: true schema: type: string - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - name: curator_fees.curator_fee_publishers.inventory_source in: query description: Filter for records that have the specified inventory_source on a curator_fees.curator_fee_publishers association schema: type: string - name: curator_fees.curator_fee_publishers.publisher in: query description: Filter for records that have the specified publisher on a curator_fees.curator_fee_publishers association schema: type: string - name: curator_fees.curator_fee_publishers.ad_source_ids in: query schema: type: array items: type: number - name: marketplace_buyers.inventory_source in: query description: Filter for records that have the specified inventory_source on a marketplace_buyers association schema: type: string - name: marketplace_buyers.dsp_id in: query description: Filter for records that have the specified dsp_id on a marketplace_buyers association schema: type: string - name: marketplace_buyers.buyer_id in: query description: Filter for records that have the specified buyer_id on a marketplace_buyers association schema: type: string - "$ref": ref/params.yaml#/components/parameters/includeParam - "$ref": ref/params.yaml#/components/parameters/additionalDataQuickStatsParam responses: '200': description: '' content: application/json: schema: type: object tags: - Supply Tags operationId: supply_tags_id_demand_tag_priorities_get "/api/v1/supply_tags/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Supply Tags operationId: supply_tags_id_permissions_get "/api/v1/system_settings/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: "$ref": ref/permissions.yaml#/components/schemas/Permissions tags: - System Settings operationId: system_settings_id_permissions_get "/api/v1/user_accounts/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - User Accounts operationId: user_accounts_id_permissions_get "/api/v1/users/{id}/permissions": get: summary: Permissions Member parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Users operationId: users_id_permissions_get "/api/v1/accounts/bulk/update": post: summary: Update Multiple Accounts description: Update multiple accounts in a single request. Returns different status codes based on success/failure ratio. requestBody: required: true content: application/json: schema: type: array items: allOf: - type: object required: - id examples: single: "$ref": "#/components/examples/account_bulk_update_single" multiple: "$ref": "#/components/examples/account_bulk_update_multiple" responses: '204': description: All updates successful '200': description: Partial success - some objects updated successfully, others failed content: application/json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string examples: - errors: '1': - Name cannot be blank other: - Object at index 2 is missing an ID '400': description: Bad request - no objects provided content: application/json: schema: type: object properties: error: type: string examples: - error: No objects provided '422': description: All updates failed - no objects were updated successfully content: application/json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string examples: - errors: '1': - Name cannot be blank '2': - Rate must be greater than 0 other: - Object at index 3 is missing an ID tags: - Accounts operationId: accounts_bulk_update_many_post "/api/v1/auth0/users/{email}": get: summary: Retrieve basic info about a user by email address description: 'If a user can be found with the provided email address, return the platform_type and role from their active user_account. Note: only SpringServe token based authentication works with this endpoint - you cannot use cookie based auth' tags: - Auth parameters: - name: email in: path required: true schema: type: string examples: - user@magnite.com responses: '200': description: successful content: application/json: schema: type: object '400': description: bad request - invalid credentials content: application/json: schema: type: object operationId: auth0_users_email_get "/api/v1/changelogs/versioned_type/{versioned_type}": get: summary: Get By Type parameters: - name: versioned_type in: path required: true schema: type: string - name: page in: query schema: type: number - name: per in: query schema: type: number - name: search in: query description: Searches by version change id and summary schema: type: string - name: time in: query schema: "$ref": "#/components/schemas/ChangelogsTimeFilter" - name: user in: query description: all/exclude_system_updates/each_user schema: type: string - name: change_type in: query description: created/updated/deleted schema: type: string - name: sort in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Changelogs operationId: changelogs_versioned_type_versioned_type_get "/api/v1/creatives/bulk/update": post: summary: Update Multiple Creatives description: Update multiple creatives independently in a single request. Returns different status codes based on success/failure ratio. requestBody: required: true content: application/json: schema: type: array items: allOf: - type: object required: - id examples: single: "$ref": "#/components/examples/creative_bulk_update_many_single" multiple: "$ref": "#/components/examples/creative_bulk_update_many_multiple" responses: '204': description: All updates successful '200': description: Partial success - some objects updated successfully, others failed content: application/json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string examples: - errors: '1': - Name cannot be blank other: - Object at index 2 is missing an ID '400': description: Bad request - no objects provided content: application/json: schema: type: object properties: error: type: string examples: - error: No objects provided '422': description: All updates failed - no objects were updated successfully content: application/json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string examples: - errors: '1': - Name cannot be blank '2': - Active must be true or false other: - Object at index 3 is missing an ID tags: - Creatives operationId: creatives_bulk_update_many_post "/api/v1/demand_tags/bulk/update": post: summary: Update Multiple Demand Tags description: Update multiple demand tags independently in a single request. Returns different status codes based on success/failure ratio. requestBody: required: true content: application/json: schema: type: array items: allOf: - type: object required: - id examples: single: "$ref": "#/components/examples/demand_tag_bulk_update_many_single" multiple: "$ref": "#/components/examples/demand_tag_bulk_update_many_multiple" responses: '204': description: All updates successful '200': description: Partial success - some objects updated successfully, others failed content: application/json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string examples: - errors: '1': - Name cannot be blank other: - Object at index 2 is missing an ID '400': description: Bad request - no objects provided content: application/json: schema: type: object properties: error: type: string examples: - error: No objects provided '422': description: All updates failed - no objects were updated successfully content: application/json: schema: type: object properties: errors: type: object additionalProperties: type: array items: type: string examples: - errors: '1': - Name cannot be blank '2': - Rate must be greater than 0 other: - Object at index 3 is missing an ID tags: - Demand Tags operationId: demand_tags_bulk_update_many_post "/api/v1/demand_tags/new_from_forecast/{id}": get: summary: New From Demand Forecast parameters: - name: id in: path required: true schema: type: string - name: include in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Demand Tags operationId: demand_tags_new_from_forecast_id_get "/api/v1/magnite_programmatic/contentMetadata/search": get: summary: Search content-targeting values from Magnite SpringServe description: Returns content-targeting picklist values from Magnite SpringServe parameters: - name: search in: query required: false schema: type: string description: Search query forwarded to the Magnite SpringServe API - name: field in: query required: true schema: type: string enum: - videoId - videoTitle - seriesName - season - episode - contentLength - contentCategoriesSet - contentRating - genre - producer - contentNetwork - contentChannel description: Target field to extract from Magnite Streaming results responses: '200': description: successful content: application/json: schema: type: array items: type: object properties: value: type: string example: Sports text: type: string example: Sports required: - value - text '400': description: bad request content: application/json: examples: missing_seats: summary: No Magnite SpringServe seats configured for account value: error: No valid Magnite SpringServe seats for account 123 missing_field: summary: Missing field parameter value: error: Field param is required invalid_field: summary: Unsupported field parameter value: error: 'Field param is invalid. Allowed values: videoId, videoTitle, seriesName, season, episode, contentLength, contentCategoriesSet, contentRating, genre, producer, contentNetwork, contentChannel' schema: type: object properties: error: type: string tags: - Magnite Programmatic operationId: magnite_programmatic_contentMetadata_search_get "/api/v1/notifications/user/mark-read": put: summary: Mark all user notifications as read description: Mark all user notifications as read responses: '200': description: '' content: application/json: schema: type: object tags: - Notifications operationId: notifications_user_mark-read_put "/api/v1/notifications/user/mark-unread": put: summary: Mark all user notifications as unread description: Mark all user notifications as unread responses: '200': description: '' content: application/json: schema: type: object tags: - Notifications operationId: notifications_user_mark-unread_put "/api/v1/notifications/user/{id}": get: summary: Get user notification by ID description: Get notification by notification ID parameters: - name: id in: path required: true schema: type: number responses: '200': description: '' content: application/json: schema: type: object tags: - Notifications operationId: notifications_user_id_get "/api/v1/reports/download/{id}": get: summary: Download parameters: - name: id in: path required: true schema: type: string - name: zipped in: query schema: type: string responses: '200': description: Download content: application/json: schema: type: object tags: - Reports operationId: reports_download_id_get "/api/v1/reports/templates/{id}": get: tags: - Report Templates parameters: - in: path name: id required: true schema: type: integer summary: Show responses: '200': "$ref": "#/components/responses/reportTemplate" '404': "$ref": ref/errors.yaml#/components/responses/notFoundError '500': "$ref": "#/components/responses/reportSerializationError" operationId: reports_templates_id_get patch: tags: - Report Templates summary: Update description: | NOTE: This operation will overwrite and/or delete already existing parameters in the report template. Make sure that everything that should be in the report template is specified in the request body. parameters: - in: path name: id required: true schema: type: integer requestBody: content: application/json: schema: "$ref": "#/components/schemas/reportTemplate" examples: report_template_update_simple: "$ref": "#/components/examples/report_template_update_simple" report_template_update_full: "$ref": "#/components/examples/report_template_update_full" required: true responses: '200': "$ref": "#/components/responses/reportTemplate" '400': "$ref": "#/components/responses/reportParameterError" '404': "$ref": ref/errors.yaml#/components/responses/notFoundError '422': "$ref": ref/errors.yaml#/components/responses/validationError '500': "$ref": "#/components/responses/reportSerializationError" operationId: reports_templates_id_patch delete: tags: - Report Templates summary: Delete parameters: - in: path name: id required: true schema: type: integer responses: '204': description: No content '404': "$ref": ref/errors.yaml#/components/responses/notFoundError operationId: reports_templates_id_delete "/api/v1/app_bundle_lists/{id}/app_bundles/bulk_create": post: summary: Add App Bundles parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: single: "$ref": "#/components/examples/app_bundle_list_bundles_bulk_single" multiple: "$ref": "#/components/examples/app_bundle_list_bundles_bulk_multiple" schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_app_bundles_bulk_create_post "/api/v1/app_bundle_lists/{id}/app_bundles/bulk_delete": delete: summary: Delete App Bundles parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: example: app_bundles: - apple schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_app_bundles_bulk_delete_delete "/api/v1/app_bundle_lists/{id}/app_bundles/bulk_replace": post: summary: Replace App Bundles parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: single: "$ref": "#/components/examples/app_bundle_list_bundles_bulk_single" multiple: "$ref": "#/components/examples/app_bundle_list_bundles_bulk_multiple" schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_app_bundles_bulk_replace_post "/api/v1/app_bundle_lists/{id}/app_bundles/file_bulk_create": post: summary: Add App Bundles (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_app_bundles_file_bulk_create_post "/api/v1/app_bundle_lists/{id}/app_bundles/file_bulk_delete": delete: summary: Delete App Bundles (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_app_bundles_file_bulk_delete_delete "/api/v1/app_bundle_lists/{id}/app_bundles/file_bulk_replace": post: summary: Replace App Bundles (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - App Bundle Lists operationId: app_bundle_lists_id_app_bundles_file_bulk_replace_post "/api/v1/app_name_lists/{id}/app_names/bulk_create": post: summary: Add App Names parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: single: "$ref": "#/components/examples/app_name_list_names_bulk_single" multiple: "$ref": "#/components/examples/app_name_list_names_bulk_multiple" schema: type: object required: false responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_app_names_bulk_create_post "/api/v1/app_name_lists/{id}/app_names/bulk_delete": delete: summary: Delete App Names parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: example: app_names: - app_name_1 - app_name_2 items: app_name_1 schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_app_names_bulk_delete_delete "/api/v1/app_name_lists/{id}/app_names/bulk_replace": post: summary: Replace App Names parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: single: "$ref": "#/components/examples/app_name_list_names_bulk_single" multiple: "$ref": "#/components/examples/app_name_list_names_bulk_multiple" schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_app_names_bulk_replace_post "/api/v1/app_name_lists/{id}/app_names/file_bulk_create": post: summary: Add App Names (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_app_names_file_bulk_create_post "/api/v1/app_name_lists/{id}/app_names/file_bulk_delete": delete: summary: Delete App Names (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_app_names_file_bulk_delete_delete "/api/v1/app_name_lists/{id}/app_names/file_bulk_replace": post: summary: Replace App Names (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - App Name Lists operationId: app_name_lists_id_app_names_file_bulk_replace_post "/api/v1/deal_lists/{deal_list_id}/deals/bulk_create": post: summary: Add Deals parameters: - name: deal_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/deal_list_deals_bulk_create_single" multiple: "$ref": "#/components/examples/deal_list_deals_bulk_create_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_deal_list_id_deals_bulk_create_post "/api/v1/deal_lists/{deal_list_id}/deals/bulk_delete": delete: summary: Delete Deals parameters: - name: deal_list_id in: path required: true schema: type: string requestBody: content: application/json: example: deals: - 1 - 2 schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_deal_list_id_deals_bulk_delete_delete "/api/v1/deal_lists/{deal_list_id}/deals/bulk_replace": post: summary: Replace Deals parameters: - name: deal_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/deal_list_deals_bulk_replace_single" multiple: "$ref": "#/components/examples/deal_list_deals_bulk_replace_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Lists operationId: deal_lists_deal_list_id_deals_bulk_replace_post "/api/v1/domain_lists/{id}/domains/bulk_create": post: summary: Bulk Create Domains parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: single: "$ref": "#/components/examples/domain_list_domains_bulk_create_single" multiple: "$ref": "#/components/examples/domain_list_domains_bulk_create_multiple" schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_domains_bulk_create_post "/api/v1/domain_lists/{id}/domains/bulk_delete": delete: summary: Bulk Delete Domains parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: example: domains: - ciao.com - aloha.com schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_domains_bulk_delete_delete "/api/v1/domain_lists/{id}/domains/bulk_replace": post: summary: Bulk Replace Domains parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: examples: single: "$ref": "#/components/examples/domain_list_domains_bulk_replace_single" multiple: "$ref": "#/components/examples/domain_list_domains_bulk_replace_multiple" schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_domains_bulk_replace_post "/api/v1/domain_lists/{id}/domains/file_bulk_create": post: summary: File Bulk Create Domains parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: account_id: type: string csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_domains_file_bulk_create_post "/api/v1/domain_lists/{id}/domains/file_bulk_delete": delete: summary: File Bulk Delete Domains parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: account_id: type: string csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_domains_file_bulk_delete_delete "/api/v1/domain_lists/{id}/domains/file_bulk_replace": post: summary: File Bulk Replace Domains parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: account_id: type: string csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - Domain Lists operationId: domain_lists_id_domains_file_bulk_replace_post "/api/v1/domain_lists/{id}/{resource_type}/available": get: summary: Available Resources description: Returns resources available for targeting with this domain list. Filter is_allowlist defaults to false. parameters: - name: id in: path required: true schema: type: string - name: resource_type in: path required: true description: Type of resource to retrieve schema: "$ref": ref/types.yaml#/components/schemas/ResourceType - "$ref": ref/params.yaml#/components/parameters/pageParam - "$ref": ref/params.yaml#/components/parameters/perParam - "$ref": ref/params.yaml#/components/parameters/sortParam - "$ref": ref/params.yaml#/components/parameters/searchParam - "$ref": ref/params.yaml#/components/parameters/filterParams - "$ref": ref/params.yaml#/components/parameters/idsParam responses: '200': "$ref": ref/concerns/targeting_resources.yaml#/components/responses/AvailableResourcesResponse tags: - Domain Lists operationId: domain_lists_id_resource_type_available_get "/api/v1/domain_lists/{id}/{resource_type}/bulk_delete": post: summary: Bulk delete targeted resources from list description: | Removes resources identified by `object_ids` from the specified list. Does not delete the resources themselves, only their association with the list. Removing a resource that is not on the list is treated as success. parameters: - name: id in: path required: true description: ID of the domain list schema: type: integer - name: resource_type in: path required: true description: Type of targeting resource to remove from the list schema: "$ref": ref/types.yaml#/components/schemas/ResourceType requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/TargetingResourceBatchRequest" examples: single: "$ref": "#/components/examples/domain_list_resource_bulk_delete_single" multiple: "$ref": "#/components/examples/domain_list_resource_bulk_delete_multiple" responses: '200': "$ref": "#/components/responses/TargetingResourceBatchResponse" tags: - Domain Lists operationId: domain_lists_id_resource_type_bulk_delete_post "/api/v1/domain_lists/{id}/{resource_type}/bulk_update": post: summary: Bulk update targeted resources description: | Updates allowlist vs blocklist mode for resources identified by `object_ids`. Use `is_allowlist` to set allowlist vs blocklist mode for each resource in `object_ids`. `is_allowlist` cannot be changed when a resource is associated with multiple lists. parameters: - name: id in: path required: true description: ID of the domain list schema: type: integer - name: resource_type in: path required: true description: Type of targeting resource to update schema: "$ref": ref/types.yaml#/components/schemas/ResourceType requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/TargetingResourceBatchUpdateRequest" examples: single: "$ref": "#/components/examples/domain_list_resource_bulk_update_single" multiple: "$ref": "#/components/examples/domain_list_resource_bulk_update_multiple" responses: '200': "$ref": "#/components/responses/TargetingResourceBatchResponse" tags: - Domain Lists operationId: domain_lists_id_resource_type_bulk_update_same_attributes_post "/api/v1/isp_lists/{id}/isp_names/bulk_create": post: tags: - ISP Lists summary: Add ISPs parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/isp_list_isp_names_bulk_create_single" multiple: "$ref": "#/components/examples/isp_list_isp_names_bulk_create_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_isp_names_bulk_create_post "/api/v1/isp_lists/{id}/isp_names/bulk_delete": delete: tags: - ISP Lists summary: Delete ISPs parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: example: isp_names: - Akamai Technologies - iCloud Private Relay - Verizon Internet Services schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_isp_names_bulk_delete_delete "/api/v1/isp_lists/{id}/isp_names/bulk_replace": post: tags: - ISP Lists summary: Replace ISPs parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/isp_list_isp_names_bulk_replace_single" multiple: "$ref": "#/components/examples/isp_list_isp_names_bulk_replace_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_isp_names_bulk_replace_post "/api/v1/isp_lists/{id}/isp_names/file_bulk_create": post: tags: - ISP Lists summary: Add ISPs (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_isp_names_file_bulk_create_post "/api/v1/isp_lists/{id}/isp_names/file_bulk_delete": delete: tags: - ISP Lists summary: Remove ISPs (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_isp_names_file_bulk_delete_delete "/api/v1/isp_lists/{id}/isp_names/file_bulk_replace": post: tags: - ISP Lists summary: Replace ISPs (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object operationId: isp_lists_id_isp_names_file_bulk_replace_post "/api/v1/scanned_creative_lists/{id}/creatives/bulk_create": post: summary: Add Creatives parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/scanned_creative_list_creatives_bulk_create_single" multiple: "$ref": "#/components/examples/scanned_creative_list_creatives_bulk_create_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_creatives_bulk_create_post "/api/v1/scanned_creative_lists/{id}/creatives/bulk_delete": delete: summary: Delete Creatives parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: example: vast_hashes: - abc123def456 schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_creatives_bulk_delete_delete "/api/v1/scanned_creative_lists/{id}/creatives/bulk_replace": post: summary: Replace Creatives parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/scanned_creative_list_creatives_bulk_replace_single" multiple: "$ref": "#/components/examples/scanned_creative_list_creatives_bulk_replace_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_creatives_bulk_replace_post "/api/v1/scanned_creative_lists/{id}/creatives/file_bulk_create": post: summary: Add Creatives (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_creatives_file_bulk_create_post "/api/v1/scanned_creative_lists/{id}/creatives/file_bulk_delete": delete: summary: Delete Creatives (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_creatives_file_bulk_delete_delete "/api/v1/scanned_creative_lists/{id}/creatives/file_bulk_replace": post: summary: Replace Creatives (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object tags: - Scanned Creative Lists operationId: scanned_creative_lists_id_creatives_file_bulk_replace_post "/api/v1/supply_name_lists/{id}/supply_names/bulk_create": post: tags: - Supply Name Lists summary: Add Supply Names parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/supply_name_list_supply_names_bulk_create_single" multiple: "$ref": "#/components/examples/supply_name_list_supply_names_bulk_create_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_supply_names_bulk_create_post "/api/v1/supply_name_lists/{id}/supply_names/bulk_delete": delete: tags: - Supply Name Lists summary: Delete Supply Names parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: example: supply_names: - Test Publisher 1 - Test Publisher 2 schema: type: object required: true responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_supply_names_bulk_delete_delete "/api/v1/supply_name_lists/{id}/supply_names/bulk_replace": post: tags: - Supply Name Lists summary: Replace Supply Names parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/supply_name_list_supply_names_bulk_replace_single" multiple: "$ref": "#/components/examples/supply_name_list_supply_names_bulk_replace_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_supply_names_bulk_replace_post "/api/v1/supply_name_lists/{id}/supply_names/file_bulk_create": post: tags: - Supply Name Lists summary: Add Publishers Names (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_supply_names_file_bulk_create_post "/api/v1/supply_name_lists/{id}/supply_names/file_bulk_delete": delete: tags: - Supply Name Lists summary: Remove Supply Names (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_supply_names_file_bulk_delete_delete "/api/v1/supply_name_lists/{id}/supply_names/file_bulk_replace": post: tags: - Supply Name Lists summary: Replace Supply Names (CSV) parameters: - name: id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: csv_file: type: string format: binary responses: '200': description: '' content: application/json: schema: type: object operationId: supply_name_lists_id_supply_names_file_bulk_replace_post "/api/v1/accounts/dvplus/{dvplus_id}/set_current": post: summary: Set Current by Magnite DV+ ID description: Set the active account for the authenticated user to the account with the configured Magnite DV+ ID parameters: - name: dvplus_id in: path required: true schema: type: string nullable: true responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_dvplus_dvplus_id_set_current_post "/api/v1/changelogs/versioned_type/{versioned_type}/{versioned_id}": get: summary: Get By Type and Id parameters: - name: versioned_type in: path required: true schema: type: string - name: versioned_id in: path required: true schema: type: string - name: page in: query schema: type: number - name: per in: query schema: type: number - name: search in: query description: Searches by version change id and summary schema: type: string - name: time in: query schema: "$ref": "#/components/schemas/ChangelogsTimeFilter" - name: user in: query description: all/exclude_system_updates/each_user schema: type: string - name: change_type in: query description: created/updated/deleted schema: type: string - name: sort in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Changelogs operationId: changelogs_versioned_type_versioned_type_versioned_id_get "/api/v1/notifications/user/{id}/mark-read": put: summary: Mark user notification as read description: Mark user notification with given ID as read parameters: - name: id in: path required: true schema: type: number responses: '200': description: '' content: application/json: schema: type: object tags: - Notifications operationId: notifications_user_id_mark-read_put "/api/v1/notifications/user/{id}/mark-unread": put: summary: Mark user notification as unread description: Mark user notification with given ID as unread parameters: - name: id in: path required: true schema: type: number responses: '200': description: '' content: application/json: schema: type: object tags: - Notifications operationId: notifications_user_id_mark-unread_put "/api/v1/reports/templates/{id}/set_default": post: tags: - Report Templates summary: Set as default description: 'Sets the authenticated user''s default report template to this template. ' parameters: - in: path name: id required: true schema: type: integer responses: '200': description: Success with an empty body. content: application/json: schema: type: object '404': "$ref": ref/errors.yaml#/components/responses/notFoundError '422': "$ref": ref/errors.yaml#/components/responses/validationError operationId: reports_templates_id_set_default_post "/api/v1/accounts/foreign_seat/{foreign_platform_name}/{foreign_seat_id}/white_label": get: summary: Show for Account by Foreign Seat parameters: - name: foreign_platform_name in: path required: true schema: type: string - name: foreign_seat_id in: path required: true schema: type: string - name: include in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_foreign_seat_foreign_platform_name_foreign_seat_id_white_label_get components: examples: white_label_create_simple: summary: Simple value: name: White Label Name domain: console.example.com ui_theme_id: 1 ui_logo_attributes: asset: logo.png ui_logo_alt_attributes: asset: logo_alt.png ui_icon_attributes: asset: icon.png white_label_create_full: summary: Full value: name: White Label Name domain: console.example.com description: Custom white label theme ui_theme_id: 1 ui_logo_attributes: asset: logo.png ui_logo_alt_attributes: asset: logo_alt.png ui_icon_attributes: asset: icon.png white_label_update_simple: summary: Simple value: name: White Label Name white_label_update_full: summary: Full value: name: White Label Name domain: console.example.com description: Updated white label ui_theme_id: 1 ui_logo_attributes: id: 1 asset: logo.png ui_logo_alt_attributes: id: 1 asset: logo_alt.png ui_icon_attributes: id: 1 asset: icon.png video_creative_create_simple: summary: Simple value: name: Video Creative Name demand_partner_id: 1 creative_remote_url: https://example.com/video.mp4 video_creative_create_full: summary: Full value: name: Video Creative Name demand_partner_id: 1 creative_remote_url: https://example.com/video.mp4 creative_landing_page_url: https://example.com/landing code: video-code secondary_code: video-secondary advertiser_domain: example.com iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_source: list country_list_ids: - 1 state_source: list state_list_ids: - 1 city_source: list city_list_ids: - 1 metro_area_source: list metro_area_list_ids: - 1 postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true targeted_macros_enabled: true all_user_agent_devices: true all_user_agent_operating_systems: true all_user_agent_browsers: true all_user_agent_brands: true budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: true tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image is_active: true video_creative_update_simple: summary: Simple value: name: Video Creative Name is_active: true video_creative_update_full: summary: Full value: name: Video Creative Name creative_landing_page_url: https://example.com/landing code: video-code secondary_code: video-secondary advertiser_domain: example.com iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_source: list country_list_ids: - 1 state_source: list state_list_ids: - 1 city_source: list city_list_ids: - 1 metro_area_source: list metro_area_list_ids: - 1 postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true targeted_macros_enabled: true all_user_agent_devices: true all_user_agent_operating_systems: true all_user_agent_browsers: true all_user_agent_brands: true budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: true tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image is_active: true user_update_current_simple: summary: Simple value: name: User Name timezone: America/New_York user_update_current_full: summary: Full value: name: User Name timezone: America/New_York default_report_template_id: 1 notification_opt_outs: - DC Requests all_notification_opt_outs: false user_account_create_simple: summary: Simple value: email: user@example.com role: analytics user_account_create_full: summary: Full value: email: user@example.com role: supply_client client_object_type: partner supply_partner_ids: - 1 demand_partner_ids: [] supply_label_ids: [] demand_label_ids: [] read_marketplace_ids: [] write_marketplace_ids: [] account_contact: false high_volume_user: false is_active: true user_account_update_simple: summary: Simple value: is_active: true user_account_update_full: summary: Full value: role: ad_ops client_object_type: partner supply_partner_ids: - 1 demand_partner_ids: - 1 supply_label_ids: - 1 demand_label_ids: - 1 read_marketplace_ids: - 1 write_marketplace_ids: - 1 account_contact: false high_volume_user: false is_active: true user_account_bulk_update_single: summary: Single value: is_active: true object_ids: - 1 user_account_bulk_update_multiple: summary: Multiple value: is_active: false object_ids: - 1 - 2 ui_theme_create_simple: summary: Simple value: name: UI Theme Name primary_color: "#40C1D1" primary_dark_color: "#089191" primary_light_color: "#bbe3e8" secondary_color: "#FA9200" chart_primary_color: "#40C1D1" chart_secondary_color: "#FA9200" chart_tertiary_color: "#8b3f98" chart_quaternary_color: "#7f7f7f" chart_quinary_color: "#4BB543" chart_senary_color: "#E84855" chart_septenary_color: "#2F6DF6" chart_octonary_color: "#C5A100" chart_nonary_color: "#FF7EBA" chart_denary_color: "#2E8B84" navbar_background_color: "#222222" navbar_background_highlight_color: "#000000" navbar_text_color: "#f9f9f9" navbar_text_active_color: "#ffffff" navbar_text_hover_color: "#f9f9f9" navbar_accent_color: "#40C1D1" broadfall_color: "#d9eef1" ui_theme_create_full: summary: Full value: name: UI Theme Name description: Custom theme wiki_instructions: See wiki for details macro_wiki_url: https://example.com/wiki primary_color: "#40C1D1" primary_dark_color: "#089191" primary_light_color: "#bbe3e8" secondary_color: "#FA9200" chart_primary_color: "#40C1D1" chart_secondary_color: "#FA9200" chart_tertiary_color: "#8b3f98" chart_quaternary_color: "#7f7f7f" chart_quinary_color: "#4BB543" chart_senary_color: "#E84855" chart_septenary_color: "#2F6DF6" chart_octonary_color: "#C5A100" chart_nonary_color: "#FF7EBA" chart_denary_color: "#2E8B84" navbar_background_color: "#222222" navbar_background_highlight_color: "#000000" navbar_text_color: "#f9f9f9" navbar_text_active_color: "#ffffff" navbar_text_hover_color: "#f9f9f9" navbar_accent_color: "#40C1D1" broadfall_color: "#d9eef1" streaming_primary_highlight_color: "#40C1D1" streaming_link_color: "#089191" streaming_link_highlight_color: "#bbe3e8" ui_theme_update_simple: summary: Simple value: name: UI Theme Name ui_theme_update_full: summary: Full value: name: UI Theme Name description: Updated theme wiki_instructions: See wiki for details macro_wiki_url: https://example.com/wiki primary_color: "#40C1D1" primary_dark_color: "#089191" primary_light_color: "#bbe3e8" secondary_color: "#FA9200" chart_primary_color: "#40C1D1" chart_secondary_color: "#FA9200" chart_tertiary_color: "#8b3f98" chart_quaternary_color: "#7f7f7f" chart_quinary_color: "#4BB543" chart_senary_color: "#E84855" chart_septenary_color: "#2F6DF6" chart_octonary_color: "#C5A100" chart_nonary_color: "#FF7EBA" chart_denary_color: "#2E8B84" navbar_background_color: "#222222" navbar_background_highlight_color: "#000000" navbar_text_color: "#f9f9f9" navbar_text_active_color: "#ffffff" navbar_text_hover_color: "#f9f9f9" navbar_accent_color: "#40C1D1" broadfall_color: "#d9eef1" streaming_primary_highlight_color: "#40C1D1" streaming_link_color: "#089191" streaming_link_highlight_color: "#bbe3e8" tile_creative_clickable_image_create_simple: summary: Clickable Image Simple value: name: Tile Creative Name demand_partner_id: 1 tiles_template: clickable_image creative_landing_page_url: https://www.example.com creative_remote_url: https://www.example.com/image.jpg tile_creative_clickable_image_create_full: summary: Clickable Image Full value: name: Tile Creative Name demand_partner_id: 1 tiles_template: clickable_image creative_landing_page_url: https://www.example.com creative_remote_url: https://www.example.com/image.jpg code: tile-code secondary_code: tile-secondary line_item_demand_tag_ids: - 1 overlay_text: Click here iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list country_white_list: true state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve key_value_targeting: true targeted_macros_enabled: true user_agent_devices: - desktop all_user_agent_devices: false user_agent_operating_systems: - Windows all_user_agent_operating_systems: false user_agent_browsers: - Chrome all_user_agent_browsers: false user_agent_brands: - '1' all_user_agent_brands: false budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: true is_active: true tile_creative_clickable_video_create_simple: summary: Clickable Video Simple value: name: Tile Creative Name demand_partner_id: 1 tiles_template: clickable_video creative_landing_page_url: https://www.example.com creative_remote_url: https://www.example.com/video.mp4 tile_creative_clickable_video_create_full: summary: Clickable Video Full value: name: Tile Creative Name demand_partner_id: 1 tiles_template: clickable_video creative_landing_page_url: https://www.example.com creative_remote_url: https://www.example.com/video.mp4 code: tile-code secondary_code: tile-secondary line_item_demand_tag_ids: - 1 overlay_text: Click here iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list country_white_list: true frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York is_active: true tile_creative_multimedia_create_simple: summary: Multimedia Simple description: Requires the native_creatives beta feature on the account. value: name: Tile Creative Name demand_partner_id: 1 tiles_template: multimedia creative_landing_page_url: https://www.example.com creative_remote_urls: - https://www.example.com/video.mp4 - https://www.example.com/image.jpg creative_input_types: - url - url tile_creative_multimedia_create_full: summary: Multimedia Full description: Requires the native_creatives beta feature on the account. value: name: Tile Creative Name demand_partner_id: 1 tiles_template: multimedia creative_landing_page_url: https://www.example.com creative_remote_urls: - https://www.example.com/video.mp4 - https://www.example.com/image.jpg creative_input_types: - url - url code: tile-code secondary_code: tile-secondary line_item_demand_tag_ids: - 1 overlay_text: Click here iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list country_white_list: true frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York is_active: true tile_creative_custom_create_simple: summary: Custom Simple value: name: Tile Creative Name demand_partner_id: 1 tiles_template: custom custom: true custom_code: "
Ad
" width: 1 height: 1 tile_creative_custom_create_full: summary: Custom Full value: name: Tile Creative Name demand_partner_id: 1 tiles_template: custom custom: true custom_code: "
Ad
" width: 1 height: 1 creative_landing_page_url: https://www.example.com code: tile-code secondary_code: tile-secondary line_item_demand_tag_ids: - 1 overlay_text: Click here iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve key_value_targeting: true targeted_macros_enabled: true budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York is_active: true tile_creative_update_simple: summary: Simple value: name: Tile Creative Name creative_landing_page_url: https://www.example.com is_active: true tile_creative_update_full: summary: Full value: name: Tile Creative Name creative_landing_page_url: https://www.example.com overlay_text: Click here code: tile-code secondary_code: tile-secondary line_item_demand_tag_ids: - 1 iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve key_value_targeting: true targeted_macros_enabled: true budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York is_active: true tag_creative_create_simple: summary: Simple value: name: Tag Creative Name demand_partner_id: 1 vast_endpoint_url: https://staging-tv.springserve.com/vast tag_creative_create_full: summary: Full value: name: Tag Creative Name demand_partner_id: 1 vast_endpoint_url: https://staging-tv.springserve.com/vast creative_format: video creative_landing_page_url: https://ad.example.com/landing advertiser_domain: example.com code: tag-code secondary_code: tag-secondary line_item_demand_tag_ids: - 1 iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list country_white_list: true state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve key_value_targeting: true targeted_macros_enabled: true user_agent_devices: - desktop all_user_agent_devices: false user_agent_operating_systems: - Windows all_user_agent_operating_systems: false user_agent_browsers: - Chrome all_user_agent_browsers: false user_agent_brands: - '1' all_user_agent_brands: false budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: true is_active: true tag_creative_update_simple: summary: Simple value: name: Tag Creative Name vast_endpoint_url: https://staging-tv.springserve.com/vast is_active: true tag_creative_update_full: summary: Full value: name: Tag Creative Name vast_endpoint_url: https://staging-tv.springserve.com/vast creative_landing_page_url: https://ad.example.com/landing advertiser_domain: example.com code: tag-code secondary_code: tag-secondary line_item_demand_tag_ids: - 1 iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve key_value_targeting: true targeted_macros_enabled: true budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York is_active: true system_setting_create_simple: summary: Simple value: key: pause_ads_enabled value: 'false' system_setting_create_full: summary: Full value: key: pause_ads_enabled value: 'false' super_admin_only: false account_ids: - 1 system_setting_update_simple: summary: Simple value: value: 'true' system_setting_update_full: summary: Full value: key: pause_ads_enabled value: 'true' super_admin_only: false account_ids: - 1 supply_tag_bulk_update_many_single: summary: Single value: - id: 1 is_active: true supply_tag_bulk_update_many_multiple: summary: Multiple value: - id: 1 is_active: true rate: 1.11 - id: 2 rate: 1.11 rpm_floor: 1.11 open_market_enabled: true payment_terms: CPM supply_label_ids: - 1 supply_tag_update_simple: summary: Simple value: rate: 1.11 is_active: true supply_tag_update_full: summary: Full value: supply_partner_id: 1 format: video rate: 1.11 rpm_floor: 1.11 rpm_floor_hb: false open_market_enabled: false payment_terms: CPM budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: spend budget_value: 1.11 budget_pacing: smooth rtb_version_targeting_enabled: false rtb_version: '2.5' supply_label_ids: - 1 key_ids: - 1 macro_overrides: - override_type: static macro_param: "{{IP}}" override_value: '1' advanced_floor_rules: - dimension: adomain values: - example.com floor_price: 1.11 code: supply-tag-code is_active: true supply_router_create_simple: summary: Simple value: name: Supply Router Name supply_partner_id: 1 supply_router_create_full: summary: Full value: name: Supply Router Name supply_partner_id: 1 code: '1' environment: desktop format: video supply_router_ratios: - supply_tag_id: 1 fallback_supply_tag_id: 1 ratio: 1 key_ids: - 1 domain_white_list: true domain_list_ids: - 1 advertiser_domain_white_list: true advertiser_domain_list_ids: - 1 blocking_unknown_advertiser_domains: true iab_category_tier1_list_ids: - 1 targeted_iab_category_codes: - IAB1 targeted_iab_category_source: list targeted_iab_category_white_list: true iab_category_tier2_list_ids: - 1 targeted_iab_tier2_category_codes: - IAB1-1 targeted_iab_tier2_category_source: list targeted_iab_tier2_category_white_list: true app_name_white_list: true app_name_list_ids: - 1 app_name_override_targeting_enabled: true app_bundle_white_list: true app_bundle_list_ids: - 1 app_bundle_override_targeting_enabled: true player_sizes: - s - m - l min_aspect_ratio: 1.11 max_aspect_ratio: 1.11 country_list_ids: - 1 country_codes: - US country_source: list country_white_list: true metro_area_list_ids: - 1 metro_area_codes: - 2001 metro_area_source: list metro_area_white_list: true user_agent_devices: - '1' user_agent_brands: - '1' user_agent_operating_systems: - '1' user_agent_browsers: - '1' ip_white_list: true ip_list_ids: - 1 segment_targeting_enabled: true segment_groups: - group: 1 white_list: true segment_ids: - 1 coppa_values: - '1' coppa_param_required: true dnt_values: - '1' dnt_param_required: true lmt_values: - '1' lmt_param_required: true us_privacy_values: - '1' us_privacy_param_required: true us_privacy_supply_white_list: true gdpr_supply_values: - '1' gdpr_supply_param_required: true gdpr_consent_string_values: - '1' gdpr_consent_param_required: true start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: household audited_creative_statuses: - approved scanned_creative_white_list: true scanned_creative_list_ids: - 1 third_party_override: true post_imp_detection_enabled: true post_imp_percentage_whiteops: 1 post_imp_percentage_ias: 1 post_imp_percentage_moat: 1 post_imp_percentage_protected: 1 post_imp_percentage_forensiq: 1 pre_bid_blocking_enabled: true pre_bid_blocking_components: - '1' tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel custom_response: '1' active: true note: Supply Router note supply_router_update_simple: summary: Simple value: name: Supply Router Name active: true supply_router_update_full: summary: Full value: name: Supply Router Name supply_partner_id: 1 code: '1' environment: desktop supply_router_ratios: - supply_tag_id: 1 fallback_supply_tag_id: 1 ratio: 1 key_ids: - 1 domain_white_list: true domain_list_ids: - 1 player_sizes: - s - m - l country_list_ids: - 1 country_codes: - US country_source: list country_white_list: true segment_targeting_enabled: true segment_groups: - group: 1 white_list: true segment_ids: - 1 start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York third_party_override: true post_imp_detection_enabled: true custom_response: '1' active: true note: Supply Router note supply_label_create_simple: summary: Simple value: name: Supply Label Name supply_label_create_full: summary: Full value: name: Supply Label Name supply_tag_ids: - 1 supply_label_update_simple: summary: Simple value: name: Supply Label Name supply_label_update_full: summary: Full value: name: Supply Label Name supply_tag_ids: - 1 supply_name_list_create_simple: summary: Simple value: name: Supply Name List Name supply_name_list_create_full: summary: Full value: name: Supply Name List Name description: Supply name list description active: true streaming_seller_seat_ids: - 1 - 2 supply_name_list_update_simple: summary: Simple value: name: Supply Name List Name supply_name_list_update_full: summary: Full value: name: Supply Name List Name description: Supply name list description active: true streaming_seller_seat_ids: - 1 - 2 supply_name_list_supply_names_bulk_create_single: summary: Single value: supply_names: - Publisher Name One supply_name_list_supply_names_bulk_create_multiple: summary: Multiple value: supply_names: - Publisher Name One - Publisher Name Two - Publisher Name Three supply_name_list_supply_names_bulk_replace_single: summary: Single value: supply_names: - Publisher Name One supply_name_list_supply_names_bulk_replace_multiple: summary: Multiple value: supply_names: - Publisher Name One - Publisher Name Two - Publisher Name Three state_list_create_simple: summary: Simple value: name: State List Name state_codes: - US-CA - US-NY state_list_create_full: summary: Full value: name: State List Name description: State List Description active: true state_codes: - US-CA - US-NY state_list_update_simple: summary: Simple value: name: State List Name state_list_update_full: summary: Full value: name: State List Name description: State List Description active: true state_codes: - CA-ON - GB-ENG list_action: append showcase_create_simple: summary: Simple value: name: Showcase Name is_active: true showcase_create_full: summary: Full value: name: Showcase Name description: Showcase description is_active: true is_private: false is_magnite_owned: true header_theme_color: "#000000" header_text_color: "#FFFFFF" max_carousel_count: 1 showcase_category_ids: - 1 showcase_account_ids: - 1 showcase_categories: - name: Showcase Category Name is_featured: true featured_rank: 1 is_shelf: true shelf_rank: 1 showcase_accounts: - account_id: 1 role: seller showcase_update_simple: summary: Simple value: name: Showcase Name is_active: true showcase_update_full: summary: Full value: name: Showcase Name description: Showcase description is_active: true is_private: false is_magnite_owned: true header_theme_color: "#000000" header_text_color: "#FFFFFF" max_carousel_count: 1 showcase_category_ids: - 1 showcase_account_ids: - 1 showcase_categories: - id: 1 name: Showcase Category Name is_featured: true featured_rank: 1 is_shelf: true shelf_rank: 1 _destroy: false showcase_accounts: - id: 1 account_id: 1 role: seller _destroy: false scheduled_report_create_simple: summary: Simple value: name: Scheduled Report Name interval: daily start_date: '2026-10-01' hour: 8 report_params: date_range: Yesterday dimensions: - supply_tag_id metrics: - impressions - revenue scheduled_report_create_full: summary: Full value: name: Scheduled Report Name is_active: true interval: weekly weekdays: - Monday - Wednesday hour: 8 timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' permissions: require_login message: Your scheduled report is ready. report_params: date_range: Yesterday interval: day timezone: Etc/UTC currency: USD dimensions: - supply_tag_id - demand_tag_id filters: - dimension: supply_tag_id type: values values: - 1 is_include: true is_exact_match: false metrics: - impressions - revenue - fill_rate - cpm scheduled_report_recipients: - user_account_id: 1 scheduled_report_external_recipients: - email: example@example.com report_type: supply_client scheduled_report_update_simple: summary: Simple value: name: Scheduled Report Name is_active: true scheduled_report_update_full: summary: Full value: name: Scheduled Report Name is_active: true interval: monthly day_of_month: 1 hour: 8 timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' permissions: require_login message: Your scheduled report is ready. report_params: date_range: Yesterday interval: day timezone: Etc/UTC currency: USD dimensions: - supply_tag_id - demand_tag_id metrics: - impressions - revenue - fill_rate - cpm scheduled_report_recipients: - user_account_id: 1 scheduled_report_external_recipients: - email: example@example.com report_type: supply_client scheduled_report_bulk_update_single: summary: Single value: is_active: true object_ids: - 1 scheduled_report_bulk_update_multiple: summary: Multiple value: is_active: false object_ids: - 1 - 2 scanned_creative_update_simple: summary: Simple value: overrides: audit_status: approved adomain: example.com scanned_creative_update_full: summary: Full value: overrides: audit_status: approved language: en-US adomain: example.com brand_safe: true malicious: false stitched: false political: false iab_tier_1: - IAB1 iab_tier_2: - IAB1-1 objectionable: - violence scanned_creative_lists: - 1 scanned_creative_list_create_simple: summary: Simple value: name: Scanned Creative List Name scanned_creative_list_create_full: summary: Full value: name: Scanned Creative List Name description: Scanned creative list description is_active: true scanned_creative_list_update_simple: summary: Simple value: name: Scanned Creative List Name scanned_creative_list_update_full: summary: Full value: name: Scanned Creative List Name description: Scanned creative list description is_active: true scanned_creative_list_creatives_bulk_create_single: summary: Single value: vast_hashes: - abc123def456 scanned_creative_list_creatives_bulk_create_multiple: summary: Multiple value: vast_hashes: - abc123def456 - def456ghi789 - ghi789jkl012 scanned_creative_list_creatives_bulk_replace_single: summary: Single value: vast_hashes: - abc123def456 scanned_creative_list_creatives_bulk_replace_multiple: summary: Multiple value: vast_hashes: - abc123def456 - def456ghi789 - ghi789jkl012 run_as_start_internal_user: summary: Internal (Magnite) User value: email: user@magnite.com run_as_start_external_user: summary: External (Partner) User value: email: partner@example.com report_create_simple: summary: Simple value: date_range: Yesterday dimensions: - supply_tag_id metrics: - impressions - revenue report_create_full: summary: Full value: async: false csv: false currency: USD date_range: Yesterday dimensions: - supply_tag_id - demand_tag_id filters: - dimension: supply_tag_id type: values values: - 1 is_include: true is_exact_match: false - dimension: demand_tag_id type: values values: - 1 is_include: false is_exact_match: false having: - metric: impressions max: false value: 1 interval: day metrics: - impressions - revenue - fill_rate - cpm sort: - impressions desc timezone: Etc/UTC report_template_create_simple: summary: Simple value: name: Report Template Name date_range: Yesterday dimensions: - supply_partner_id metrics: - usable_requests report_template_create_full: summary: Full value: name: Report Template Name description: My report template date_range: Last 7 Days interval: day interval_start_day: monday timezone: America/New_York currency: USD dimensions: - supply_partner_id - supply_tag_id metrics: - usable_requests - fill_rate filters: - dimension: supply_partner_id type: values values: - 1 is_include: true is_exact_match: false having: - metric: usable_requests max: false value: 1 report_template_update_simple: summary: Simple value: name: Report Template Name report_template_update_full: summary: Full value: name: Report Template Name description: Updated report template date_range: Last 7 Days interval: day interval_start_day: monday timezone: America/New_York currency: USD dimensions: - supply_partner_id - supply_tag_id metrics: - usable_requests - fill_rate filters: - dimension: supply_partner_id type: values values: - 1 is_include: true is_exact_match: false programmatic_guaranteed_create_simple: summary: Simple value: name: Programmatic Guaranteed Name demand_class: 11 demand_partner_id: 1 rate: 1.11 inventory_groups: - group: 1 list_type: white_list source_type: values inventory_object: DealList inventory_values: - 1 programmatic_guaranteed_create_full: summary: Full value: name: Programmatic Guaranteed Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 code: '1' secondary_code: '1' vast_endpoint_url: https://staging-tv.springserve.com/vast inventory_groups: - group: 1 list_type: white_list source_type: values inventory_object: DealList inventory_values: - 1 deal_list_ids: - 1 line_item_ratios: - creative_id: 1 ratio: 1 demand_label_ids: - 1 tag_pixels: - pixel_url: https://ad.example.com/pixel pixel_type: AdImpression pixel_format: image custom_vast_extensions: - custom_key: '1' custom_value: '1' budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York post_imp_detection_enabled: true post_imp_percentage_whiteops: 1 post_imp_percentage_ias: 1 post_imp_percentage_moat: 1 post_imp_percentage_protected: 1 post_imp_percentage_forensiq: 1 mediaocean_prisma_enabled: true mediaocean_prisma_order_id: '1' mediaocean_prisma_campaign_id: '1' mediaocean_prisma_placement_id: '1' mediaocean_prisma_campaign_link: https://prisma.example.com/campaign campaign_tier: 1 active: true note: Programmatic Guaranteed note programmatic_guaranteed_update_simple: summary: Simple value: name: Programmatic Guaranteed Name rate: 1.11 active: true programmatic_guaranteed_update_full: summary: Full value: name: Programmatic Guaranteed Name campaign_id: 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 secondary_code: '1' vast_endpoint_url: https://staging-tv.springserve.com/vast line_item_ratios: - creative_id: 1 ratio: 1 demand_label_ids: - 1 budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York post_imp_detection_enabled: true campaign_tier: 1 active: true note: Programmatic Guaranteed note postal_code_list_create_simple: summary: Simple value: name: Postal Code List Name postal_codes: - '10001' postal_code_list_create_full: summary: Full value: name: Postal Code List Name description: Postal Code List Description postal_codes: - '10001' active: true postal_code_list_update_simple: summary: Simple value: name: Postal Code List Name postal_code_list_update_full: summary: Full value: name: Postal Code List Name description: Postal Code List Description active: true list_action: append postal_codes: - '10001' polygon_list_create_simple: summary: Simple value: name: Polygon List Name polygon_list_create_full: summary: Full value: name: Polygon List Name description: Polygon list description active: true polygon_list_update_simple: summary: Simple value: name: Polygon List Name polygon_list_update_full: summary: Full value: name: Polygon List Name description: Polygon list description active: true polygon_list_bulk_update_single: summary: Single value: active: true object_ids: - 1 polygon_list_bulk_update_multiple: summary: Multiple value: active: true object_ids: - 1 - 2 - 3 partner_segment_update_simple: summary: Activate a Partner Segment value: is_active: true partner_segment_update_full: summary: Deactivate a Partner Segment value: is_active: false partner_segment_bulk_create_single: summary: Create a single Partner Segment value: partner_segments: - code: EXAMPLE_PARTNER_SEGMENT_1 vendor_id: 1 description: Example Partner Segment cpm: 1.11 partner_segment_bulk_create_multiple: summary: Create multiple Partner Segments value: partner_segments: - code: EXAMPLE_PARTNER_SEGMENT_1 vendor_id: 1 description: Example Partner Segment cpm: 1.11 external_code: '' dmp_segment_id: 1 category: EXAMPLE_CATEGORY political: false adv_id: 1 enabled: true - code: EXAMPLE_PARTNER_SEGMENT_2 vendor_id: 1 description: Another Partner Segment cpm: 1.11 external_code: '' dmp_segment_id: 1 category: EXAMPLE_CATEGORY political: false adv_id: 1 enabled: false package_create_simple: summary: Simple value: name: Package Name showcase_id: 1 is_active: true package_create_full: summary: Full value: name: Package Name showcase_id: 1 description: Package description is_active: true rate: 1.11 rate_currency: USD package_showcase_categories: - showcase_category_id: 1 package_update_simple: summary: Simple value: name: Package Name is_active: true package_update_full: summary: Full value: name: Package Name description: Package description is_active: true rate: 1.11 rate_currency: USD package_showcase_categories: - id: 1 showcase_category_id: 1 _destroy: false metro_area_list_create_simple: summary: Simple value: name: Metro Area List Name metro_area_codes: - 2001 metro_area_list_create_full: summary: Full value: name: Metro Area List Name description: Metro Area List Description metro_area_codes: - 2001 active: true metro_area_list_update_simple: summary: Simple value: name: Metro Area List Name metro_area_list_update_full: summary: Full value: name: Metro Area List Name description: Metro Area List Description active: true list_action: append metro_area_codes: - 2001 isp_list_create_simple: summary: Simple value: name: ISP List Name isp_list_create_full: summary: Full value: name: ISP List Name description: ISP list description is_active: true isp_names: - Akamai Technologies - Verizon Internet Services isp_list_update_simple: summary: Simple value: name: ISP List Name isp_list_update_full: summary: Full value: name: ISP List Name description: ISP list description is_active: true isp_names: - Akamai Technologies - Verizon Internet Services isp_list_isp_names_bulk_create_single: summary: Single value: isp_names: - Akamai Technologies isp_list_isp_names_bulk_create_multiple: summary: Multiple value: isp_names: - Akamai Technologies - Verizon Internet Services - iCloud Private Relay isp_list_isp_names_bulk_replace_single: summary: Single value: isp_names: - Akamai Technologies isp_list_isp_names_bulk_replace_multiple: summary: Multiple value: isp_names: - Akamai Technologies - Verizon Internet Services - iCloud Private Relay dv_plus_deals_sync_single: summary: Single Deal value: deals: - type: MD buyerDealId: MGNI-MD-101-26970 name: "[MD] CLA Deal" seatTokens: - '12345' startDate: '2026-04-06T07:00:00Z' endDate: '2026-12-31T15:59:59Z' impressionGoal: 10000000 price: type: Auction cpm: 33.33 currency: USD dv_plus_deals_sync_multiple: summary: Multiple Deals value: deals: - type: MD buyerDealId: MGNI-MD-101-26970 name: "[MD] CLA Deal" seatTokens: - '12345' startDate: '2026-04-06T07:00:00Z' endDate: '2026-12-31T15:59:59Z' impressionGoal: 10000000 price: type: Auction cpm: 33.33 currency: USD - type: PG buyerDealId: MGNI-PG-202-26971 name: "[PG] CLA Deal" seatTokens: - '12345' - '67890' startDate: '2026-01-01T00:00:00Z' endDate: '2026-06-30T23:59:59Z' impressionGoal: 5000000 price: type: Fixed cpm: 1.11 currency: USD hb_bid_map_create_simple: summary: Simple value: name: HB Bid Map Name bid_platform: amazon hb_bid_map_type: inventory_split hb_bid_map_create_full: summary: Full value: name: HB Bid Map Name bid_platform: amazon hb_bid_map_type: paid description: HB Bid Map description hb_bid_map_entries: - parameter_value: ott1_4033_30 bid_floor: 1.11 - parameter_value: ott2_4034_60 bid_floor: 2.22 hb_bid_map_update_simple: summary: Simple value: name: HB Bid Map Name hb_bid_map_update_full: summary: Full value: name: HB Bid Map Name description: Updated description list_action: append hb_bid_map_entries: - parameter_value: ott3_4035_30 bid_floor: 1.11 global_fcap_pixel_create_simple: summary: Simple value: name: Global Fcap Pixel Name frequency_cap_period_amount: 1 frequency_cap_period: hour list_type: ip_address global_fcap_pixel_create_full: summary: Full value: name: Global Fcap Pixel Name description: Global Fcap Pixel Description active: true list_type: ip_address frequency_cap_period_amount: 1 frequency_cap_period: hour global_fcap_pixel_update_simple: summary: Simple value: name: Global Fcap Pixel Name active: true global_fcap_pixel_update_full: summary: Full value: name: Global Fcap Pixel Name description: Global Fcap Pixel Description active: true geo_list_bulk_update_single: summary: Single value: object_ids: - 1 active: true geo_list_bulk_update_multiple: summary: Multiple value: object_ids: - 1 - 2 active: false filepath_creative_create_simple: summary: Simple value: name: Filepath Creative Name demand_partner_id: 1 filepath_value: "/path/to/creative.mp4" duration_seconds: 1 filepath_creative_create_full: summary: Full value: name: Filepath Creative Name demand_partner_id: 1 filepath_value: "/path/to/creative.mp4" duration_seconds: 1 clickable: false creative_landing_page_url: https://www.example.com advertiser_domain: example.com code: FP01 secondary_code: FP01-SEC is_active: true iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_codes: - US country_source: list country_list_ids: - 1 country_white_list: whitelist state_codes: - NY state_source: list state_list_ids: - 1 state_white_list: whitelist city_codes: - '1' city_source: list city_list_ids: - 1 city_white_list: whitelist metro_area_codes: - 2001 metro_area_source: list metro_area_list_ids: - 1 metro_area_white_list: whitelist postal_codes: - '10001' postal_code_source: list postal_code_list_ids: - 1 postal_code_white_list: whitelist key_value_targeting: false targeted_macros_enabled: false all_user_agent_devices: true all_user_agent_operating_systems: true all_user_agent_browsers: true all_user_agent_brands: true budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting: day_parting_users_timezone: false tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image filepath_creative_update_simple: summary: Simple value: name: Filepath Creative Name is_active: true filepath_creative_update_full: summary: Full value: name: Filepath Creative Name filepath_value: "/path/to/creative-v2.mp4" duration_seconds: 1 clickable: false creative_landing_page_url: https://www.example.com advertiser_domain: example.com code: FP01 secondary_code: FP01-SEC is_active: true iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_codes: - US country_source: list country_list_ids: - 1 country_white_list: whitelist state_codes: - NY state_source: list state_list_ids: - 1 state_white_list: whitelist city_codes: - '1' city_source: list city_list_ids: - 1 city_white_list: whitelist metro_area_codes: - 2001 metro_area_source: list metro_area_list_ids: - 1 metro_area_white_list: whitelist postal_codes: - '10001' postal_code_source: list postal_code_list_ids: - 1 postal_code_white_list: whitelist key_value_targeting: false targeted_macros_enabled: false all_user_agent_devices: true all_user_agent_operating_systems: true all_user_agent_browsers: true all_user_agent_brands: true budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting: day_parting_users_timezone: false tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image dynamic_floor_replace_simple: summary: Simple value: active: true dynamic_floor_rules: - entity_type: supply_tags filter_type: include entity_ids: - 1 - 2 - 3 minimum_floor: '12.50' minimum_floor_currency: USD dynamic_floor_replace_full: summary: Full value: active: true dynamic_floor_rules: - id: 12 entity_type: supply_tags filter_type: include entity_ids: - 1 - 2 - 3 minimum_floor: '12.50' minimum_floor_currency: USD - entity_type: demand_tags filter_type: exclude entity_ids: - 5 - 6 domain_list_create_simple: summary: Simple value: name: Domain List Name domain_list_create_full: summary: Full value: name: Domain List Name description: Domain List Description is_active: true domain_list_create_enabled_demand_partners_expansion: summary: Demand partner expansion enabled value: name: Domain List Name description: Domain List Description is_active: true demand_partner_permission_ids: - 1 - 2 domain_list_create_another_account: summary: For another account (super admin only) description: 'Super admins may create a domain list in another account by supplying account_id. Other users may only create in their own account; a foreign account_id is rejected with 401. ' value: name: Domain List Name description: Domain List Description is_active: true account_id: 2 domain_list_duplicate_enabled_demand_partners_expansion: summary: Demand partner expansion enabled value: name: Domain List Name (copy) description: Domain List Description is_active: true demand_partner_permission_ids: - 1 - 2 domain_list_duplicate_disabled_demand_partners_expansion: summary: Demand partner expansion disabled value: name: Domain List Name (copy) description: Domain List Description is_active: true domain_list_duplicate_another_account: summary: For another account (super admin only) description: 'Super admins may create the duplicate in another account by supplying account_id. Other users may only duplicate into their own account; a foreign account_id is rejected with 401. ' value: name: Domain List Name (copy) description: Domain List Description is_active: true account_id: 2 domain_list_update_simple: summary: Simple value: name: Domain List Name domain_list_update_full: summary: Full value: name: Domain List Name description: Domain List Description is_active: true domain_list_bulk_update_simple: summary: Simple value: is_active: true object_ids: - 1 domain_list_bulk_update_full: summary: Full value: is_active: true object_ids: - 1 - 2 domain_list_domains_bulk_create_single: summary: Single value: domains: - example.com domain_list_domains_bulk_create_multiple: summary: Multiple value: domains: - aloha.com - shalom.com - ciao.com domain_list_domains_bulk_replace_single: summary: Single value: domains: - example.com domain_list_domains_bulk_replace_multiple: summary: Multiple value: domains: - bazbop.com - bazfoo.com domain_list_resource_bulk_update_single: summary: Single value: object_ids: - 1 is_allowlist: true domain_list_resource_bulk_update_multiple: summary: Multiple value: object_ids: - 1 - 2 is_allowlist: false domain_list_resource_add_single: summary: Single value: object_ids: - 1 is_allowlist: true domain_list_resource_add_multiple: summary: Multiple value: object_ids: - 1 - 2 is_allowlist: true domain_list_resource_bulk_delete_single: summary: Single value: object_ids: - 1 domain_list_resource_bulk_delete_multiple: summary: Multiple value: object_ids: - 1 - 2 display_creative_hosted_image_create_simple: summary: Hosted Image Simple value: name: Display Creative Name demand_partner_id: 1 creative_landing_page_url: https://www.example.com creative_remote_url: https://www.example.com/banner.jpg display_creative_hosted_image_create_full: summary: Hosted Image Full value: name: Display Creative Name demand_partner_id: 1 creative_landing_page_url: https://www.example.com creative_remote_url: https://www.example.com/banner.jpg code: DISP01 secondary_code: DISP01-SEC is_active: true iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_codes: - US country_source: list country_list_ids: - 1 country_white_list: whitelist state_codes: - NY state_source: list state_list_ids: - 1 state_white_list: whitelist city_codes: - '1' city_source: list city_list_ids: - 1 city_white_list: whitelist metro_area_codes: - 2001 metro_area_source: list metro_area_list_ids: - 1 metro_area_white_list: whitelist postal_codes: - '10001' postal_code_source: list postal_code_list_ids: - 1 postal_code_white_list: whitelist key_value_targeting: false targeted_macros_enabled: false budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting: day_parting_users_timezone: false tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image display_creative_custom_code_create_simple: summary: Custom Code Simple value: name: Display Creative Name demand_partner_id: 1 creative_landing_page_url: https://www.example.com custom: true custom_code: "
ad markup here
" width: 300 height: 250 display_creative_custom_code_create_full: summary: Custom Code Full value: name: Display Creative Name demand_partner_id: 1 creative_landing_page_url: https://www.example.com custom: true custom_code: "
ad markup here
" width: 300 height: 250 code: DISP02 secondary_code: DISP02-SEC is_active: true iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_codes: - US country_source: list country_list_ids: - 1 country_white_list: whitelist state_codes: - NY state_source: list state_list_ids: - 1 state_white_list: whitelist city_codes: - '1' city_source: list city_list_ids: - 1 city_white_list: whitelist metro_area_codes: - 2001 metro_area_source: list metro_area_list_ids: - 1 metro_area_white_list: whitelist postal_codes: - '10001' postal_code_source: list postal_code_list_ids: - 1 postal_code_white_list: whitelist key_value_targeting: false targeted_macros_enabled: false budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting: day_parting_users_timezone: false tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image display_creative_update_simple: summary: Simple value: name: Display Creative Name is_active: true display_creative_update_full: summary: Full value: name: Display Creative Name creative_landing_page_url: https://www.example.com creative_remote_url: https://www.example.com/banner-v2.jpg custom_code: "
updated markup
" code: DISP01 secondary_code: DISP01-SEC is_active: true iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_codes: - US country_source: list country_list_ids: - 1 country_white_list: whitelist state_codes: - NY state_source: list state_list_ids: - 1 state_white_list: whitelist city_codes: - '1' city_source: list city_list_ids: - 1 city_white_list: whitelist metro_area_codes: - 2001 metro_area_source: list metro_area_list_ids: - 1 metro_area_white_list: whitelist postal_codes: - '10001' postal_code_source: list postal_code_list_ids: - 1 postal_code_white_list: whitelist key_value_targeting: false targeted_macros_enabled: false budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting: day_parting_users_timezone: false tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image demand_tag_bulk_update_many_single: summary: Single value: - id: 1 name: Demand Tag Name is_active: true demand_tag_bulk_update_many_multiple: summary: Multiple value: - id: 1 name: Demand Tag Name rate: 1.11 is_active: true - id: 2 name: Demand Tag Name rate: 1.11 is_active: false demand_tag_bulk_update_same_single: summary: Single value: object_ids: - 1 is_active: true demand_tag_bulk_update_same_multiple: summary: Multiple value: object_ids: - 1 - 2 is_active: true rate: 1.11 demand_partner_id: 1 min_bid_price: 1.11 max_bid_price: 1.11 demand_tag_macro_suggester_simple: summary: Simple value: vast_endpoint_url: https://staging-tv.springserve.com/vast demand_tag_macro_suggester_full: summary: Full value: vast_endpoint_url: https://staging-tv.springserve.com/vast ad_server_id: 1 environment: ctv include_all: false demand_tag_tag_create_simple: summary: Tag Simple value: name: Demand Tag Name demand_class: 1 demand_partner_id: 1 vast_endpoint_url: https://staging-tv.springserve.com/vast rate: 1.11 demand_tag_tag_create_full: summary: Tag Full value: name: Demand Tag Name demand_class: 1 demand_partner_id: 1 campaign_id: 1 player_sizes: - s - m - l format: video environment: desktop secondary_code: secondary vast_endpoint_url: https://staging-tv.springserve.com/vast timeout: 1 cost_model_type: 0 multi_call_enabled: false multi_call_maximum: 1 domain_targeting: Allowlist domain_list_ids: - 1 app_name_targeting: Allowlist app_name_list_ids: - 1 app_bundle_targeting: Allowlist app_bundle_list_ids: - 1 ip_targeting: Allowlist ip_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 state_targeting: Include state_source: list state_list_ids: - 1 city_targeting: Include city_source: list city_list_ids: - 1 metro_area_targeting: Include metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: Include postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true targeted_macros_enabled: true advertiser_domain_white_list: true advertiser_domain_list_ids: - 1 blocking_unknown_advertiser_domains: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 budget_timezone: America/New_York share_of_voice_goal_percent: 1 day_parting_users_timezone: true pre_bid_blocking_enabled: true post_imp_detection_enabled: true post_imp_percentage_whiteops: 1 post_imp_percentage_ias: 1 post_imp_percentage_moat: 1 realtime_viewability: true respect_pod_order: true daa_ad_choices: true device_id_required: true skip_enabled: true skip_offset: 1 suppress_xff_ip: true is_active: true note: Demand Tag note demand_tag_bidder_create_simple: summary: Bidder Simple value: name: Demand Tag Name demand_class: 3 demand_partner_id: 1 bid_platform: magnite bid_floor_type: static rate: 1.11 demand_tag_bidder_create_full: summary: Bidder Full value: name: Demand Tag Name demand_class: 3 demand_partner_id: 1 player_sizes: - s - m - l format: video environment: desktop bid_platform: magnite bid_params: seat_id: '1' bid_floor_type: static bid_margin: 1.11 allow_tier_breakout: false breakout_bid: 1.11 override_supply_floor: false partner_tier_override_enabled: true partner_tier_override: '1' multi_call_enabled: false multi_call_maximum: 1 domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD budget_timezone: America/New_York pre_bid_blocking_enabled: true post_imp_detection_enabled: true realtime_viewability: true daa_ad_choices: true device_id_required: true is_active: true note: Demand Tag note demand_tag_line_item_create_simple: summary: Line Item Simple value: name: Demand Tag Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 rate: 1.11 demand_tag_line_item_create_full: summary: Line Item Full value: name: Demand Tag Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 creative_id: 1 player_sizes: - s - m - l format: video environment: desktop line_item_ratios: - creative_id: 1 ratio: 1 domain_targeting: Allowlist domain_list_ids: - 1 app_name_targeting: Allowlist app_name_list_ids: - 1 app_bundle_targeting: Allowlist app_bundle_list_ids: - 1 ip_targeting: Allowlist ip_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 state_targeting: Include state_source: list state_list_ids: - 1 city_targeting: Include city_source: list city_list_ids: - 1 metro_area_targeting: Include metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: Include postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true targeted_macros_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 budget_timezone: America/New_York share_of_voice_goal_percent: 1 guaranteed_delivery: false guaranteed_tier: '1' start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York price_extension_enabled: false daa_ad_choices: true device_id_required: true is_reserved: false is_active: true note: Demand Tag note demand_tag_house_ad_create_simple: summary: House Ad Simple value: name: Demand Tag Name demand_class: 8 demand_partner_id: 1 creative_id: 1 creative_landing_page_url: https://ad.example.com/landing demand_tag_house_ad_create_full: summary: House Ad Full value: name: Demand Tag Name demand_class: 8 demand_partner_id: 1 creative_id: 1 creative_landing_page_url: https://ad.example.com/landing player_sizes: - s - m - l format: video environment: desktop domain_targeting: Allowlist domain_list_ids: - 1 app_name_targeting: Allowlist app_name_list_ids: - 1 app_bundle_targeting: Allowlist app_bundle_list_ids: - 1 ip_targeting: Allowlist ip_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 state_targeting: Include state_source: list state_list_ids: - 1 city_targeting: Include city_source: list city_list_ids: - 1 metro_area_targeting: Include metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: Include postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true targeted_macros_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 budget_timezone: America/New_York daa_ad_choices: true device_id_required: true is_active: true note: Demand Tag note demand_tag_dsp_sub_line_item_create_simple: summary: DSP Sub Line Item Simple value: name: Demand Tag Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 bid_floor_type: static buying_model: private_market rate: 1.11 demand_tag_dsp_sub_line_item_create_full: summary: DSP Sub Line Item Full value: name: Demand Tag Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 player_sizes: - s - m - l format: video environment: desktop buying_model: private_market bid_floor_type: static bid_margin: 1.11 campaign_tier: 1 domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 isp_source: list isp_list_ids: - 1 isp_names: - '1' key_value_targeting: true segment_targeting_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 budget_timezone: America/New_York guaranteed_delivery: false start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York daa_ad_choices: true device_id_required: true is_reserved: false is_active: true note: Demand Tag note demand_tag_marketplace_deal_create_simple: summary: Marketplace Deal Simple value: name: Demand Tag Name demand_class: 12 demand_partner_id: 1 curator_fee_type: revshare demand_tag_priorities: - supply_tag_id: 1 rate: 1.11 demand_tag_marketplace_deal_create_full: summary: Marketplace Deal Full value: name: Demand Tag Name demand_class: 12 demand_partner_id: 1 player_sizes: - s - m - l format: video environment: desktop demand_tag_priorities: - supply_tag_id: 1 priority: 1 tier: 1 ratio: 1 marketplace_buyers: - inventory_source: '1' dsp_id: 1 buyer_ids: - 1 domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true demand_label_ids: - 1 rate: 1.11 rate_currency: USD curator_fee_type: revshare curator_fee_currency: USD curator_fees: - fee_value: 1.11 cpm_price: 1.11 cpm_currency: USD auction_type: first price budget_timezone: America/New_York daa_ad_choices: true device_id_required: true is_active: true note: Demand Tag note demand_tag_direct_io_line_item_create_simple: summary: Direct IO Line Item Simple value: name: Demand Tag Name demand_class: 14 demand_partner_id: 1 campaign_id: 1 direct_io_supply_partner_id: 1 rate: 1.11 demand_tag_direct_io_line_item_create_full: summary: Direct IO Line Item Full value: name: Demand Tag Name demand_class: 14 demand_partner_id: 1 campaign_id: 1 creative_id: 1 direct_io_supply_partner_id: 1 player_sizes: - s - m - l format: video environment: desktop line_item_ratios: - creative_id: 1 ratio: 1 domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true demand_label_ids: - 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 budget_timezone: America/New_York guaranteed_delivery: false start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York daa_ad_choices: true device_id_required: true is_reserved: false is_active: true note: Demand Tag note demand_tag_update_simple: summary: Simple value: name: Demand Tag Name rate: 1.11 is_active: true demand_tag_update_full: summary: Full value: name: Demand Tag Name campaign_id: 1 creative_id: 1 player_sizes: - s - m - l environment: desktop domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 budget_timezone: America/New_York non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD advanced_floor_rules: - dimension: adomain values: - example.com floor_price: 1.11 daa_ad_choices: true device_id_required: true is_reserved: false is_active: true note: Demand Tag note demand_partner_create_simple: summary: Simple value: name: Demand Partner Name demand_partner_create_full: summary: Full value: name: Demand Partner Name code: dp_code secondary_code: dp_secondary_code default_tier: 1 creative_landing_page_url: https://ad.example.com/landing third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false nielsen_dar_active: false nielsen_traf_cid: '1' nielsen_custom_param_value: '1' audited_creative_statuses: [] sequential_liability_approved: false targeting_spend_profile: budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: impressions budget_value: 1 budget_pacing: smooth targeting_time_profile: start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: false frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve targeting_geo_profile: country_source: list country_white_list: true country_codes: - US country_list_ids: - 1 targeting_page_attribute_profile: domain_white_list: true domain_list_ids: - 1 app_name_white_list: true app_name_list_ids: - 1 app_bundle_white_list: true app_bundle_list_ids: - 1 ip_white_list: true ip_list_ids: - 1 daa_ad_choices: false euro_daa_ad_choices: false segment_targeting_enabled: false competitive_exclusions_enabled: false competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 advertiser_domain_white_list: true advertiser_domain_list_ids: - 1 blocking_unknown_advertiser_domains: false tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image non_billable_fees: - cost_basis: impressions value: '1.11' currency: USD account_manager_ids: - 1 note: Demand Partner note demand_partner_update_simple: summary: Simple value: name: Demand Partner Name demand_partner_update_full: summary: Full value: name: Demand Partner Name code: dp_code secondary_code: dp_secondary_code default_tier: 1 creative_landing_page_url: https://ad.example.com/landing third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false nielsen_dar_active: false nielsen_traf_cid: '1' nielsen_custom_param_value: '1' audited_creative_statuses: [] targeting_spend_profile: budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: impressions budget_value: 1 budget_pacing: smooth targeting_time_profile: start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: false frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve targeting_geo_profile: country_source: list country_white_list: true country_codes: - US country_list_ids: - 1 targeting_page_attribute_profile: domain_white_list: true domain_list_ids: - 1 app_name_white_list: true app_name_list_ids: - 1 app_bundle_white_list: true app_bundle_list_ids: - 1 ip_white_list: true ip_list_ids: - 1 daa_ad_choices: false euro_daa_ad_choices: false segment_targeting_enabled: false competitive_exclusions_enabled: false competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 advertiser_domain_white_list: true advertiser_domain_list_ids: - 1 blocking_unknown_advertiser_domains: false tag_pixels: - id: 1 pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image non_billable_fees: - id: 1 cost_basis: impressions value: '1.11' currency: USD account_manager_ids: - 1 note: Demand Partner note demand_label_create_simple: summary: Simple value: name: Demand Label Name demand_label_create_full: summary: Full value: name: Demand Label Name demand_tag_ids: - 1 demand_label_update_simple: summary: Simple value: name: Demand Label Name demand_label_update_full: summary: Full value: name: Demand Label Name demand_tag_ids: - 1 demand_forecast_create_simple: summary: Simple value: name: Demand Forecast Name start_date: '2026-10-01' end_date: '2026-10-31' flight_dates_timezone: Etc/UTC show_max_availability: true supply_type: run_of_network demand_forecast_create_full: summary: Full value: name: Demand Forecast Name description: Demand Forecast description tier: 1 supply_targeting_source: tags supply_type: include supply_format: video include_inactive_tags: false selected_supply: - 1 start_date: '2026-10-01' end_date: '2026-10-31' flight_dates_timezone: Etc/UTC show_max_availability: false player_sizes: - s - m - l country_source: list country_list_ids: - 1 state_source: list state_list_ids: - 1 metro_area_source: list metro_area_list_ids: - 1 city_source: list city_list_ids: - 1 postal_code_source: list postal_code_list_ids: - 1 user_agent_devices: - '1' segment_targeting_enabled: true segment_groups: - group: '1' white_list: true segment_group_type: audiences segment_ids: - 1 partner_segment_ids: - 1 targeted_macros_enabled: true targeted_macros: - macro_param: '1' list_type: white_list param_required: true source_type: values group: '1' targeted_values: - '1' parameter_list_ids: - 1 key_value_targeting: true targeting_keys: - key_id: 1 list_type: white_list group: '1' targeting_key_type: list key_required: true value_ids: - 1 frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve estimated_cpm: 1.11 budget: budget_metric: revenue budget_period: month budget_value: 1.11 budget_pacing: smooth demand_forecast_update_simple: summary: Simple value: name: Demand Forecast Name start_date: '2026-10-01' end_date: '2026-10-31' flight_dates_timezone: Etc/UTC show_max_availability: true demand_forecast_update_full: summary: Full value: name: Demand Forecast Name description: Demand Forecast description tier: 1 supply_targeting_source: tags supply_type: include supply_format: video include_inactive_tags: false selected_supply: - 1 start_date: '2026-10-01' end_date: '2026-10-31' flight_dates_timezone: Etc/UTC show_max_availability: false player_sizes: - s - m - l country_source: list country_list_ids: - 1 segment_targeting_enabled: true segment_groups: - group: '1' white_list: true segment_group_type: audiences segment_ids: - 1 key_value_targeting: true targeting_keys: - key_id: 1 list_type: white_list group: '1' targeting_key_type: list key_required: true value_ids: - 1 estimated_cpm: 1.11 budget: budget_metric: revenue budget_period: month budget_value: 1.11 budget_pacing: smooth delivery_modifier_create_simple: summary: Simple value: name: Delivery Modifier Name multiplier_interaction: stacked modifier_rules: - modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US delivery_modifier_create_full: summary: Full value: name: Delivery Modifier Name description: Delivery Modifier Description active: true multiplier_interaction: stacked day_parting_users_timezone: false demand_tag_ids: - 1 modifier_rules: - modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US - modifier_rule_object: DeviceType source_type: values multiplier: '0.90' user_agent_devices: - CTV - modifier_rule_object: DomainList source_type: list multiplier: '1.05' domain_list_ids: - 1 delivery_modifier_update_simple: summary: Simple value: name: Delivery Modifier Name active: true delivery_modifier_update_full: summary: Full value: name: Delivery Modifier Name description: Delivery Modifier Description active: true multiplier_interaction: stacked day_parting_users_timezone: false demand_tag_ids: - 1 modifier_rules: - id: 1 modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US - modifier_rule_object: DeviceType source_type: values multiplier: '0.90' user_agent_devices: - CTV - modifier_rule_object: DomainList source_type: list multiplier: '1.05' domain_list_ids: - 1 deal_list_create_simple: summary: Simple value: name: Deal List Name deal_list_create_full: summary: Full value: name: Deal List Name description: Deal list description is_active: true deals: - 1 deal_list_update_simple: summary: Simple value: name: Deal List Name deal_list_update_full: summary: Full value: name: Deal List Name description: Deal list description is_active: true deals: - 1 deal_list_deals_bulk_create_single: summary: Single value: deals: - 1 deal_list_deals_bulk_create_multiple: summary: Multiple value: deals: - 1 - 2 - 3 deal_list_deals_bulk_replace_single: summary: Single value: deals: - 1 deal_list_deals_bulk_replace_multiple: summary: Multiple value: deals: - 1 - 2 - 3 deal_list_bulk_update_single: summary: Single value: is_active: true object_ids: - 1 deal_list_bulk_update_multiple: summary: Multiple value: is_active: true object_ids: - 1 - 2 curated_marketplace_create_simple: summary: Simple value: name: Curated Marketplace Name supply_partner_id: 1 rate: 1.11 curated_marketplace_create_full: summary: Full value: name: Curated Marketplace Name supply_partner_id: 1 selling_strategy_name: Selling Strategy Name revenue_model_type: 0 rate: 1.11 rate_currency: USD supply_tag_type: 1 bulk_add_enabled: true rpm_floor: 1.11 optimization_active: false optimization_learn_pct: 1 optimization_version: 1 optimization_mode: black_box optimization_settings: metric: fill_rate lookback_minutes: '60' supply_allocation: 1 custom_supply_allocation: false waterfall_management: demand_tag is_country_white_list: true country_codes: - US obfuscate_ip_address_enabled: false obfuscate_latlon_enabled: false tier_breakout_enabled: false note: note is_active: true curated_marketplace_update_simple: summary: Simple value: name: Curated Marketplace Name is_active: true curated_marketplace_update_full: summary: Full value: name: Curated Marketplace Name selling_strategy_name: Selling Strategy Name rate: 1.11 rate_currency: USD bulk_add_enabled: true rpm_floor: 1.11 optimization_active: false optimization_learn_pct: 1 optimization_version: 1 optimization_mode: black_box optimization_settings: metric: fill_rate lookback_minutes: '60' supply_allocation: 1 custom_supply_allocation: false waterfall_management: demand_tag is_country_white_list: true country_codes: - US obfuscate_ip_address_enabled: false obfuscate_latlon_enabled: false tier_breakout_enabled: false note: note is_active: true creative_bulk_update_many_single: summary: Single value: - id: 1 name: Creative Name is_active: true creative_bulk_update_many_multiple: summary: Multiple value: - id: 1 name: Creative Name is_active: true - id: 2 name: Creative Name is_active: false country_list_create_simple: summary: Simple value: name: Country List Name country_codes: - AL - AD country_list_create_full: summary: Full value: name: Country List Name description: Country List Description active: true country_codes: - AL - AD country_list_update_simple: summary: Simple value: name: Country List Name country_list_update_full: summary: Full value: name: Country List Name description: Country List Description active: true country_codes: - UA - US list_action: append clearline_rtd_signal_create_simple: summary: Simple value: value: Some RTD Signal String clearline_rtd_signal_create_full: summary: Full value: value: Some RTD Signal String is_active: true clearline_rtd_signal_update_simple: summary: Simple value: value: Updated RTD Signal clearline_rtd_signal_update_full: summary: Full value: value: Updated RTD Signal is_active: false clearline_forecast_simple: summary: Minimum required params value: name: A ClearLine Forecast inventory_groups: - group: '1' list_type: white_list source_type: values inventory_object: DealList inventory_values: - 1 - 5 - 9 custom_dates: summary: Custom Lookback Dates value: name: A ClearLine Forecast lookback_date: custom start_date: '2026-07-01' end_date: '2026-07-07' inventory_groups: - group: '1' list_type: white_list source_type: values inventory_object: DealList inventory_values: - 1 - 5 - 9 breakdown: summary: Results Breakdown value: name: A ClearLine Forecast lookback_date: last_7_days breakdown_type: dma inventory_groups: - group: '1' list_type: white_list source_type: values inventory_object: DealList inventory_values: - 1 - 5 - 9 clearline_forecast_full_targeting: summary: All Targeting Params value: name: A ClearLine Forecast lookback_date: last_7_days description: This is a detailed Clearline Forecast example country_targeting: Exclude country_source: list country_list_ids: - 16 - 21 state_targeting: Include state_source: values state_codes: - US-AR - US-CO metro_area_targeting: Include metro_area_source: list metro_area_list_ids: - 18 - 23 postal_code_targeting: Include postal_code_source: values postal_codes: - '12345' - '67890' - AB:123 domain_list_ids: - 1 app_bundle_list_ids: - 1 app_name_list_ids: - 1 domain_targeting: Allowlist app_bundle_targeting: Blocklist app_name_targeting: Allowlist inventory_groups: - group: '1' list_type: white_list source_type: values inventory_object: DealList inventory_values: - 9 - group: '1' list_type: black_list source_type: values inventory_object: AppBundleList inventory_values: - some app bundle - some other app bundle - group: '2' list_type: white_list source_type: list inventory_object: DealList deal_list_ids: - 4 - 9 user_agent_devices: - Computer - Mobile Web - CTV segment_targeting_enabled: true device_id_required: true segment_groups: - group: '1' white_list: true segment_group_type: partner_segments partner_segment_ids: - 1789 - 2026 - 2769 - 4349 clearline_deal_create_simple: summary: Simple value: name: ClearLine Deal Name deal_setting: auction_type: pg external_deal_id: EXT-DEAL-1 gross_rate: 1.11 is_active: true clearline_deal_create_full: summary: Full value: name: ClearLine Deal Name deal_setting: auction_type: fixed_price external_deal_id: EXT-DEAL-1 gross_rate: 1.11 gross_rate_currency: USD timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' booked_imps: 1 ssp: magnite_streaming is_active: true pending: false note: ClearLine Deal note clearline_deal_update_simple: summary: Simple value: name: ClearLine Deal Name is_active: true clearline_deal_update_full: summary: Full value: name: ClearLine Deal Name deal_setting: id: 1 external_deal_id: EXT-DEAL-1 auction_type: fixed_price gross_rate: 1.11 gross_rate_currency: USD timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' booked_imps: 1 ssp: magnite_streaming is_active: true pending: false note: ClearLine Deal note clearline_deal_bulk_update_single: summary: Single value: is_active: true object_ids: - 1 clearline_deal_bulk_update_multiple: summary: Multiple value: is_active: true object_ids: - 1 - 2 clearline_deal_breakdown_single: summary: Single value: object_ids: - 1 clearline_deal_breakdown_multiple: summary: Multiple value: object_ids: - 1 - 2 city_list_create_simple: summary: Simple value: name: City List Name city_codes: - 2988507 - 2643743 city_list_create_full: summary: Full value: name: City List Name description: City List Description active: true city_codes: - 2988507 - 2643743 city_list_update_simple: summary: Simple value: name: City List Name city_list_update_full: summary: Full value: name: City List Name description: City List Description active: true city_codes: - 2988507 - 2643743 list_action: append campaign_bulk_update_many_single: summary: Single value: - id: 1 name: Campaign Name is_active: true campaign_bulk_update_many_multiple: summary: Multiple value: - id: 1 name: Campaign Name rate: 1.11 is_active: true - id: 2 name: Campaign Name rate: 1.11 is_active: false campaign_bulk_update_same_single: summary: Single value: object_ids: - 1 is_active: true campaign_bulk_update_same_multiple: summary: Multiple value: object_ids: - 1 - 2 is_active: false campaign_managed_create_simple: summary: Managed Simple value: name: Campaign Name demand_partner_id: 1 has_rate: true rate: 1.11 campaign_managed_create_full: summary: Managed Full value: name: Campaign Name demand_partner_id: 1 code: '1' secondary_code: '1' has_rate: true rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 partner_tier_override_enabled: true partner_tier_override: '1' demand_tiering: false guaranteed_delivery: false guaranteed_tier: '1' audited_creative_statuses: - approved demand_tag_ids: - 1 set_campaign_tiers: - supply_tag_id: 1 tier: 1 slot_order: '1' slot_number: 1 tiles_screen_deduplication: false third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel mediaocean_prisma_enabled: false mediaocean_prisma_order_id: '1' mediaocean_prisma_campaign_id: '1' mediaocean_prisma_placement_id: '1' mediaocean_prisma_campaign_link: https://prisma.example.com/campaign is_active: true note: Campaign note campaign_direct_connect_create_simple: summary: Direct Connect Simple value: name: Campaign Name demand_partner_id: 1 has_rate: false campaign_direct_connect_create_full: summary: Direct Connect Full value: name: Campaign Name demand_partner_id: 1 code: '1' secondary_code: '1' has_rate: false partner_tier_override_enabled: true partner_tier_override: '1' guaranteed_delivery: false guaranteed_tier: '1' audited_creative_statuses: - approved demand_tag_ids: - 1 set_campaign_tiers: - supply_tag_id: 1 tier: 1 slot_order: '1' slot_number: 1 tiles_screen_deduplication: false third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel is_active: true note: Campaign note campaign_tiles_dedup_create_simple: summary: Tiles Screen Deduplication Simple value: name: Campaign Name demand_partner_id: 1 has_rate: true rate: 1.11 tiles_screen_deduplication: true max_bids_per_screen: 1 campaign_tiles_dedup_create_full: summary: Tiles Screen Deduplication Full value: name: Campaign Name demand_partner_id: 1 code: '1' secondary_code: '1' has_rate: true rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 partner_tier_override_enabled: true partner_tier_override: '1' guaranteed_delivery: false guaranteed_tier: '1' audited_creative_statuses: - approved demand_tag_ids: - 1 set_campaign_tiers: - supply_tag_id: 1 tier: 1 slot_order: '1' slot_number: 1 tiles_screen_deduplication: true max_bids_per_screen: 1 third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel is_active: true note: Campaign note campaign_update_simple: summary: Simple value: name: Campaign Name rate: 1.11 is_active: true campaign_update_full: summary: Full value: name: Campaign Name demand_partner_id: 1 code: '1' secondary_code: '1' has_rate: true rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 partner_tier_override_enabled: true partner_tier_override: '1' guaranteed_delivery: false guaranteed_tier: '1' audited_creative_statuses: - approved demand_tag_ids: - 1 set_campaign_tiers: - supply_tag_id: 1 tier: 1 slot_order: '1' slot_number: 1 tiles_screen_deduplication: false third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel is_active: true note: Campaign note bill_create_simple: summary: Simple value: name: Bill Name month: '2026-01-01' currency: USD is_invoice: false is_direct_connect: false is_openrtb: false bill_create_full: summary: Full value: name: Bill Name month: '2026-01-01' currency: USD is_invoice: false is_direct_connect: false is_openrtb: false is_finalized: false bill_update_simple: summary: Simple value: name: Bill Name bill_update_full: summary: Full value: name: Bill Name month: '2026-01-01' currency: USD is_invoice: false is_direct_connect: false is_openrtb: false is_finalized: false bid_modifier_create_simple: summary: Simple value: name: Bid Modifier Name multiplier_interaction: stacked modifier_rules: - modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US bid_modifier_create_full: summary: Full value: name: Bid Modifier Name description: Bid Modifier Description active: true multiplier_interaction: stacked day_parting_users_timezone: false demand_tag_ids: - 1 modifier_rules: - modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US - modifier_rule_object: DeviceType source_type: values multiplier: '0.90' user_agent_devices: - CTV - modifier_rule_object: DomainList source_type: list multiplier: '1.05' domain_list_ids: - 1 bid_modifier_update_simple: summary: Simple value: name: Bid Modifier Name active: true bid_modifier_update_full: summary: Full value: name: Bid Modifier Name description: Bid Modifier Description active: true multiplier_interaction: stacked day_parting_users_timezone: false demand_tag_ids: - 1 modifier_rules: - id: 1 modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US - modifier_rule_object: DeviceType source_type: values multiplier: '0.90' user_agent_devices: - CTV - modifier_rule_object: DomainList source_type: list multiplier: '1.05' domain_list_ids: - 1 audio_creative_create_simple: summary: Simple value: name: Audio Creative Name demand_partner_id: 1 creative_remote_url: https://example.com/audio.mp3 audio_creative_create_full: summary: Full value: name: Audio Creative Name demand_partner_id: 1 creative_remote_url: https://example.com/audio.mp3 code: audio-code secondary_code: audio-secondary advertiser_domain: example.com iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_source: list country_list_ids: - 1 state_source: list state_list_ids: - 1 city_source: list city_list_ids: - 1 metro_area_source: list metro_area_list_ids: - 1 postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true targeted_macros_enabled: true all_user_agent_devices: true all_user_agent_operating_systems: true all_user_agent_browsers: true all_user_agent_brands: true budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: true tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image is_active: true audio_creative_update_simple: summary: Simple value: name: Audio Creative Name is_active: true audio_creative_update_full: summary: Full value: name: Audio Creative Name code: audio-code secondary_code: audio-secondary advertiser_domain: example.com iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_source: list country_list_ids: - 1 state_source: list state_list_ids: - 1 city_source: list city_list_ids: - 1 metro_area_source: list metro_area_list_ids: - 1 postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true targeted_macros_enabled: true all_user_agent_devices: true all_user_agent_operating_systems: true all_user_agent_browsers: true all_user_agent_brands: true budget_timezone: America/New_York budgets: - budget_period: day budget_metric: impressions budget_value: 1 budget_pacing: smooth start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: true tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image is_active: true app_name_list_create_simple: summary: Simple value: name: App Name List Name app_name_list_create_full: summary: Full value: name: App Name List Name description: App Name List Description partial_match: false is_active: true app_name_list_update_simple: summary: Simple value: name: App Name List Name is_active: true app_name_list_update_full: summary: Full value: name: App Name List Name description: App Name List Description partial_match: false is_active: true app_name_list_bulk_update_single: summary: Single value: is_active: true object_ids: - 1 app_name_list_bulk_update_multiple: summary: Multiple value: is_active: true object_ids: - 1 - 2 app_name_list_names_bulk_single: summary: Single value: app_names: - Example App Name app_name_list_names_bulk_multiple: summary: Multiple value: app_names: - Example App Name - Another App Name - Third App Name app_bundle_list_create_simple: summary: Simple value: name: App Bundle List Name app_bundle_list_create_full: summary: Full value: name: App Bundle List Name description: App Bundle List Description partial_match: false is_active: true app_bundle_list_update_simple: summary: Simple value: name: App Bundle List Name is_active: true app_bundle_list_update_full: summary: Full value: name: App Bundle List Name description: App Bundle List Description partial_match: false is_active: true app_bundle_list_bundles_bulk_single: summary: Single value: app_bundles: - com.example.app app_bundle_list_bundles_bulk_multiple: summary: Multiple value: app_bundles: - com.example.app - com.example.app2 - com.example.app3 anomaly_create_simple: summary: Simple value: metric: impressions anomaly_points: - datetime: '2025-02-10T12:00:00Z' value: 1 anomaly_create_full: summary: Full value: account_id: 1 metric: impressions dimensions: supply_partner_id: '1' anomaly_points: - datetime: '2025-02-10T12:00:00Z' value: 1 - datetime: '2025-02-11T12:00:00Z' value: 1 anomaly_update_simple: summary: Simple value: metric: usable_requests anomaly_update_full: summary: Full value: account_id: 1 metric: usable_requests dimensions: supply_partner_id: '1' anomaly_points: - datetime: '2025-02-10T12:00:00Z' value: 1 advertiser_domain_list_create_simple: summary: Simple value: name: Advertiser Domain List Name advertiser_domain_list_create_full: summary: Full value: name: Advertiser Domain List Name description: Advertiser Domain List Description active: true advertiser_domain_list_update_simple: summary: Simple value: name: Advertiser Domain List Name active: true advertiser_domain_list_update_full: summary: Full value: name: Advertiser Domain List Name description: Advertiser Domain List Description active: true advertiser_domain_list_domains_bulk_single: summary: Single value: names: - example1.com advertiser_domain_list_domains_bulk_multiple: summary: Multiple value: names: - example1.com - example2.com - example3.com account_publisher_create_simple: summary: Publisher Simple value: name: Account Name platform_type: publisher account_type_id: 1 reporting_view: publisher net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' multicall_max: 2 dsp_bidder_fee_type: cpm ssp_bidder_fee_type: cpm oem_bidder_fee_type: cpm tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 cdn_fee: 1.11 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_publisher_create_full: summary: Publisher Full value: name: Account Name platform_type: publisher account_type_id: 1 reporting_view: publisher website_url: https://account.example.com email: account@example.com phone: '1' salesforce_id: '1' salesforce_contract_terms_id: '1' account_manager_id: 1 technical_account_manager_id: 1 account_owner_id: 1 daily_impression_goal: 1 is_test: false spotx_joint_solution_enabled: false net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' contract_term_months: 1 minimum_commencement_date: '2026-01-01' credit_limit: 1 digital_payment_customer: false monthly_minimum: 1 multicall_max: 2 direct_connect_enabled: true video_enabled: true cdn_fee: 1.11 cdn_fee_type: cpg player_fee: 1.11 pmp_revshare_rate: 1 house_ads_enabled: true house_ads_cpm_fee: 1.11 tile_house_ads_cpm_fee: 1.11 creative_review: true creative_audit_status_targeting: true support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' dsp_bidder_fee_type: cpm dsp_bidder_fee_value: 1.11 ssp_bidder_fee_type: cpm ssp_bidder_fee_value: 1.11 oem_bidder_fee_type: cpm oem_bidder_fee_value: 1.11 management_fee_type: cpm management_fee_value: 1.11 white_label_fee: 1.11 white_label_fee_commencement_date: '2026-01-01' server_side_hb_enabled: false fees_a_la_carte_enabled: false infrastructure_fee_type: none infrastructure_fill_cutoff: 1 infrastructure_cpm_fee: 1.11 partner_segments_enabled: true partner_segment_markups: - vendor_id: 1 markup_pct: 1.11 log_level_impressions: disabled tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 pods_enabled: true campaign_waterfall_management_enabled: true multi_currency_enabled: true default_currency: USD quickstats_currencies: - EUR vast_qps_enabled: false guaranteed_delivery: true tiles_response_type_enabled: true support_clearcast_clock_id: true deal_bypass_and_pass_through_enabled: true beta_features: [] dma_reporting_enabled: true state_reporting_enabled: true key_value_keys_limit: 1 key_value_values_limit: 1 is_active: true display_in_dropdown: true server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_dsp_main_create_simple: summary: DSP Main Simple value: name: Account Name platform_type: dsp_main account_type_id: 1 reporting_view: dsp_main net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' multicall_max: 2 dsp_bidder_fee_type: cpm ssp_bidder_fee_type: cpm oem_bidder_fee_type: cpm tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 cdn_fee: 1.11 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_dsp_main_create_full: summary: DSP Main Full value: name: Account Name platform_type: dsp_main account_type_id: 1 reporting_view: dsp_main website_url: https://account.example.com email: account@example.com account_manager_id: 1 account_owner_id: 1 is_test: false net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' contract_term_months: 1 minimum_commencement_date: '2026-01-01' monthly_minimum: 1 multicall_max: 2 direct_connect_enabled: true cdn_fee: 1.11 cdn_fee_type: cpg player_fee: 1.11 pmp_revshare_rate: 1 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' dsp_bidder_fee_type: cpm dsp_bidder_fee_value: 1.11 ssp_bidder_fee_type: cpm ssp_bidder_fee_value: 1.11 oem_bidder_fee_type: cpm oem_bidder_fee_value: 1.11 management_fee_type: cpm management_fee_value: 1.11 tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 create_sub_accounts_enabled: true demand_partner_expansion_enabled: true advertiser_domain_required: true mediaocean_prisma_enabled: true cl_budget_allocations_enabled: true creative_pre_approval_enabled: true creative_pre_approval_publishers: - 1 multi_currency_enabled: true default_currency: USD quickstats_currencies: - EUR dma_reporting_enabled: true state_reporting_enabled: true is_active: true display_in_dropdown: true server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_dsp_sub_create_simple: summary: DSP Sub Simple value: name: Account Name platform_type: dsp_sub account_type_id: 1 reporting_view: dsp_sub net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' minimum_commencement_date: '2026-01-01' support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' multicall_max: 2 dsp_bidder_fee_type: cpm ssp_bidder_fee_type: cpm oem_bidder_fee_type: cpm tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 cdn_fee: 1.11 server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_dsp_sub_create_full: summary: DSP Sub Full value: name: Account Name platform_type: dsp_sub account_type_id: 1 reporting_view: dsp_sub website_url: https://account.example.com email: account@example.com account_manager_id: 1 account_owner_id: 1 is_test: false net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' contract_term_months: 1 minimum_commencement_date: '2026-01-01' monthly_minimum: 1 multicall_max: 2 cdn_fee: 1.11 cdn_fee_type: cpg player_fee: 1.11 pmp_revshare_rate: 1 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' dsp_bidder_fee_type: cpm dsp_bidder_fee_value: 1.11 ssp_bidder_fee_type: cpm ssp_bidder_fee_value: 1.11 oem_bidder_fee_type: cpm oem_bidder_fee_value: 1.11 management_fee_type: cpm management_fee_value: 1.11 tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 demand_partner_expansion_enabled: true advertiser_domain_required: true mediaocean_prisma_enabled: true cl_budget_allocations_enabled: true creative_pre_approval_enabled: true creative_pre_approval_publishers: - 1 support_long_names_enabled: true multi_currency_enabled: true default_currency: USD quickstats_currencies: - EUR dma_reporting_enabled: true state_reporting_enabled: true unrestricted_external_reports: true is_active: true display_in_dropdown: true server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_clearline_sub_create_simple: summary: ClearLine Sub Simple value: name: Account Name platform_type: dsp_sub account_type_id: 1 reporting_view: dsp_sub net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' minimum_commencement_date: '2026-01-01' support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' multicall_max: 2 dsp_bidder_fee_type: cpm ssp_bidder_fee_type: cpm oem_bidder_fee_type: cpm cl_direct_ios_enabled: true tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 cdn_fee: 1.11 server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_clearline_sub_create_full: summary: ClearLine Sub Full value: name: Account Name platform_type: dsp_sub account_type_id: 1 reporting_view: dsp_sub website_url: https://account.example.com email: account@example.com account_manager_id: 1 account_owner_id: 1 is_test: false net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' contract_term_months: 1 minimum_commencement_date: '2026-01-01' monthly_minimum: 1 multicall_max: 2 cdn_fee: 1.11 cdn_fee_type: cpg player_fee: 1.11 pmp_revshare_rate: 1 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' dsp_bidder_fee_type: cpm dsp_bidder_fee_value: 1.11 ssp_bidder_fee_type: cpm ssp_bidder_fee_value: 1.11 oem_bidder_fee_type: cpm oem_bidder_fee_value: 1.11 management_fee_type: cpm management_fee_value: 1.11 tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 cl_direct_ios_enabled: true cl_tiles_enabled: true cl_open_auction_enabled: true cl_budget_caps_enabled: true cl_budget_allocations_enabled: true cl_management_fee_enabled: true cl_request_fcaps_enabled: true netflix_pre_approval_enabled: true support_long_names_enabled: true multi_currency_enabled: true default_currency: USD quickstats_currencies: - EUR dma_reporting_enabled: true state_reporting_enabled: true unrestricted_external_reports: true is_active: true display_in_dropdown: true server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_curator_main_create_simple: summary: Curator Main Simple value: name: Account Name platform_type: curator_main account_type_id: 1 reporting_view: curator_main net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' multicall_max: 2 dsp_bidder_fee_type: cpm ssp_bidder_fee_type: cpm oem_bidder_fee_type: cpm tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 cdn_fee: 1.11 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_curator_main_create_full: summary: Curator Main Full value: name: Account Name platform_type: curator_main account_type_id: 1 reporting_view: curator_main website_url: https://account.example.com email: account@example.com account_manager_id: 1 account_owner_id: 1 is_test: false net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' contract_term_months: 1 minimum_commencement_date: '2026-01-01' monthly_minimum: 1 multicall_max: 2 cdn_fee: 1.11 cdn_fee_type: cpg player_fee: 1.11 pmp_revshare_rate: 1 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' dsp_bidder_fee_type: cpm dsp_bidder_fee_value: 1.11 ssp_bidder_fee_type: cpm ssp_bidder_fee_value: 1.11 oem_bidder_fee_type: cpm oem_bidder_fee_value: 1.11 management_fee_type: cpm management_fee_value: 1.11 tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 multi_currency_enabled: true default_currency: USD quickstats_currencies: - EUR dma_reporting_enabled: true state_reporting_enabled: true is_active: true display_in_dropdown: true server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_curator_sub_create_simple: summary: Curator Sub Simple value: name: Account Name platform_type: curator_sub account_type_id: 1 reporting_view: curator_sub net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' minimum_commencement_date: '2026-01-01' support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' multicall_max: 2 dsp_bidder_fee_type: cpm ssp_bidder_fee_type: cpm oem_bidder_fee_type: cpm tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 cdn_fee: 1.11 server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_curator_sub_create_full: summary: Curator Sub Full value: name: Account Name platform_type: curator_sub account_type_id: 1 reporting_view: curator_sub website_url: https://account.example.com email: account@example.com account_manager_id: 1 account_owner_id: 1 is_test: false net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' contract_term_months: 1 minimum_commencement_date: '2026-01-01' monthly_minimum: 1 multicall_max: 2 cdn_fee: 1.11 cdn_fee_type: cpg player_fee: 1.11 pmp_revshare_rate: 1 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' dsp_bidder_fee_type: cpm dsp_bidder_fee_value: 1.11 ssp_bidder_fee_type: cpm ssp_bidder_fee_value: 1.11 oem_bidder_fee_type: cpm oem_bidder_fee_value: 1.11 management_fee_type: cpm management_fee_value: 1.11 tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 multi_currency_enabled: true default_currency: USD quickstats_currencies: - EUR dma_reporting_enabled: true state_reporting_enabled: true is_active: true display_in_dropdown: true server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_external_bidder_create_simple: summary: External Bidder Simple value: name: Account Name platform_type: publisher account_type_id: 1 reporting_view: network net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' multicall_max: 2 dsp_bidder_fee_type: cpm ssp_bidder_fee_type: cpm oem_bidder_fee_type: cpm openrtb_enabled: true openrtb_buyer_fee_type: revshare openrtb_buyer_fee_value: 1.11 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_external_bidder_create_full: summary: External Bidder Full value: name: Account Name platform_type: publisher account_type_id: 1 reporting_view: network website_url: https://account.example.com email: account@example.com account_manager_id: 1 account_owner_id: 1 is_test: false net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' contract_term_months: 1 multicall_max: 2 cdn_fee: 1.11 cdn_fee_type: cpg player_fee: 1.11 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' dsp_bidder_fee_type: cpm ssp_bidder_fee_type: cpm oem_bidder_fee_type: cpm openrtb_enabled: true openrtb_buyer_fee_type: revshare openrtb_buyer_fee_value: 1.11 openrtb_buyer_requires_user_id: true openrtb_buyer_timeout: 600 openrtb_hosting_user_mapping: true openrtb_sync_url: https://account.example.com/sync account_usersync_weights: - sync_on_account_id: 1 weight: 1 is_active: true display_in_dropdown: true server_side_hb_fee: 1.11 server_side_hb_fee_commencement_date: '2026-01-01' account_update_simple: summary: Simple value: name: Account Name is_active: true account_update_full: summary: Full value: name: Account Name website_url: https://account.example.com email: account@example.com account_manager_id: 1 account_owner_id: 1 daily_impression_goal: 1 net_payable_term: 1 net_receivable_term: 1 contract_commencement_date: '2026-01-01' contract_term_months: 1 credit_limit: 1 multicall_max: 2 cdn_fee: 1.11 player_fee: 1.11 pmp_revshare_rate: 1 support_level: level_1 support_fee: 1.11 support_commencement_date: '2026-01-01' dsp_bidder_fee_type: cpm ssp_bidder_fee_type: cpm oem_bidder_fee_type: cpm tier_a_active: true tier_a_cutoff_type: impressions tier_a_fees: - tier_fee_type: platform fee_type: cpm fee_value: 1.11 multi_currency_enabled: true default_currency: USD quickstats_currencies: - EUR is_active: true display_in_dropdown: true account_bulk_update_single: summary: Single value: - id: 1 name: Account Name is_active: true account_bulk_update_multiple: summary: Multiple value: - id: 1 name: Account Name is_active: true - id: 2 name: Account Name daily_impression_goal: 1 account_bulk_connect_curators_one: summary: Connect One value: other_account_ids: - 1 account_bulk_connect_curators_many: summary: Connect Many value: other_account_ids: - 1 - 2 account_bulk_connect_dsps_one: summary: Connect One value: other_account_ids: - 1 account_bulk_connect_dsps_many: summary: Connect Many value: other_account_ids: - 1 - 2 account_bulk_set_dc_visibility_one: summary: Single value: other_account_ids: - 1 account_bulk_set_dc_visibility_many: summary: Multiple value: other_account_ids: - 1 - 2 account_partner_segment_create_simple: summary: Create with required fields only value: partner_segment_id: 1 account_partner_segment_create_full: summary: Create with all fields value: partner_segment_id: 1 is_active: true account_partner_segment_update_simple: summary: Update active status only value: is_active: false account_partner_segment_update_full: summary: Update all mutable fields value: is_active: true account_partner_segment_bulk_update_single: summary: Bulk update a single segment value: object_ids: - 1 is_active: true account_partner_segment_bulk_update_multiple: summary: Bulk update multiple segments value: object_ids: - 1 - 2 is_active: true schemas: VideoCreativeBaseProperties: allOf: - type: object properties: name: type: string is_active: type: boolean default: true creative_remote_url: type: - string - 'null' code: type: - string - 'null' secondary_code: type: - string - 'null' line_item_demand_tag_ids: type: array items: type: number iab_tier_1_category_codes: type: array items: type: string iab_tier_2_category_codes: type: array items: type: string postal_codes: type: array items: type: string postal_code_list_ids: type: array items: type: number postal_code_source: type: string postal_code_white_list: type: string key_value_targeting: type: boolean targeted_macros_enabled: type: boolean all_user_agent_devices: type: boolean all_user_agent_operating_systems: type: boolean all_user_agent_browsers: type: boolean all_user_agent_brands: type: boolean budget_timezone: type: string budgets: type: array items: type: object day_parting: type: - array - 'null' items: type: array items: type: boolean day_parting_users_timezone: type: boolean advertiser_domain: type: - string - 'null' creative_landing_page_url: type: - string - 'null' - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/city_codes.yaml#/components/schemas/CityCodes - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandKeyValue - "$ref": ref/concerns/targeted_macro.yaml#/components/schemas/TargetedMacro - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates VideoCreativeUpdateData: "$ref": "#/components/schemas/VideoCreativeBaseProperties" VideoCreativeCreateData: allOf: - "$ref": "#/components/schemas/VideoCreativeBaseProperties" - type: object required: - demand_partner_id properties: demand_partner_id: type: number VideoCreativeResponse: allOf: - "$ref": "#/components/schemas/VideoCreativeBaseProperties" - type: object properties: id: type: integer account_id: type: integer demand_partner_id: type: integer creative_format: type: string type: type: string height: type: integer width: type: integer duration_seconds: type: number creative_file_name: type: string creative_content_type: type: string creative_file_size: type: integer creative_updated_at: type: string format: date-time netflix_pre_approval_enabled: type: boolean netflix_approval_status: type: - string - 'null' netflix_deal_ids: type: array items: type: string - "$ref": ref/concerns/timestamps.yaml#/components/schemas/Timestamps VideoCreativeIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: "$ref": "#/components/schemas/VideoCreativeResponse" TileCreativeBaseProperties: allOf: - type: object properties: name: type: string is_active: type: boolean default: true creative_remote_url: type: - string - 'null' creative_remote_urls: type: array items: type: string code: type: - string - 'null' secondary_code: type: - string - 'null' line_item_demand_tag_ids: type: array items: type: number iab_tier_1_category_codes: type: array items: type: string iab_tier_2_category_codes: type: array items: type: string postal_codes: type: array items: type: string postal_code_list_ids: type: array items: type: number postal_code_source: type: string postal_code_white_list: type: string key_value_targeting: type: boolean targeted_macros_enabled: type: boolean all_user_agent_devices: type: boolean all_user_agent_operating_systems: type: boolean all_user_agent_browsers: type: boolean all_user_agent_brands: type: boolean budget_timezone: type: string budgets: type: array items: type: object day_parting: type: - array - 'null' items: type: array items: type: boolean day_parting_users_timezone: type: boolean creative_landing_page_url: type: string width: type: integer height: type: integer custom_code: type: string overlay_text: type: string tiles_template: type: string enum: - clickable_image - clickable_video - custom - multimedia - ih_clicktoweb_iv - ih_clicktoweb - ih_clicktovideo_iv - ih_clicktovideo - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/city_codes.yaml#/components/schemas/CityCodes - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandKeyValue - "$ref": ref/concerns/targeted_macro.yaml#/components/schemas/TargetedMacro - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates TileCreativeUpdateData: "$ref": "#/components/schemas/TileCreativeBaseProperties" TileCreativeMultipartData: type: object required: - demand_partner_id - name - tiles_template - creative_landing_page_url properties: demand_partner_id: type: number description: ID of the demand partner (required) name: type: string description: Name of the creative (required) tiles_template: type: string enum: - clickable_image - clickable_video - custom - multimedia - ih_clicktoweb_iv - ih_clicktoweb - ih_clicktovideo_iv - ih_clicktovideo description: Select one of the available templates (required) creative_landing_page_url: type: string description: Landing page URL (required) creatives: type: array items: type: string format: binary description: File uploads in positional order, one per 'file' entry in creative_input_types is_active: type: boolean default: true description: Whether the creative is active (optional, defaults to true) TileCreativeCreateData: type: object required: - demand_partner_id - creative_landing_page_url - name - tiles_template properties: demand_partner_id: type: number name: type: string tiles_template: type: string enum: - clickable_image - clickable_video - custom - multimedia - ih_clicktoweb_iv - ih_clicktoweb - ih_clicktovideo_iv - ih_clicktovideo creative_landing_page_url: type: string creative_input_types: type: array default: [] items: type: string enum: - file - url description: 'One entry per asset slot indicating whether that position uses a file upload or URL. Order must match the template''s asset order (e.g. ih_clicktovideo: background, logo, full screen video, end card; ih_clicktovideo_iv: background, logo, immersion video, full screen video, end card).' creative_remote_urls: type: array items: type: string description: URLs in positional order, one per 'url' entry in creative_input_types is_active: type: boolean default: true TileCreativeResponse: allOf: - "$ref": "#/components/schemas/TileCreativeBaseProperties" - type: object properties: id: type: integer account_id: type: integer demand_partner_id: type: integer creative_format: type: string type: type: string creative_file_name: type: string creative_content_type: type: string creative_file_size: type: integer creative_updated_at: type: string format: date-time custom: type: boolean netflix_pre_approval_enabled: type: boolean netflix_approval_status: type: - string - 'null' netflix_deal_ids: type: array items: type: string - "$ref": ref/concerns/timestamps.yaml#/components/schemas/Timestamps TileCreativeIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: "$ref": "#/components/schemas/TileCreativeResponse" TagCreativeBaseProperties: allOf: - type: object properties: name: type: string is_active: type: boolean default: true vast_endpoint_url: type: string code: type: - string - 'null' secondary_code: type: - string - 'null' line_item_demand_tag_ids: type: array items: type: number iab_tier_1_category_codes: type: array items: type: string iab_tier_2_category_codes: type: array items: type: string postal_codes: type: array items: type: string postal_code_list_ids: type: array items: type: number postal_code_source: type: string postal_code_white_list: type: string key_value_targeting: type: boolean targeted_macros_enabled: type: boolean all_user_agent_devices: type: boolean all_user_agent_operating_systems: type: boolean all_user_agent_browsers: type: boolean all_user_agent_brands: type: boolean budget_timezone: type: string budgets: type: array items: type: object day_parting: type: - array - 'null' items: type: array items: type: boolean day_parting_users_timezone: type: boolean advertiser_domain: type: - string - 'null' creative_landing_page_url: type: - string - 'null' creative_format: type: string - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/city_codes.yaml#/components/schemas/CityCodes - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandKeyValue - "$ref": ref/concerns/targeted_macro.yaml#/components/schemas/TargetedMacro - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates TagCreativeUpdateData: "$ref": "#/components/schemas/TagCreativeBaseProperties" TagCreativeCreateData: allOf: - "$ref": "#/components/schemas/TagCreativeBaseProperties" - type: object required: - demand_partner_id properties: demand_partner_id: type: number TagCreativeResponse: allOf: - "$ref": "#/components/schemas/TagCreativeBaseProperties" - type: object properties: id: type: integer account_id: type: integer demand_partner_id: type: integer type: type: string netflix_pre_approval_enabled: type: boolean netflix_approval_status: type: - string - 'null' netflix_deal_ids: type: array items: type: string - "$ref": ref/concerns/timestamps.yaml#/components/schemas/Timestamps TagCreativeIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: "$ref": "#/components/schemas/TagCreativeResponse" streamingDemandTagPriority: type: object properties: streaming_id: type: integer description: ID of the unified-demand object in Magnite Streaming examples: - 92 streaming_type: type: string enum: - ad_source - supply_channel demand_tag_id: type: integer examples: - 47 priority: type: - integer - 'null' description: Priority within the supply tag's waterfall examples: - 0 SupplyRouterResponse: allOf: - type: object properties: id: type: integer examples: - 1 account_id: type: integer examples: - 1 name: type: string examples: - Supply Router Name supply_partner_id: type: integer examples: - 1 active: type: boolean examples: - true code: type: string key_ids: type: array items: type: integer note: type: string supply_router_ratios: type: array items: type: object properties: supply_tag_id: type: integer fallback_supply_tag_id: type: - integer - 'null' ratio: type: number custom_response: type: string created_at: type: string format: date-time updated_at: type: string format: date-time - "$ref": ref/concerns/advertiser_domain_list.yaml#/components/schemas/AdvertiserDomainList - "$ref": ref/concerns/app_bundle_list.yaml#/components/schemas/AppBundleList - "$ref": ref/concerns/app_name_list.yaml#/components/schemas/AppNameList - "$ref": ref/concerns/aspect_ratios.yaml#/components/schemas/AspectRatios - "$ref": ref/concerns/audited_creative_statuses_for_supply.yaml#/components/schemas/AuditedCreativeStatusesForSupply - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/domain_list.yaml#/components/schemas/DomainList - "$ref": ref/concerns/environment.yaml#/components/schemas/Environment - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates - "$ref": ref/concerns/format.yaml#/components/schemas/Format - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/ip_list.yaml#/components/schemas/IpList - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/player_sizes.yaml#/components/schemas/PlayerSizes - "$ref": ref/concerns/privacy_targeting.yaml#/components/schemas/PrivacyTargeting - "$ref": ref/concerns/scanned_creative_list.yaml#/components/schemas/ScannedCreativeList - "$ref": ref/concerns/segment_groups.yaml#/components/schemas/SegmentGroups - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - "$ref": ref/concerns/vendor_selection.yaml#/components/schemas/VendorSelection SupplyRouterCreateRequest: allOf: - "$ref": ref/concerns/advertiser_domain_list.yaml#/components/schemas/AdvertiserDomainList - "$ref": ref/concerns/app_bundle_list.yaml#/components/schemas/AppBundleList - "$ref": ref/concerns/app_name_list.yaml#/components/schemas/AppNameList - "$ref": ref/concerns/aspect_ratios.yaml#/components/schemas/AspectRatios - "$ref": ref/concerns/audited_creative_statuses_for_supply.yaml#/components/schemas/AuditedCreativeStatusesForSupply - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/domain_list.yaml#/components/schemas/DomainList - "$ref": ref/concerns/environment.yaml#/components/schemas/Environment - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates - "$ref": ref/concerns/format.yaml#/components/schemas/Format - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/ip_list.yaml#/components/schemas/IpList - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/player_sizes.yaml#/components/schemas/PlayerSizes - "$ref": ref/concerns/privacy_targeting.yaml#/components/schemas/PrivacyTargeting - "$ref": ref/concerns/scanned_creative_list.yaml#/components/schemas/ScannedCreativeList - "$ref": ref/concerns/segment_groups.yaml#/components/schemas/SegmentGroups - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - "$ref": ref/concerns/vendor_selection.yaml#/components/schemas/VendorSelection - type: object properties: supply_partner_id: type: integer examples: - 1 name: type: string description: The name of the supply router. examples: - Supply Router Name active: type: boolean examples: - true supply_router_ratios: type: array items: type: object properties: supply_tag_id: type: integer fallback_supply_tag_id: type: - integer - 'null' ratio: type: number custom_response: type: string required: - name - supply_partner_id SupplyRouterUpdateRequest: allOf: - "$ref": ref/concerns/advertiser_domain_list.yaml#/components/schemas/AdvertiserDomainList - "$ref": ref/concerns/app_bundle_list.yaml#/components/schemas/AppBundleList - "$ref": ref/concerns/app_name_list.yaml#/components/schemas/AppNameList - "$ref": ref/concerns/aspect_ratios.yaml#/components/schemas/AspectRatios - "$ref": ref/concerns/audited_creative_statuses_for_supply.yaml#/components/schemas/AuditedCreativeStatusesForSupply - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/domain_list.yaml#/components/schemas/DomainList - "$ref": ref/concerns/environment.yaml#/components/schemas/Environment - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/ip_list.yaml#/components/schemas/IpList - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/player_sizes.yaml#/components/schemas/PlayerSizes - "$ref": ref/concerns/privacy_targeting.yaml#/components/schemas/PrivacyTargeting - "$ref": ref/concerns/scanned_creative_list.yaml#/components/schemas/ScannedCreativeList - "$ref": ref/concerns/segment_groups.yaml#/components/schemas/SegmentGroups - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - "$ref": ref/concerns/vendor_selection.yaml#/components/schemas/VendorSelection - type: object properties: supply_partner_id: type: integer examples: - 1 name: type: string description: The name of the supply router. examples: - Supply Router Name active: type: boolean examples: - true supply_router_ratios: type: array items: type: object properties: supply_tag_id: type: integer fallback_supply_tag_id: type: - integer - 'null' ratio: type: number custom_response: type: string required: - name - supply_partner_id SupplyLabel: type: object properties: id: type: number account_id: type: number name: type: string created_at: type: string format: date-time updated_at: type: string format: date-time supply_tag_ids: type: array items: type: number SupplyLabelIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: allOf: - "$ref": "#/components/schemas/SupplyLabel" StateListCreateRequest: type: object properties: name: type: string description: The name of the state list. examples: - State List Name description: type: string description: The description of the state list. examples: - This is my state list. active: type: boolean description: Whether the state list is active. examples: - true required: - name StateListUpdateRequest: type: object properties: name: type: string description: The updated name of the state list. examples: - Updated State List Name description: type: string description: The updated description of the state list. examples: - Updated State List Description active: type: boolean description: Whether the state list is active. examples: - true list_action: type: string enum: - append - replace - remove description: The action to perform on the state codes in the state list. Required if state_codes or csv_file is provided. examples: - append StateListResponse: type: object properties: id: type: integer examples: - 1 account_id: type: integer name: type: string description: type: string active: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time state_codes: type: array items: type: string StateListErrorResponse: type: object properties: status: type: integer error: type: string examples: - error: State codes can't be blank errors: state_codes: - can't be blank Showcase: type: object properties: id: type: integer name: type: string is_magnite_owned: type: boolean is_private: type: boolean header_theme_color: type: string header_text_color: type: string max_carousel_count: type: integer showcase_categories: type: array items: "$ref": "#/components/schemas/ShowcaseCategory" showcase_accounts: type: array items: "$ref": "#/components/schemas/ShowcaseAccount" ShowcaseCategory: type: object properties: id: type: integer name: type: string ShowcaseAccount: type: object properties: id: type: integer role: type: string account_id: type: integer showcase_id: type: integer AdServerSearchResult: type: object required: - name - url_match properties: id: type: integer nullable: true description: AdServer primary key; null for SpringServe, Other, and header-bidding platform options. name: type: string url_match: type: string V1SearchResponse: type: array items: allOf: - "$ref": "#/components/schemas/V1SearchResponseItem" V1SearchResponseItem: type: object properties: id: type: number label: type: string scheduledReport: type: object properties: id: type: integer readOnly: true examples: - 1 name: type: string examples: - Example Scheduled Report account_id: type: integer readOnly: true examples: - 1 user_account_id: type: integer readOnly: true examples: - 1 is_active: type: boolean default: true interval: type: string default: ad_hoc enum: - ad_hoc - daily - weekly - monthly message: type: string timezone: type: string examples: - UTC start_date: type: string examples: - '2025-01-01T00:00:00Z' end_date: type: string examples: - '2025-12-31T23:59:59Z' weekdays: type: array items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday default: [] day_of_month: type: integer oneOf: - enum: - -1 - type: integer exclusiveMinimum: 1 exclusiveMaximum: 28 hour: type: integer last_scheduled_success: type: string readOnly: true permissions: type: string enum: - attach_csv - link_sharing - require_login default: require_login created_at: type: string readOnly: true updated_at: type: string readOnly: true report_params: "$ref": ref/reports.yaml#/components/schemas/reportParameters scheduled_report_recipients: type: array items: "$ref": "#/components/schemas/scheduledReportRecipient" scheduled_report_external_recipients: description: '***NOTE:*** external recipients are automatically deleted from scheduled reports which have the "require_login" permission ' type: array items: "$ref": "#/components/schemas/scheduledReportExternalRecipient" user_account: readOnly: true allOf: - "$ref": "#/components/schemas/partialUserAccount" scheduledReportRecipient: type: object properties: id: type: integer user_account_id: type: integer user_account: readOnly: true allOf: - "$ref": "#/components/schemas/partialUserAccount" created_at: type: string readOnly: true updated_at: type: string readOnly: true examples: - user_account_id: 1 scheduledReportExternalRecipient: type: object properties: id: type: integer email: type: string examples: - example@example.com report_type: type: string enum: - supply_client - unrestricted default: supply_client created_at: type: string readOnly: true updated_at: type: string readOnly: true examples: - email: example@example.com partialUserAccount: type: object properties: id: type: integer examples: - 1 user_id: type: integer examples: - 1 user: readOnly: true allOf: - "$ref": "#/components/schemas/partialUser" account_id: type: integer examples: - 1 partialUser: type: object properties: id: type: integer examples: - 1 email: type: string examples: - example@example.com name: type: - string - 'null' examples: - Example User reportTemplate: allOf: - "$ref": ref/reports.yaml#/components/schemas/reportParameters - type: object properties: id: type: integer readOnly: true name: type: string description: type: string created_at: type: string readOnly: true updated_at: type: string readOnly: true examples: - id: 1 name: Example Report Template date_range: Yesterday interval: dimensions: - supply_partner_id - supply_tag_id filters: - dimension: supply_partner_id type: values values: - 1 - 2 - 3 is_include: true is_exact_match: false metrics: - usable_requests reportSerializationError: type: object properties: error: type: string examples: - 'Could not serialize report template with /api/v1 format: ...' reportParameterError: type: object properties: error: type: string examples: - 'Could not parse report parameters: ...' ProgrammaticGuaranteedList: type: object properties: count: type: integer description: Number of results in this response total_count: type: integer description: Total number of results across all pages current_page: type: integer description: Current page number (first page is 1) total_pages: type: integer description: Total number of pages includable_fields: type: array items: type: string description: Associations that can be included in the result additional_data_fields: type: array items: type: string description: Additional data fields that can be included results: type: array items: "$ref": "#/components/schemas/ProgrammaticGuaranteed" ProgrammaticGuaranteed: type: object properties: id: type: integer description: Unique identifier for the programmatic guaranteed name: type: string description: Name of the programmatic guaranteed active: type: boolean description: Whether the programmatic guaranteed is active demand_class: type: integer description: Demand class identifier demand_partner_id: type: integer description: ID of the associated demand partner campaign_id: type: integer description: ID of the associated campaign rate: type: number format: float description: Rate for the programmatic guaranteed rate_currency: type: string description: Currency for the rate booked_revenue: type: number format: float description: Booked revenue amount code: type: string description: Code identifier secondary_code: type: string description: Secondary code identifier note: type: string description: Additional notes vast_endpoint_url: type: string format: uri description: VAST endpoint URL is_active: type: boolean description: Whether the programmatic guaranteed is active post_imp_detection_enabled: type: boolean description: Whether post-impression detection is enabled post_imp_percentage_whiteops: type: number format: float description: Post-impression percentage for WhiteOps post_imp_percentage_ias: type: number format: float description: Post-impression percentage for IAS post_imp_percentage_moat: type: number format: float description: Post-impression percentage for Moat post_imp_percentage_protected: type: number format: float description: Post-impression percentage for Protected post_imp_percentage_forensiq: type: number format: float description: Post-impression percentage for Forensiq budget_timezone: type: string description: Timezone for budget calculations start_date: type: string format: date description: Start date for the programmatic guaranteed end_date: type: string format: date description: End date for the programmatic guaranteed flight_dates_timezone: type: string description: Timezone for flight dates demand_label_ids: type: array items: type: integer description: Array of demand label IDs inventory_groups: type: array items: type: object properties: id: type: integer group: type: integer list_type: type: string enum: - white_list - black_list source_type: type: string enum: - values - file inventory_object: type: string inventory_values: type: array items: type: string deal_list_ids: type: array items: type: integer description: Array of inventory groups mediaocean_prisma_enabled: type: boolean description: Whether MediaOcean Prisma is enabled mediaocean_prisma_order_id: type: string description: MediaOcean Prisma order ID mediaocean_prisma_campaign_id: type: string description: MediaOcean Prisma campaign ID mediaocean_prisma_placement_id: type: string description: MediaOcean Prisma placement ID mediaocean_prisma_campaign_link: type: string format: uri description: MediaOcean Prisma campaign link created_at: type: string format: date-time description: Creation timestamp updated_at: type: string format: date-time description: Last update timestamp required: - name - demand_class - demand_partner_id - rate PostalCodeListCreateRequest: type: object properties: name: type: string examples: - Postal Code List Name description: type: string examples: - Postal Code List Description active: type: boolean examples: - true required: - name PostalCodeListUpdateRequest: type: object properties: name: type: string examples: - Update Postal Code List Name description: type: string examples: - Update Postal Code List Description active: type: boolean examples: - true list_action: type: string enum: - append - replace - remove examples: - append PostalCodeListResponse: type: object properties: id: type: integer account_id: type: integer name: type: string description: type: string active: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time postal_codes: type: array items: type: string PostalCodeListErrorResponse: type: object properties: error: type: string description: General error message examples: - Postal codes can't be blank errors: type: object description: Detailed validation errors by field additionalProperties: type: array items: type: string examples: - postal_codes: - can't be blank PolygonListMultipart: type: object properties: name: type: string description: type: string active: type: boolean default: true csv_file: type: string format: binary PolygonListJson: type: object properties: name: type: string description: type: string active: type: array items: type: integer examples: - name: Polygon List description: Polygon list description active: true PartnerSegment: type: object properties: id: type: number code: type: string description: type: string cpm: type: number vendor_id: type: number created_at: type: string format: date-time updated_at: type: string format: date-time size: type: number is_active: type: boolean vendor: type: object properties: id: type: number name: type: string account_partner_segment: type: object properties: id: type: number account_id: type: number partner_segment_id: type: number is_active: type: boolean PartnerSegmentIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: allOf: - "$ref": "#/components/schemas/PartnerSegment" Package: type: object properties: id: type: string name: type: string description: type: string showcase_id: type: integer is_active: type: boolean rate: type: number format: float rate_currency: type: string created_at: type: string format: date-time updated_at: type: string format: date-time required: - name - showcase_id MetroAreaListCreateRequest: type: object properties: name: type: string examples: - Metro Area List Name description: type: string examples: - Metro Area List Description active: type: boolean examples: - true required: - name MetroAreaListUpdateRequest: type: object properties: name: type: string examples: - Update Metro Area List Name description: type: string examples: - Update Metro Area List Description active: type: boolean examples: - true list_action: type: string enum: - append - replace - remove examples: - append MetroAreaListResponse: type: object properties: id: type: integer account_id: type: integer name: type: string description: type: string active: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time metro_area_codes: type: array items: type: number MetroAreaListErrorResponse: type: object properties: error: type: string description: General error message examples: - Metro Area codes can't be blank errors: type: object description: Detailed validation errors by field additionalProperties: type: array items: type: string examples: - metro_area_codes: - can't be blank HbBidMap: type: object properties: name: type: string examples: - HB Bid Map description: type: string examples: - Description of the HB Bid Map bid_platform: type: string examples: - amazon hb_bid_map_type: type: string enum: - paid - inventory_split default: inventory_split examples: - paid HbBidMapCreateRequest: allOf: - "$ref": "#/components/schemas/HbBidMap" - type: object required: - name - bid_platform - hb_bid_map_type HbBidMapUpdateRequest: allOf: - "$ref": "#/components/schemas/HbBidMap" - type: object properties: bid_platform: readOnly: true hb_bid_map_type: readOnly: true list_action: type: string enum: - append - remove - replace default: append HbBidMapResponseFields: type: object properties: id: type: integer account_id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time HbBidMapEntryArray: type: object properties: hb_bid_map_entries: type: array items: "$ref": "#/components/schemas/HbBidMapEntry" HbBidMapEntry: type: object properties: parameter_value: type: string examples: - ott1_4033_30 bid_floor: type: number format: float examples: - 15.0 id: type: integer examples: - 1 required: - parameter_value - bid_floor HbBidMapsIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: allOf: - "$ref": "#/components/schemas/HbBidMap" - "$ref": "#/components/schemas/HbBidMapResponseFields" GlobalFcapPixel: type: object properties: name: type: string examples: - Create Global FCap Pixel description: type: string examples: - Description Global FCap Pixel active: type: boolean default: true examples: - true list_type: type: string enum: - ip_address - device_id default: ip_address examples: - ip_address frequency_cap_period_amount: type: integer examples: - 3 frequency_cap_period: type: string enum: - minute - hour - day default: minute examples: - hour required: - name - frequency_cap_period_amount GlobalFcapPixelUpdateRequest: type: object properties: name: type: string examples: - Test Update description: type: string examples: - Description Update active: type: boolean examples: - true GlobalFcapPixelResponseFields: type: object properties: id: type: integer account_id: type: integer hash_check: type: string created_at: type: string format: date-time updated_at: type: string format: date-time UnsupportedContentErrorResponse: type: object properties: error: type: string examples: - Name can't be blank errors: type: object additionalProperties: type: array items: type: string examples: - name: - can't be blank GeoList: type: object properties: id: type: number name: type: string type: type: string description: type: string active: type: boolean account_id: type: number created_at: type: string format: date-time updated_at: type: string format: date-time FilepathCreativeBaseProperties: allOf: - type: object properties: name: type: string is_active: type: boolean default: true filepath_value: type: string duration_seconds: type: number clickable: type: boolean code: type: - string - 'null' secondary_code: type: - string - 'null' line_item_demand_tag_ids: type: array items: type: number iab_tier_1_category_codes: type: array items: type: string iab_tier_2_category_codes: type: array items: type: string postal_codes: type: array items: type: string postal_code_list_ids: type: array items: type: number postal_code_source: type: string postal_code_white_list: type: string key_value_targeting: type: boolean targeted_macros_enabled: type: boolean all_user_agent_devices: type: boolean all_user_agent_operating_systems: type: boolean all_user_agent_browsers: type: boolean all_user_agent_brands: type: boolean budget_timezone: type: string budgets: type: array items: type: object day_parting: type: - array - 'null' items: type: array items: type: boolean day_parting_users_timezone: type: boolean advertiser_domain: type: - string - 'null' creative_landing_page_url: type: - string - 'null' - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/city_codes.yaml#/components/schemas/CityCodes - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandKeyValue - "$ref": ref/concerns/targeted_macro.yaml#/components/schemas/TargetedMacro - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates FilepathCreativeUpdateData: "$ref": "#/components/schemas/FilepathCreativeBaseProperties" FilepathCreativeCreateData: allOf: - "$ref": "#/components/schemas/FilepathCreativeBaseProperties" - type: object required: - demand_partner_id - duration_seconds properties: demand_partner_id: type: number FilepathCreativeResponse: allOf: - "$ref": "#/components/schemas/FilepathCreativeBaseProperties" - type: object properties: id: type: integer account_id: type: integer demand_partner_id: type: integer creative_format: type: string type: type: string creative_landing_page_url: type: - string - 'null' netflix_pre_approval_enabled: type: boolean netflix_approval_status: type: - string - 'null' netflix_deal_ids: type: array items: type: string - "$ref": ref/concerns/timestamps.yaml#/components/schemas/Timestamps FilepathCreativeIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: "$ref": "#/components/schemas/FilepathCreativeResponse" DynamicFloorRule: type: object description: Direct serialization of a dynamic floor rule row. properties: id: type: integer description: Present on reads; include it on writes to update the existing rule. entity_type: type: string enum: - supply_partners - supply_tags - demand_partners - demand_tags filter_type: type: string description: Demand rules may only be `exclude`. enum: - include - exclude entity_ids: type: array items: type: integer minimum_floor: type: - string - 'null' description: Minimum floor (USD). Required for supply `include` rules, blank otherwise. minimum_floor_currency: type: - string - 'null' description: Always `USD` when a minimum floor is set. DynamicFloorSettings: type: object properties: active: type: boolean dynamic_floor_rules: type: array items: "$ref": "#/components/schemas/DynamicFloorRule" supply_partners: type: array items: "$ref": "#/components/schemas/DynamicFloorReferencedEntity" supply_tags: type: array items: "$ref": "#/components/schemas/DynamicFloorReferencedEntity" demand_partners: type: array items: "$ref": "#/components/schemas/DynamicFloorReferencedEntity" demand_tags: type: array items: "$ref": "#/components/schemas/DynamicFloorReferencedEntity" DynamicFloorReferencedEntity: type: object description: Minimal-serialized referenced entity (tag or partner). properties: id: type: integer name: type: string _meta: type: object description: Present for tags; carries the DC/HB/PC connection marker. properties: dc_label: type: string DomainListDuplicateRequest: oneOf: - "$ref": "#/components/schemas/DomainListDuplicateEnabledDemandPartnersExpansion" - "$ref": "#/components/schemas/DomainListDuplicateDisabledDemandPartnersExpansion" DomainListDuplicateBase: type: object required: - name properties: name: type: string description: type: string is_active: type: boolean account_id: type: integer description: 'Target account for the duplicate. Only honored for super admins (and equivalent all-accounts users); other users may only create in their own account and a foreign account_id is rejected. Defaults to the requesting user''s account when omitted. ' DomainListDuplicateEnabledDemandPartnersExpansion: allOf: - "$ref": "#/components/schemas/DomainListDuplicateBase" type: object required: - demand_partner_permission_ids properties: demand_partner_permission_ids: type: array items: type: integer DomainListDuplicateDisabledDemandPartnersExpansion: allOf: - "$ref": "#/components/schemas/DomainListDuplicateBase" TargetingResourceBatchRequest: type: object required: - object_ids properties: object_ids: type: array items: type: integer TargetingResourceBatchUpdateRequest: allOf: - "$ref": "#/components/schemas/TargetingResourceBatchRequest" type: object required: - is_allowlist properties: is_allowlist: type: boolean DisplayCreativeBaseProperties: allOf: - type: object properties: name: type: string is_active: type: boolean default: true creative_remote_url: type: - string - 'null' code: type: - string - 'null' secondary_code: type: - string - 'null' line_item_demand_tag_ids: type: array items: type: number iab_tier_1_category_codes: type: array items: type: string iab_tier_2_category_codes: type: array items: type: string postal_codes: type: array items: type: string postal_code_list_ids: type: array items: type: number postal_code_source: type: string postal_code_white_list: type: string key_value_targeting: type: boolean targeted_macros_enabled: type: boolean budget_timezone: type: string budgets: type: array items: type: object day_parting: type: - array - 'null' items: type: array items: type: boolean day_parting_users_timezone: type: boolean creative_landing_page_url: type: string width: type: integer height: type: integer custom: type: boolean custom_code: type: string - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/city_codes.yaml#/components/schemas/CityCodes - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandKeyValue - "$ref": ref/concerns/targeted_macro.yaml#/components/schemas/TargetedMacro - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates DisplayCreativeUpdateData: "$ref": "#/components/schemas/DisplayCreativeBaseProperties" DisplayCreativeMultipartData: type: object required: - creative - demand_partner_id - creative_landing_page_url properties: creative: type: string format: binary description: Image file to upload demand_partner_id: type: number description: ID of the demand partner (required) name: type: string description: Name of the creative (optional) creative_landing_page_url: type: string description: Landing page URL (required) is_active: type: boolean default: true description: Whether the creative is active (optional, defaults to true) DisplayCreativeCreateData: allOf: - "$ref": "#/components/schemas/DisplayCreativeBaseProperties" - type: object required: - demand_partner_id - creative_landing_page_url properties: demand_partner_id: type: number DisplayCreativeResponse: allOf: - "$ref": "#/components/schemas/DisplayCreativeBaseProperties" - type: object properties: id: type: integer account_id: type: integer demand_partner_id: type: integer creative_format: type: string type: type: string creative_file_name: type: string creative_content_type: type: string creative_file_size: type: integer creative_updated_at: type: string format: date-time netflix_pre_approval_enabled: type: boolean netflix_approval_status: type: - string - 'null' netflix_deal_ids: type: array items: type: string - "$ref": ref/concerns/timestamps.yaml#/components/schemas/Timestamps DisplayCreativeIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: "$ref": "#/components/schemas/DisplayCreativeResponse" MacroSuggesterRequest: type: object properties: vast_endpoint_url: type: string description: VAST endpoint URL entered on the demand tag form ad_server_id: type: integer nullable: true description: Selected AdServer id from search; optional if detectable from URL environment: type: string description: Demand tag environment for macro suggestions enum: - '' - desktop - mobile_web - in_app - ctv include_all: type: boolean description: Include all environment macros (tag creative forms) MacroSuggesterResponse: type: object properties: vast_endpoint_url: type: string nullable: true ad_server_id: type: integer nullable: true DemandTagPriority: type: object description: Supply tag priority assignment for a demand tag properties: supply_tag_id: type: integer format: int64 priority: type: integer tier: type: integer ratio: type: - integer - 'null' slot_number: type: - integer - 'null' slot_order: type: - string - 'null' DemandTagCreateRequest: type: object properties: name: type: string active: type: boolean demand_class: type: integer demand_partner_id: type: integer rate: type: number demand_tag_priorities: type: array items: type: object properties: supply_tag_id: type: integer curator_fee_type: type: string spring_serve_deal_id: type: - integer - 'null' description: SpringServe deal foreign key (only persisted for OpenRTB demand tags). auction_type: type: string enum: - first price - fixed price DemandTagResponse: type: object description: Demand Tag schema based on DemandTagSerializer for V1 API allOf: - "$ref": ref/concerns/advertiser_domain_list.yaml#/components/schemas/AdvertiserDomainList - "$ref": ref/concerns/app_bundle_list.yaml#/components/schemas/AppBundleList - "$ref": ref/concerns/app_name_list.yaml#/components/schemas/AppNameList - "$ref": ref/concerns/aspect_ratios.yaml#/components/schemas/AspectRatios - "$ref": ref/concerns/city_codes.yaml#/components/schemas/CityCodes - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandKeyValue - "$ref": ref/concerns/domain_list.yaml#/components/schemas/DomainList - "$ref": ref/concerns/environment.yaml#/components/schemas/Environment - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates - "$ref": ref/concerns/format.yaml#/components/schemas/Format - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/ip_list.yaml#/components/schemas/IpList - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/player_sizes.yaml#/components/schemas/PlayerSizes - "$ref": ref/concerns/postal_codes.yaml#/components/schemas/PostalCodes - "$ref": ref/concerns/privacy_targeting.yaml#/components/schemas/PrivacyTargeting - "$ref": ref/concerns/segment_groups.yaml#/components/schemas/SegmentGroups - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/targeted_macro.yaml#/components/schemas/TargetedMacro - "$ref": ref/concerns/timestamps.yaml#/components/schemas/Timestamps - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - type: object properties: id: type: integer format: int64 account_id: type: integer format: int64 name: type: string is_active: type: boolean is_new: type: boolean description: Whether the demand tag is in the "new" state (legacy index parity). note: type: - string - 'null' rate: type: string player_size_targeting: type: string direct_connect: type: boolean media_file_mime_type_targeting: type: boolean media_file_mime_types: type: array items: type: string blocking_unknown_media_file_mime_type: type: boolean media_file_duration_targeting: type: boolean media_file_min_duration: type: - string - 'null' media_file_max_duration: type: - string - 'null' blocking_unknown_media_file_duration: type: boolean media_file_bit_rate_targeting: type: boolean media_file_min_bit_rate: type: - string - 'null' media_file_max_bit_rate: type: - string - 'null' blocking_unknown_media_file_bit_rate: type: boolean targeted_macros_enabled: type: boolean blocking_unknown_media_containers: type: boolean media_file_media_container_targeting: type: boolean media_file_media_containers: type: array items: type: string media_file_audio_volume_targeting: type: boolean media_file_audio_volume_mean: type: - string - 'null' blocking_unknown_media_file_audio_volume: type: boolean blocking_vast_containing_companion_ads: type: boolean removing_companion_ads_from_vast: type: boolean creative_political_ads: type: array items: type: string type: type: - string - 'null' blocking_stitched_creatives: type: boolean budget_timezone: type: string creative_language_allow_list: "$ref": ref/types.yaml#/components/schemas/BooleanOrEmptyString creative_language_codes: type: array items: type: string creative_language_block_unknown: type: boolean allow_tier_breakout: type: boolean override_supply_floor: type: boolean audited_creative_statuses: type: array items: type: string bid_floor_type: type: string bid_margin: type: - string - 'null' bid_optional_params: type: - object - 'null' bid_params: type: - object - 'null' bid_platform: type: - string - 'null' bidder_type: type: - string - 'null' booked_revenue: type: - string - 'null' breakout_bid: type: - string - 'null' bulk_add_enabled: type: boolean bypass_private_auction_flag_enabled: type: boolean campaign_id: type: integer format: int64 campaign_tier: type: integer format: int32 tier_name: type: - string - 'null' description: Display label for campaign_tier when campaign demand tiering is enabled (e.g. "Tier 2"); null otherwise. competitive_exclusion_iab_source: type: string competitive_exclusion_iab_tier2_source: type: string competitive_exclusions_enabled: type: boolean competitive_exclusions_tier2_enabled: type: boolean cost_model_type: type: integer format: int32 creative_allow_objectionable: type: boolean creative_brandsafe_override: type: boolean creative_id: type: - string - 'null' line_item_creatives_count: type: integer description: Number of active creatives linked via line item ratios. supply_tags_count: type: integer description: Number of active supply tags linked through non-deleted demand tag priorities ad_server: type: string readOnly: true description: Computed ad server label (SpringServe, matched vendor name, Other, bid platform, or empty). creative_landing_page_url: type: - string - 'null' curator_fee_currency: type: - string - 'null' curator_fee_type: type: - string - 'null' auction_type: type: - string - 'null' enum: - first price - fixed price daa_ad_choices: type: boolean day_parting_users_timezone: type: boolean day_parting: type: array items: type: object deal_id: type: - string - 'null' demand_class: type: integer format: int32 demand_code: type: - string - 'null' demand_forecast_id: type: - integer - 'null' format: int64 demand_partner_id: type: integer format: int64 device_id_required: type: boolean euro_daa_ad_choices: type: boolean floor_rate: type: - string - 'null' guaranteed_delivery: type: boolean guaranteed_tier: type: - string - 'null' is_reserved: type: boolean isp_source: type: string isp_white_list: "$ref": ref/types.yaml#/components/schemas/BooleanOrEmptyString key_value_targeting: type: boolean multi_call_enabled: type: boolean multi_call_maximum: type: integer format: int32 partner_tier_override_enabled: type: boolean partner_tier_override: type: - string - 'null' post_imp_detection_enabled: type: boolean post_imp_percentage_forensiq: type: integer format: int32 post_imp_percentage_ias: type: integer format: int32 post_imp_percentage_moat: type: integer format: int32 post_imp_percentage_protected: type: integer format: int32 post_imp_percentage_whiteops: type: integer format: int32 pre_bid_blocking_components: type: array items: type: string pre_bid_blocking_enabled: type: boolean price_extension_enabled: type: boolean realtime_viewability: type: boolean respect_external_tier: type: array items: type: string respect_pod_order: type: boolean secondary_code: type: - string - 'null' share_of_voice_goal_percent: type: - string - 'null' skip_enabled: type: boolean skip_offset: type: - integer - 'null' iris_visibility_enabled: type: boolean share_eids_enabled: type: boolean suppress_xff_ip: type: boolean targeting_demand_ids: type: array items: type: integer targeting_demand_white_list: "$ref": ref/types.yaml#/components/schemas/BooleanOrEmptyString timeout: type: integer format: int32 vast_endpoint_url: type: - string - 'null' demand_label_ids: type: array items: type: integer demand_labels: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject isp_names: type: array items: type: string isp_names_meta: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject isp_list_ids: type: array items: type: integer advertiser_domain_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject competitive_exclusion_advertiser_domain_list_ids: type: array items: type: integer competitive_exclusion_advertiser_domain_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalActiveObject competitive_exclusion_iab_category_codes: type: array items: type: string competitive_exclusion_iab_categories: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject competitive_exclusion_iab_category_list_ids: type: array items: type: integer competitive_exclusion_iab_category_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalActiveObject competitive_exclusion_iab_tier2_category_codes: type: array items: type: string competitive_exclusion_iab_tier2_categories: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject competitive_exclusion_iab_tier2_category_list_ids: type: array items: type: integer competitive_exclusion_iab_tier2_category_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalActiveObject targeted_iab_categories: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject targeted_iab_tier2_categories: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject iab_category_tier1_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject iab_category_tier2_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject isp_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject bid_shading: type: boolean min_bid_price: type: - string - 'null' use_deal_floor: type: boolean max_bid_price: type: - string - 'null' bid_modifier_ids: type: array items: type: integer bid_modifiers: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalActiveObject delivery_modifier_ids: type: array items: type: integer delivery_modifiers: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalActiveObject bid_modifier_multiplier_interaction: type: - string - 'null' delivery_modifier_multiplier_interaction: type: - string - 'null' rate_currency: type: string floor_rate_currency: type: - string - 'null' coco_enabled: type: boolean forward_deal_ids_enabled: type: boolean buying_model: type: string mediaocean_prisma_enabled: type: boolean mediaocean_prisma_order_id: type: string mediaocean_prisma_campaign_id: type: string mediaocean_prisma_placement_id: type: string mediaocean_prisma_campaign_link: type: - string - 'null' quickstats: "$ref": ref/quickstats.yaml#/components/schemas/QuickstatsMetrics description: Quickstats metrics (included when additional_data includes quickstats) type: - 'null' goal_targetings: type: array items: type: object macro_overrides: type: array items: type: object custom_vast_extensions: type: array items: type: object budgets: type: array items: "$ref": ref/concerns/budget.yaml#/components/schemas/Budget supply_tag_assignments: type: array items: type: object line_item_ratios: type: array items: type: object inventory_groups: type: array items: type: object budget_caps: type: array items: type: object budget_allocations: type: array items: type: object non_billable_fees: type: array items: type: object marketplace_buyers: type: array items: type: object curator_fees: type: array items: type: object demand_tag_priorities: type: array items: "$ref": "#/components/schemas/DemandTagPriority" demand_tag_keys: type: array items: "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandTagKey campaign: "$ref": ref/types.yaml#/components/schemas/MinimalObject creative: "$ref": ref/types.yaml#/components/schemas/MinimalObject description: Minimal (id, name) representation of the associated creative. Only included when `include=creative` is passed; emitted as `null` when `creative_id` is null. demand_partner: type: object spring_serve_deal_id: type: - integer - 'null' description: SpringServe deal foreign key (only populated for OpenRTB demand tags). spring_serve_deal: "$ref": ref/types.yaml#/components/schemas/MinimalObject description: Minimal (id, name) representation of the associated SpringServe deal. Only included when `include=spring_serve_deal` is passed; emitted as `null` when `spring_serve_deal_id` is null. audience_unite_id: type: - string - 'null' examples: - 12:609 rtd_signals: type: array description: Only available for curator accounts. All values must be positive integers. items: type: integer budget_data: type: array items: "$ref": ref/concerns/budget.yaml#/components/schemas/BudgetReportData DemandTagIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: allOf: - "$ref": "#/components/schemas/DemandTagResponse" DemandPartnerResponse: type: object properties: id: type: integer account_id: type: integer name: type: string code: type: string secondary_code: type: string note: type: - string - 'null' third_party_fee: type: string third_party_fee_metric: type: integer third_party_fee_net_revenue: type: boolean third_party_fee_currency: type: string direct_connect: type: boolean default_tier: type: integer creative_landing_page_url: type: string audited_creative_statuses: type: array items: type: string direct_connect_account_id: type: - integer - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time account_managers: type: array items: type: object properties: id: type: integer user: type: object properties: id: type: integer tag_pixels: type: array items: type: object properties: id: type: integer pixel_type: type: string pixel_url: type: string pixel_format: type: string created_at: type: string format: date-time non_billable_fees: type: array items: type: object properties: id: type: integer cost_basis: type: string value: type: string currency: type: - string - 'null' created_at: type: string format: date-time budget_data: type: array items: "$ref": ref/concerns/budget.yaml#/components/schemas/BudgetReportData DemandPartnerIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: "$ref": "#/components/schemas/DemandPartnerResponse" DemandLabel: type: object properties: id: type: number account_id: type: number name: type: string created_at: type: string format: date-time updated_at: type: string format: date-time demand_tag_ids: type: array items: type: number tags_count: type: integer description: Present when `additional_data` contains `quickstats` (active demand tags on the label). users_count: type: integer description: Present when `additional_data` contains `quickstats` (demand-label client users). quickstats: description: Aggregated quickstats across linked demand tags; present when `additional_data` contains `quickstats`. allOf: - "$ref": "./ref/quickstats.yaml#/components/schemas/QuickstatsMetrics" demand_tags: type: array description: Minimal demand tag objects; present when `include` contains `demand_tags` and tags are preloaded. items: type: object DemandForecastResponse: allOf: - type: object properties: id: type: string examples: - '1' name: type: string examples: - My Demand Forecast description: type: string examples: - This is a demand forecast tier: type: integer examples: - 0 supply_targeting_source: type: string enum: - tags - routers - partners - labels examples: - tags supply_type: type: string enum: - run_of_network - include - exclude examples: - run_of_network supply_format: type: string enum: - audio - video - tile examples: - audio selected_supply: type: array items: type: integer examples: - [] selected_supply_objects: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObjectCollection include_inactive_tags: type: boolean examples: - false affected_supply_tags_count: type: - number - 'null' examples: - 1 demand_tag: "$ref": ref/types.yaml#/components/schemas/MinimalObject - "$ref": ref/concerns/timestamps.yaml#/components/schemas/Timestamps - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates - "$ref": ref/concerns/player_sizes.yaml#/components/schemas/PlayerSizes - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/city_codes.yaml#/components/schemas/CityCodes - "$ref": ref/concerns/postal_codes.yaml#/components/schemas/PostalCodes - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - type: object properties: segment_targeting_enabled: type: boolean examples: - false - "$ref": ref/concerns/segment_groups_with_group_type.yaml#/components/schemas/SegmentGroupsWithGroupType - type: object properties: targeted_macros_enabled: type: boolean examples: - false - "$ref": ref/concerns/targeted_macro.yaml#/components/schemas/TargetedMacro - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandKeyValue - type: object properties: budget: "$ref": ref/concerns/budget.yaml#/components/schemas/Budget - type: object properties: estimated_cpm: type: - number - 'null' format: float examples: - 1.0 estimated_fill_rate: type: - number - 'null' format: float examples: - 0.5 DemandForecastCreateRequest: allOf: - type: object properties: name: type: string examples: - My Demand Forecast description: type: string examples: - This is a demand forecast tier: type: integer examples: - 0 include_inactive_tags: type: boolean examples: - false supply_targeting_source: type: string enum: - tags - routers - partners - labels examples: - tags supply_type: type: string enum: - run_of_network - include - exclude examples: - run_of_network supply_format: type: string enum: - audio - video - tile examples: - audio selected_supply: type: array items: type: integer examples: - - 1 - 2 - 3 - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates - "$ref": ref/concerns/player_sizes.yaml#/components/schemas/PlayerSizes - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/city_codes.yaml#/components/schemas/CityCodes - "$ref": ref/concerns/postal_codes.yaml#/components/schemas/PostalCodes - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - type: object properties: segment_targeting_enabled: type: boolean examples: - false - "$ref": ref/concerns/segment_groups_with_group_type.yaml#/components/schemas/SegmentGroupsWithGroupType - type: object properties: targeted_macros_enabled: type: boolean examples: - true - "$ref": ref/concerns/targeted_macro.yaml#/components/schemas/TargetedMacro - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandKeyValue - type: object properties: budget: "$ref": ref/concerns/budget.yaml#/components/schemas/Budget - type: object properties: estimated_cpm: type: - number - 'null' format: float examples: - 1.0 estimated_fill_rate: type: - number - 'null' format: float examples: - 0.5 DemandForecastUpdateRequest: allOf: - "$ref": "#/components/schemas/DemandForecastCreateRequest" DemandForecastIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: allOf: - "$ref": "#/components/schemas/DemandForecastResponse" DeliveryModifier: type: object properties: id: type: number account_id: type: number name: type: string description: type: string active: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time multiplier_interaction: type: string demand_tag_ids: type: array items: type: number modifier_rules: type: array items: type: object properties: id: type: integer source_type: type: string multiplier: type: string modifier_rule_object: type: string city_codes: type: array items: type: string ObjectIds: type: object properties: object_ids: type: array items: type: number description: Array of creative IDs to update required: - object_ids Status: type: object required: - object_ids properties: is_active: type: boolean description: Indicates whether to activate (true) or deactivate (false) the creatives object_ids: type: array items: type: number description: Array of creative IDs to update Country: allOf: - "$ref": ref/geo_targeting.yaml#/components/schemas/Country - "$ref": "#/components/schemas/ObjectIds" Region: allOf: - "$ref": ref/geo_targeting.yaml#/components/schemas/Region - "$ref": "#/components/schemas/ObjectIds" City: allOf: - "$ref": ref/geo_targeting.yaml#/components/schemas/City - "$ref": "#/components/schemas/ObjectIds" PostalCode: allOf: - "$ref": ref/geo_targeting.yaml#/components/schemas/PostalCode - "$ref": "#/components/schemas/ObjectIds" MetroArea: allOf: - "$ref": ref/geo_targeting.yaml#/components/schemas/MetroArea - "$ref": "#/components/schemas/ObjectIds" Device: allOf: - "$ref": ref/user_agent_targeting.yaml#/components/schemas/Device - "$ref": "#/components/schemas/ObjectIds" OS: allOf: - "$ref": ref/user_agent_targeting.yaml#/components/schemas/OS - "$ref": "#/components/schemas/ObjectIds" Browser: allOf: - "$ref": ref/user_agent_targeting.yaml#/components/schemas/Browser - "$ref": "#/components/schemas/ObjectIds" Brand: allOf: - "$ref": ref/user_agent_targeting.yaml#/components/schemas/Brand - "$ref": "#/components/schemas/ObjectIds" CountryListCreateRequest: type: object properties: name: type: string examples: - Country List Name description: type: string examples: - Country List Description active: type: boolean examples: - true required: - name CountryListUpdateRequest: type: object properties: name: type: string examples: - Update Country List Name description: type: string examples: - Update Country List Description active: type: boolean examples: - true list_action: type: string enum: - append - replace - remove examples: - append CountryListResponse: type: object properties: id: type: integer account_id: type: integer name: type: string description: type: string active: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time country_codes: type: array items: type: string CountryListErrorResponse: type: object properties: error: type: string description: General error message examples: - Country codes can't be blank errors: type: object description: Detailed validation errors by field additionalProperties: type: array items: type: string examples: - country_codes: - can't be blank ClearlineRtdSignal: type: object properties: id: type: integer value: type: string description: Display name for the RTD signal. unite_id: type: integer description: Identifier from the external Unite system. is_active: type: boolean account_id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time ClearlineRtdSignalCreate: type: object required: - value properties: value: type: string description: Display name for the RTD signal. is_active: type: boolean ClearlineForecastResponse: allOf: - type: object properties: id: type: string examples: - '1' name: type: string examples: - My ClearLine Forecast description: type: string examples: - This is a ClearLine forecast breakdown_type: type: - string - 'null' enum: - deal - dma - supplySeat examples: - dma lookback_date: type: string enum: - custom - yesterday - last_3_days - last_7_days - last_14_days - last_28_days examples: - last_7_days domain_white_list: type: boolean examples: - true domain_list_ids: type: array items: type: integer examples: - - 1 - 2 app_name_white_list: type: boolean examples: - true app_name_list_ids: type: array items: type: integer examples: - - 1 - 2 app_bundle_white_list: type: boolean examples: - true app_bundle_list_ids: type: array items: type: integer examples: - - 1 - 2 device_id_required: type: boolean examples: - false forecast_data: type: - array - 'null' items: type: object examples: - [] inventory_groups: type: array items: type: object examples: - [] domain_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject examples: - [] app_name_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject examples: - [] app_bundle_lists: type: array items: "$ref": ref/types.yaml#/components/schemas/MinimalObject examples: - [] demand_tag: "$ref": ref/types.yaml#/components/schemas/MinimalObject type: - 'null' user_account: "$ref": ref/types.yaml#/components/schemas/MinimalObject type: - 'null' - "$ref": ref/concerns/timestamps.yaml#/components/schemas/Timestamps - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates - "$ref": ref/concerns/player_sizes.yaml#/components/schemas/PlayerSizes - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/postal_codes.yaml#/components/schemas/PostalCodes - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - type: object properties: segment_targeting_enabled: type: boolean examples: - false - "$ref": ref/concerns/segment_groups_with_group_type.yaml#/components/schemas/SegmentGroupsWithGroupType - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps CityListCreateRequest: type: object properties: name: type: string examples: - City List Name description: type: string examples: - City List Description active: type: boolean examples: - true required: - name CityListUpdateRequest: type: object properties: name: type: string examples: - Update City List Name description: type: string examples: - Update City List Description active: type: boolean examples: - true list_action: type: string enum: - append - replace - remove examples: - append CityListResponse: type: object properties: id: type: integer account_id: type: integer name: type: string description: type: string active: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time city_codes: type: array items: type: integer CityListErrorResponse: type: object properties: status: type: integer error: type: string examples: - error: City codes can't be blank errors: city_codes: - can't be blank ChangelogsTimeFilter: type: string enum: - last_year - today - yesterday - last_7_days - last_30_days CampaignCreateRequest: allOf: - type: object properties: name: type: string is_active: type: boolean demand_partner_id: type: number rate: type: number - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/non_billable_fees.yaml#/components/schemas/NonBillableFees CampaignUpdateRequest: allOf: - type: object properties: name: type: string is_active: type: boolean demand_partner_id: type: number rate: type: number targeting_page_attribute_profile: "$ref": ref/concerns/targeting_page_attribute_profile.yaml#/components/schemas/TargetingPageAttributeProfile targeting_spend_profile: "$ref": ref/concerns/targeting_spend_profile.yaml#/components/schemas/TargetingSpendProfile targeting_time_profile: "$ref": ref/concerns/targeting_time_profile.yaml#/components/schemas/TargetingTimeProfile targeting_geo_profile: "$ref": ref/concerns/targeting_geo_profile.yaml#/components/schemas/TargetingGeoProfile - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/non_billable_fees.yaml#/components/schemas/NonBillableFees CampaignResponse: allOf: - type: object properties: id: type: number examples: - 1 name: type: string examples: - My Campaign is_active: type: boolean examples: - true demand_partner_id: type: number examples: - 1 rate: type: number examples: - 0.1 budget_data: type: array items: "$ref": ref/concerns/budget.yaml#/components/schemas/BudgetReportData demand_partner: type: object "$ref": ref/types.yaml#/components/schemas/MinimalObject targeting_page_attribute_profile: type: object "$ref": ref/concerns/targeting_page_attribute_profile.yaml#/components/schemas/TargetingPageAttributeProfile targeting_spend_profile: type: object "$ref": ref/concerns/targeting_spend_profile.yaml#/components/schemas/TargetingSpendProfile targeting_time_profile: type: object "$ref": ref/concerns/targeting_time_profile.yaml#/components/schemas/TargetingTimeProfile targeting_geo_profile: type: object "$ref": ref/concerns/targeting_geo_profile.yaml#/components/schemas/TargetingGeoProfile - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/non_billable_fees.yaml#/components/schemas/NonBillableFees QualityReportResponse: allOf: - type: object properties: ias_impressions: type: number ias_groupm_viewability_rate: type: number format: float ias_complete_audible_visible_rate: type: number format: float ias_ivt_rate: type: number format: float ias_mrc_viewability_rate: type: number format: float Bill: type: object properties: id: type: number account_id: type: number name: type: string month: type: string is_finalized: type: boolean is_invoice: type: boolean is_direct_connect: type: boolean is_openrtb: type: boolean currency: type: string total_bill_amount: type: number total_amount_collected: type: number bill_items_count: type: number created_at: type: string format: date-time updated_at: type: string format: date-time BidModifier: type: object properties: id: type: integer account_id: type: integer name: type: string description: type: string active: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time modifier_rules: type: array items: type: object properties: id: type: integer source_type: type: string multiplier: type: string modifier_rule_object: type: string city_codes: type: array items: type: string AudioCreativeBaseProperties: allOf: - type: object properties: name: type: string is_active: type: boolean default: true creative_remote_url: type: - string - 'null' code: type: - string - 'null' secondary_code: type: - string - 'null' line_item_demand_tag_ids: type: array items: type: number iab_tier_1_category_codes: type: array items: type: string iab_tier_2_category_codes: type: array items: type: string postal_codes: type: array items: type: string postal_code_list_ids: type: array items: type: number postal_code_source: type: string postal_code_white_list: type: string key_value_targeting: type: boolean targeted_macros_enabled: type: boolean all_user_agent_devices: type: boolean all_user_agent_operating_systems: type: boolean all_user_agent_browsers: type: boolean all_user_agent_brands: type: boolean budget_timezone: type: string budgets: type: array items: type: object day_parting: type: - array - 'null' items: type: array items: type: boolean day_parting_users_timezone: type: boolean advertiser_domain: type: - string - 'null' - "$ref": ref/concerns/tag_pixels.yaml#/components/schemas/TagPixels - "$ref": ref/concerns/country_codes.yaml#/components/schemas/CountryCodes - "$ref": ref/concerns/state_codes.yaml#/components/schemas/StateCodes - "$ref": ref/concerns/metro_area_codes.yaml#/components/schemas/MetroAreaCodes - "$ref": ref/concerns/city_codes.yaml#/components/schemas/CityCodes - "$ref": ref/concerns/frequency_caps.yaml#/components/schemas/FrequencyCaps - "$ref": ref/concerns/demand_key_value.yaml#/components/schemas/DemandKeyValue - "$ref": ref/concerns/targeted_macro.yaml#/components/schemas/TargetedMacro - "$ref": ref/concerns/user_agent.yaml#/components/schemas/UserAgent - "$ref": ref/concerns/flight_dates.yaml#/components/schemas/FlightDates AudioCreativeUpdateData: "$ref": "#/components/schemas/AudioCreativeBaseProperties" AudioCreativeCreateData: allOf: - "$ref": "#/components/schemas/AudioCreativeBaseProperties" - type: object required: - demand_partner_id properties: demand_partner_id: type: number AudioCreativeResponse: allOf: - "$ref": "#/components/schemas/AudioCreativeBaseProperties" - type: object properties: id: type: integer account_id: type: integer demand_partner_id: type: integer creative_format: type: string type: type: string duration_seconds: type: number creative_file_name: type: string creative_content_type: type: string creative_file_size: type: integer creative_updated_at: type: string format: date-time netflix_pre_approval_enabled: type: boolean netflix_approval_status: type: - string - 'null' netflix_deal_ids: type: array items: type: string - "$ref": ref/concerns/timestamps.yaml#/components/schemas/Timestamps AudioCreativeIndexResponse: allOf: - "$ref": ref/params.yaml#/components/schemas/ParamsResponse - type: object properties: results: type: array items: "$ref": "#/components/schemas/AudioCreativeResponse" Anomaly: type: object properties: id: type: integer account_id: type: integer dimensions: type: object description: JSON object of dimension key/value pairs metric: type: string created_at: type: string format: date-time updated_at: type: string format: date-time anomaly_points: type: array items: "$ref": "#/components/schemas/AnomalyPoint" AnomalyPoint: type: object properties: id: type: integer anomaly_id: type: integer datetime: type: string format: date-time value: type: integer AnomalyCreate: type: object properties: dimensions: type: object description: JSON object of dimension key/value pairs metric: type: string account_id: type: integer anomaly_points: type: array items: type: object required: - datetime - value properties: datetime: type: string format: date-time value: type: integer AdvertiserDomainList: type: object properties: id: type: number name: type: string active: type: boolean description: type: string parameters: streamingTypeParam: name: streaming_type in: path required: true description: The unified-demand streaming type schema: type: string enum: - ad_source - supply_channel q: name: q description: the string to search for in: query schema: type: string limit: name: limit description: max number of results to return in: query schema: type: string with_deleted: name: with_deleted in: query schema: type: boolean is_active: name: is_active description: Filter results by active state. `true` returns only active records, `false` returns only inactive records. Omit to return both. in: query schema: type: boolean account_id: name: account_id description: Scope the search to the given account instead of your currently active account. Only supported for `streaming_publishers` and `streaming_seller_seats`. in: query schema: type: integer additionalDataPartnerSegmentParam: name: additional_data description: Include additional data from non-model sources on the result. Comma-delimited. in: query schema: type: string enum: - size - account_partner_segment - size,account_partner_segment additionalDataParam: name: additional_data description: "Include additional data from non-model sources in the response. \nSupported values: 'quickstats', 'budget_data'. \nMultiple values can be specified as comma-separated (e.g., 'quickstats,budget_data').\n" in: query schema: type: string example: quickstats responses: scheduledReport: description: A scheduled report content: application/json: schema: "$ref": "#/components/schemas/scheduledReport" reportTemplate: description: A report template content: application/json: schema: "$ref": "#/components/schemas/reportTemplate" reportSerializationError: description: Report Serialization Error content: application/json: schema: "$ref": "#/components/schemas/reportSerializationError" reportParameterError: description: Report Parameter Error content: application/json: schema: "$ref": "#/components/schemas/reportParameterError" TargetingResourceBatchResponse: description: Successful response for bulk action content: application/json: schema: type: object properties: message: type: string securitySchemes: api_key: type: apiKey in: header name: Authorization description: SpringServe authorization token based authentication. bearer_token: type: http scheme: bearer bearerFormat: JWT description: SpringServe authorization bearer token based authentication. This key is included in the response from the /api/v0/auth and /api/v1/auth endpoints. This key will be automatically set if you run the example for /api/v0/auth or /api/v1/auth tags: - name: Auth description: Endpoints that provide authentication for the API - name: Account Partner Segments - name: Accounts - name: App Bundle Lists - name: App Name Lists - name: Audiences - name: Bills - name: Changelogs - name: City Lists - name: Content Categories - name: Country Lists - name: Creatives - name: Creatives Audio - name: Creatives Filepaths - name: Creatives Tag - name: Creatives Tile - name: Creatives Video - name: Curated Marketplaces - name: Currencies - name: Dashboards - name: Deal Lists - name: Demand Labels - name: Demand Tags - name: Domain Lists - name: Geo Lists - name: Global Fcap Pixels - name: Hb Bid Maps - name: Header Bidding Platforms - name: ISP Lists - name: Magnite Programmatic - name: Metro Area Lists - name: Notifications - name: Partner Segments - name: Permissions - name: Postal Code Lists - name: Report - name: Report Templates - name: Reports - name: Run As - name: Scanned Creative Lists - name: Scheduled Reports - name: Search - name: Session - name: State Lists - name: Supply Labels - name: Supply Name Lists - name: Supply Routers - name: Supply Tags - name: System Settings - name: Timezones - name: User Accounts description: The entity that combines a User and an Account and defines the role the user plays on that account - name: Users - name: Vendors - name: White Labels security: - api_key: [] - bearer_token: []