{"openapi":"3.0.3","info":{"title":"Reference Resources","version":"2.0.0","description":"Buzz API v2"},"paths":{"/ref/ad-positions":{"get":{"operationId":"ref_ad_positions_list","description":"Retrieves a list of publisher-declared ad positions. These represent where an ad slot appears on the page (e.g., 'above the fold'). Note that these values are publisher-provided and do **not** guarantee viewability.","summary":"Get a list of ad positions","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"open_rtb_code","schema":{"type":"string"}},{"in":"query","name":"open_rtb_code__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"open_rtb_code__isempty","schema":{"type":"boolean"}},{"in":"query","name":"open_rtb_code__not","schema":{"type":"string"}},{"in":"query","name":"open_rtb_code__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Environment Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAdPositionList"}}},"description":"Ad positions retrieved successfully."},"401":{"description":"Authentication required."},"500":{"description":"Internal server error."}}}},"/ref/ads-txts":{"get":{"operationId":"ref_ads_txts_list","description":"Retrieve a list of Ads.txt records. Non-FES buzz keys will not see legacy or deprecated Ads.txt values.","summary":"List Ads.txt entries","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Environment Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAdsTxtList"}}},"description":"Ads.txt entries retrieved successfully."},"400":{"description":"Invalid request."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/advertiser-categories":{"get":{"operationId":"ref_advertiser_categories_list","description":"Retrieve a list of advertiser categories with optional filtering and search.","summary":"List advertiser categories","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}],"tags":["Advertisers"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAdvertiserCategoryList"}}},"description":"Advertiser categories retrieved successfully."},"400":{"description":"Invalid request parameters."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/advertiser-indexes":{"get":{"operationId":"ref_advertiser_indexes_list","description":"Retrieve a list of advertiser indexes with optional filtering.","summary":"List advertiser indexes","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Advertisers"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAdvertiserIndexList"}}},"description":"Advertiser indexes retrieved successfully."},"400":{"description":"Invalid request parameters."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/advertiser-sensitive-categories":{"get":{"operationId":"ref_advertiser_sensitive_categories_list","description":"Retrieve a list of advertiser sensitive categories with optional filtering.","summary":"List advertiser sensitive categories","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Advertisers"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAdvertiserSensitiveCategoryList"}}},"description":"Advertiser sensitive categories retrieved successfully."},"400":{"description":"Invalid request parameters."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/audio-content-genres":{"get":{"operationId":"ref_audio_content_genres_list","description":"Retrieve a list of audio content genres with optional filtering.","summary":"List audio content genres","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Content Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedAudioContentGenreList"}}},"description":"Audio content genres retrieved successfully."},"400":{"description":"Invalid request parameters."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/bandwidths":{"get":{"operationId":"ref_bandwidths_list","description":"Retrieve a list of bandwidth types. Represents the `connectiontype` field defined in OpenRTB 5.18.","summary":"List bandwidth types","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBandwidthList"}}},"description":"Bandwidth list retrieved successfully."},"400":{"description":"Invalid request parameters."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/bid-models":{"get":{"operationId":"ref_bid_models_list","description":"Retrieve a list of active bid models. Supports filtering, searching, and sorting to locate specific model types and attributes.","summary":"List bid models","parameters":[{"in":"query","name":"id","schema":{"type":"integer"},"description":"Filter by ID (exact match)."},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Filter by name (contains match)."},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"ordering","schema":{"type":"string"},"description":"Ordering field, supports: update_date."},{"in":"query","name":"search","schema":{"type":"string"},"description":"Search across name and value type."},{"in":"query","name":"value_type","schema":{"type":"string"},"description":"Filter by value type (exact match)."},{"in":"query","name":"value_type__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"value_type__isempty","schema":{"type":"boolean"}},{"in":"query","name":"value_type__not","schema":{"type":"string","enum":["BID","BUDGET_WEIGHT","MULTIPLIER"]},"description":"Valid values are BID, MULTIPLIER, or BUDGET_WEIGHT. Determines whether the values in the Bid Model should be multiplied by the base bid at the Line Item level or used instead of that bid. BUDGET_WEIGHT should be used for Delivery Models.\n\n* `BID` - Bid\n* `MULTIPLIER` - Multiplier\n* `BUDGET_WEIGHT` - Budget Weight"},{"in":"query","name":"value_type__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBidModelRefList"}}},"description":"Bid models retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/bid-modifier-targeting-keys":{"get":{"operationId":"ref_bid_modifier_targeting_keys_list","description":"Retrieve all available Delivery Modifier Key configurations. Each configuration defines the targeting key and its associated metadata.","summary":"List Delivery Modifier Key configurations","parameters":[{"in":"query","name":"module","schema":{"type":"string"},"description":"Filter targeting keys by module."}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"description":"List of Delivery Modifier Key configurations."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Forbidden."},"500":{"description":"Internal server error."}}}},"/ref/bid-modifier-targeting-keys/{key}":{"get":{"operationId":"ref_bid_modifier_targeting_keys_retrieve","description":"Retrieve configuration details for a specific targeting key.","summary":"Retrieve Bid Modifier targeting key details","parameters":[{"in":"path","name":"key","schema":{"type":"string"},"description":"Unique targeting key identifier for Bid Modifier config","required":true}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BidModifierTermV2"}}},"description":""}}}},"/ref/bidding-strategies":{"get":{"operationId":"bidding_strategies_standard_ref_retrieve","description":"Retrieve all standard bidding strategies.","summary":"List bidding strategies","parameters":[{"in":"query","name":"allow_bid_models","schema":{"type":"boolean"}},{"in":"query","name":"allow_bid_modifiers","schema":{"type":"boolean"}},{"in":"query","name":"allow_bid_shading","schema":{"type":"boolean"}},{"in":"query","name":"allow_delivery_models","schema":{"type":"boolean"}},{"in":"query","name":"custom","schema":{"type":"boolean"}},{"in":"query","name":"description","schema":{"type":"string"}},{"in":"query","name":"description__contains","schema":{"type":"string"}},{"in":"query","name":"description__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"description__not","schema":{"type":"string"}},{"in":"query","name":"description__not_contains","schema":{"type":"string"}},{"in":"query","name":"description__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"line_item_types__contains","schema":{"type":"number"}},{"in":"query","name":"line_item_types__not_contains","schema":{"type":"number"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"paced","schema":{"type":"boolean"}}],"tags":["Line Items"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBiddingStrategyRefList"}}},"description":""}}}},"/ref/bidding-strategies/{id}":{"get":{"operationId":"bidding_strategy_ref_retrieve","description":"Retrieve a single bidding strategy by ID.","summary":"Retrieve bidding strategy","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this bidding strategy.","required":true},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Line Items"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBiddingStrategyRefList"}}},"description":""}}}},"/ref/browser-versions":{"get":{"operationId":"ref_browser_versions_list","description":"Retrieve a list of all active browser versions.","summary":"List browser versions","parameters":[{"in":"query","name":"browser_key","schema":{"type":"string"}},{"in":"query","name":"browser_key__contains","schema":{"type":"string"}},{"in":"query","name":"browser_key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"browser_key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"browser_key__not","schema":{"type":"string"}},{"in":"query","name":"browser_key__not_contains","schema":{"type":"string"}},{"in":"query","name":"browser_key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBrowserVersionList"}}},"description":"Browser versions retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/browsers":{"get":{"operationId":"ref_browsers_list","description":"Retrieves a list of browsers represented in the system.","summary":"Get a list of browsers","parameters":[{"in":"query","name":"category","schema":{"type":"string"},"description":"Filter by exact category"},{"in":"query","name":"category__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"category__isempty","schema":{"type":"boolean"}},{"in":"query","name":"category__not","schema":{"type":"string"}},{"in":"query","name":"category__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Filter by exact key"},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Filter by name containing substring"},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"ordering","schema":{"type":"string"},"description":"Fields to order by (comma-separated)"}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBrowserList"}}},"description":"Browsers retrieved successfully."},"401":{"description":"Authentication required."},"500":{"description":"Internal server error."}}}},"/ref/budget-types":{"get":{"operationId":"ref_budget_types_list","description":"Retrieve a list of all available budget types.","summary":"List budget types","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBudgetTypeList"}}},"description":"Budget types retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/carriers":{"get":{"operationId":"ref_carriers_list","description":"Retrieve a list of mobile carriers filtered by key, name, or category.","summary":"List mobile carriers","parameters":[{"in":"query","name":"category","schema":{"type":"string"},"description":"Filter by category"},{"in":"query","name":"category__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"category__isempty","schema":{"type":"boolean"}},{"in":"query","name":"category__not","schema":{"type":"string"}},{"in":"query","name":"category__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Filter by key"},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Filter by name containing substring"},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCarrierList"}}},"description":"Mobile carriers retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/cities":{"get":{"operationId":"ref_cities_list","description":"Retrieve a list of cities with optional filtering and search capabilities.","summary":"List cities","parameters":[{"in":"query","name":"country_code_2","schema":{"type":"string"}},{"in":"query","name":"country_code_2__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"country_code_2__isempty","schema":{"type":"boolean"}},{"in":"query","name":"country_code_2__not","schema":{"type":"string"}},{"in":"query","name":"country_code_2__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"country_code_3","schema":{"type":"string"}},{"in":"query","name":"country_code_3__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"country_code_3__isempty","schema":{"type":"boolean"}},{"in":"query","name":"country_code_3__not","schema":{"type":"string"}},{"in":"query","name":"country_code_3__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"geoname","schema":{"type":"string"}},{"in":"query","name":"geoname__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"geoname__isempty","schema":{"type":"boolean"}},{"in":"query","name":"geoname__not","schema":{"type":"string"}},{"in":"query","name":"geoname__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"metro_code","schema":{"type":"string"}},{"in":"query","name":"metro_code__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"metro_code__isempty","schema":{"type":"boolean"}},{"in":"query","name":"metro_code__not","schema":{"type":"string"}},{"in":"query","name":"metro_code__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"region_code","schema":{"type":"string"}},{"in":"query","name":"region_code__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"region_code__isempty","schema":{"type":"boolean"}},{"in":"query","name":"region_code__not","schema":{"type":"string"}},{"in":"query","name":"region_code__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"region_name","schema":{"type":"string"}},{"in":"query","name":"region_name__contains","schema":{"type":"string"}},{"in":"query","name":"region_name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"region_name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"region_name__not","schema":{"type":"string"}},{"in":"query","name":"region_name__not_contains","schema":{"type":"string"}},{"in":"query","name":"region_name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}],"tags":["Geo Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCityList"}}},"description":"Cities retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/congressional-districts":{"get":{"operationId":"ref_congressional_districts_list","description":"Retrieve a list of congressional legislative districts.","summary":"List congressional districts","parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__not","schema":{"type":"string"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"state","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"state__isempty","schema":{"type":"boolean"}},{"in":"query","name":"state__not","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"state_id","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"state_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"state_id__not","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Geo Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedLegislativeDistrictList"}}},"description":"Congressional districts retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/content-categories":{"get":{"operationId":"ref_content_categories_list","description":"Get list of IAB categories from OpenRTB.","summary":"Get list of IAB content categories","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Content Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedContentCategoryList"}}},"description":"Content categories retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/content-genres":{"get":{"operationId":"ref_content_genres_list","description":"Retrieve a list of active content genres.","summary":"List content genres","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Content Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedContentGenreList"}}},"description":"Content genres retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/content-ratings":{"get":{"operationId":"ref_content_ratings_list","description":"Get list of content rating types according to OpenRTB 6.18.","summary":"Get list of content rating types","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Content Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedContentRatingList"}}},"description":"Content rating types retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/continents":{"get":{"operationId":"ref_continents_list","description":"Get list of continents (groups of countries).","summary":"Get list of continents","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedContinentList"}}},"description":"List of continents retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/conversion-attribution-methods":{"get":{"operationId":"ref_conversion_attribution_methods_list","description":"Retrieve a list of all available conversion attribution methods.","summary":"List conversion attribution methods","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedConversionAttributionMethodList"}}},"description":"Conversion attribution methods retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/countries":{"get":{"operationId":"ref_countries_list","description":"Get list of country codes validated against ISO 3166-1 alpha-3.","summary":"Get list of country codes","parameters":[{"in":"query","name":"country_code_2","schema":{"type":"string"}},{"in":"query","name":"country_code_2__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"country_code_2__isempty","schema":{"type":"boolean"}},{"in":"query","name":"country_code_2__not","schema":{"type":"string"}},{"in":"query","name":"country_code_2__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"country_code_3","schema":{"type":"string"}},{"in":"query","name":"country_code_3__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"country_code_3__isempty","schema":{"type":"boolean"}},{"in":"query","name":"country_code_3__not","schema":{"type":"string"}},{"in":"query","name":"country_code_3__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Geo Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCountryList"}}},"description":"List of countries retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/creative-approval-vendors":{"get":{"operationId":"ref_creative_approval_vendors_list","description":"Retrieve the list of creative approval vendors. These vendors define approval workflows used for validating creatives.","summary":"Get list of creative approval vendors","parameters":[{"in":"query","name":"blocking","schema":{"type":"integer"}},{"in":"query","name":"blocking__gt","schema":{"type":"integer"}},{"in":"query","name":"blocking__gte","schema":{"type":"integer"}},{"in":"query","name":"blocking__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"blocking__isempty","schema":{"type":"boolean"}},{"in":"query","name":"blocking__lt","schema":{"type":"integer"}},{"in":"query","name":"blocking__lte","schema":{"type":"integer"}},{"in":"query","name":"blocking__not","schema":{"type":"integer"}},{"in":"query","name":"blocking__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"creative_type_id","schema":{"type":"integer"}},{"in":"query","name":"creative_type_id__gt","schema":{"type":"integer"}},{"in":"query","name":"creative_type_id__gte","schema":{"type":"integer"}},{"in":"query","name":"creative_type_id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"creative_type_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"creative_type_id__lt","schema":{"type":"integer"}},{"in":"query","name":"creative_type_id__lte","schema":{"type":"integer"}},{"in":"query","name":"creative_type_id__not","schema":{"type":"integer"}},{"in":"query","name":"creative_type_id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"required","schema":{"type":"integer"}},{"in":"query","name":"required__gt","schema":{"type":"integer"}},{"in":"query","name":"required__gte","schema":{"type":"integer"}},{"in":"query","name":"required__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"required__isempty","schema":{"type":"boolean"}},{"in":"query","name":"required__lt","schema":{"type":"integer"}},{"in":"query","name":"required__lte","schema":{"type":"integer"}},{"in":"query","name":"required__not","schema":{"type":"integer"}},{"in":"query","name":"required__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Creatives"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCreativeApprovalVendorsList"}}},"description":"Creative approval vendors retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/creative-sizes":{"get":{"operationId":"ref_creative_sizes_list","description":"Retrieve a list of all available creative sizes in the format 'WxH'.","summary":"List creative sizes","parameters":[{"in":"query","name":"category","schema":{"type":"string"}},{"in":"query","name":"category__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"category__isempty","schema":{"type":"boolean"}},{"in":"query","name":"category__not","schema":{"type":"string"}},{"in":"query","name":"category__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"creative_height","schema":{"type":"integer"}},{"in":"query","name":"creative_height__gt","schema":{"type":"integer"}},{"in":"query","name":"creative_height__gte","schema":{"type":"integer"}},{"in":"query","name":"creative_height__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"creative_height__isempty","schema":{"type":"boolean"}},{"in":"query","name":"creative_height__lt","schema":{"type":"integer"}},{"in":"query","name":"creative_height__lte","schema":{"type":"integer"}},{"in":"query","name":"creative_height__not","schema":{"type":"integer"}},{"in":"query","name":"creative_height__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"creative_width","schema":{"type":"integer"}},{"in":"query","name":"creative_width__gt","schema":{"type":"integer"}},{"in":"query","name":"creative_width__gte","schema":{"type":"integer"}},{"in":"query","name":"creative_width__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"creative_width__isempty","schema":{"type":"boolean"}},{"in":"query","name":"creative_width__lt","schema":{"type":"integer"}},{"in":"query","name":"creative_width__lte","schema":{"type":"integer"}},{"in":"query","name":"creative_width__not","schema":{"type":"integer"}},{"in":"query","name":"creative_width__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCreativeSizeList"}}},"description":"Creative sizes retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/currencies":{"get":{"operationId":"ref_currencies_list","description":"Retrieves a list of supported currencies. ","summary":"Get a list of currencies","parameters":[{"in":"query","name":"emoji_flag","schema":{"type":"string"}},{"in":"query","name":"emoji_flag__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"emoji_flag__isempty","schema":{"type":"boolean"}},{"in":"query","name":"emoji_flag__not","schema":{"type":"string"}},{"in":"query","name":"emoji_flag__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"glyph","schema":{"type":"string"}},{"in":"query","name":"glyph__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"glyph__isempty","schema":{"type":"boolean"}},{"in":"query","name":"glyph__not","schema":{"type":"string"}},{"in":"query","name":"glyph__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCurrencyList"}}},"description":"Currencies retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/custom-bidding-strategies":{"get":{"operationId":"ref_custom_bidding_strategies_line_item_list","description":"Retrieve all custom bidding strategies available for reference.","summary":"List custom bidding strategies","parameters":[{"in":"query","name":"allow_bid_models","schema":{"type":"boolean"}},{"in":"query","name":"allow_bid_modifiers","schema":{"type":"boolean"}},{"in":"query","name":"allow_bid_shading","schema":{"type":"boolean"}},{"in":"query","name":"allow_delivery_models","schema":{"type":"boolean"}},{"in":"query","name":"custom","schema":{"type":"boolean"}},{"in":"query","name":"description","schema":{"type":"string"}},{"in":"query","name":"description__contains","schema":{"type":"string"}},{"in":"query","name":"description__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"description__not","schema":{"type":"string"}},{"in":"query","name":"description__not_contains","schema":{"type":"string"}},{"in":"query","name":"description__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"line_item_types__contains","schema":{"type":"number"}},{"in":"query","name":"line_item_types__not_contains","schema":{"type":"number"}},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"paced","schema":{"type":"boolean"}}],"tags":["Line Items"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBiddingStrategyRefList"}}},"description":""}}}},"/ref/custom-bidding-strategies/{id}":{"get":{"operationId":"ref_custom_bidding_strategies_line_item_retrieve","description":"Retrieve a single custom bidding strategy by ID.","summary":"Retrieve custom bidding strategy","parameters":[{"in":"path","name":"id","schema":{"type":"integer","maximum":2147483647,"minimum":-2147483648},"description":"A unique value identifying this bidding strategy custom.","required":true},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Line Items"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedBiddingStrategyRefList"}}},"description":""}}}},"/ref/custom-list-types":{"get":{"operationId":"ref_custom_list_types_list","description":"Retrieve a list of all custom list types available for targeting and data management.","summary":"List custom list types","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Lists"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCustomListTypeList"}}},"description":"Custom list types retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/dashboards":{"get":{"operationId":"ref_dashboards_list","description":"Retrieve all dashboards enabled for the authenticated user's account.","summary":"List available dashboards","parameters":[{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Analytics"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedReportDashboardList"}}},"description":""}}}},"/ref/deals":{"get":{"operationId":"ref_deals_list","description":"Retrieves a combined list of deals from multiple sources, including standard deals and optionally curated deals (if the feature flag is enabled). Each entry includes details such as pricing, inventory source, and activity status. The response always includes source (Deal Source), deal_type (Deal Type), name (Supplier Deal Name), name_override (supplier name override), seller_status (Deal Status from seller), and archived (platform active/archived status).","summary":"Get a unified list of deals","parameters":[{"in":"query","name":"active","schema":{"type":"boolean"},"description":"Filter deals by active status."},{"in":"query","name":"advertiser_id","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__equals_or_null","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"advertiser_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id__lt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__lte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"archived","schema":{"type":"boolean"},"description":"Archived deals cannot be selected for targeting"},{"in":"query","name":"create_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"create_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"deal_format","schema":{"type":"string"}},{"in":"query","name":"deal_format__equals_or_null","schema":{"type":"string"}},{"in":"query","name":"deal_format__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"deal_format__isempty","schema":{"type":"string"}},{"in":"query","name":"deal_format__not","schema":{"type":"string"}},{"in":"query","name":"deal_format__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"deal_id","schema":{"type":"string"}},{"in":"query","name":"deal_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"deal_id__isempty","schema":{"type":"string"}},{"in":"query","name":"deal_id__not","schema":{"type":"string"}},{"in":"query","name":"deal_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"end_date__range_or_null","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"inventory_source_active","schema":{"type":"boolean"}},{"in":"query","name":"inventory_source_key","schema":{"type":"string"},"description":"Filter deals by inventory source key."},{"in":"query","name":"inventory_source_viewable","schema":{"type":"boolean"},"description":"Viewability of the inventory source"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"string"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"restricted_adomains__contains","schema":{"type":"string"}},{"in":"query","name":"restricted_adomains__not_contains","schema":{"type":"string"}},{"in":"query","name":"search","schema":{"type":"string"},"description":"Search deals by name or inventory deal ID."},{"in":"query","name":"source","schema":{"type":"string"},"description":"Filter deals by source (manual, curated source value)."},{"in":"query","name":"type","schema":{"type":"string"},"description":"Filter by deal type (deal, curated_deal)."},{"in":"query","name":"update_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"update_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDealRefList"}}},"description":"Unified deal list retrieved successfully."},"404":{"description":"No deals found."},"500":{"description":"Internal server error."}}}},"/ref/deliveries":{"get":{"operationId":"ref_deliveries_list","description":"Retrieve a list of deliveries.","summary":"List deliveries","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Audio Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDeliveryList"}}},"description":"Deliveries retrieved successfully."},"400":{"description":"Invalid request."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/delivery-modifier-targeting-keys":{"get":{"operationId":"ref_delivery_modifier_targeting_keys_list","description":"Retrieve all available targeting keys.","summary":"List targeting keys","parameters":[{"in":"query","name":"module","schema":{"type":"string"},"description":"Filter targeting keys by module."}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedKeyConfigList"}}},"description":"List of targeting key configuration."},"400":{"description":"The request was invalid. See response body for details."},"401":{"description":"Authentication credentials were not provided or are invalid."},"403":{"description":"You do not have permission to access this resource."},"500":{"description":"An error occurred on the server."}}}},"/ref/delivery-modifier-targeting-keys/{key}":{"get":{"operationId":"ref_delivery_modifier_targeting_keys_retrieve","description":"Fetch a configuration for a Delivery Modifier Key by its unique key. Returns 404 if the key does not exist.","summary":"Retrieve a Delivery Modifier Key configuration","parameters":[{"in":"path","name":"key","schema":{"type":"string"},"description":"Unique identifier of the delivery modifier key.","required":true}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryModifierTermV2"}}},"description":"Delivery Modifier Key configuration retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"404":{"description":"No matches found for the provided targeting key."},"500":{"description":"Internal server error."}}}},"/ref/device-makes":{"get":{"operationId":"ref_device_makes_list","description":"Retrieve a list of device manufacturers (e.g., Samsung, Apple).","summary":"List device makes","parameters":[{"in":"query","name":"category","schema":{"type":"string"},"description":"Filter by category"},{"in":"query","name":"category__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"category__isempty","schema":{"type":"boolean"}},{"in":"query","name":"category__not","schema":{"type":"string"}},{"in":"query","name":"category__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Filter by key"},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Filter by name containing substring"},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDeviceMakeList"}}},"description":"Device makes retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/device-models":{"get":{"operationId":"ref_device_models_list","description":"Retrieve a list of device models (e.g., Samsung Galaxy, iPhone 14).","summary":"List device models","parameters":[{"in":"query","name":"category","schema":{"type":"string"},"description":"Filter by category"},{"in":"query","name":"device_make","schema":{"type":"integer"},"description":"Filter by device make ID"},{"in":"query","name":"device_make_key","schema":{"type":"string"}},{"in":"query","name":"device_make_key__contains","schema":{"type":"string"}},{"in":"query","name":"device_make_key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"device_make_key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"device_make_key__not","schema":{"type":"string"}},{"in":"query","name":"device_make_key__not_contains","schema":{"type":"string"}},{"in":"query","name":"device_make_key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Filter by name containing substring"},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDeviceModelList"}}},"description":"Device models retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/device-screen-sizes":{"get":{"operationId":"ref_device_screen_sizes_list","description":"Retrieve a list of available device screen sizes.","summary":"List device screen sizes","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDeviceScreenSizeList"}}},"description":"Device screen sizes retrieved successfully."},"400":{"description":"Invalid request."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/devices":{"get":{"operationId":"ref_devices_list","description":"Retrieve a list of device types as defined in OpenRTB section 6.16.","summary":"List device types","parameters":[{"in":"query","name":"id","schema":{"type":"integer"},"description":"Filter by ID"},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Filter by name"},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDeviceList"}}},"description":"Device types retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/environment-types":{"get":{"operationId":"ref_environment_types_list","description":"Retrieve a list of environment types indicating where an ad may be shown, such as web or app environments.","summary":"List environment types","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Environment Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedEnvironmentTypeList"}}},"description":"Environment types retrieved successfully."},"400":{"description":"Invalid request."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/event-tag-types":{"get":{"operationId":"ref_event_tag_types_list","description":"Retrieve a list of all available event tag types.","summary":"List event tag types","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedEventTagTypeList"}}},"description":"Event tag types retrieved successfully."},"400":{"description":"Invalid request."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/event-types":{"get":{"operationId":"ref_event_types_list","description":"Retrieve a list of all available event types.","summary":"List event types","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedEventTypeList"}}},"description":"Event types retrieved successfully."},"400":{"description":"Invalid request."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/experiment-id-types":{"get":{"operationId":"ref_experiment_id_types_list","description":"Retrieve a list of experiment ID types, including standard and IP-based IDs. Cross-device ID types are included per allowed vendor settings.","summary":"List experiment ID types","parameters":[{"in":"query","name":"cross_device","schema":{"type":"boolean"},"description":"Optional boolean flag to include cross-device ID types. Overrides system feature flag if provided."}],"tags":["Campaigns"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedExperimentIDTypeList"}}},"description":"Experiment ID types retrieved successfully."},"400":{"description":"Invalid request."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/feeds":{"get":{"operationId":"ref_feeds_list","description":"Retrieve the list of feeds available in the system.","summary":"Get list of feeds","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Audio Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedFeedList"}}},"description":"Feeds retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/frequency-cap-id-types":{"get":{"operationId":"ref_frequency_cap_id_types_list","description":"Returns a list of Frequency Cap ID Types based on system settings and feature flags. Includes standard, IP-based, customer-level, and optionally cross-device ID types.","summary":"Get list of Frequency Cap ID Types","parameters":[{"in":"query","name":"cross_device","schema":{"type":"boolean"},"description":"Optional boolean flag to include cross-device frequency cap types. Overrides system feature flag if provided."}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRefFrequencyCapIDTypeList"}}},"description":"Frequency Cap ID types retrieved successfully."},"400":{"description":"Invalid system configuration or unsupported frequency cap type."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/inventory-sources":{"get":{"operationId":"ref_inventory_sources_list","description":"Retrieve a list of inventory sources. These are two- or three-letter codes representing the exchange or inventory provider.","summary":"List inventory sources","parameters":[{"in":"query","name":"active","schema":{"type":"integer","enum":[-1,0,1]},"description":"Whether the object is active\n\n* `1` - Active\n* `0` - Inactive\n* `-1` - Deleted"},{"in":"query","name":"active__gt","schema":{"type":"integer"}},{"in":"query","name":"active__gte","schema":{"type":"integer"}},{"in":"query","name":"active__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"active__isempty","schema":{"type":"boolean"}},{"in":"query","name":"active__lt","schema":{"type":"integer"}},{"in":"query","name":"active__lte","schema":{"type":"integer"}},{"in":"query","name":"active__not","schema":{"type":"integer","enum":[-1,0,1]},"description":"Whether the object is active\n\n* `1` - Active\n* `0` - Inactive\n* `-1` - Deleted"},{"in":"query","name":"active__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"category","schema":{"type":"string"}},{"in":"query","name":"category__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"category__isempty","schema":{"type":"boolean"}},{"in":"query","name":"category__not","schema":{"type":"string"}},{"in":"query","name":"category__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"viewable","schema":{"type":"boolean"}}],"tags":["Exchange Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedInventorySourceList"}}},"description":"Inventory sources retrieved successfully."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/languages":{"get":{"operationId":"ref_languages_list","description":"Get list of languages of sites on which ads are shown. Lookup is based on ISO 639-1 language codes.","summary":"Get list of languages","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Content Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedLanguageList"}}},"description":"Languages retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/line-item-types":{"get":{"operationId":"ref_line_item_types_list","description":"Retrieve a list of all available line item types. Certain audio-related line item types may be excluded depending on account-level settings.","summary":"List line item types","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"pixel_size","schema":{"type":"integer"}},{"in":"query","name":"pixel_size__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"pixel_size__isempty","schema":{"type":"boolean"}},{"in":"query","name":"pixel_size__not","schema":{"type":"integer"}},{"in":"query","name":"pixel_size__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"sizeless","schema":{"type":"boolean"}},{"in":"query","name":"sizeless__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"sizeless__isempty","schema":{"type":"boolean"}},{"in":"query","name":"sizeless__not","schema":{"type":"integer"}},{"in":"query","name":"sizeless__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedLineItemTypeList"}}},"description":"Line item types retrieved successfully."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/lists":{"get":{"operationId":"ref_lists_list","description":"Retrieves a list of all available custom lists. These lists are used for targeting, segmentation, and other campaign-level data management tasks.","summary":"Get a list of available custom lists","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"},"description":"Unique Key of the custom list type, e.q. \"ip_address\""},{"in":"query","name":"type__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"type__isempty","schema":{"type":"boolean"}},{"in":"query","name":"type__not","schema":{"type":"string"},"description":"Unique Key of the custom list type, e.q. \"ip_address\""},{"in":"query","name":"type__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Lists"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedListList"}}},"description":"Custom lists retrieved successfully."},"404":{"description":"No custom lists found."},"500":{"description":"Internal server error."}}}},"/ref/lists/{id}":{"get":{"operationId":"ref_lists_retrieve","description":"Retrieve details of a specific custom list identified by its ID.","summary":"Get a custom list by ID","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this list.","required":true}],"tags":["Lists"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List"}}},"description":"Custom list retrieved successfully."},"404":{"description":"Custom list not found."},"500":{"description":"Internal server error."}}}},"/ref/lists/{id}/items":{"get":{"operationId":"ref_lists_items_retrieve","description":"Retrieve all items that belong to a specific custom list. Supports search and pagination.","summary":"Get items of a custom list","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this list.","required":true}],"tags":["Lists"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedCustomListItemList"}}},"description":"Custom list items retrieved successfully."},"404":{"description":"Custom list not found."},"500":{"description":"Internal server error."}}}},"/ref/metros":{"get":{"operationId":"ref_metros_list","description":"Retrieve a list of Google's metro codes, similar to Nielsen DMAs. Applicable only for U.S. regions.","summary":"Get list of metro codes","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Geo Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDMAList"}}},"description":"Metro codes retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/native-layouts":{"get":{"operationId":"ref_native_layouts_list","description":"Retrieve a list of native creative layouts supported by the platform. These layouts determine the format and structure of native creatives.","summary":"Get list of native layouts","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Environment Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedNativeLayoutList"}}},"description":"Native layouts retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/object-types":{"get":{"operationId":"ref_object_types_list","description":"Retrieve a list of all object types available in the system. Object types represent different entities used across the platform.","summary":"Get list of object types","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__contains","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_contains","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedObjectTypeList"}}},"description":"Object types retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/operating-system-versions":{"get":{"operationId":"ref_operating_system_versions_list","description":"Retrieve a list of all operating system versions. Each version is tied to its corresponding operating system.","summary":"List operating system versions","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"operating_system_key","schema":{"type":"string"},"description":"Foreign key to the /ref/operating-systems resource"},{"in":"query","name":"operating_system_key__contains","schema":{"type":"string"}},{"in":"query","name":"operating_system_key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"operating_system_key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"operating_system_key__not","schema":{"type":"string"}},{"in":"query","name":"operating_system_key__not_contains","schema":{"type":"string"}},{"in":"query","name":"operating_system_key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedOperatingSystemVersionList"}}},"description":"Operating system versions retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/operating-systems":{"get":{"operationId":"ref_operating_systems_list","description":"Retrieve a list of all operating systems. Filtering is supported on key, name, and category.","summary":"List operating systems","parameters":[{"in":"query","name":"category","schema":{"type":"string"},"description":"Filter by category"},{"in":"query","name":"category__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"category__isempty","schema":{"type":"boolean"}},{"in":"query","name":"category__not","schema":{"type":"string"}},{"in":"query","name":"category__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Filter by key"},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Filter by name"},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Platform Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedOperatingSystemList"}}},"description":"Operating systems retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/regions":{"get":{"operationId":"ref_regions_list","description":"Get list of regions. Represents geographic subdivisions of a country, based on ISO 3166-2.","summary":"Get list of regions","parameters":[{"in":"query","name":"country_code_2","schema":{"type":"string"}},{"in":"query","name":"country_code_2__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"country_code_2__isempty","schema":{"type":"boolean"}},{"in":"query","name":"country_code_2__not","schema":{"type":"string"}},{"in":"query","name":"country_code_2__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"country_code_3","schema":{"type":"string"}},{"in":"query","name":"country_code_3__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"country_code_3__isempty","schema":{"type":"boolean"}},{"in":"query","name":"country_code_3__not","schema":{"type":"string"}},{"in":"query","name":"country_code_3__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Region in format <country_code>/<region_code>"},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"region_code","schema":{"type":"string"}},{"in":"query","name":"region_code__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"region_code__isempty","schema":{"type":"boolean"}},{"in":"query","name":"region_code__not","schema":{"type":"string"}},{"in":"query","name":"region_code__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"region_name","schema":{"type":"string"}},{"in":"query","name":"region_name__contains","schema":{"type":"string"}},{"in":"query","name":"region_name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"region_name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"region_name__not","schema":{"type":"string"}},{"in":"query","name":"region_name__not_contains","schema":{"type":"string"}},{"in":"query","name":"region_name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}],"tags":["Geo Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRegionList"}}},"description":"List of regions retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/report-field-groups":{"get":{"operationId":"ref_report_field_groups_list","description":"Retrieve a list of all report field groups with optional filtering.","summary":"List report field groups","parameters":[{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Analytics"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedReportFieldGroupList"}}},"description":"Report field groups retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/revenue-types":{"get":{"operationId":"ref_revenue_types_list","description":"Retrieve a list of all revenue types. Optionally filters out audio-related revenue types when the audio feature flag is disabled.","summary":"List revenue types","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedRevenueTypeList"}}},"description":"Revenue types retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/second-level-domains":{"get":{"operationId":"ref_second_level_domains_list","description":"Retrieve a list of all second-level domains with optional filtering.","summary":"List second-level domains","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__contains","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_contains","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["App/Site Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSecondLevelDomainList"}}},"description":"Second-level domains retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/segment-search":{"get":{"operationId":"ref_segment_search_list","description":"Search across custom segments that are either directly owned by the active account or shared with it. Returns a flat list of matching segment nodes.","summary":"Search custom segments","parameters":[{"in":"query","name":"advertiser_id","schema":{"type":"number"},"description":"Only return segments owned by a specific advertiser."},{"in":"query","name":"advertiser_id__equals_or_null","schema":{"type":"number"},"description":"Only return segments with no owner or owned by a specific advertiser."},{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"cpm","schema":{"type":"number"},"description":"Only return segments whose CPM exactly matches this value."},{"in":"query","name":"cpm__gt","schema":{"type":"number"},"description":"Only return segments whose CPM is greater than this value."},{"in":"query","name":"cpm__lt","schema":{"type":"number"},"description":"Only return segments whose CPM is less than this value."},{"name":"favorite","required":false,"in":"query","description":"Filter to the set of objects the user has \"favorited\".","schema":{"type":"boolean"}},{"in":"query","name":"key__contains","schema":{"type":"string"},"description":"Only return segments whose key contains this value (case-insensitive)."},{"in":"query","name":"name","schema":{"type":"string"},"description":"Only return segments whose name exactly matches this value."},{"in":"query","name":"name__contains","schema":{"type":"string"},"description":"Only return segments whose name contains this value (case-insensitive)."},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segments whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"},"description":"When true, only return segments with an empty or missing name. When false, exclude them."},{"in":"query","name":"name__not","schema":{"type":"string"},"description":"Exclude segments whose name exactly matches this value."},{"in":"query","name":"name__not_contains","schema":{"type":"string"},"description":"Exclude segments whose name contains this value (case-insensitive)."},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segments whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"},"description":"Only return segments whose type matches this value ('segment' or 'category')."},{"in":"query","name":"type__isempty","schema":{"type":"boolean"},"description":"When true, only return segments with an empty or missing type. When false, exclude them."},{"in":"query","name":"type__not","schema":{"type":"string"},"description":"Exclude segments whose type matches this value ('segment' or 'category')."},{"in":"query","name":"user_count_by_region__apac__gt","schema":{"type":"number"},"description":"Only return segments whose APAC user count is greater than this value."},{"in":"query","name":"user_count_by_region__apac__lt","schema":{"type":"number"},"description":"Only return segments whose APAC user count is less than this value."},{"in":"query","name":"user_count_by_region__emea__gt","schema":{"type":"number"},"description":"Only return segments whose EMEA user count is greater than this value."},{"in":"query","name":"user_count_by_region__emea__lt","schema":{"type":"number"},"description":"Only return segments whose EMEA user count is less than this value."},{"in":"query","name":"user_count_by_region__nam__gt","schema":{"type":"number"},"description":"Only return segments whose North America (NAM) user count is greater than this value."},{"in":"query","name":"user_count_by_region__nam__lt","schema":{"type":"number"},"description":"Only return segments whose North America (NAM) user count is less than this value."},{"in":"query","name":"user_count_update_date__gt","schema":{"type":"string","format":"date-time"},"description":"Only return segments whose user count update date is after this timestamp."},{"in":"query","name":"user_count_update_date__lt","schema":{"type":"string","format":"date-time"},"description":"Only return segments whose user count update date is before this timestamp."}],"tags":["Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSegmentTreeNodeList"}}},"description":"Segments retrieved successfully."},"400":{"description":"Invalid search or filter parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/segment-tree":{"get":{"operationId":"ref_segment_tree_list","description":"Returns the hierarchical segment tree including segment categories and segments. Includes both locally owned and shared segments for the active account.","summary":"Navigate segment tree","parameters":[{"in":"query","name":"advertiser_id","schema":{"type":"number"},"description":"Only return segments owned by a specific advertiser."},{"in":"query","name":"advertiser_id__equals_or_null","schema":{"type":"number"},"description":"Only return segments with no owner or owned by a specific advertiser."},{"in":"query","name":"key","schema":{"type":"string"},"description":"Only return segment tree nodes whose key exactly matches this value."},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segment tree nodes whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"},"description":"When true, only return segment tree nodes with an empty or missing key. When false, exclude them."},{"in":"query","name":"key__not","schema":{"type":"string"},"description":"Exclude segment tree nodes whose key exactly matches this value."},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segment tree nodes whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Only return segment tree nodes whose name exactly matches this value."},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"parent_key","schema":{"type":"string"},"description":"Only return segment tree nodes whose parent key exactly matches this value."},{"in":"query","name":"parent_key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segment tree nodes whose parent key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"parent_key__isempty","schema":{"type":"boolean"},"description":"When true, only return segment tree nodes with an empty or missing parent key. When false, exclude them."},{"in":"query","name":"parent_key__not","schema":{"type":"string"},"description":"Exclude segment tree nodes whose parent key exactly matches this value."},{"in":"query","name":"parent_key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segment tree nodes whose parent key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"type","schema":{"type":"string"},"description":"Only return segment tree nodes whose type matches this value ('segment' or 'category')."},{"in":"query","name":"type__isempty","schema":{"type":"boolean"},"description":"When true, only return segment tree nodes with an empty or missing type. When false, exclude them."},{"in":"query","name":"type__not","schema":{"type":"string"},"description":"Exclude segment tree nodes whose type matches this value ('segment' or 'category')."}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSegmentTreeNodeList"}}},"description":"Segment tree retrieved successfully."},"400":{"description":"Invalid filter or query parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/state-house-districts":{"get":{"operationId":"ref_state_house_districts_list","description":"Retrieve a list of state house legislative districts.","summary":"List state house districts","parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__not","schema":{"type":"string"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"state","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"state__isempty","schema":{"type":"boolean"}},{"in":"query","name":"state__not","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"state_id","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"state_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"state_id__not","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Geo Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedLegislativeDistrictList"}}},"description":"State house districts retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/state-senate-districts":{"get":{"operationId":"ref_state_senate_districts_list","description":"Retrieve a list of state senate legislative districts.","summary":"List state senate districts","parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__not","schema":{"type":"string"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"state","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"state__isempty","schema":{"type":"boolean"}},{"in":"query","name":"state__not","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"state_id","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"state_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"state_id__not","schema":{"type":"string"},"description":"Unique ID of the USA state"},{"in":"query","name":"state_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Geo Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedLegislativeDistrictList"}}},"description":"State senate districts retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/system-alerts":{"get":{"operationId":"ref_system_alerts_list","description":"Retrieve a list of all visible system alerts.","summary":"List system alerts","parameters":[{"in":"query","name":"description","schema":{"type":"string"}},{"in":"query","name":"description__contains","schema":{"type":"string"}},{"in":"query","name":"description__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"description__isempty","schema":{"type":"boolean"}},{"in":"query","name":"description__not","schema":{"type":"string"}},{"in":"query","name":"description__not_contains","schema":{"type":"string"}},{"in":"query","name":"description__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__contains","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_contains","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Admin"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSystemAlertList"}}},"description":"System alerts retrieved successfully."},"400":{"description":"Invalid query parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/system-fee-types":{"get":{"operationId":"ref_system_fee_types_list","description":"Retrieve the list of system fee types configured in the platform.","summary":"Get list of system fee types","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSystemFeeTypeList"}}},"description":"System fee types retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/targeting-keys":{"get":{"operationId":"ref_targeting_keys_list","description":"Retrieve all available targeting keys.","summary":"List targeting keys","parameters":[{"in":"query","name":"module","schema":{"type":"string"},"description":"Filter targeting keys by module."}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedKeyConfigList"}}},"description":"List of targeting key configuration."},"400":{"description":"The request was invalid. See response body for details."},"401":{"description":"Authentication credentials were not provided or are invalid."},"403":{"description":"You do not have permission to access this resource."},"500":{"description":"An error occurred on the server."}}}},"/ref/targeting-keys/{key}":{"get":{"operationId":"ref_targeting_keys_retrieve","description":"Retrieve configuration details for a specific targeting key.","summary":"Retrieve targeting key details","parameters":[{"in":"path","name":"key","schema":{"type":"string"},"description":"Unique targeting key (e.g., \"metro\").","required":true}],"tags":["Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedKeyConfigList"}}},"description":"List of targeting key configuration."},"400":{"description":"The request was invalid. See response body for details."},"401":{"description":"Authentication credentials were not provided or are invalid."},"403":{"description":"You do not have permission to access this resource."},"404":{"description":"No matches for targeting key."},"500":{"description":"An error occurred on the server."}}}},"/ref/timezones":{"get":{"operationId":"ref_timezones_list","description":"Retrieves a list of timezones.","summary":"Get list of timezones","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"selectable","schema":{"type":"boolean"}}],"tags":["Admin"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedTimezoneList"}}},"description":"Timezones retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/usa-states":{"get":{"operationId":"ref_usa_states_list","description":"Retrieve a list of USA states.","summary":"List USA states","parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__not","schema":{"type":"string"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Geo Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedUSAStatesList"}}},"description":"USA states retrieved successfully."},"400":{"description":"Invalid request parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/vendor-fee-types":{"get":{"operationId":"ref_vendor_fee_types_list","description":"Retrieve the list of vendor fee types available in the system.","summary":"Get list of vendor fee types","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVendorFeeTypeList"}}},"description":"Vendor fee types retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/vendors":{"get":{"operationId":"ref_vendors_list","description":"Retrieve a list of all vendors.","summary":"List vendors","parameters":[{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Trafficking"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVendorList"}}},"description":"Vendors retrieved successfully."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/video-apis":{"get":{"operationId":"ref_video_apis_list","description":"Retrieve the list of video APIs available for video creatives.","summary":"Get list of video APIs","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Creatives"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVideoApiList"}}},"description":"Video API list retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/video-autoplay-types":{"get":{"operationId":"ref_video_autoplay_types_list","description":"Retrieve the list of available video autoplay types.","summary":"Get list of video autoplay types","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Video Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVideoAutoplayTypeList"}}},"description":"Video autoplay types retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/video-encoding-profiles":{"get":{"operationId":"ref_video_encoding_profiles_list","description":"Retrieve a list of available video encoding profiles.","summary":"List video encoding profiles","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Creatives"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVideoEncodingProfileList"}}},"description":"Video encoding profiles retrieved successfully."},"400":{"description":"Invalid request."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/video-encoding-statuses":{"get":{"operationId":"ref_video_encoding_statuses_list","description":"Retrieve a list of all available video encoding statuses.","summary":"List video encoding statuses","parameters":[{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"video_encoding_status_description","schema":{"type":"string"}},{"in":"query","name":"video_encoding_status_description__contains","schema":{"type":"string"}},{"in":"query","name":"video_encoding_status_description__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"video_encoding_status_description__isempty","schema":{"type":"boolean"}},{"in":"query","name":"video_encoding_status_description__not","schema":{"type":"string"}},{"in":"query","name":"video_encoding_status_description__not_contains","schema":{"type":"string"}},{"in":"query","name":"video_encoding_status_description__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"video_encoding_status_id","schema":{"type":"integer"}},{"in":"query","name":"video_encoding_status_id__gt","schema":{"type":"integer"}},{"in":"query","name":"video_encoding_status_id__gte","schema":{"type":"integer"}},{"in":"query","name":"video_encoding_status_id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"video_encoding_status_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"video_encoding_status_id__lt","schema":{"type":"integer"}},{"in":"query","name":"video_encoding_status_id__lte","schema":{"type":"integer"}},{"in":"query","name":"video_encoding_status_id__not","schema":{"type":"integer"}},{"in":"query","name":"video_encoding_status_id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Creatives"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVideoEncodingStatusList"}}},"description":"Video encoding statuses retrieved successfully."},"400":{"description":"Invalid request."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/ref/video-placement-types":{"get":{"operationId":"ref_video_placement_types_list","description":"Retrieve the list of video placement types. These define the context in which a video is shown.","summary":"Get list of video placement types","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Video Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVideoPlacementTypeList"}}},"description":"Video placement types retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/video-playback-methods":{"get":{"operationId":"ref_video_playback_methods_list","description":"Retrieve the list of video playback methods, defining how a video will be played. These values follow the OpenRTB 6.6 specification.","summary":"Get list of video playback methods","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Video Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVideoPlaybackMethodList"}}},"description":"Video playback methods retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/video-player-sizes":{"get":{"operationId":"ref_video_player_sizes_list","description":"Retrieve the list of available video player sizes.","summary":"Get list of video player sizes","parameters":[{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Video Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVideoPlayerSizeList"}}},"description":"Video player sizes retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/video-protocols":{"get":{"operationId":"ref_video_protocols_list","description":"Retrieve the list of supported video protocols.","summary":"Get list of video protocols","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Creatives"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVideoProtocolList"}}},"description":"Video protocols retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/video-start-delays":{"get":{"operationId":"ref_video_start_delays_list","description":"Retrieve list of video start delays. Indicates the position of the video ad relative to the content, based on OpenRTB 6.9.","summary":"Get list of video start delays","parameters":[{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__gt","schema":{"type":"integer"}},{"in":"query","name":"id__gte","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__lt","schema":{"type":"integer"}},{"in":"query","name":"id__lte","schema":{"type":"integer"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"}},{"in":"query","name":"name__contains","schema":{"type":"string"}},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"}},{"in":"query","name":"name__not","schema":{"type":"string"}},{"in":"query","name":"name__not_contains","schema":{"type":"string"}},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Video Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedVideoStartDelayList"}}},"description":"Video start delays retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"500":{"description":"Internal server error."}}}},"/ref/warning-codes":{"get":{"operationId":"ref_warning_codes_list","description":"Retrieve a list of all available warning codes.","summary":"List warning codes","parameters":[{"in":"query","name":"code","schema":{"type":"string"}},{"in":"query","name":"code__contains","schema":{"type":"string"}},{"in":"query","name":"code__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"code__isempty","schema":{"type":"boolean"}},{"in":"query","name":"code__not","schema":{"type":"string"}},{"in":"query","name":"code__not_contains","schema":{"type":"string"}},{"in":"query","name":"code__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id","schema":{"type":"integer"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"id__not","schema":{"type":"integer"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Reference"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedWarningCodeList"}}},"description":"Warning codes retrieved successfully."},"400":{"description":"Invalid request."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/segment-categories":{"get":{"operationId":"segment_categories_list","description":"Returns a list of segment categories for the current account. Supports filtering by parent category, advertiser, and other attributes. Includes both locally owned and shared segment categories.","summary":"List segment categories","parameters":[{"in":"query","name":"account_id","schema":{"type":"number"}},{"in":"query","name":"account_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"account_id__not","schema":{"type":"number"}},{"in":"query","name":"account_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"active","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__equals_or_null","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"advertiser_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id__lt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__lte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"create_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"create_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Only return records whose key exactly matches this value."},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return records whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"},"description":"When true, only return records with an empty or missing key. When false, exclude them."},{"in":"query","name":"key__not","schema":{"type":"string"},"description":"Exclude records whose key exactly matches this value."},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude records whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Only return records whose name exactly matches this value."},{"in":"query","name":"name__contains","schema":{"type":"string"},"description":"Only return records whose name contains this value (case-insensitive)."},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return records whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"},"description":"When true, only return records with an empty or missing name. When false, exclude them."},{"in":"query","name":"name__not","schema":{"type":"string"},"description":"Exclude records whose name exactly matches this value."},{"in":"query","name":"name__not_contains","schema":{"type":"string"},"description":"Exclude records whose name contains this value (case-insensitive)."},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude records whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"notes__isempty","schema":{"type":"boolean"},"description":"When true, only return segment categories with an empty or missing note text. When false, exclude them."},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"parent_key","schema":{"type":"string"},"description":"Only return segment categories whose parent category key exactly matches this value."},{"in":"query","name":"parent_key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segment categories whose parent category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"parent_key__isempty","schema":{"type":"boolean"},"description":"When true, only return segment categories with an empty or missing parent category key. When false, exclude them."},{"in":"query","name":"parent_key__not","schema":{"type":"string"},"description":"Exclude segment categories whose parent category key exactly matches this value."},{"in":"query","name":"parent_key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segment categories whose parent category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"update_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"update_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSegmentCategoryList"}}},"description":"Segment categories retrieved successfully."},"400":{"description":"Invalid filter or query parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}},"post":{"operationId":"segment_categories_create","description":"Creates a new segment category with the provided attributes. Segment categories organize segments hierarchically and can have parent-child relationships.","summary":"Create a segment category","tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}}},"description":"Segment category created successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/segment-categories/bulk":{"post":{"operationId":"segment_categories_bulk_create","description":"Create multiple segment categories at once. Accepts up to 100 objects per request.","summary":"Bulk create segment categories","tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategory"}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategory"}}},"multipart/form-data":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategory"}}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategory"}}}},"description":"Segment categories created successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}},"patch":{"operationId":"segment_categories_bulk_partial_update","description":"Update multiple segment categories at once. Accepts up to 100 objects per request. A request body is required.","summary":"Bulk update segment categories","parameters":[{"in":"query","name":"ids","schema":{"type":"string"},"description":"Comma-separated list of IDs to update. Required when the request body is a single object, which is then applied to every listed ID. Omit it when the request body is a list of objects, each carrying its own id. At most 100 IDs per request."}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/PatchedSegmentCategory"}},{"$ref":"#/components/schemas/PatchedSegmentCategory"}]}}}},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategory"}}}},"description":"Segment categories updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}},"delete":{"operationId":"segment_categories_bulk_destroy","description":"Delete multiple segment categories using the ids query parameter. Accepts up to 100 IDs per request.","summary":"Bulk delete segment categories","parameters":[{"in":"query","name":"ids","schema":{"type":"string"},"description":"Comma-separated list of IDs to delete. At most 100 IDs per request.","required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"204":{"description":"Segment categories deleted successfully."},"400":{"description":"Cannot delete category with child categories, segments, or shared relationships."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}}},"/segment-categories/tree":{"get":{"operationId":"segment_categories_tree_list","description":"Returns one level of the segment category tree at a time for lazy loading. Without parent_key parameter: returns top-level categories (where parent_key is NULL). With parent_key=<key>: returns child categories of the specified parent. Each category includes a subcategories_url for navigating to its children.","summary":"Navigate segment category tree","parameters":[{"in":"query","name":"account_id","schema":{"type":"number"}},{"in":"query","name":"account_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"account_id__not","schema":{"type":"number"}},{"in":"query","name":"account_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"active","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__equals_or_null","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"advertiser_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id__lt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__lte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"create_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"create_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Only return records whose key exactly matches this value."},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return records whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"},"description":"When true, only return records with an empty or missing key. When false, exclude them."},{"in":"query","name":"key__not","schema":{"type":"string"},"description":"Exclude records whose key exactly matches this value."},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude records whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Only return records whose name exactly matches this value."},{"in":"query","name":"name__contains","schema":{"type":"string"},"description":"Only return records whose name contains this value (case-insensitive)."},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return records whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"},"description":"When true, only return records with an empty or missing name. When false, exclude them."},{"in":"query","name":"name__not","schema":{"type":"string"},"description":"Exclude records whose name exactly matches this value."},{"in":"query","name":"name__not_contains","schema":{"type":"string"},"description":"Exclude records whose name contains this value (case-insensitive)."},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude records whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"notes__isempty","schema":{"type":"boolean"},"description":"When true, only return segment categories with an empty or missing note text. When false, exclude them."},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"parent_key","schema":{"type":"string"},"description":"Only return segment categories whose parent category key exactly matches this value."},{"in":"query","name":"parent_key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segment categories whose parent category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"parent_key__isempty","schema":{"type":"boolean"},"description":"When true, only return segment categories with an empty or missing parent category key. When false, exclude them."},{"in":"query","name":"parent_key__not","schema":{"type":"string"},"description":"Exclude segment categories whose parent category key exactly matches this value."},{"in":"query","name":"parent_key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segment categories whose parent category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"update_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"update_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSegmentCategoryTreeList"}}},"description":"Segment category tree level retrieved successfully."},"400":{"description":"Invalid filter or query parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/segment-categories/{id}":{"get":{"operationId":"segment_categories_retrieve","description":"Fetches details of a specific segment category by its ID.","summary":"Retrieve a segment category","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"Unique ID of the segment category"},"required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}}},"description":"Segment category retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}},"put":{"operationId":"segment_categories_update","description":"Performs a full update on the specified segment category. All required fields must be provided.","summary":"Update a segment category","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"Unique ID of the segment category"},"required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}}},"description":"Segment category updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}},"patch":{"operationId":"segment_categories_partial_update","description":"Performs a partial update on the specified segment category. All fields are optional; only provided fields are modified.","summary":"Partial update a segment category","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"Unique ID of the segment category"},"required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedSegmentCategory"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedSegmentCategory"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedSegmentCategory"}}}},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}}},"description":"Segment category updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}},"delete":{"operationId":"segment_categories_destroy","description":"Deletes the specified segment category. Cannot delete categories that have child categories, contain segments, or are shared with other accounts.","summary":"Delete a segment category","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"Unique ID of the segment category"},"required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"204":{"description":"Segment category deleted successfully."},"400":{"description":"Cannot delete category with child categories, segments, or shared relationships."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}}},"/segment-categories/{id}/duplicate":{"get":{"operationId":"segment_categories_duplicate_retrieve","description":"Returns the duplication options for this segment category: the `duplicate` field lists the entities that can be copied for this particular category. Use it to build the POST body.","summary":"Preview segment category duplication","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"Unique ID of the segment category"},"required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategoryDuplicate"}}},"description":"Segment category duplication preview retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}},"post":{"operationId":"segment_categories_duplicate_create","description":"Creates a duplicate of the segment category with a new name and optionally duplicates child entities.","summary":"Duplicate a segment category","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"Unique ID of the segment category"},"required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategoryDuplicate"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentCategoryDuplicate"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentCategoryDuplicate"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategory"}}},"description":"Segment category duplicated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}}},"/segment-tags":{"get":{"operationId":"segment_tags_list","description":"Returns tracking tags for multiple segments. Tags are rendered based on the tag_type query parameter (default: 'js'). Used to add users to segments when they visit your website.","summary":"List segment tags","parameters":[{"in":"query","name":"account_id","schema":{"type":"number"}},{"in":"query","name":"account_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"account_id__not","schema":{"type":"number"}},{"in":"query","name":"account_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"active","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__equals_or_null","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"advertiser_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id__lt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__lte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"aggregate_excludes","schema":{"type":"boolean"},"description":"Only return segments whose aggregate excludes flag matches this value."},{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"category_keys","schema":{"type":"string"},"description":"Only return segments whose segment category key exactly matches this value."},{"in":"query","name":"category_keys__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segments whose segment category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"category_keys__isempty","schema":{"type":"boolean"},"description":"When true, only return segments with an empty or missing segment category key. When false, exclude them."},{"in":"query","name":"category_keys__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segments whose segment category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"cpm_cost","schema":{"type":"number"},"description":"Only return segments whose CPM cost exactly matches this value."},{"in":"query","name":"cpm_cost__gt","schema":{"type":"number"},"description":"Only return segments whose CPM cost is greater than this value."},{"in":"query","name":"cpm_cost__in","schema":{"type":"array","items":{"type":"number"}},"description":"Only return segments whose CPM cost matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"cpm_cost__lt","schema":{"type":"number"},"description":"Only return segments whose CPM cost is less than this value."},{"in":"query","name":"cpm_cost__not","schema":{"type":"number"},"description":"Exclude segments whose CPM cost exactly matches this value."},{"in":"query","name":"cpm_cost__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Exclude segments whose CPM cost matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"create_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"create_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"description","schema":{"type":"string"},"description":"Only return segments whose description exactly matches this value."},{"in":"query","name":"description__contains","schema":{"type":"string"},"description":"Only return segments whose description contains this value (case-insensitive)."},{"in":"query","name":"description__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segments whose description matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"description__isempty","schema":{"type":"boolean"},"description":"When true, only return segments with an empty or missing description. When false, exclude them."},{"in":"query","name":"description__not","schema":{"type":"string"},"description":"Exclude segments whose description exactly matches this value."},{"in":"query","name":"description__not_contains","schema":{"type":"string"},"description":"Exclude segments whose description contains this value (case-insensitive)."},{"in":"query","name":"description__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segments whose description matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"extensible","schema":{"type":"boolean"},"description":"Only return segments whose extensible flag matches this value."},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Only return records whose key exactly matches this value."},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return records whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"},"description":"When true, only return records with an empty or missing key. When false, exclude them."},{"in":"query","name":"key__not","schema":{"type":"string"},"description":"Exclude records whose key exactly matches this value."},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude records whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Only return records whose name exactly matches this value."},{"in":"query","name":"name__contains","schema":{"type":"string"},"description":"Only return records whose name contains this value (case-insensitive)."},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return records whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"},"description":"When true, only return records with an empty or missing name. When false, exclude them."},{"in":"query","name":"name__not","schema":{"type":"string"},"description":"Exclude records whose name exactly matches this value."},{"in":"query","name":"name__not_contains","schema":{"type":"string"},"description":"Exclude records whose name contains this value (case-insensitive)."},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude records whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"tag_type","schema":{"type":"string","enum":["iframe","image_ip","in_app","js","js_alt"],"default":"js"},"description":"Format of the tag to render. Each value names a template in the segment tag directory. Defaults to 'js'."},{"in":"query","name":"ttl_days","schema":{"type":"integer"},"description":"Only return segments whose TTL in days exactly matches this value."},{"in":"query","name":"ttl_days__gt","schema":{"type":"integer"},"description":"Only return segments whose TTL in days is greater than this value."},{"in":"query","name":"ttl_days__lt","schema":{"type":"integer"},"description":"Only return segments whose TTL in days is less than this value."},{"in":"query","name":"ttl_days__not","schema":{"type":"integer"},"description":"Exclude segments whose TTL in days exactly matches this value."},{"in":"query","name":"update_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"update_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"verb","schema":{"type":"string"},"description":"Only return segments whose verb usage exactly matches this value."},{"in":"query","name":"verb__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segments whose verb usage matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"verb__isempty","schema":{"type":"boolean"},"description":"When true, only return segments with an empty or missing verb usage. When false, exclude them."},{"in":"query","name":"verb__not","schema":{"type":"string"},"description":"Exclude segments whose verb usage exactly matches this value."},{"in":"query","name":"verb__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segments whose verb usage matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSegmentTagList"}}},"description":"Segment tags retrieved successfully."},"400":{"description":"Invalid data provided."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/segment-tags/{id}":{"get":{"operationId":"segment_tags_retrieve","description":"Returns a tracking tag for a specific segment by ID. Tag format determined by the tag_type query parameter (default: 'js').","summary":"Retrieve segment tag","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"The unique ID of the segment"},"required":true},{"in":"query","name":"tag_type","schema":{"type":"string","enum":["iframe","image_ip","in_app","js","js_alt"],"default":"js"},"description":"Format of the tag to render. Each value names a template in the segment tag directory. Defaults to 'js'."}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentTag"}}},"description":"Segment tag retrieved successfully."},"400":{"description":"Invalid data provided."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment not found."}}}},"/segment-uploads":{"get":{"operationId":"segment_uploads_list","description":"Returns a list of segment upload jobs for the current account. Segment uploads import user IDs to populate segments from files or S3 references.","summary":"List segment uploads","parameters":[{"in":"query","name":"account_id","schema":{"type":"number"}},{"in":"query","name":"account_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"account_id__not","schema":{"type":"number"}},{"in":"query","name":"account_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"complete_date","schema":{"type":"string","format":"date-time"},"description":"Only return segment uploads whose completion date exactly matches this timestamp."},{"in":"query","name":"complete_date__gt","schema":{"type":"string","format":"date-time"},"description":"Only return segment uploads whose completion date is after this timestamp."},{"in":"query","name":"complete_date__gte","schema":{"type":"string","format":"date-time"},"description":"Only return segment uploads whose completion date is at or after this timestamp."},{"in":"query","name":"complete_date__isempty","schema":{"type":"boolean"},"description":"When true, only return segment uploads with no completion date. When false, exclude them."},{"in":"query","name":"complete_date__lt","schema":{"type":"string","format":"date-time"},"description":"Only return segment uploads whose completion date is before this timestamp."},{"in":"query","name":"complete_date__lte","schema":{"type":"string","format":"date-time"},"description":"Only return segment uploads whose completion date is at or before this timestamp."},{"in":"query","name":"complete_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"Only return segment uploads whose completion date falls in the selected relative date range.\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"continent","schema":{"type":"string"},"description":"Only return segment uploads whose continent exactly matches this value."},{"in":"query","name":"continent__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segment uploads whose continent matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"continent__isempty","schema":{"type":"boolean"},"description":"When true, only return segment uploads with an empty or missing continent. When false, exclude them."},{"in":"query","name":"continent__not","schema":{"type":"string"},"description":"Exclude segment uploads whose continent exactly matches this value."},{"in":"query","name":"continent__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segment uploads whose continent matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"create_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"create_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"is_pii_segment","schema":{"type":"boolean"},"description":"Only return segment uploads whose PII flag matches this value."},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"partner_handle","schema":{"type":"string"},"description":"Only return segment uploads whose partner handle exactly matches this value."},{"in":"query","name":"partner_handle__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segment uploads whose partner handle matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"partner_handle__isempty","schema":{"type":"boolean"},"description":"When true, only return segment uploads with an empty or missing partner handle. When false, exclude them."},{"in":"query","name":"partner_handle__not","schema":{"type":"string"},"description":"Exclude segment uploads whose partner handle exactly matches this value."},{"in":"query","name":"partner_handle__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segment uploads whose partner handle matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"status","schema":{"type":"string","enum":["COMPLETE","ERROR","IN_PROGRESS","NOT_UPLOADED","PENDING","PII_NOT_INGESTED"]},"description":"Only return segment uploads whose status exactly matches this value.\n\n* `NOT_UPLOADED` - Not Uploaded\n* `PENDING` - Pending\n* `COMPLETE` - Complete\n* `ERROR` - Error\n* `IN_PROGRESS` - In Progress\n* `PII_NOT_INGESTED` - Pii Not Ingested"},{"in":"query","name":"update_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"update_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSegmentUploadBaseList"}}},"description":"Segment uploads retrieved successfully."},"400":{"description":"Invalid filter or query parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/segment-uploads/file":{"post":{"operationId":"segment_uploads_file_create","description":"Creates a new segment upload job by directly uploading a file. Accepts multipart/form-data for file upload. File must be in CSV or TSV format and under the maximum size limit. The system will validate the file format and content before processing.","summary":"Create a segment upload from file","tags":["Segments"],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentUploadFile"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentUploadFile"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentUploadFile"}}},"description":"Segment upload created successfully from uploaded file."},"400":{"description":"Validation error, or the request was not sent as multipart/form-data. An unsupported Content-Type is reported as a non-field validation error, not as a 415."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/segment-uploads/references":{"post":{"operationId":"segment_uploads_references_create","description":"Creates a new segment upload job using pre-uploaded files on S3. This endpoint accepts S3 file references instead of direct file uploads. Files must be in allowed S3 locations and accessible to the system. Use this for large files or when files are already in S3.","summary":"Create a segment upload from S3 references","tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentUploadReferences"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentUploadReferences"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentUploadReferences"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentUploadReferences"}}},"description":"Segment upload created successfully from S3 references."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/segment-uploads/{segment_upload_id}":{"get":{"operationId":"segment_uploads_retrieve","description":"Fetches details of a specific segment upload job by its ID.","summary":"Retrieve a segment upload","parameters":[{"in":"path","name":"segment_upload_id","schema":{"type":"integer"},"description":"A unique integer value identifying this segment upload.","required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentUploadBase"}}},"description":"Segment upload retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment upload not found."}}}},"/segment-uploads/{segment_upload_id}/status":{"get":{"operationId":"segment_uploads_status_retrieve","description":"Returns the current status of the segment upload job.","summary":"Get segment upload status","parameters":[{"in":"path","name":"segment_upload_id","schema":{"type":"integer"},"description":"A unique integer value identifying this segment upload.","required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentUploadStatus"}}},"description":"Segment upload status retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment upload not found."}}}},"/segments":{"get":{"operationId":"segments_list","description":"Returns a list of segments for the current account. Supports filtering by segment category, advertiser, alternative ID, and other attributes. Includes both locally owned and shared segments.","summary":"List segments","parameters":[{"in":"query","name":"account_id","schema":{"type":"number"}},{"in":"query","name":"account_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"account_id__not","schema":{"type":"number"}},{"in":"query","name":"account_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"active","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__equals_or_null","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__gte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"advertiser_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"advertiser_id__lt","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__lte","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not","schema":{"type":"number"}},{"in":"query","name":"advertiser_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"aggregate_excludes","schema":{"type":"boolean"},"description":"Only return segments whose aggregate excludes flag matches this value."},{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"category_keys","schema":{"type":"string"},"description":"Only return segments whose segment category key exactly matches this value."},{"in":"query","name":"category_keys__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segments whose segment category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"category_keys__isempty","schema":{"type":"boolean"},"description":"When true, only return segments with an empty or missing segment category key. When false, exclude them."},{"in":"query","name":"category_keys__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segments whose segment category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"cpm_cost","schema":{"type":"number"},"description":"Only return segments whose CPM cost exactly matches this value."},{"in":"query","name":"cpm_cost__gt","schema":{"type":"number"},"description":"Only return segments whose CPM cost is greater than this value."},{"in":"query","name":"cpm_cost__in","schema":{"type":"array","items":{"type":"number"}},"description":"Only return segments whose CPM cost matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"cpm_cost__lt","schema":{"type":"number"},"description":"Only return segments whose CPM cost is less than this value."},{"in":"query","name":"cpm_cost__not","schema":{"type":"number"},"description":"Exclude segments whose CPM cost exactly matches this value."},{"in":"query","name":"cpm_cost__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Exclude segments whose CPM cost matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"create_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"create_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"description","schema":{"type":"string"},"description":"Only return segments whose description exactly matches this value."},{"in":"query","name":"description__contains","schema":{"type":"string"},"description":"Only return segments whose description contains this value (case-insensitive)."},{"in":"query","name":"description__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segments whose description matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"description__isempty","schema":{"type":"boolean"},"description":"When true, only return segments with an empty or missing description. When false, exclude them."},{"in":"query","name":"description__not","schema":{"type":"string"},"description":"Exclude segments whose description exactly matches this value."},{"in":"query","name":"description__not_contains","schema":{"type":"string"},"description":"Exclude segments whose description contains this value (case-insensitive)."},{"in":"query","name":"description__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segments whose description matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"extensible","schema":{"type":"boolean"},"description":"Only return segments whose extensible flag matches this value."},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Only return records whose key exactly matches this value."},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return records whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"},"description":"When true, only return records with an empty or missing key. When false, exclude them."},{"in":"query","name":"key__not","schema":{"type":"string"},"description":"Exclude records whose key exactly matches this value."},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude records whose key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name","schema":{"type":"string"},"description":"Only return records whose name exactly matches this value."},{"in":"query","name":"name__contains","schema":{"type":"string"},"description":"Only return records whose name contains this value (case-insensitive)."},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return records whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"},"description":"When true, only return records with an empty or missing name. When false, exclude them."},{"in":"query","name":"name__not","schema":{"type":"string"},"description":"Exclude records whose name exactly matches this value."},{"in":"query","name":"name__not_contains","schema":{"type":"string"},"description":"Exclude records whose name contains this value (case-insensitive)."},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude records whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"ttl_days","schema":{"type":"integer"},"description":"Only return segments whose TTL in days exactly matches this value."},{"in":"query","name":"ttl_days__gt","schema":{"type":"integer"},"description":"Only return segments whose TTL in days is greater than this value."},{"in":"query","name":"ttl_days__lt","schema":{"type":"integer"},"description":"Only return segments whose TTL in days is less than this value."},{"in":"query","name":"ttl_days__not","schema":{"type":"integer"},"description":"Exclude segments whose TTL in days exactly matches this value."},{"in":"query","name":"update_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"update_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"verb","schema":{"type":"string"},"description":"Only return segments whose verb usage exactly matches this value."},{"in":"query","name":"verb__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return segments whose verb usage matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"verb__isempty","schema":{"type":"boolean"},"description":"When true, only return segments with an empty or missing verb usage. When false, exclude them."},{"in":"query","name":"verb__not","schema":{"type":"string"},"description":"Exclude segments whose verb usage exactly matches this value."},{"in":"query","name":"verb__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude segments whose verb usage matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSegmentList"}}},"description":"Segments retrieved successfully."},"400":{"description":"Invalid filter or query parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}},"post":{"operationId":"segments_create","description":"Creates a new segment with the provided attributes. Segments represent user audiences and can be associated with one or more segment categories.","summary":"Create a segment","tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Segment"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Segment"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"description":"Segment created successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/segments/bulk":{"post":{"operationId":"segments_bulk_create","description":"Create multiple segments at once. Accepts up to 100 objects per request.","summary":"Bulk create segments","tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}},"multipart/form-data":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}}},"description":"Segments created successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}},"patch":{"operationId":"segments_bulk_partial_update","description":"Update multiple segments at once. Accepts up to 100 objects per request. A request body is required.","summary":"Bulk update segments","parameters":[{"in":"query","name":"ids","schema":{"type":"string"},"description":"Comma-separated list of IDs to update. Required when the request body is a single object, which is then applied to every listed ID. Omit it when the request body is a list of objects, each carrying its own id. At most 100 IDs per request."}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/PatchedSegment"}},{"$ref":"#/components/schemas/PatchedSegment"}]}}}},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}}},"description":"Segments updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/segments/{id}":{"get":{"operationId":"segments_retrieve","description":"Fetches details of a specific segment by its ID.","summary":"Retrieve a segment","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"The unique ID of the segment"},"required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"description":"Segment retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment not found."}}},"put":{"operationId":"segments_update","description":"Performs a full update on the specified segment. All required fields must be provided.","summary":"Update a segment","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"The unique ID of the segment"},"required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Segment"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Segment"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"description":"Segment updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment not found."}}},"patch":{"operationId":"segments_partial_update","description":"Performs a partial update on the specified segment. All fields are optional; only provided fields are modified.","summary":"Partial update a segment","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"The unique ID of the segment"},"required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedSegment"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedSegment"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedSegment"}}}},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"description":"Segment updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment not found."}}}},"/segments/{id}/duplicate":{"get":{"operationId":"segments_duplicate_retrieve","description":"Returns the duplication options for this segment: the `duplicate` field lists the entities that can be copied for this particular segment. Use it to build the POST body.","summary":"Preview segment duplication","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"The unique ID of the segment"},"required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentDuplicate"}}},"description":"Segment duplication preview retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment not found."}}},"post":{"operationId":"segments_duplicate_create","description":"Creates a duplicate of the segment under a new name. The `duplicate` list selects what is copied and must always include `resource` (the segment's own fields). Adding `categories` also copies the segment's category associations. Requesting an entity the segment has nothing to duplicate for returns a validation error — call GET on this endpoint first to see which entities are available.","summary":"Duplicate a segment","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"The unique ID of the segment"},"required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentDuplicate"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentDuplicate"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentDuplicate"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"description":"Segment duplicated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment not found."}}}},"/segments/{id}/statistics":{"get":{"operationId":"segments_statistics_retrieve","description":"Returns user count statistics for the segment by continent (NAM, EMEA, APAC). Statistics represent the approximate number of unique users in the segment.","summary":"Retrieve segment statistics","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"The unique ID of the segment"},"required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentStatistics"}}},"description":"Segment statistics retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment not found."}}}},"/segments/{id}/tag":{"get":{"operationId":"segments_tag_retrieve","description":"Returns a tracking tag for the segment, rendered in the format named by the tag_type query parameter (default: 'js'). The tag is used to add users to the segment when they visit your website.","summary":"Retrieve segment tag","parameters":[{"in":"path","name":"id","schema":{"type":"integer","description":"The unique ID of the segment"},"required":true},{"in":"query","name":"tag_type","schema":{"type":"string","enum":["iframe","image_ip","in_app","js","js_alt"],"default":"js"},"description":"Format of the tag to render. Each value names a template in the segment tag directory. Defaults to 'js'."}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"text/html":{"schema":{"type":"string"}}},"description":"Segment tag retrieved successfully."},"400":{"description":"Invalid data provided."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment not found."}}}},"/shared/segment-categories":{"get":{"operationId":"shared_segment_categories_list","description":"Returns a list of segment category sharing relationships for the current account. Shows which segment categories are shared with other accounts.","summary":"List segment category sharing relationships","parameters":[{"in":"query","name":"account_id","schema":{"type":"number"}},{"in":"query","name":"account_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"account_id__not","schema":{"type":"number"}},{"in":"query","name":"account_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"active","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"cpm_cost","schema":{"type":"number"},"description":"Only return sharing relationships whose CPM cost exactly matches this value."},{"in":"query","name":"cpm_cost__gt","schema":{"type":"number"},"description":"Only return sharing relationships whose CPM cost is greater than this value."},{"in":"query","name":"cpm_cost__in","schema":{"type":"array","items":{"type":"number"}},"description":"Only return sharing relationships whose CPM cost matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"cpm_cost__lt","schema":{"type":"number"},"description":"Only return sharing relationships whose CPM cost is less than this value."},{"in":"query","name":"cpm_cost__not","schema":{"type":"number"},"description":"Exclude sharing relationships whose CPM cost exactly matches this value."},{"in":"query","name":"cpm_cost__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Exclude sharing relationships whose CPM cost matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"create_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"create_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Only return sharing relationships whose shared segment category key exactly matches this value."},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return sharing relationships whose shared segment category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"},"description":"When true, only return sharing relationships with an empty or missing shared segment category key. When false, exclude them."},{"in":"query","name":"key__not","schema":{"type":"string"},"description":"Exclude sharing relationships whose shared segment category key exactly matches this value."},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude sharing relationships whose shared segment category key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"notes","schema":{"type":"string"},"description":"Only return sharing relationships whose note text exactly matches this value."},{"in":"query","name":"notes__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return sharing relationships whose note text matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"notes__isempty","schema":{"type":"boolean"},"description":"When true, only return sharing relationships with an empty or missing note text. When false, exclude them."},{"in":"query","name":"notes__not","schema":{"type":"string"},"description":"Exclude sharing relationships whose note text exactly matches this value."},{"in":"query","name":"notes__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude sharing relationships whose note text matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"shared_account_id","schema":{"type":"number"},"description":"Only return sharing relationships whose shared account ID exactly matches this value."},{"in":"query","name":"shared_account_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Only return sharing relationships whose shared account ID matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"shared_account_id__not","schema":{"type":"number"},"description":"Exclude sharing relationships whose shared account ID exactly matches this value."},{"in":"query","name":"shared_account_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Exclude sharing relationships whose shared account ID matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"update_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"update_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSegmentCategorySharingList"}}},"description":"Segment category sharing relationships retrieved successfully."},"400":{"description":"Invalid filter or query parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}},"post":{"operationId":"shared_segment_categories_create","description":"Creates a new segment category sharing relationship to share a segment category with another account. The category owner grants access to the specified recipient account. When a category is shared, all segments within it may also become accessible.","summary":"Create a segment category sharing relationship","tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}}},"description":"Segment category sharing relationship created successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/shared/segment-categories/bulk":{"post":{"operationId":"shared_segment_categories_bulk_create","description":"Create multiple segment category sharing relationships at once. Accepts up to 100 objects per request.","summary":"Bulk create segment category sharing relationships","tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategorySharing"}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategorySharing"}}},"multipart/form-data":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategorySharing"}}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategorySharing"}}}},"description":"Segment category sharing relationships created successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}},"patch":{"operationId":"shared_segment_categories_bulk_partial_update","description":"Update multiple segment category sharing relationships at once. Accepts up to 100 objects per request. A request body is required.","summary":"Bulk update segment category sharing relationships","parameters":[{"in":"query","name":"ids","schema":{"type":"string"},"description":"Comma-separated list of IDs to update. Required when the request body is a single object, which is then applied to every listed ID. Omit it when the request body is a list of objects, each carrying its own id. At most 100 IDs per request."}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/PatchedSegmentCategorySharing"}},{"$ref":"#/components/schemas/PatchedSegmentCategorySharing"}]}}}},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategorySharing"}}}},"description":"Segment category sharing relationships updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/shared/segment-categories/{id}":{"get":{"operationId":"shared_segment_categories_retrieve","description":"Fetches details of a specific segment category sharing relationship by its ID.","summary":"Retrieve a segment category sharing relationship","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this segment category sharing.","required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}}},"description":"Segment category sharing relationship retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}},"put":{"operationId":"shared_segment_categories_update","description":"Performs a full update on the specified segment category sharing relationship. All required fields must be provided.","summary":"Update a segment category sharing relationship","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this segment category sharing.","required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}}},"description":"Segment category sharing relationship updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}},"patch":{"operationId":"shared_segment_categories_partial_update","description":"Performs a partial update on the specified segment category sharing relationship. All fields are optional; only provided fields are modified.","summary":"Partial update a segment category sharing relationship","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this segment category sharing.","required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedSegmentCategorySharing"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedSegmentCategorySharing"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedSegmentCategorySharing"}}}},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCategorySharing"}}},"description":"Segment category sharing relationship updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment category not found."}}}},"/shared/segments":{"get":{"operationId":"shared_segments_list","description":"Returns a list of segment sharing relationships where segments are shared between accounts. Shows which segments are shared, the owner account, and the recipient account.","summary":"List segment sharing relationships","parameters":[{"in":"query","name":"account_id","schema":{"type":"number"}},{"in":"query","name":"account_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"account_id__not","schema":{"type":"number"}},{"in":"query","name":"account_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"active","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"cpm_cost","schema":{"type":"number"},"description":"Only return sharing relationships whose CPM cost exactly matches this value."},{"in":"query","name":"cpm_cost__gt","schema":{"type":"number"},"description":"Only return sharing relationships whose CPM cost is greater than this value."},{"in":"query","name":"cpm_cost__in","schema":{"type":"array","items":{"type":"number"}},"description":"Only return sharing relationships whose CPM cost matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"cpm_cost__lt","schema":{"type":"number"},"description":"Only return sharing relationships whose CPM cost is less than this value."},{"in":"query","name":"cpm_cost__not","schema":{"type":"number"},"description":"Exclude sharing relationships whose CPM cost exactly matches this value."},{"in":"query","name":"cpm_cost__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Exclude sharing relationships whose CPM cost matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"create_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"create_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"create_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was first created\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"},{"in":"query","name":"id","schema":{"type":"number"}},{"in":"query","name":"id__gt","schema":{"type":"number"}},{"in":"query","name":"id__gte","schema":{"type":"number"}},{"in":"query","name":"id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"id__lt","schema":{"type":"number"}},{"in":"query","name":"id__lte","schema":{"type":"number"}},{"in":"query","name":"id__not","schema":{"type":"number"}},{"in":"query","name":"id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"},"description":"Only return sharing relationships whose shared segment key exactly matches this value."},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return sharing relationships whose shared segment key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"},"description":"When true, only return sharing relationships with an empty or missing shared segment key. When false, exclude them."},{"in":"query","name":"key__not","schema":{"type":"string"},"description":"Exclude sharing relationships whose shared segment key exactly matches this value."},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude sharing relationships whose shared segment key matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"notes","schema":{"type":"string"},"description":"Only return sharing relationships whose note text exactly matches this value."},{"in":"query","name":"notes__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return sharing relationships whose note text matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"notes__isempty","schema":{"type":"boolean"},"description":"When true, only return sharing relationships with an empty or missing note text. When false, exclude them."},{"in":"query","name":"notes__not","schema":{"type":"string"},"description":"Exclude sharing relationships whose note text exactly matches this value."},{"in":"query","name":"notes__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude sharing relationships whose note text matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"shared_account_id","schema":{"type":"number"},"description":"Only return sharing relationships whose shared account ID exactly matches this value."},{"in":"query","name":"shared_account_id__in","schema":{"type":"array","items":{"type":"number"}},"description":"Only return sharing relationships whose shared account ID matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"shared_account_id__not","schema":{"type":"number"},"description":"Exclude sharing relationships whose shared account ID exactly matches this value."},{"in":"query","name":"shared_account_id__not_in","schema":{"type":"array","items":{"type":"number"}},"description":"Exclude sharing relationships whose shared account ID matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"update_date","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__gte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__isempty","schema":{"type":"boolean"}},{"in":"query","name":"update_date__lt","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__lte","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"update_date__range","schema":{"type":"string","format":"date-time","nullable":true,"enum":["future","last_14_complete_days","last_14_days","last_24_hours","last_30_complete_days","last_30_days","last_365_complete_days","last_365_days","last_7_complete_days","last_7_days","last_90_complete_days","last_90_days","last_month","last_quarter","last_week","last_year","past","this_month","this_quarter","this_week","this_year","today","until_past_24_hours","yesterday"]},"description":"The date and time the object was last updated\n\n* `today` - From last midnight to next midnight\n* `yesterday` - The last complete calendar day\n* `last_24_hours` - The last 24 hours (as opposed to today, which is from midnight to midnight)\n* `this_week` - From midnight the previous Sunday until midnight the coming Sunday\n* `last_week` - The last complete calendar week\n* `this_year` - From the January 1 to December 31 this year\n* `last_year` - The last complete calendar year\n* `this_month` - From the first day to the last day of the current month\n* `last_month` - The last complete calendar month\n* `this_quarter` - From the first day to the last day of the current quarter\n* `last_quarter` - The last complete calendar quarter\n* `last_7_days` - From midnight 7 days ago to the present\n* `last_7_complete_days` - From midnight 7 days ago to last midnight\n* `last_14_days` - From midnight 14 days ago to the present\n* `last_14_complete_days` - From midnight 14 days ago to last midnight\n* `last_30_days` - From midnight 30 days ago to the present\n* `last_30_complete_days` - From midnight 30 days ago to last midnight\n* `last_90_days` - From midnight 90 days ago to the present\n* `last_90_complete_days` - From midnight 90 days ago to last midnight\n* `last_365_days` - From midnight 365 days ago to the present\n* `last_365_complete_days` - From midnight 365 days ago to last midnight\n* `past` - Any date in the past. Useful for Buzz queries against end_date and similar fields\n* `future` - Any date in the future. Useful for Buzz queries against end_date and similar fields\n* `until_past_24_hours` - From the very first date in the past and up until past 24 hours"}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSegmentSharingList"}}},"description":"Segment sharing relationships retrieved successfully."},"400":{"description":"Invalid filter or query parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}},"post":{"operationId":"shared_segments_create","description":"Creates a new segment sharing relationship to share a segment with another account. The segment owner grants access to the specified recipient account.","summary":"Create a segment sharing relationship","tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}}},"description":"Segment sharing relationship created successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/shared/segments/bulk":{"post":{"operationId":"shared_segments_bulk_create","description":"Create multiple segment sharing relationships at once. Accepts up to 100 objects per request.","summary":"Bulk create segment sharing relationships","tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentSharing"}}},"application/x-www-form-urlencoded":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentSharing"}}},"multipart/form-data":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentSharing"}}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"201":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentSharing"}}}},"description":"Segment sharing relationships created successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}},"patch":{"operationId":"shared_segments_bulk_partial_update","description":"Update multiple segment sharing relationships at once. Accepts up to 100 objects per request. A request body is required.","summary":"Bulk update segment sharing relationships","parameters":[{"in":"query","name":"ids","schema":{"type":"string"},"description":"Comma-separated list of IDs to update. Required when the request body is a single object, which is then applied to every listed ID. Omit it when the request body is a list of objects, each carrying its own id. At most 100 IDs per request."}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/PatchedSegmentSharing"}},{"$ref":"#/components/schemas/PatchedSegmentSharing"}]}}}},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SegmentSharing"}}}},"description":"Segment sharing relationships updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."}}}},"/shared/segments/{id}":{"get":{"operationId":"shared_segments_retrieve","description":"Fetches details of a specific segment sharing relationship by its ID.","summary":"Retrieve a segment sharing relationship","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this segment sharing.","required":true}],"tags":["Segments"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}}},"description":"Segment sharing relationship retrieved successfully."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment sharing relationship not found."}}},"put":{"operationId":"shared_segments_update","description":"Performs a full update on the specified segment sharing relationship. All required fields must be provided.","summary":"Update a segment sharing relationship","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this segment sharing.","required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}}},"required":true},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}}},"description":"Segment sharing relationship updated successfully."},"400":{"description":"Validation error."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"404":{"description":"Segment sharing relationship not found."}}},"patch":{"operationId":"shared_segments_partial_update","description":"Performs a partial update on the specified segment sharing relationship. All fields are optional; only provided fields are modified.","summary":"Partial update a segment sharing relationship","parameters":[{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this segment sharing.","required":true}],"tags":["Segments"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedSegmentSharing"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedSegmentSharing"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedSegmentSharing"}}}},"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentSharing"}}},"description":"Segment sharing relationship updated successfully."},"400":{"description":"Validation error or invalid parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"404":{"description":"Segment sharing relationship not found."}}}},"/third-party/data-providers":{"get":{"operationId":"third_party_data_providers_list","description":"Retrieve a list of third-party data providers enabled for the account.","summary":"List third-party data providers","parameters":[{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}],"tags":["Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedThirdPartyDataProviderList"}}},"description":"Third-party data providers retrieved successfully."},"400":{"description":"Invalid data provided."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/third-party/segment-search":{"get":{"operationId":"third_party_segment_search_list","description":"Search across third-party segments shared with the active account. Returns a flat list of matching segment nodes.","summary":"Search third-party segments","parameters":[{"in":"query","name":"alternative_id","schema":{"type":"string"}},{"in":"query","name":"alternative_id__contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"alternative_id__not","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_contains","schema":{"type":"string"}},{"in":"query","name":"alternative_id__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"alternative_id__not_startswith","schema":{"type":"string"}},{"in":"query","name":"alternative_id__startswith","schema":{"type":"string"}},{"in":"query","name":"cpm","schema":{"type":"number"},"description":"Only return third-party segments whose CPM exactly matches this value."},{"in":"query","name":"cpm__gt","schema":{"type":"number"},"description":"Only return third-party segments whose CPM is greater than this value."},{"in":"query","name":"cpm__lt","schema":{"type":"number"},"description":"Only return third-party segments whose CPM is less than this value."},{"in":"query","name":"data_provider_id","schema":{"type":"integer"},"description":"Only return third-party segments whose data provider ID exactly matches this value."},{"in":"query","name":"data_provider_id__gt","schema":{"type":"integer"},"description":"Only return third-party segments whose data provider ID is greater than this value."},{"in":"query","name":"data_provider_id__gte","schema":{"type":"integer"},"description":"Only return third-party segments whose data provider ID is greater than or equal to this value."},{"in":"query","name":"data_provider_id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Only return third-party segments whose data provider ID matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"data_provider_id__isempty","schema":{"type":"boolean"},"description":"When true, only return third-party segments with no data provider ID. When false, exclude them."},{"in":"query","name":"data_provider_id__lt","schema":{"type":"integer"},"description":"Only return third-party segments whose data provider ID is less than this value."},{"in":"query","name":"data_provider_id__lte","schema":{"type":"integer"},"description":"Only return third-party segments whose data provider ID is less than or equal to this value."},{"in":"query","name":"data_provider_id__not","schema":{"type":"integer"},"description":"Exclude third-party segments whose data provider ID exactly matches this value."},{"in":"query","name":"data_provider_id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Exclude third-party segments whose data provider ID matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"favorite","required":false,"in":"query","description":"Filter to the set of objects the user has \"favorited\".","schema":{"type":"boolean"}},{"in":"query","name":"name","schema":{"type":"string"},"description":"Only return third-party segments whose name exactly matches this value."},{"in":"query","name":"name__contains","schema":{"type":"string"},"description":"Only return third-party segments whose name contains this value (case-insensitive)."},{"in":"query","name":"name__in","schema":{"type":"array","items":{"type":"string"}},"description":"Only return third-party segments whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"name__isempty","schema":{"type":"boolean"},"description":"When true, only return third-party segments with an empty or missing name. When false, exclude them."},{"in":"query","name":"name__not","schema":{"type":"string"},"description":"Exclude third-party segments whose name exactly matches this value."},{"in":"query","name":"name__not_contains","schema":{"type":"string"},"description":"Exclude third-party segments whose name contains this value (case-insensitive)."},{"in":"query","name":"name__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Exclude third-party segments whose name matches one of these values. Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}},{"in":"query","name":"type","schema":{"type":"string"},"description":"Only return third-party segments whose type matches this value ('segment' or 'category')."},{"in":"query","name":"type__isempty","schema":{"type":"boolean"},"description":"When true, only return third-party segments with an empty or missing type. When false, exclude them."},{"in":"query","name":"type__not","schema":{"type":"string"},"description":"Exclude third-party segments whose type matches this value ('segment' or 'category')."},{"in":"query","name":"user_count_by_region__apac__gt","schema":{"type":"integer"},"description":"Only return segments whose APAC user count is greater than this value."},{"in":"query","name":"user_count_by_region__apac__lt","schema":{"type":"integer"},"description":"Only return segments whose APAC user count is less than this value."},{"in":"query","name":"user_count_by_region__emea__gt","schema":{"type":"integer"},"description":"Only return segments whose EMEA user count is greater than this value."},{"in":"query","name":"user_count_by_region__emea__lt","schema":{"type":"integer"},"description":"Only return segments whose EMEA user count is less than this value."},{"in":"query","name":"user_count_by_region__nam__gt","schema":{"type":"integer"},"description":"Only return segments whose North America (NAM) user count is greater than this value."},{"in":"query","name":"user_count_by_region__nam__lt","schema":{"type":"integer"},"description":"Only return segments whose North America (NAM) user count is less than this value."},{"in":"query","name":"user_count_update_date__gt","schema":{"type":"string","format":"date-time"},"description":"Only return segments whose user count update date is after this timestamp."},{"in":"query","name":"user_count_update_date__lt","schema":{"type":"string","format":"date-time"},"description":"Only return segments whose user count update date is before this timestamp."}],"tags":["Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedThirdPartySegmentTreeNodeList"}}},"description":"Third-party segments retrieved successfully."},"400":{"description":"Invalid search or filter parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}},"/third-party/segment-tree":{"get":{"operationId":"third_party_segment_tree_list","description":"Returns the hierarchical third-party segment tree including categories and segments shared with the active account.","summary":"Navigate third-party segment tree","parameters":[{"in":"query","name":"data_provider_id","schema":{"type":"integer"}},{"in":"query","name":"data_provider_id__gt","schema":{"type":"integer"}},{"in":"query","name":"data_provider_id__gte","schema":{"type":"integer"}},{"in":"query","name":"data_provider_id__in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"data_provider_id__isempty","schema":{"type":"boolean"}},{"in":"query","name":"data_provider_id__lt","schema":{"type":"integer"}},{"in":"query","name":"data_provider_id__lte","schema":{"type":"integer"}},{"in":"query","name":"data_provider_id__not","schema":{"type":"integer"}},{"in":"query","name":"data_provider_id__not_in","schema":{"type":"array","items":{"type":"integer"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key","schema":{"type":"string"}},{"in":"query","name":"key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"key__not","schema":{"type":"string"}},{"in":"query","name":"key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"name":"order","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"in":"query","name":"parent_key","schema":{"type":"string"}},{"in":"query","name":"parent_key__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"parent_key__isempty","schema":{"type":"boolean"}},{"in":"query","name":"parent_key__not","schema":{"type":"string"}},{"in":"query","name":"parent_key__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"type","schema":{"type":"string","enum":["category","segment"]},"description":"Either segment or category\n\n* `category` - Category\n* `segment` - Segment"},{"in":"query","name":"type__in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"},{"in":"query","name":"type__isempty","schema":{"type":"boolean"}},{"in":"query","name":"type__not","schema":{"type":"string","enum":["category","segment"]},"description":"Either segment or category\n\n* `category` - Category\n* `segment` - Segment"},{"in":"query","name":"type__not_in","schema":{"type":"array","items":{"type":"string"}},"description":"Multiple values may be separated by commas.","explode":false,"style":"form"}],"tags":["Targeting"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedThirdPartySegmentTreeNodeList"}}},"description":"Third-party segment tree retrieved successfully."},"400":{"description":"Invalid filter or query parameters."},"401":{"description":"Authentication credentials were not provided."},"403":{"description":"Permission denied."},"500":{"description":"Internal server error."}}}}},"components":{"schemas":{"AdPosition":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the ad position"},"open_rtb_code":{"type":"string","nullable":true,"description":"ID used in the OpenRTB specification","maxLength":25},"name":{"type":"string","description":"Name of the ad position","maxLength":40}},"required":["id","name"]},"AdsTxt":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128},"enum_code":{"type":"string","nullable":true,"maxLength":40},"name":{"type":"string","nullable":true,"description":"Name of the Ads.txt category, e.g. \"RESELLER\"","maxLength":40},"description":{"type":"string","nullable":true,"maxLength":200}},"required":["id"]},"AdvertiserCategory":{"type":"object","properties":{"key":{"type":"string","description":"The key of the advertiser category","maxLength":10},"name":{"type":"string","description":"The name of the advertiser category","maxLength":40}},"required":["key","name"]},"AdvertiserIndex":{"type":"object","properties":{"id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"The ID of the advertiser index"},"name":{"type":"string","nullable":true,"description":"The name of the advertiser index","maxLength":100}},"required":["id"]},"AdvertiserSensitiveCategory":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"The ID of the advertiser sensitive category"},"name":{"type":"string","nullable":true,"description":"The name of the advertiser sensitive category","maxLength":40}},"required":["id"]},"AudioContentGenre":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"active":{"type":"boolean","default":true},"key":{"type":"string","maxLength":40},"name":{"type":"string","maxLength":40}},"required":["id","key","name"]},"Bandwidth":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the bandwidth"},"name":{"type":"string","nullable":true,"description":"Name of the user's bandwidth, such as \"WIFI\".","maxLength":40}},"required":["id"]},"BidModelRef":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The ID of the BidModel"},"name":{"type":"string","description":"Name of the Bid Model, e.g. \"CPI Model\"","maxLength":100},"current_version":{"type":"integer","description":"The ID of the BidModelVersion","nullable":true},"value_type":{"allOf":[{"$ref":"#/components/schemas/ValueTypeEnum"}],"description":"Valid values are BID, MULTIPLIER, or BUDGET_WEIGHT. Determines whether the values in the Bid Model should be multiplied by the base bid at the Line Item level or used instead of that bid. BUDGET_WEIGHT should be used for Delivery Models.\n\n* `BID` - Bid\n* `MULTIPLIER` - Multiplier\n* `BUDGET_WEIGHT` - Budget Weight"},"create_date":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255},"active":{"type":"boolean","default":true}},"required":["id","name","update_date"]},"BidModifierTermV2":{"type":"object","properties":{"recency":{"allOf":[{"$ref":"#/components/schemas/TargetingRecency"}],"nullable":true},"comparator":{"allOf":[{"$ref":"#/components/schemas/ComparatorEnum"}],"description":"The method for comparing the defined value against the incoming bid request to determine a match (i.e. equals, in_range, boolean)\n\n* `equals` - Equals\n* `in_range` - In Range\n* `boolean_expression` - Boolean"},"multiplier":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","description":"The amount to multiply the bid price by."},"override_multiplier":{"type":"boolean"},"targeting_key":{"allOf":[{"$ref":"#/components/schemas/TargetingKeyEnum"}],"description":"The targeting key e.g. country\n\n* `ad_position` - Ad Position\n* `ad_size` - Ad Size\n* `ads_txt` - Ads Txt\n* `app_bundle_list` - App Bundle List\n* `app_id_list` - App ID List\n* `app_name` - App Name\n* `auction_type` - Auction Type\n* `audio_companion_required` - Audio Companion Required\n* `audio_content_genre` - Audio Content Genre\n* `audio_start_delay` - Audio Start Delay\n* `bandwidth` - Bandwidth\n* `browser` - Browser\n* `browser_version` - Browser Version\n* `carrier` - Carrier\n* `city` - City\n* `companion_required` - Companion Required\n* `congressional_district` - Congressional District\n* `content_category` - Content Category\n* `content_genre` - Content Genre\n* `content_rating` - Content Rating\n* `country` - Country\n* `deal_id` - Deal ID\n* `deal_id_list` - Deal ID List\n* `delivery` - Delivery\n* `device_make` - Device Make\n* `device_model` - Device Model\n* `device_screen_size` - Device Screen Size\n* `device_type` - Device Type\n* `domain_list` - Domain List ID\n* `environment_type` - Environment Type\n* `feed` - Feed\n* `interstitial` - Interstitial\n* `interstitial_type` - Interstitial Type\n* `inventory_source` - Inventory Source\n* `ip_address` - IP Address\n* `ipv4_address` - IPv4 address\n* `language` - Language\n* `lat_long_list` - Latitude & Longitude List\n* `lat_long_present` - Latitude & Longitude Present\n* `location_type` - Location Type\n* `metro` - Metro\n* `native_layout` - Native Layout\n* `operating_system` - Operating System\n* `operating_system_version` - Operating System Version\n* `placement` - Placement ID\n* `placement_list` - Placement ID List\n* `playback_method` - Playback Method\n* `player_size` - Player Size\n* `publisher_id` - Publisher ID\n* `publisher_id_list` - Publisher ID List\n* `region` - Region\n* `rewarded` - Rewarded\n* `segment` - Segment\n* `site` - Site ID\n* `site_list` - Site ID List\n* `start_delay` - Video Start Delay\n* `state_house_district` - State House District\n* `state_senate_district` - State Senate District\n* `time_of_week` - Time Of Week\n* `topframe` - Topframe\n* `user_id` - User ID\n* `user_time_of_week` - User Time Of Week\n* `video_api` - Video API\n* `video_placement_type` - Video Placement Type\n* `zip` - Zip\n* `zip_code_list` - Zip Code List"},"value":{"type":"string","description":"The value to match, e.g. USA","maxLength":1024}},"required":["comparator","multiplier","targeting_key","value"]},"BiddingStrategyFieldRef":{"type":"object","properties":{"field_name":{"type":"string"},"field_type":{"$ref":"#/components/schemas/FieldTypeEnum"},"required":{"type":"boolean"},"field_label":{"type":"string"},"field_description":{"type":"string"}},"required":["field_description","field_label","field_name","field_type","required"]},"BiddingStrategyRef":{"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"line_item_types":{"type":"array","items":{"type":"string"},"readOnly":true},"paced":{"type":"boolean"},"description":{"type":"string"},"allow_bid_models":{"type":"boolean"},"allow_bid_modifiers":{"type":"boolean"},"allow_bid_shading":{"type":"boolean"},"allow_delivery_models":{"type":"boolean"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/BiddingStrategyFieldRef"}}},"required":["allow_bid_models","allow_bid_modifiers","allow_bid_shading","allow_delivery_models","description","fields","id","key","line_item_types","name","paced"]},"Browser":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"active":{"type":"boolean","default":true},"key":{"type":"string","description":"String description of the browser, for use in targeting","maxLength":30},"name":{"type":"string","description":"Longer descriptive name of the browser","maxLength":30},"category":{"type":"string","nullable":true,"description":"Categorization of browsers for convenience","maxLength":20}},"required":["id","key","name"]},"BrowserVersion":{"type":"object","properties":{"browser_key":{"type":"string"},"active":{"type":"boolean","default":true},"key":{"type":"string","description":"String description of the browser version, for use in targeting","maxLength":20},"name":{"type":"string","description":"Longer descriptive name of the browser version","maxLength":20}},"required":["browser_key","key","name"]},"BudgetType":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"The ID of the budget type"},"name":{"type":"string","nullable":true,"description":"The name of the budget type","maxLength":40}},"required":["id"]},"Carrier":{"type":"object","properties":{"active":{"type":"boolean","default":true},"key":{"type":"string","description":"String description of the carrier, for use in targeting","maxLength":40},"name":{"type":"string","description":"Longer descriptive name of the carrier","maxLength":40},"category":{"type":"string","nullable":true,"description":"Categorization of carriers for convenience","maxLength":20}},"required":["key","name"]},"City":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","description":"Name of the city","maxLength":80},"country_code_2":{"type":"string","nullable":true,"description":"2-character country code, e.g. \"US\"","maxLength":2},"country_code_3":{"type":"string","nullable":true,"description":"3-character country code, e.g. \"USA\"","maxLength":3},"region_code":{"type":"string","nullable":true,"description":"ID for the region code for the city, e.g. \"NY\"","maxLength":3},"region_name":{"type":"string","nullable":true,"description":"Name of the region, e.g. \"New York\"","maxLength":80},"metro_code":{"type":"string","nullable":true,"description":"ID of the metro area for the city","maxLength":10},"geoname":{"type":"string","description":"Unique ID of the city, referencing the Geonames database","maxLength":20}},"required":["geoname","id","name"]},"ComparatorEnum":{"enum":["equals","in_range","boolean_expression"],"type":"string","description":"* `equals` - Equals\n* `in_range` - In Range\n* `boolean_expression` - Boolean"},"ContentCategory":{"type":"object","properties":{"key":{"type":"string","description":"Alphanumeric key for the content category, e.g. \"IAB-1\"","maxLength":20},"name":{"type":"string","description":"Name of the content category","maxLength":80}},"required":["key","name"]},"ContentGenre":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"active":{"type":"boolean","default":true},"key":{"type":"string","maxLength":40},"name":{"type":"string","maxLength":40},"mappings":{}},"required":["id","key","mappings","name"]},"ContentRating":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the content rating"},"name":{"type":"string","description":"Name of the content rating","maxLength":40}},"required":["id","name"]},"Continent":{"type":"object","properties":{"key":{"type":"string","description":"Unique Key of the continent, e.q. \"EMEA\"","maxLength":10},"name":{"type":"string","description":"Name of the continent, e.q. \"Europe\"","maxLength":50}},"required":["key","name"]},"ContinentEnum":{"enum":["NAM","EMEA","APAC"],"type":"string","description":"* `NAM` - NAM\n* `EMEA` - EMEA\n* `APAC` - APAC"},"ConversionAttributionMethod":{"type":"object","properties":{"id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"The ID of the conversion attribution method"},"name":{"type":"string","nullable":true,"description":"The name of the conversion attribution method","maxLength":100}},"required":["id"]},"Country":{"type":"object","properties":{"country_code_3":{"type":"string","description":"3-character country code, e.g. \"USA\"","maxLength":3},"country_code_2":{"type":"string","description":"2-character country code, e.g. \"US\". Note, this value is not used in targeting but is provided for reference.","maxLength":2},"name":{"type":"string","description":"Name of the country, e.g. \"United States of America\".","maxLength":80}},"required":["country_code_2","country_code_3","name"]},"CreativeApprovalVendors":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The ID of the creative approval vendor"},"name":{"type":"string","description":"The name of the creative approval vendor","maxLength":80},"key":{"type":"string","description":"The key of the creative approval vendor","maxLength":20},"creative_type_id":{"type":"integer","maximum":127,"minimum":-128,"nullable":true,"description":"The type of creatives that are submitted to the vendor for approval. One of: 0 (banner), 1 (video), or 2 (native). -1 represents all creative types."},"required":{"type":"integer","maximum":127,"minimum":-128,"nullable":true,"description":"Whether creative approval from the vendor is required or not for serving"},"blocking":{"type":"integer","maximum":127,"minimum":-128,"nullable":true,"description":"Whether the creative should serve or not if the creative approval status is rejected"},"inventory_source_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"The ID of the inventory source","nullable":true}},"required":["id","name"]},"CreativeSize":{"type":"object","properties":{"category":{"type":"string","description":"Categorization of creative size for convenience","maxLength":20},"creative_height":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"Height of the creative in pixels"},"creative_width":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"Weight of the creative in pixels"},"name":{"type":"string","description":"Name of the creative size in format \"WxH\"","maxLength":40}},"required":["category","creative_height","creative_width","name"]},"Currency":{"type":"object","properties":{"key":{"type":"string","description":"The key of the currency","maxLength":3},"name":{"type":"string","nullable":true,"description":"The name of the currency","maxLength":50},"glyph":{"type":"string","nullable":true,"description":"The glyph of the currency","maxLength":4},"emoji_flag":{"type":"string","nullable":true,"description":"The emoji flag of the currency","maxLength":20}},"required":["key"]},"CustomListItem":{"type":"object","properties":{"account_id":{"type":"integer","readOnly":true,"description":"Defaults to the account in the active session"},"active":{"type":"boolean","default":true},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"id":{"type":"integer","readOnly":true,"description":"Unique ID of the list item."},"item":{"type":"string","description":"The item, passed as a string for most list times, or a json object for lat/long custom_lists."},"list_id":{"type":"integer","description":"The unique ID of the list. List must be active."},"pushed_to_server":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"pushed_to_serving":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"name":{"type":"string","description":"Optional name for the list item."},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"value":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","description":"A numeric value assigned to the list item that can be used by a Bid Modifier."}},"required":["account_id","create_date","id","item","list_id","pushed_to_server","pushed_to_serving","update_date"]},"CustomListType":{"type":"object","properties":{"key":{"type":"string","description":"Unique Key of the custom list type, e.q. \"ip_address\"","maxLength":20},"name":{"type":"string","nullable":true,"description":"Name of the custom list type, e.q. \"IP Address\"","maxLength":100}},"required":["key"]},"DMA":{"type":"object","properties":{"key":{"type":"string","description":"Three-digit numeric string for the metro area, e.g. \"505\". Note, \"000\" is a valid value for unknown.","maxLength":3},"name":{"type":"string","description":"Name of the metro area, e.g. \"Detroit, MI\"","maxLength":60}},"required":["key","name"]},"DealRef":{"type":"object","properties":{"type":{"type":"string","description":"One of: \"deal\", \"curated_deal\""},"id":{"type":"integer"},"favorite":{"type":"boolean","default":false},"source":{"type":"string","nullable":true},"inventory_source_key":{"type":"string"},"inventory_source_active":{"type":"boolean"},"archived":{"type":"boolean","default":true,"description":"Archived deals cannot be selected for targeting"},"create_date":{"type":"string","format":"date-time","description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","description":"The date and time the object was last updated"},"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"alternative_id":{"type":"string","description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters."},"notes":{"type":"string","description":"Free-form notes of up to 255 characters."},"cpm_override":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"Default CPM bid value to use when this deal is targeted and matches a bid request"},"deal_format":{"type":"string","description":"One of: `\"banner\"`, `\"video\"`, `\"native\"`, `\"audio\"`"},"deal_type":{"type":"string","description":"One of: `\"open_auction\"`, `\"private_auction\"`, `\"preferred\"`, `\"guaranteed\"`, `\"advanced\"`"},"floor_price":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"Lowest possible CPM bid price"},"name":{"type":"string"},"name_override":{"type":"string","nullable":true},"publisher":{"type":"string"},"seller_status":{"type":"string","nullable":true},"deal_id":{"type":"string","description":"The supply-side deal identifier"},"account_id":{"type":"integer"},"advertiser_id":{"type":"integer"},"currency":{"type":"string","description":"Currency in which floor_price and cpm_override are expressed"},"restricted_adomains":{}},"required":["account_id","advertiser_id","alternative_id","cpm_override","create_date","currency","deal_format","deal_id","deal_type","end_date","floor_price","id","inventory_source_active","inventory_source_key","name","name_override","notes","publisher","restricted_adomains","seller_status","source","start_date","type","update_date"]},"Delivery":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the delivery"},"name":{"type":"string","description":"Name of the delivery, e.g. \"Streaming\"","maxLength":40}},"required":["id","name"]},"DeliveryModifierTermTargeting":{"type":"object","properties":{"key":{"allOf":[{"$ref":"#/components/schemas/KeyEnum"}],"description":"The targeting key e.g. country\n\n* `ad_position` - Ad Position\n* `ad_size` - Ad Size\n* `ads_txt` - Ads Txt\n* `app_bundle_list` - App Bundle List\n* `app_id_list` - App ID List\n* `app_name` - App Name\n* `auction_type` - Auction Type\n* `audio_companion_required` - Audio Companion Required\n* `audio_content_genre` - Audio Content Genre\n* `audio_start_delay` - Audio Start Delay\n* `bandwidth` - Bandwidth\n* `browser` - Browser\n* `browser_version` - Browser Version\n* `carrier` - Carrier\n* `city` - City\n* `companion_required` - Companion Required\n* `congressional_district` - Congressional District\n* `content_genre` - Content Genre\n* `content_rating` - Content Rating\n* `country` - Country\n* `deal_id` - Deal ID\n* `deal_id_list` - Deal ID List\n* `delivery` - Delivery\n* `device_make` - Device Make\n* `device_model` - Device Model\n* `device_screen_size` - Device Screen Size\n* `device_type` - Device Type\n* `domain_list` - Domain List ID\n* `environment_type` - Environment Type\n* `feed` - Feed\n* `interstitial` - Interstitial\n* `interstitial_type` - Interstitial Type\n* `inventory_source` - Inventory Source\n* `language` - Language\n* `lat_long_list` - Latitude & Longitude List\n* `lat_long_present` - Latitude & Longitude Present\n* `metro` - Metro\n* `native_layout` - Native Layout\n* `operating_system` - Operating System\n* `operating_system_version` - Operating System Version\n* `placement` - Placement ID\n* `placement_list` - Placement ID List\n* `playback_method` - Playback Method\n* `player_size` - Player Size\n* `publisher_id` - Publisher ID\n* `publisher_id_list` - Publisher ID List\n* `region` - Region\n* `rewarded` - Rewarded\n* `site` - Site ID\n* `site_list` - Site ID List\n* `start_delay` - Video Start Delay\n* `state_house_district` - State House District\n* `state_senate_district` - State Senate District\n* `user_time_of_week` - User Time Of Week\n* `video_placement_type` - Video Placement Type\n* `zip` - Zip\n* `zip_code_list` - Zip Code List"},"value":{"type":"string","nullable":true,"description":"The targeting key value to match, e.g. USA","maxLength":1024},"comparator":{"allOf":[{"$ref":"#/components/schemas/ComparatorEnum"}],"description":"The method for comparing the defined value against the incoming bid request to determine a match (i.e. equals, in_range, boolean)\n\n* `equals` - Equals\n* `in_range` - In Range\n* `boolean_expression` - Boolean"},"expand_list":{"type":"boolean","description":"List items in expanded lists are interpreted as individual delivery modifier terms"}},"required":["comparator","key"]},"DeliveryModifierTermV2":{"type":"object","properties":{"targeting":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryModifierTermTargeting"}},"budget_cap_percentage":{"type":"integer","maximum":100,"minimum":1,"nullable":true,"description":"The maximum percentage of the budget that can be spent by the term. Must be greater than the term's percentage of the total budget."},"rank":{"type":"integer","maximum":100,"minimum":1,"description":"Tie breaker used when multiple Delivery Modifier Terms match an auction. Delivery will be counted against the Delivery Modifier Term with the highest rank. For this reason, all rank values in a Delivery Modifier must be unique."},"weight":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","description":"The relative weight of delivery of matching auctions. Min = 0 (don't bid), Max = 100."}},"required":["rank","targeting","weight"]},"Device":{"type":"object","properties":{"id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"ID of the device type according to OpenRTB"},"active":{"type":"boolean","default":true},"name":{"type":"string","description":"Description of the device type, e.g. \"Tablet\"","maxLength":20}},"required":["id","name"]},"DeviceMake":{"type":"object","properties":{"active":{"type":"boolean","default":true},"key":{"type":"string","description":"String description of the device maker, for use in targeting","maxLength":20},"name":{"type":"string","description":"Longer descriptive name of the device maker","maxLength":40},"category":{"type":"string","nullable":true,"description":"Categorization of device makers for convenience","maxLength":20}},"required":["key","name"]},"DeviceModel":{"type":"object","properties":{"device_make_key":{"type":"string"},"active":{"type":"boolean","default":true},"key":{"type":"string","description":"String description of the device model, for use in targeting","maxLength":40},"name":{"type":"string","description":"Longer descriptive name of the device model","maxLength":40}},"required":["device_make_key","key","name"]},"DeviceScreenSize":{"type":"object","properties":{"key":{"type":"string","description":"String IDs such as \"S\", \"M\", \"L\", \"XL\", and \"NA\"","maxLength":2},"name":{"type":"string","description":"Description of the screen size","maxLength":40},"field_order":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true}},"required":["key","name"]},"EnvironmentType":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the environment type"},"name":{"type":"string","description":"Description of the environment type, e.g. \"Web\"","maxLength":40}},"required":["id","name"]},"EventTagType":{"type":"object","properties":{"key":{"type":"string","description":"The key of the event tag type","maxLength":40},"name":{"type":"string","description":"The name of the event tag type","maxLength":100}},"required":["key","name"]},"EventType":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"The ID of the event type"},"name":{"type":"string","nullable":true,"description":"The name of the event type","maxLength":40}},"required":["id"]},"ExperimentIDType":{"type":"object","properties":{"type":{"type":"string"},"type_label":{"type":"string"},"vendor_id":{"type":"integer"}},"required":["type","type_label"]},"Feed":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the feed"},"name":{"type":"string","description":"Name of the feed, e.g. \"Podcast\"","maxLength":40}},"required":["id","name"]},"FieldTypeEnum":{"enum":["STRING","INT","NUMERIC","BOOLEAN","PERCENTAGE","LIST"],"type":"string","description":"* `STRING` - String\n* `INT` - Int\n* `NUMERIC` - Numeric\n* `BOOLEAN` - Boolean\n* `PERCENTAGE` - Percentage\n* `LIST` - List"},"InventorySource":{"type":"object","properties":{"id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"Unique ID for the inventory source. Note, this is not used for targeting, the key is used"},"account_viewable":{"type":"boolean","description":"Based on the existing \"account_mapping\" for the inventory_source"},"default_viewable":{"type":"boolean","description":"Default inventory source viewable value"},"viewable":{"type":"boolean","description":"Inventory source viewable based on \"account_viewable\" and \"default_viewable\" values"},"super_user_only":{"type":"boolean"},"active":{"type":"boolean","default":true},"name":{"type":"string","description":"Name of the inventory source","maxLength":40},"key":{"type":"string","description":"Two-or three-letter code for the inventory source or exchange","maxLength":10},"mobile_app":{"type":"integer","maximum":127,"minimum":-128,"nullable":true},"mobile_web":{"type":"integer","maximum":127,"minimum":-128,"nullable":true},"video":{"type":"integer","maximum":127,"minimum":-128,"nullable":true},"desktop":{"type":"integer","maximum":127,"minimum":-128,"nullable":true},"mobile_native":{"type":"integer","maximum":127,"minimum":-128,"nullable":true},"desktop_native":{"type":"integer","maximum":127,"minimum":-128,"nullable":true},"other":{"type":"integer","maximum":127,"minimum":-128,"nullable":true},"category":{"type":"string","nullable":true,"description":"Categorization of inventory sources for convenience","maxLength":40},"update_date":{"type":"string","format":"date-time","nullable":true,"description":"The date and time when object was updated last time"}},"required":["account_viewable","default_viewable","id","key","name","super_user_only","viewable"]},"KeyConfig":{"type":"object","properties":{"name":{"type":"string"},"comparators":{"type":"array","items":{"type":"string"}},"module":{"type":"string"},"choices":{"type":"array","items":{"type":"string"},"readOnly":true},"choices_url":{"type":"string","readOnly":true},"related_field":{"type":"string","readOnly":true},"usage_tips":{"type":"array","items":{"type":"string"},"readOnly":true}},"required":["choices","choices_url","comparators","module","name","related_field","usage_tips"]},"KeyEnum":{"enum":["ad_position","ad_size","ads_txt","app_bundle_list","app_id_list","app_name","auction_type","audio_companion_required","audio_content_genre","audio_start_delay","bandwidth","browser","browser_version","carrier","city","companion_required","congressional_district","content_genre","content_rating","country","deal_id","deal_id_list","delivery","device_make","device_model","device_screen_size","device_type","domain_list","environment_type","feed","interstitial","interstitial_type","inventory_source","language","lat_long_list","lat_long_present","metro","native_layout","operating_system","operating_system_version","placement","placement_list","playback_method","player_size","publisher_id","publisher_id_list","region","rewarded","site","site_list","start_delay","state_house_district","state_senate_district","user_time_of_week","video_placement_type","zip","zip_code_list"],"type":"string","description":"* `ad_position` - Ad Position\n* `ad_size` - Ad Size\n* `ads_txt` - Ads Txt\n* `app_bundle_list` - App Bundle List\n* `app_id_list` - App ID List\n* `app_name` - App Name\n* `auction_type` - Auction Type\n* `audio_companion_required` - Audio Companion Required\n* `audio_content_genre` - Audio Content Genre\n* `audio_start_delay` - Audio Start Delay\n* `bandwidth` - Bandwidth\n* `browser` - Browser\n* `browser_version` - Browser Version\n* `carrier` - Carrier\n* `city` - City\n* `companion_required` - Companion Required\n* `congressional_district` - Congressional District\n* `content_genre` - Content Genre\n* `content_rating` - Content Rating\n* `country` - Country\n* `deal_id` - Deal ID\n* `deal_id_list` - Deal ID List\n* `delivery` - Delivery\n* `device_make` - Device Make\n* `device_model` - Device Model\n* `device_screen_size` - Device Screen Size\n* `device_type` - Device Type\n* `domain_list` - Domain List ID\n* `environment_type` - Environment Type\n* `feed` - Feed\n* `interstitial` - Interstitial\n* `interstitial_type` - Interstitial Type\n* `inventory_source` - Inventory Source\n* `language` - Language\n* `lat_long_list` - Latitude & Longitude List\n* `lat_long_present` - Latitude & Longitude Present\n* `metro` - Metro\n* `native_layout` - Native Layout\n* `operating_system` - Operating System\n* `operating_system_version` - Operating System Version\n* `placement` - Placement ID\n* `placement_list` - Placement ID List\n* `playback_method` - Playback Method\n* `player_size` - Player Size\n* `publisher_id` - Publisher ID\n* `publisher_id_list` - Publisher ID List\n* `region` - Region\n* `rewarded` - Rewarded\n* `site` - Site ID\n* `site_list` - Site ID List\n* `start_delay` - Video Start Delay\n* `state_house_district` - State House District\n* `state_senate_district` - State Senate District\n* `user_time_of_week` - User Time Of Week\n* `video_placement_type` - Video Placement Type\n* `zip` - Zip\n* `zip_code_list` - Zip Code List"},"KeyTypeEnum":{"enum":["DEFAULT","ALTERNATIVE"],"type":"string","description":"* `DEFAULT` - Default\n* `ALTERNATIVE` - Alternative"},"Language":{"type":"object","properties":{"key":{"type":"string","description":"Two-character code for the language, e.g. \"en\"","maxLength":2},"name":{"type":"string","description":"Name of the language, e.g. \"English\"","maxLength":40}},"required":["key","name"]},"LegislativeDistrict":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the Legislation District","maxLength":6},"name":{"type":"string","description":"Legislation District","maxLength":80},"state_id":{"type":"string","description":"Unique ID of the USA state"}},"required":["id","name","state_id"]},"LineItemType":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the line item type"},"sizeless":{"type":"boolean"},"name":{"type":"string","nullable":true,"description":"Name of the line item type, e.q. \"banner\"","maxLength":20},"pixel_size":{"type":"integer","maximum":127,"minimum":-128,"nullable":true}},"required":["id","sizeless"]},"List":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"account_id":{"type":"integer","readOnly":true},"active":{"type":"boolean","default":true},"favorite":{"type":"boolean","readOnly":true,"default":false},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"attributes":{"allOf":[{"$ref":"#/components/schemas/ListAttributes"}],"nullable":true},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"delimiter":{"type":"string","nullable":true,"maxLength":1},"name":{"type":"string","maxLength":100},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255},"type":{"type":"string","description":"The type of the list. One of: `\"app_bundle\"`, `\"app_id\"`, `\"deal_id\"`, `\"domain\"`, `\"lat_long\"`, `\"placement_id\"`, `\"publisher_id\"`, `\"site_id\"`, `\"zip_code\"`."},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"upload_type":{"$ref":"#/components/schemas/UploadTypeEnum"}},"required":["account_id","create_date","favorite","id","name","type","update_date"]},"ListAttributes":{"type":"object","properties":{"default_radius_km":{"type":"number","format":"double","minimum":0.001}},"required":["default_radius_km"]},"NativeLayout":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the native layout"},"name":{"type":"string","nullable":true,"description":"Name of the native layout, e.g. \"Sponsorship\"","maxLength":40}},"required":["id"]},"NullEnum":{"enum":[null]},"ObjectType":{"type":"object","properties":{"key":{"type":"string","description":"Unique key of the object type, e.q. \"News Feed\"","maxLength":30}},"required":["key"]},"OperatingSystem":{"type":"object","properties":{"active":{"type":"boolean","default":true},"key":{"type":"string","description":"Code for the OS","maxLength":40},"name":{"type":"string","description":"Name of the OS, e.g. \"Windows\"","maxLength":40},"category":{"type":"string","nullable":true,"description":"Categorization of OS for convenience","maxLength":20}},"required":["key","name"]},"OperatingSystemVersion":{"type":"object","properties":{"operating_system_key":{"type":"string"},"active":{"type":"boolean","default":true},"key":{"type":"string","description":"Code for the OS version","maxLength":40},"name":{"type":"string","description":"Name of the OS, e.g. \"Windows NT\"","maxLength":40}},"required":["key","name","operating_system_key"]},"PaginatedAdPositionList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AdPosition"}}}},"PaginatedAdsTxtList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AdsTxt"}}}},"PaginatedAdvertiserCategoryList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AdvertiserCategory"}}}},"PaginatedAdvertiserIndexList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AdvertiserIndex"}}}},"PaginatedAdvertiserSensitiveCategoryList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AdvertiserSensitiveCategory"}}}},"PaginatedAudioContentGenreList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AudioContentGenre"}}}},"PaginatedBandwidthList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Bandwidth"}}}},"PaginatedBidModelRefList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BidModelRef"}}}},"PaginatedBiddingStrategyRefList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BiddingStrategyRef"}}}},"PaginatedBrowserList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Browser"}}}},"PaginatedBrowserVersionList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BrowserVersion"}}}},"PaginatedBudgetTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BudgetType"}}}},"PaginatedCarrierList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Carrier"}}}},"PaginatedCityList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/City"}}}},"PaginatedContentCategoryList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ContentCategory"}}}},"PaginatedContentGenreList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ContentGenre"}}}},"PaginatedContentRatingList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ContentRating"}}}},"PaginatedContinentList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Continent"}}}},"PaginatedConversionAttributionMethodList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ConversionAttributionMethod"}}}},"PaginatedCountryList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}}},"PaginatedCreativeApprovalVendorsList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CreativeApprovalVendors"}}}},"PaginatedCreativeSizeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CreativeSize"}}}},"PaginatedCurrencyList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Currency"}}}},"PaginatedCustomListItemList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomListItem"}}}},"PaginatedCustomListTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomListType"}}}},"PaginatedDMAList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DMA"}}}},"PaginatedDealRefList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DealRef"}}}},"PaginatedDeliveryList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Delivery"}}}},"PaginatedDeviceList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Device"}}}},"PaginatedDeviceMakeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceMake"}}}},"PaginatedDeviceModelList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceModel"}}}},"PaginatedDeviceScreenSizeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceScreenSize"}}}},"PaginatedEnvironmentTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentType"}}}},"PaginatedEventTagTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EventTagType"}}}},"PaginatedEventTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EventType"}}}},"PaginatedExperimentIDTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ExperimentIDType"}}}},"PaginatedFeedList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Feed"}}}},"PaginatedInventorySourceList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventorySource"}}}},"PaginatedKeyConfigList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/KeyConfig"}}}},"PaginatedLanguageList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Language"}}}},"PaginatedLegislativeDistrictList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/LegislativeDistrict"}}}},"PaginatedLineItemTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/LineItemType"}}}},"PaginatedListList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/List"}}}},"PaginatedNativeLayoutList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/NativeLayout"}}}},"PaginatedObjectTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ObjectType"}}}},"PaginatedOperatingSystemList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/OperatingSystem"}}}},"PaginatedOperatingSystemVersionList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/OperatingSystemVersion"}}}},"PaginatedRefFrequencyCapIDTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RefFrequencyCapIDType"}}}},"PaginatedRegionList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Region"}}}},"PaginatedReportDashboardList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ReportDashboard"}}}},"PaginatedReportFieldGroupList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ReportFieldGroup"}}}},"PaginatedRevenueTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RevenueType"}}}},"PaginatedSecondLevelDomainList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SecondLevelDomain"}}}},"PaginatedSegmentCategoryList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategory"}}}},"PaginatedSegmentCategorySharingList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategorySharing"}}}},"PaginatedSegmentCategoryTreeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategoryTree"}}}},"PaginatedSegmentList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}}},"PaginatedSegmentSharingList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SegmentSharing"}}}},"PaginatedSegmentTagList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SegmentTag"}}}},"PaginatedSegmentTreeNodeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SegmentTreeNode"}}}},"PaginatedSegmentUploadBaseList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SegmentUploadBase"}}}},"PaginatedSystemAlertList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SystemAlert"}}}},"PaginatedSystemFeeTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SystemFeeType"}}}},"PaginatedThirdPartyDataProviderList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ThirdPartyDataProvider"}}}},"PaginatedThirdPartySegmentTreeNodeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ThirdPartySegmentTreeNode"}}}},"PaginatedTimezoneList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Timezone"}}}},"PaginatedUSAStatesList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/USAStates"}}}},"PaginatedVendorFeeTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VendorFeeType"}}}},"PaginatedVendorList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Vendor"}}}},"PaginatedVideoApiList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VideoApi"}}}},"PaginatedVideoAutoplayTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VideoAutoplayType"}}}},"PaginatedVideoEncodingProfileList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VideoEncodingProfile"}}}},"PaginatedVideoEncodingStatusList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VideoEncodingStatus"}}}},"PaginatedVideoPlacementTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VideoPlacementType"}}}},"PaginatedVideoPlaybackMethodList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VideoPlaybackMethod"}}}},"PaginatedVideoPlayerSizeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VideoPlayerSize"}}}},"PaginatedVideoProtocolList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VideoProtocol"}}}},"PaginatedVideoStartDelayList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VideoStartDelay"}}}},"PaginatedWarningCodeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer","example":123},"next":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=4"},"previous":{"type":"string","nullable":true,"format":"uri","example":"http://api.example.org/accounts/?page=2"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WarningCode"}}}},"PatchedSegment":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The unique ID of the segment"},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"advertiser_id":{"type":"integer","nullable":true,"description":"The advertiser that owns the segment, if any."},"key":{"type":"string","readOnly":true,"nullable":true,"description":"Alphanumeric key for the segment or category, in the format {Data Provider}-{Segment / Category ID}."},"name":{"type":"string","description":"The name of the segment","pattern":"^[\\w[('-]","maxLength":255},"description":{"type":"string","nullable":true,"description":"The description of the segment","maxLength":255},"cpm_cost":{"type":"string","format":"decimal","pattern":"^-?\\d{0,2}(?:\\.\\d{0,3})?$","nullable":true,"description":"The CPM cost to target this segment."},"verb":{"allOf":[{"$ref":"#/components/schemas/VerbEnum"}],"default":"ALL","description":"Restricted way segment can be applied to a targeting expression.\n\n* `ALL` - All\n* `INCLUDE` - Include\n* `EXCLUDE` - Exclude\n* `REQUIRE` - Require"},"ttl_days":{"type":"integer","description":"How long a user stays in the segment, in days (0-90). Defaults to the account's DEFAULT_SEGMENT_TTL_DAYS setting, or 30 if that is unset.","minimum":0,"maximum":90},"extensible":{"type":"boolean","default":true,"description":"Whether the segment extends across devices."},"aggregate_excludes":{"type":"boolean","default":false},"category_keys":{"type":"array","items":{"type":"string"},"description":"Keys of the segment categories this segment belongs to, e.g. 'mybuzzkey-1234'. Pass an empty list for an uncategorized segment."},"active":{"type":"boolean","default":true,"description":"Whether the segment is active."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255}}},"PatchedSegmentCategory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Unique ID of the segment category"},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"advertiser_id":{"type":"integer","nullable":true,"description":"The advertiser that owns the segment category. Pass null for none."},"key":{"type":"string","readOnly":true,"nullable":true,"description":"Alphanumeric key for the segment or category, in the format {Data Provider}-{Segment / Category ID}."},"parent_key":{"type":"string","nullable":true,"description":"Alphanumeric key for the parent node in the tree. Pass null for a top-level category."},"name":{"type":"string","description":"The descriptive name of the segments. This field cannot be blank.","maxLength":191},"active":{"type":"boolean","default":true,"description":"Whether the segment category is active."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255}}},"PatchedSegmentCategorySharing":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The unique ID of the sharing relationship."},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"shared_account_id":{"type":"integer","description":"The account the segment category is shared with."},"key":{"type":"string","description":"Key of the segment category being shared."},"cpm_cost":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"The CPM cost for the shared segment category."},"active":{"type":"boolean","default":true,"description":"Whether the sharing relationship is active."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255}}},"PatchedSegmentSharing":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The unique ID of the sharing relationship."},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"shared_account_id":{"type":"integer","description":"The account the segment is shared with."},"key":{"type":"string","description":"Key of the segment being shared."},"cpm_cost":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"The CPM cost for the shared segment."},"active":{"type":"boolean","default":true,"description":"Whether the sharing relationship is active."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255}}},"RefFrequencyCapIDType":{"type":"object","properties":{"type":{"type":"string"},"type_label":{"type":"string"},"vendor_id":{"type":"integer"},"vendor":{"type":"string"},"allow_fallback":{"type":"boolean"}},"required":["allow_fallback","type","type_label","vendor","vendor_id"]},"Region":{"type":"object","properties":{"region_code":{"type":"string","description":"ID for the region code for the city, e.g. \"NY\"","maxLength":3},"key":{"type":"string","description":"Region in format <country_code>/<region_code>"},"country_code_3":{"type":"string","description":"3-character country code, e.g. \"USA\"","maxLength":3},"country_code_2":{"type":"string","description":"2-character country code, e.g. \"US\"","maxLength":2},"region_name":{"type":"string","description":"Name of the region, e.g. \"New York\"","maxLength":80}},"required":["country_code_2","country_code_3","key","region_code","region_name"]},"ReportDashboard":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the dashboard"},"name":{"type":"string","description":"The name of the dashboard"}},"required":["id","name"]},"ReportFieldGroup":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100}},"required":["id","name"]},"RevenueType":{"type":"object","properties":{"key":{"type":"string","description":"The key of the revenue type","maxLength":10},"name":{"type":"string","nullable":true,"description":"The name of the revenue type","maxLength":100}},"required":["key"]},"SecondLevelDomain":{"type":"object","properties":{"key":{"type":"string","description":"Unique key of the second level domain, e.q. \"org.uk\"","maxLength":20}},"required":["key"]},"Segment":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The unique ID of the segment"},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"advertiser_id":{"type":"integer","nullable":true,"description":"The advertiser that owns the segment, if any."},"key":{"type":"string","readOnly":true,"nullable":true,"description":"Alphanumeric key for the segment or category, in the format {Data Provider}-{Segment / Category ID}."},"name":{"type":"string","description":"The name of the segment","pattern":"^[\\w[('-]","maxLength":255},"description":{"type":"string","nullable":true,"description":"The description of the segment","maxLength":255},"cpm_cost":{"type":"string","format":"decimal","pattern":"^-?\\d{0,2}(?:\\.\\d{0,3})?$","nullable":true,"description":"The CPM cost to target this segment."},"verb":{"allOf":[{"$ref":"#/components/schemas/VerbEnum"}],"default":"ALL","description":"Restricted way segment can be applied to a targeting expression.\n\n* `ALL` - All\n* `INCLUDE` - Include\n* `EXCLUDE` - Exclude\n* `REQUIRE` - Require"},"ttl_days":{"type":"integer","description":"How long a user stays in the segment, in days (0-90). Defaults to the account's DEFAULT_SEGMENT_TTL_DAYS setting, or 30 if that is unset.","minimum":0,"maximum":90},"extensible":{"type":"boolean","default":true,"description":"Whether the segment extends across devices."},"aggregate_excludes":{"type":"boolean","default":false},"category_keys":{"type":"array","items":{"type":"string"},"description":"Keys of the segment categories this segment belongs to, e.g. 'mybuzzkey-1234'. Pass an empty list for an uncategorized segment."},"active":{"type":"boolean","default":true,"description":"Whether the segment is active."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255}},"required":["account_id","category_keys","create_date","id","key","name","update_date"]},"SegmentCategory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Unique ID of the segment category"},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"advertiser_id":{"type":"integer","nullable":true,"description":"The advertiser that owns the segment category. Pass null for none."},"key":{"type":"string","readOnly":true,"nullable":true,"description":"Alphanumeric key for the segment or category, in the format {Data Provider}-{Segment / Category ID}."},"parent_key":{"type":"string","nullable":true,"description":"Alphanumeric key for the parent node in the tree. Pass null for a top-level category."},"name":{"type":"string","description":"The descriptive name of the segments. This field cannot be blank.","maxLength":191},"active":{"type":"boolean","default":true,"description":"Whether the segment category is active."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255}},"required":["account_id","advertiser_id","create_date","id","key","name","parent_key","update_date"]},"SegmentCategoryDuplicate":{"type":"object","properties":{"advertiser_id":{"type":"integer","nullable":true,"description":"The advertiser to assign to the duplicate."},"name":{"type":"string","description":"Name of the segment category","maxLength":191},"duplicate":{"type":"array","items":{"$ref":"#/components/schemas/SegmentCategoryDuplicateDuplicateEnum"},"description":"The list of strings that describes a set of entities to be duplicated."}},"required":["advertiser_id","duplicate","name"]},"SegmentCategoryDuplicateDuplicateEnum":{"enum":["resource","parent"],"type":"string","description":"* `resource` - resource\n* `parent` - parent"},"SegmentCategorySharing":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The unique ID of the sharing relationship."},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"shared_account_id":{"type":"integer","description":"The account the segment category is shared with."},"key":{"type":"string","description":"Key of the segment category being shared."},"cpm_cost":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"The CPM cost for the shared segment category."},"active":{"type":"boolean","default":true,"description":"Whether the sharing relationship is active."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255}},"required":["account_id","create_date","id","key","shared_account_id","update_date"]},"SegmentCategoryTree":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Unique ID of the segment category"},"account_id":{"type":"integer","readOnly":true,"description":"The account that owns the segment category."},"advertiser_id":{"type":"integer","nullable":true,"readOnly":true,"description":"The advertiser that owns the segment category, if any."},"key":{"type":"string","nullable":true,"description":"Alphanumeric key for the segment or category, in the format {Data Provider}-{Segment / Category ID}.","maxLength":30},"name":{"type":"string","description":"Name of the segment category","maxLength":191},"active":{"type":"boolean","default":true,"description":"Whether the segment category is active."},"create_date":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255},"subcategories_url":{"type":"string","readOnly":true,"description":"URL to fetch child categories of this category for lazy loading."}},"required":["account_id","advertiser_id","id","name","subcategories_url","update_date"]},"SegmentDuplicate":{"type":"object","properties":{"advertiser_id":{"type":"integer","nullable":true,"description":"The advertiser to assign to the duplicate, if any."},"name":{"type":"string","description":"The name of the segment","maxLength":255},"duplicate":{"type":"array","items":{"$ref":"#/components/schemas/SegmentDuplicateDuplicateEnum"},"description":"The list of strings that describes a set of entities to be duplicated."}},"required":["duplicate","name"]},"SegmentDuplicateDuplicateEnum":{"enum":["resource","categories"],"type":"string","description":"* `resource` - resource\n* `categories` - categories"},"SegmentSharing":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The unique ID of the sharing relationship."},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"shared_account_id":{"type":"integer","description":"The account the segment is shared with."},"key":{"type":"string","description":"Key of the segment being shared."},"cpm_cost":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","nullable":true,"description":"The CPM cost for the shared segment."},"active":{"type":"boolean","default":true,"description":"Whether the sharing relationship is active."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"notes":{"type":"string","nullable":true,"description":"Free-form notes of up to 255 characters.","maxLength":255}},"required":["account_id","create_date","id","key","shared_account_id","update_date"]},"SegmentStatistics":{"type":"object","properties":{"user_count_by_region":{"type":"object","properties":{"NAM":{"type":"integer","description":"User count in North America"},"EMEA":{"type":"integer","description":"User count in Europe, Middle East, and Africa"},"APAC":{"type":"integer","description":"User count in Asia Pacific"}},"readOnly":true,"description":"User counts by region (continent) for this segment."}},"required":["user_count_by_region"]},"SegmentTag":{"type":"object","properties":{"id":{"type":"integer","description":"The segment ID."},"tag":{"type":"string","readOnly":true,"description":"The rendered tag snippet for collecting segment data (JavaScript, image pixel, etc.)."}},"required":["id","tag"]},"SegmentTreeNode":{"type":"object","properties":{"cpm":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","description":"The CPM price to target this segment."},"children_count":{"type":"integer","readOnly":true,"description":"The number of direct child segments and categories. This will always be null for segments."},"children_url":{"type":"string","readOnly":true,"description":"The URI to fetch a list of child segments and categories. This will always be null for segments."},"user_count_by_region":{"type":"object","additionalProperties":{},"readOnly":true,"description":"Object of number of users contained in the segment keyed by global region (e.g. APAC, NAM, EMEA). This will always be null for categories."},"advertiser_id":{"type":"integer","description":"The advertiser ID for the segment or segment category."},"type":{"type":"string","description":"Either segment or category."},"key":{"type":"string","description":"Alphanumeric key for the segment or category, in the format {Data Provider}-{Segment / Category ID}."},"name":{"type":"string","description":"Name of the segment or category."},"data_provider_id":{"type":"integer","description":"Unique ID of the data provider. This value will always be null for custom segments."},"parent_key":{"type":"string","description":"Alphanumeric key for the parent node in the tree."},"alternative_id":{"type":"string","description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters."},"verb_usage":{"type":"string","description":"Restricted way segment can be applied to a targeting expression."}},"required":["advertiser_id","alternative_id","children_count","children_url","cpm","data_provider_id","key","name","parent_key","type","user_count_by_region","verb_usage"]},"SegmentUploadBase":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The unique identifier for this segment upload."},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"partner_handle":{"type":"string","description":"Partner handle for sync partner configurations.","maxLength":20},"is_pii_segment":{"type":"boolean","default":false,"description":"Whether this upload contains PII (Personally Identifiable Information) data."},"source":{"allOf":[{"$ref":"#/components/schemas/SegmentUploadBaseSource"}],"description":"Information about the upload source (file or S3 references)."},"segment":{"allOf":[{"$ref":"#/components/schemas/SegmentUploadSegment"}],"description":"Segment-specific configuration for the upload (continent, ID type, etc.)."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"}},"required":["account_id","create_date","id","segment","source","update_date"]},"SegmentUploadBaseSource":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"description":"The original file name (set by backend after upload)."},"size":{"type":"integer","readOnly":true,"description":"File size in bytes (set by backend after upload)."},"path":{"type":"string","readOnly":true,"description":"Internal S3 path where the file is stored (set by backend)."},"format":{"type":"string","description":"The anticipated file format."},"operation_type":{"type":"string","description":"The action to be taken on the segments in the file(s)."}},"required":["format","name","operation_type","path","size"]},"SegmentUploadFile":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The unique identifier for this segment upload."},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"partner_handle":{"type":"string","description":"Partner handle for sync partner configurations.","maxLength":20},"is_pii_segment":{"type":"boolean","default":false,"description":"Whether this upload contains PII (Personally Identifiable Information) data."},"source":{"allOf":[{"$ref":"#/components/schemas/SegmentUploadFileSource"}],"description":"The uploaded file the user IDs are read from."},"segment":{"allOf":[{"$ref":"#/components/schemas/SegmentUploadSegment"}],"description":"Segment-specific configuration for the upload (continent, ID type, etc.)."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"}},"required":["account_id","create_date","id","segment","source","update_date"]},"SegmentUploadFileSource":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"description":"The uploaded file name."},"size":{"type":"integer","readOnly":true,"description":"The uploaded file size in bytes."},"path":{"type":"string","readOnly":true,"description":"Internal S3 path where the file is stored (set by backend)."},"format":{"type":"string","description":"The anticipated file format."},"operation_type":{"type":"string","description":"The action to be taken on the segments in the file(s)."},"file":{"type":"string","format":"uri","writeOnly":true,"description":"The file to upload (CSV or TSV format, must be under maximum size limit)."}},"required":["file","format","name","operation_type","path","size"]},"SegmentUploadReferences":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The unique identifier for this segment upload."},"account_id":{"type":"integer","description":"Defaults to the account in the active session"},"partner_handle":{"type":"string","description":"Partner handle for sync partner configurations.","maxLength":20},"is_pii_segment":{"type":"boolean","default":false,"description":"Whether this upload contains PII (Personally Identifiable Information) data."},"source":{"allOf":[{"$ref":"#/components/schemas/SegmentUploadReferencesSource"}],"description":"The S3 references the user IDs are read from."},"segment":{"allOf":[{"$ref":"#/components/schemas/SegmentUploadSegment"}],"description":"Segment-specific configuration for the upload (continent, ID type, etc.)."},"create_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was first created"},"update_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true,"description":"The date and time the object was last updated"}},"required":["account_id","create_date","id","segment","source","update_date"]},"SegmentUploadReferencesSource":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"description":"The original file name (set by backend after upload)."},"size":{"type":"integer","readOnly":true,"description":"File size in bytes (set by backend after upload)."},"path":{"type":"string","readOnly":true,"description":"Internal S3 path where the file is stored (set by backend)."},"format":{"type":"string","description":"The anticipated file format."},"operation_type":{"type":"string","description":"The action to be taken on the segments in the file(s)."},"references":{"type":"array","items":{"type":"string","maxLength":500},"description":"A list of S3 references. Used when pre-uploading files to S3."}},"required":["format","name","operation_type","path","references","size"]},"SegmentUploadSegment":{"type":"object","properties":{"continent":{"allOf":[{"$ref":"#/components/schemas/ContinentEnum"}],"description":"The continent for the segment upload.\n\n* `NAM` - NAM\n* `EMEA` - EMEA\n* `APAC` - APAC"},"key_type":{"allOf":[{"$ref":"#/components/schemas/KeyTypeEnum"}],"default":"DEFAULT","description":"Whether user IDs map to segment key or alternative_id.\n\n* `DEFAULT` - Default\n* `ALTERNATIVE` - Alternative"},"user_id_type":{"type":"string","description":"The type of IDs being imported.","nullable":true},"first_party_user_id_type":{"type":"string","nullable":true,"description":"Custom first-party user ID type (must be uppercase snake_case, e.g., 'CUSTOM_ID_TYPE').","pattern":"^[A-Z]+(?:_[A-Z]+)*$","maxLength":191}},"required":["continent"]},"SegmentUploadStatus":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"The segment upload ID."},"status":{"type":"string","description":"Current status of the upload (e.g., 'PENDING', 'PROCESSING', 'COMPLETE', 'FAILED')."},"tasks":{"allOf":[{"$ref":"#/components/schemas/SegmentUploadTasks"}],"description":"Progress tracking for upload tasks."},"complete_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the upload completed."},"message":{"type":"string","nullable":true,"description":"Status message or error details from the upload process."}},"required":["complete_date","id","status"]},"SegmentUploadTasks":{"type":"object","properties":{"completed":{"type":"integer","minimum":0,"description":"Number of tasks completed in the upload process."},"total":{"type":"integer","minimum":0,"description":"Total number of tasks in the upload process."}},"required":["completed","total"]},"SystemAlert":{"type":"object","properties":{"key":{"type":"string","description":"Unique key of the system alert, e.q. \"creative_approval\"","maxLength":20},"visible":{"type":"boolean"},"name":{"type":"string","description":"Name of the system alert","maxLength":100},"description":{"type":"string","nullable":true,"description":"Description of the system alert","maxLength":255}},"required":["key","name","visible"]},"SystemFeeType":{"type":"object","properties":{"key":{"type":"string","description":"The key of the system fee type","maxLength":10},"name":{"type":"string","nullable":true,"description":"The name of the system fee type","maxLength":100}},"required":["key"]},"TargetingKeyEnum":{"enum":["ad_position","ad_size","ads_txt","app_bundle_list","app_id_list","app_name","auction_type","audio_companion_required","audio_content_genre","audio_start_delay","bandwidth","browser","browser_version","carrier","city","companion_required","congressional_district","content_category","content_genre","content_rating","country","deal_id","deal_id_list","delivery","device_make","device_model","device_screen_size","device_type","domain_list","environment_type","feed","interstitial","interstitial_type","inventory_source","ip_address","ipv4_address","language","lat_long_list","lat_long_present","location_type","metro","native_layout","operating_system","operating_system_version","placement","placement_list","playback_method","player_size","publisher_id","publisher_id_list","region","rewarded","segment","site","site_list","start_delay","state_house_district","state_senate_district","time_of_week","topframe","user_id","user_time_of_week","video_api","video_placement_type","zip","zip_code_list"],"type":"string","description":"* `ad_position` - Ad Position\n* `ad_size` - Ad Size\n* `ads_txt` - Ads Txt\n* `app_bundle_list` - App Bundle List\n* `app_id_list` - App ID List\n* `app_name` - App Name\n* `auction_type` - Auction Type\n* `audio_companion_required` - Audio Companion Required\n* `audio_content_genre` - Audio Content Genre\n* `audio_start_delay` - Audio Start Delay\n* `bandwidth` - Bandwidth\n* `browser` - Browser\n* `browser_version` - Browser Version\n* `carrier` - Carrier\n* `city` - City\n* `companion_required` - Companion Required\n* `congressional_district` - Congressional District\n* `content_category` - Content Category\n* `content_genre` - Content Genre\n* `content_rating` - Content Rating\n* `country` - Country\n* `deal_id` - Deal ID\n* `deal_id_list` - Deal ID List\n* `delivery` - Delivery\n* `device_make` - Device Make\n* `device_model` - Device Model\n* `device_screen_size` - Device Screen Size\n* `device_type` - Device Type\n* `domain_list` - Domain List ID\n* `environment_type` - Environment Type\n* `feed` - Feed\n* `interstitial` - Interstitial\n* `interstitial_type` - Interstitial Type\n* `inventory_source` - Inventory Source\n* `ip_address` - IP Address\n* `ipv4_address` - IPv4 address\n* `language` - Language\n* `lat_long_list` - Latitude & Longitude List\n* `lat_long_present` - Latitude & Longitude Present\n* `location_type` - Location Type\n* `metro` - Metro\n* `native_layout` - Native Layout\n* `operating_system` - Operating System\n* `operating_system_version` - Operating System Version\n* `placement` - Placement ID\n* `placement_list` - Placement ID List\n* `playback_method` - Playback Method\n* `player_size` - Player Size\n* `publisher_id` - Publisher ID\n* `publisher_id_list` - Publisher ID List\n* `region` - Region\n* `rewarded` - Rewarded\n* `segment` - Segment\n* `site` - Site ID\n* `site_list` - Site ID List\n* `start_delay` - Video Start Delay\n* `state_house_district` - State House District\n* `state_senate_district` - State Senate District\n* `time_of_week` - Time Of Week\n* `topframe` - Topframe\n* `user_id` - User ID\n* `user_time_of_week` - User Time Of Week\n* `video_api` - Video API\n* `video_placement_type` - Video Placement Type\n* `zip` - Zip\n* `zip_code_list` - Zip Code List"},"TargetingRecency":{"type":"object","properties":{"start":{"type":"integer","maximum":129600,"minimum":0,"nullable":true},"end":{"type":"integer","maximum":129600,"minimum":0,"nullable":true}}},"ThirdPartyDataProvider":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"children_url":{"type":"string","readOnly":true,"description":"The URI to fetch a list of child segments and categories. This will always be null for segments."},"active":{"type":"boolean","default":true},"account_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648},"name":{"type":"string","maxLength":100},"buzz_key":{"type":"string","maxLength":20}},"required":["account_id","buzz_key","children_url","id","name"]},"ThirdPartySegmentTreeNode":{"type":"object","properties":{"cpm":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","description":"The CPM price to target this segment."},"children_count":{"type":"integer","readOnly":true,"description":"The number of direct child segments and categories. This will always be null for segments."},"children_url":{"type":"string","readOnly":true,"description":"The URI to fetch a list of child segments and categories. This will always be null for segments."},"user_count_by_region":{"type":"object","additionalProperties":{},"readOnly":true,"description":"Object of number of users contained in the segment keyed by global region (e.g. APAC, NAM, EMEA). This will always be null for categories."},"type":{"allOf":[{"$ref":"#/components/schemas/TypeEnum"}],"description":"Either segment or category\n\n* `category` - Category\n* `segment` - Segment"},"key":{"type":"string","description":"Alphanumeric key for the segment or category, in the format {Data Provider}-{Segment / Category ID}.","maxLength":30},"name":{"type":"string","description":"Name of the segment or category","maxLength":255},"data_provider_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"description":"Unique ID of the data provider. This value will always be null for custom segments."},"parent_key":{"type":"string","nullable":true,"description":"Alphanumeric key for the parent node in the tree.","maxLength":30},"alternative_id":{"type":"string","nullable":true,"description":"An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.","maxLength":200},"verb_usage":{"nullable":true,"description":"Restricted way segment can be applied to a targeting expression.\n\n* `ALL` - All\n* `INCLUDE` - Include\n* `EXCLUDE` - Exclude\n* `REQUIRE` - Require","oneOf":[{"$ref":"#/components/schemas/VerbUsageEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"conditional_overrides":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"A list of segment pricing overrides.","readOnly":true}},"required":["children_count","children_url","conditional_overrides","cpm","data_provider_id","key","name","type","user_count_by_region"]},"Timezone":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"description":"Unique ID of the timezone"},"name":{"type":"string","description":"Name of the timezome, e.q. \"America/New_York\"","maxLength":40},"region":{"type":"string","nullable":true,"description":"Name of the geo region that timezone belongs to, e.g. \"North America\"","maxLength":40},"description":{"type":"string","nullable":true,"description":"List of cities that use the timezone","maxLength":255},"selectable":{"type":"boolean","description":"Flag indicating if this timezone is selectable in the UI."}},"required":["id","name"]},"TypeEnum":{"enum":["category","segment"],"type":"string","description":"* `category` - Category\n* `segment` - Segment"},"USAStates":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the USA state","maxLength":2},"name":{"type":"string","description":"USA state name, e.g. Colorado","maxLength":80}},"required":["id","name"]},"UploadTypeEnum":{"enum":["DIRECT_UPLOAD","BULK_UPLOAD"],"type":"string","description":"* `DIRECT_UPLOAD` - Direct Upload\n* `BULK_UPLOAD` - Bulk Upload"},"ValueTypeEnum":{"enum":["BID","MULTIPLIER","BUDGET_WEIGHT"],"type":"string","description":"* `BID` - Bid\n* `MULTIPLIER` - Multiplier\n* `BUDGET_WEIGHT` - Budget Weight"},"Vendor":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"shared_across_accounts":{"type":"boolean"}},"required":["id","name","shared_across_accounts"]},"VendorFeeType":{"type":"object","properties":{"key":{"type":"string","description":"The key of the fee type","maxLength":10},"name":{"type":"string","nullable":true,"description":"The name of the fee type","maxLength":100}},"required":["key"]},"VerbEnum":{"enum":["ALL","INCLUDE","EXCLUDE","REQUIRE"],"type":"string","description":"* `ALL` - All\n* `INCLUDE` - Include\n* `EXCLUDE` - Exclude\n* `REQUIRE` - Require"},"VerbUsageEnum":{"enum":["ALL","INCLUDE","EXCLUDE","REQUIRE"],"type":"string","description":"* `ALL` - All\n* `INCLUDE` - Include\n* `EXCLUDE` - Exclude\n* `REQUIRE` - Require"},"VideoApi":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the video API"},"name":{"type":"string","nullable":true,"description":"Name of the API, e.g. \"VPAID 2.0\"","maxLength":40}},"required":["id"]},"VideoAutoplayType":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the video autoplay type"},"name":{"type":"string","description":"Namee of the video autoplay type, e.q. \"Click-to-play\"","maxLength":40}},"required":["id","name"]},"VideoEncodingProfile":{"type":"object","properties":{"id":{"type":"integer","maximum":2147483647,"minimum":-2147483648},"name":{"type":"string","maxLength":40},"video_encoding_protocol_description":{"type":"string","nullable":true,"maxLength":80}},"required":["id","name"]},"VideoEncodingStatus":{"type":"object","properties":{"video_encoding_status_id":{"type":"integer","maximum":127,"minimum":-128},"video_encoding_status_description":{"type":"string","nullable":true,"maxLength":40}},"required":["video_encoding_status_id"]},"VideoPlacementType":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the vide placement type"},"name":{"type":"string","description":"Name of the video placement type, e.g. \"in-stream\"","maxLength":40}},"required":["id","name"]},"VideoPlaybackMethod":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the type of video playback method"},"name":{"type":"string","description":"Name of the video playback method, e.g. \"auto-play\"","maxLength":40}},"required":["id","name"]},"VideoPlayerSize":{"type":"object","properties":{"key":{"type":"string","description":"Unique string ID of the type of video player size, e.g. \"L\"","maxLength":2},"name":{"type":"string","description":"Name of the player size, e.g. \"Large\"","maxLength":20}},"required":["key","name"]},"VideoProtocol":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique ID of the video protocol"},"name":{"type":"string","nullable":true,"description":"Name of the video protocol, e.q. \"VAST 3.0\"","maxLength":40}},"required":["id"]},"VideoStartDelay":{"type":"object","properties":{"id":{"type":"integer","maximum":127,"minimum":-128,"description":"Unique string ID of the code for the video delay, e.g. \"-1\""},"name":{"type":"string","description":"Name of the delay, e.g. \"Post-roll\"","maxLength":40}},"required":["id","name"]},"WarningCode":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"code":{"type":"string","description":"The code of the warning.","maxLength":150}},"required":["code","id"]}},"securitySchemes":{"nestBasicAuth":{"type":"http","scheme":"basic","description":"Form-based Basic Authentication"},"nestSessionAuth":{"type":"http","scheme":"basic","description":"Form-based Basic Authentication"}}},"x-explorer-enabled":false,"x-samples-languages":["curl","node","ruby","javascript","python","php","java"],"servers":[{"url":"https://{buzz_key}.api.beeswax.com/rest/v2","variables":{"buzz_key":{"default":"stingersbx","description":"Unique customer ID assigned by the Beeswax"}}}]}