{
"basePath": "/api/v2.0",
"definitions": {
"ad_server": {
"example": {
"entity_type": "ad_server",
"id": 9,
"name": "TerminalOne"
},
"title": "Ad Server",
"type": "object",
"x-stoplight": {
"id": "ad_server",
"name": "ad_server",
"public": true
},
"properties": {
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"version": {
"type": "integer"
}
}
},
"advertiser": {
"example": {
"accountable_and_addressable": false,
"ad_server_id": 9,
"agency_id": 122077,
"allow_x_strat_optimization": false,
"created_on": "2019-05-23T18:10:41+0000",
"data_sharing_enabled": false,
"dmp_enabled": "inherits",
"domain": "https://www.roygbivintl.com/",
"entity_type": "advertiser",
"external_id": "Account #45612",
"frequency_interval": "not-applicable",
"frequency_type": "no-limit",
"id": 225595,
"minimize_multi_ads": false,
"name": "Roy G Biv Intl.",
"status": true,
"updated_on": "2019-05-23T18:10:41+0000",
"version": 0,
"vertical_id": 5
},
"title": "Advertiser",
"type": "object",
"x-stoplight": {
"id": "advertiser",
"name": "Advertiser",
"public": true
},
"properties": {
"accountable_and_addressable": {
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"ad_server_fee": {
"description": "Fee charged by ad serving vendor",
"type": "integer"
},
"ad_server_id": {
"description": "Enter ID for third-party adserver - refer to the \"Ad Servers\" page",
"type": "integer"
},
"agency_id": {
"description": "T1 Agency ID to which an advertiser belongs (see \"API for Agencies\")",
"type": "integer"
},
"allow_x_strat_optimization": {
"description": " \t\n\nThis option is only available if Cross-Advertiser Pacing has been enabled for the Agency. Cross-Advertiser pacing allows winning bids to be decided based on price AND pacing level. If two bids from participating Advertisers are competitive and the lower bid is from an under-pacing campaign, then the lower bid may win. If this field is set to No, this Advertiser will compete solely on bid price.",
"type": "boolean"
},
"billing_contact_id": {
"description": "T1 id for person serving as billing contact. If desired, get list of valid names and IDs by making GET \"$API_BASE/contacts\" call.",
"type": "integer"
},
"created_on": {
"type": "string"
},
"dmp_enabled": {
"type": "string"
},
"domain": {
"description": "The URL domain of the advertiser—for example, http://www.advertiser.com",
"type": "string"
},
"external_id": {
"type": "string",
"description": "External ID name of the advertiser",
"maxLength": 255
},
"frequency_amount": {
"description": "Maximum frequency of impressions per user within interval set on frequency_interval\n\nrequired if `frequency_typeis even or asap`.",
"type": "integer"
},
"frequency_interval": {
"type": "string",
"description": "Interval applicable for frequency_amount.\n\nRequired if `frequency_typeis even or asap`.",
"enum": [
"hour",
"day",
"week",
"month",
"not-applicable",
"campaign"
]
},
"frequency_type": {
"description": "Distribute impressions across frequency_interval up to frequency_value evenly or asap",
"enum": [
"asap",
"even",
"no-limit"
],
"type": "string"
},
"minimize_multi_ads": {
"description": "Minimize occurrences of multiple ads appearing on the same page",
"type": "boolean"
},
"name": {
"description": "Name for the Advertiser. 64 characters maximum allowed.",
"type": "string"
},
"status": {
"description": "Status of advertiser (defaults to off if unspecified)",
"type": "boolean"
},
"updated_on": {
"type": "string"
},
"vertical_id": {
"description": "\nVertical IDs are listed at https://api.mediamath.com/api/v2.0/verticals?sort_by=id and on 12/20/2019 are:\n\n1 'Air Travel'\n2 'Autos'\n3 'Business Services'\n4 'Electronics'\n5 'Clothing & Accessories'\n6 'Computer (Hardware & Software)'\n7 'Credit Cards'\n8 'Dating'\n9 'Employment'\n10 'Pharmaceuticals (Rx & OTC)'\n11 'Education'\n12 'Entertainment'\n13 'Food & Beverages'\n14 'Pets'\n15 'Toys'\n16 'Home & Garden'\n17 'Insurance'\n18 'Internet Services'\n19 'Personal Care'\n20 'Personal Finance'\n21 'Real Estate'\n22 'Sporting Goods'\n23 'Telecommunications'\n24 'Hotels'\n25 'Media'\n26 'Non-Profit'\n27 'Gambling'\n28 'Consumer Goods'\n29 'Government'\n30 'Alcohol'\n31 'Adult'\n32 'Tobacco'\n33 'Religion and Spirituality'\n34 'Weight Loss'",
"type": "integer"
},
"ad_server_password": {
"type": "string"
},
"ad_server_username": {
"type": "string"
},
"ads_txt_verified": {
"type": "string",
"enum": [
"ANY",
"AUTHORIZED_DIRECT_ONLY",
"AUTHORIZED_ONLY"
]
},
"data_sharing_enabled": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"political": {
"type": "boolean"
},
"sales_contact_id": {
"type": "integer"
},
"version": {
"type": "integer"
}
},
"required": [
"ad_server_id",
"agency_id",
"domain",
"name",
"vertical_id"
]
},
"agency": {
"example": {
"allow_x_adv_optimization": false,
"allow_x_adv_pixels": false,
"created_on": "2016-03-19T16:12:12+0000",
"dmp_enabled": "inherits",
"entity_type": "agency",
"id": 113388,
"name": "test_py_postgres",
"organization_id": 100048,
"status": false,
"updated_on": "2016-03-19T16:12:12+0000",
"version": 0
},
"title": "Agency",
"type": "object",
"x-stoplight": {
"id": "agency",
"name": "Agency",
"public": true
},
"description": "Agency",
"properties": {
"ads_txt_verified": {
"default": "AUTHORIZED_ONLY",
"description": "* ANY: can bid on all inventory where seller is listed in publishers ads.txt OR where publisher does not have ads.txt OR we have not checked publishers ads.txt\n* AUTHORIZED_ONLY: can only bid on inventory where seller is listed in publishers ads.txt\n* AUTHORIZED_DIRECT_ONLY: can only bid on inventory where seller is listed in publishers ads.txt as a DIRECT seller",
"enum": [
"ANY",
"AUTHORIZED_DIRECT_ONLY",
"AUTHORIZED_ONLY"
],
"type": "string"
},
"allow_x_adv_optimization": {
"default": false,
"description": "This option is only available if Cross-Advertiser Pacing has been enabled for the Agency. Cross-Advertiser pacing allows winning bids to be decided based on price AND pacing level. If two bids from participating Advertisers are competitive and the lower bid is from an under-pacing campaign, then the lower bid may win. If this field is set to No, this Advertiser will compete solely on bid price.\n\n",
"type": "boolean"
},
"allow_x_adv_pixels": {
"default": false,
"description": "This field enables the Data Co-op functionality across all the Advertisers under this organization. Cross-Advertiser Pixel Targeting allows Advertisers to target other Advertiser Event Pixels within their Agency and any other similarly enabled Agency under the same Organization.\n\n",
"type": "boolean"
},
"billing_contact_id": {
"type": "integer"
},
"created_on": {
"type": "string"
},
"dmp_enabled": {
"type": "string",
"enum": [
"disabled",
"enabled",
"inherits"
]
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"logo": {
"type": "string"
},
"name": {
"type": "string"
},
"organization_id": {
"type": "integer"
},
"sales_contact_id": {
"type": "integer"
},
"status": {
"type": "boolean"
},
"traffic_contact_id": {
"type": "integer"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
},
"eligible_for_data_sharing": {
"type": "boolean"
}
}
},
"atomic-creative": {
"example": {
"ad_format": "DISPLAY",
"ad_server_type": "DART",
"advertiser_id": 150577,
"approval_status": "PENDING",
"built": false,
"built_by_user_id": 9160,
"created_on": "2016-11-22T14:20:17+0000",
"creative_import_file_id": 76091,
"entity_type": "atomic_creative",
"expansion_direction": "NONRESTRICTED",
"expansion_trigger": "MOUSEOVER",
"external_identifier": "140191381",
"file_type": "unknown",
"has_sound": false,
"height": 250,
"id": 3260345,
"is_https": true,
"is_mraid": false,
"is_multi_creative": false,
"last_modified": "2016-11-22T14:21:47+0000",
"media_type": "DISPLAY",
"name": "DesCK_Algo 1: HHE Retargeting Gift Card_LF_Stan_Disp_DS_Retarget_Geo_65_300x250_300x250_PD_dCPM_NA_NA_HTML5_11/14/16_12/31/16",
"rich_media": false,
"sizmek_creative_status": "NOT_USED",
"sizmek_tag_status": "NOT_USED",
"status": false,
"t1as": false,
"tag": "\n \n",
"tag_type": "SCRIPT",
"tpas_ad_tag_name": "DesCK_Algo 1: HHE Retargeting Gift Card_LF_Stan_Disp_DS_Retarget_Geo_65_300x250_300x250_PD_dCPM_NA_NA_HTML5_11/14/16_12/31/16",
"updated_on": "2016-11-22T14:21:47+0000",
"version": 1,
"width": 300
},
"properties": {
"ad_format": {
"default": "DISPLAY",
"description": "Advertising format in which creative will appear. ",
"enum": [
"DISPLAY",
"EXPANDABLE",
"MOBILE"
],
"type": "string"
},
"ad_server_type": {
"description": "The primary Third Party Ad Server involved with serving the creative. To obtain the most up-to-date list of Ad Servers, see \"API for Ad Servers\".",
"enum": [
"ATLAS",
"DART",
"EYEWONDER",
"MEDIAMIND",
"MEDIAPLEX",
"POINTROLL",
"YIELD_MANAGER",
"TERMINALONE",
"MEDIAFORGE",
"OTHER"
],
"type": "string"
},
"advertiser_id": {
"description": "ID of TerminalOne Advertiser to which the creative belongs. See \"API for Ad Servers\".",
"type": "integer"
},
"approval_status": {
"enum": [
"PENDING",
"APPROVED",
"REJECTED"
],
"type": "string"
},
"built": {
"default": false,
"type": "boolean"
},
"built_by_user_id": {
"description": "Id number for the user who made the creative.",
"type": "integer"
},
"click_through_url": {
"description": "T1AS creatives: destination URL to which the user is directed after clicking an ad.",
"maxLength": 2048,
"type": "string"
},
"click_url": {
"description": "T1 user-declared URL describing where the end user is redirected after clicking an ad, after all redirects.",
"maxLength": 2048,
"type": "string"
},
"concept_id": {
"description": "ID of TerminalOne Concept ID which the creative belongs; see above.",
"type": "integer"
},
"created_on": {
"type": "string"
},
"creative_import_file_id": {
"description": "ID of the file where creative ad tag source came from during the Bulk 3PAS upload.",
"type": "integer"
},
"edited_tag": {
"description": "Default or user-modified source HTML for T1AS creative.",
"type": "string"
},
"entity_type": {
"type": "string"
},
"expand": {
"description": "Direction in which an EXPANDABLE creative expands.",
"enum": [
"L",
"R",
"U",
"D",
"LD",
"RD",
"LU",
"RU"
],
"type": "string"
},
"expansion_direction": {
"default": "NONRESTRICTED",
"description": "Determines whether an 'EXPANDABLE' format ad is restricted with respect to its movement on a page and, if so, which directions are permissible.Defaults to: 'NONRESTRICTED'.",
"type": "string"
},
"expansion_trigger": {
"description": "Action which causes an ad to expand. Defaults to: 'MOUSEOVER'",
"enum": [
"AUTOMATIC",
"MOUSEOVER",
"CLICK"
],
"type": "string"
},
"external_identifier": {
"type": "string"
},
"file_type": {
"description": "Specify the file type",
"enum": [
"gif",
"html5",
"jpg",
"png",
"swf",
"tif",
"tiff",
"unknown",
"vast",
"zip"
],
"type": "string"
},
"has_sound": {
"description": "Set to 'on' if the creative uses sound. This will restrict the creative from running on certain publishers, as enforced by each supply source. Defaults to: 'off'",
"type": "boolean"
},
"height": {
"type": "integer"
},
"id": {
"type": "integer"
},
"is_https": {
"type": "boolean"
},
"is_mraid": {
"type": "boolean"
},
"is_multi_creative": {
"description": "Set to 'on' if the creatives serving through the ad tag vary significantly (e.g different offers or products or drastically different treatments) in order to reduce the weight given to the Creative in algorithmic optimization (when applied). Best practice is to separate creative with significant differences to allow full visibility to the optimization algorithm. Defaults to 'off'.",
"type": "boolean"
},
"last_modified": {
"type": "string"
},
"media_type": {
"default": "DISPLAY",
"description": "Media Type of the creative. ",
"enum": [
"DISPLAY",
"VIDEO",
"MOBILE"
],
"type": "string"
},
"name": {
"type": "string"
},
"rich_media": {
"default": false,
"type": "boolean"
},
"status": {
"type": "boolean"
},
"t1as": {
"description": "If 'on', creative is served by MediaMath's TerminalOne Ad Server.If 'off', creative is a 3PAS creative.",
"type": "boolean"
},
"tag": {
"description": "The actual 3PAS ad tag HTML used in order serve the ad. The appropriate T1 Macros necessary must be incorporated.",
"type": "string"
},
"tag_type": {
"description": "Specify the implementation tag type into this field",
"enum": [
"IFRAME_SCRIPT_NOSCRIPT",
"IFRAME_SCRIPT",
"IFRAME_NOSCRIPT",
"IFRAME_IMG",
"SCRIPT_NOSCRIPT",
"SCRIPT",
"NOSCRIPT",
"IFRAME",
"IMG"
],
"type": "string"
},
"tpas_ad_tag_name": {
"description": "Descriptive name of the placement from the 3PAS.",
"maxLength": 255,
"type": "string"
},
"updated_on": {
"type": "string"
},
"version": {
"description": "Used to protect against simultaneous updates. Refer to \"Optimistc Locking\" in the API overview for more information.",
"type": "integer"
},
"width": {
"type": "integer"
}
},
"required": [
"ad_server_type",
"advertiser_id",
"external_identifier",
"file_type",
"height",
"width",
"tag",
"tag_type",
"tpas_ad_tag_name"
],
"title": "Atomic Creative",
"type": "object",
"x-stoplight": {
"id": "atomic-creative",
"name": "Atomic Creative",
"public": true
}
},
"audience-segment": {
"example": {
"audience_segment_id": 1505371,
"created_on": "2017-01-24T21:56:26+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 2053020,
"name": "Strategy Audience Segments #2053020",
"restriction": "INCLUDE",
"strategy_id": 1068421,
"updated_on": "2017-01-24T21:56:26+0000",
"version": 0
},
"properties": {
"audience_vendor_id": {
"type": "integer"
},
"buyable": {
"type": "boolean"
},
"child_count": {
"description": "The number of audience segments that have this segment as a direct parent.",
"type": "integer"
},
"created_on": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"full_path": {
"type": "string"
},
"id": {
"type": "integer"
},
"meta": {
"type": "object"
},
"name": {
"type": "string"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"required": [
"entity_type",
"name"
],
"title": "Audience Segment",
"type": "object",
"x-stoplight": {
"id": "audience-segment",
"name": "Audience Segment",
"public": true
}
},
"budget-flight": {
"example": {
"campaign_id": 301839,
"created_on": "2016-10-20T16:32:37+0000",
"currency_code": "EUR",
"end_date": "2016-11-20T04:59:00+0000",
"entity_type": "budget_flight",
"id": 283192,
"is_relevant": true,
"name": "Budget Flights #283192",
"start_date": "2016-10-27T04:00:00+0000",
"total_budget": [
{
"currency_code": "EUR",
"value": 1200
}
],
"updated_on": "2016-10-20T16:32:37+0000",
"version": 0,
"zone_name": "America/New_York"
},
"title": "Budget Flight",
"type": "object",
"x-stoplight": {
"id": "budget-flight",
"name": "Budget Flight",
"public": true
},
"properties": {
"campaign_id": {
"type": "integer"
},
"created_on": {
"type": "string"
},
"currency_code": {
"type": "string",
"description": "Currency setting for budget flight. All budget flights under a campaign inherit the campaign's selected currency. Once the campaign starts, it cannot be switched to another currency (existing campaigns are locked into USD, and the currency for a new campaign can't be switched once it has launched).\n\n",
"minLength": 3,
"maxLength": 3
},
"end_date": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_relevant": {
"type": "boolean",
"description": "Which flight is the \"relevant\" one (0=not relevant, 1=relevant)\n\nScenarios:\n1) All budget flights are in the past: The very last budget flight for the campaign\n2) An existing budget flight has start <= now() <= end:\tSimply the flight where start <= now() <= end for the campaign\n3) now() is currently in a gap between two existing budget flights: The very next upcoming budget flight for the campaign\n4) All budget flights are in the future: The very next upcoming budget flight for the campaign"
},
"name": {
"type": "string"
},
"start_date": {
"type": "string"
},
"total_budget": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string",
"minLength": 3,
"maxLength": 3
},
"value": {
"type": "integer"
}
}
}
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
},
"zone_name": {
"type": "string",
"description": "Indicate the time zone for reporting for the campaign. All budget flights under a campaign inherit the campaign's selected zone_name.\n\n",
"maxLength": 64
}
}
},
"bulk-editing-actions-add": {
"example": {
"collection": "aliqua",
"id": 34510090
},
"properties": {
"collection": {
"type": "string"
},
"id": {
"type": "integer"
}
},
"title": "Bulk Editing Actions Add",
"type": "object",
"x-stoplight": {
"id": "bulk-editing-actions-add",
"name": "Bulk Editing Actions Add",
"public": true
}
},
"bulk-editing-actions-overwrite": {
"properties": {
"collection": {
"type": "string"
},
"exclude": {
"type": "boolean"
},
"id": {
"type": "integer"
}
},
"title": "Bulk Editing Actions Overwrite",
"type": "object",
"x-stoplight": {
"id": "bulk-editing-actions-overwrite",
"name": "Bulk Editing Actions Overwrite",
"public": true
}
},
"bulk-editing-actions-post-data": {
"example": [
{
"add": {
"collection": "concepts",
"id": 100001
},
"collection": "strategies",
"tag": "concepts"
},
{
"add": {
"collection": "concepts",
"id": 100002
},
"collection": "strategies",
"tag": "concepts"
},
{
"collection": "strategies",
"overwrite": {
"collection": "target_values",
"exclude": false,
"id": 100001
},
"tag": "location"
},
{
"collection": "strategies",
"overwrite": {
"collection": "target_values",
"exclude": false,
"id": 100003
},
"tag": "location"
},
{
"collection": "strategies",
"overwrite": {
"collection": "target_values",
"exclude": true,
"id": 100002
},
"tag": "location"
},
{
"collection": "strategies",
"remove": {
"collection": "target_values",
"id": 100001
},
"tag": "location"
},
{
"collection": "strategies",
"remove": {
"collection": "target_values",
"id": 100002
},
"tag": "location"
},
{
"collection": "strategies",
"remove": {
"collection": "target_values",
"id": 100003
},
"tag": "location"
},
{
"collection": "strategies",
"tag": "details"
}
],
"items": {
"properties": {
"collection": {
"type": "string"
},
"overwrite": {
"properties": {
"collection": {
"type": "string"
},
"exclude": {
"type": "boolean"
},
"id": {
"type": "integer"
}
},
"type": "object"
},
"remove": {
"properties": {
"collection": {
"type": "string"
},
"id": {
"type": "integer"
}
},
"type": "object"
},
"tag": {
"type": "string"
}
},
"type": "object"
},
"title": "Bulk Editing Actions Post Data",
"type": "array",
"x-stoplight": {
"id": "bulk-editing-actions-post-data",
"name": "Bulk Editing Actions Post Data",
"public": true
}
},
"bulk-editing-actions-remove": {
"properties": {
"collection": {
"type": "string"
},
"id": {
"type": "integer"
}
},
"title": "Bulk Editing Actions Remove",
"type": "object",
"x-stoplight": {
"id": "bulk-editing-actions-remove",
"name": "Bulk Editing Actions Remove",
"public": true
}
},
"bulk-editing-actions-update": {
"example": {
"pixel_target_exrp_targeting_operator": "AND"
},
"title": "Bulk Editing Actions Update",
"type": "object",
"x-stoplight": {
"id": "bulk-editing-actions-update",
"name": "Bulk Editing Actions Update",
"public": true
},
"properties": {
"audience_segment_exclude_op": {
"default": "OR",
"description": "Exclude associated audience segment from targeting",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"audience_segment_include_op": {
"default": "OR",
"description": "Include associated audience segment in targeting",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"bid_aggressiveness": {
"default": 50,
"description": "Apply a multiplier for the bid amount determined by the algorithm",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"bid_price_is_media_only": {
"default": 1,
"description": "Informs T1 that value entered on the strategygoal_valuemax_bidshould be the amount forthe \"media only\" (bid_price_is_media_only=1)or \"total spend\" (bid_price_is_media_only=0)",
"type": [
"boolean",
"number"
]
},
"budget": {
"description": "Allocated budget for strategy",
"type": [
"array",
"number"
],
"items": {}
},
"campaign_id": {
"description": "Specify parent campaign of strategy",
"type": "integer"
},
"end_date": {
"description": "Date which strategy will end",
"type": "string"
},
"frequency_amount": {
"description": "Maximum frequency of impressions per user within interval set onfrequency_interval",
"type": "integer"
},
"frequency_interval": {
"description": "Interval applicable for frequency_amount",
"type": "string"
},
"frequency_optimization": {
"type": "boolean"
},
"frequency_type": {
"description": "Distribute impressions across frequency_interval up to frequency_value evenly or asap",
"enum": [
"even",
"asap",
"no-limit"
],
"type": "string"
},
"goal_type": {
"description": "Goal type which campaign performance will be measured",
"type": "string"
},
"goal_value": {
"description": "Target goal value for campaign",
"type": [
"array",
"integer"
],
"items": {}
},
"impression_pacing_interval": {
"default": "day",
"description": "Period of time over which impression pacing is to be distributed",
"enum": [
"hour",
"day"
],
"type": "string"
},
"impression_pacing_type": {
"description": "Type of impression pacing applied to strategy.",
"enum": [
"even",
"asap",
"no-limit"
],
"type": "string"
},
"max_bid": {
"description": "Max bid price which strategy should place",
"type": [
"array",
"integer"
],
"items": {}
},
"media_type": {
"description": "Whether the strategy is a display or video strategy.",
"enum": [
"DISPLAY",
"VIDEO"
],
"type": "string"
},
"min_bid": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"name": {
"description": "Descriptive name of strategy",
"maxLength": 64,
"type": "string"
},
"pacing_amount": {
"description": "Specify max amount strategy can spend within pacing_interval",
"type": [
"array",
"integer"
],
"items": {}
},
"pacing_interval": {
"description": "Specify distribution of spend across thepacing_interval",
"enum": [
"hour",
"day"
],
"type": "string"
},
"pacing_type": {
"description": "Specify distribution of spend across the pacing_interval",
"enum": [
"even",
"asap"
],
"type": "string"
},
"pixel_target_expr": {
"description": "Specify pixel targeting for the strategy. Poll must be run to obtain available Pixel IDs. To configure Pixel-Targeting, pixels must have previously been generated. See \"API for Event Pixels and Data Pixels\" for more information on creating and obtaining information on Pixels.\n\n\n( [pixel_id] INCL_COND [pixel_id] ) AND NOT ( [pixel_id EXCL_COND[pixel_id] )1024 characters maximum*note* Although theINCL_CONDandEXCL_CONDis not required to be consistent, the conditional logic between all pixels to be included or excluded must be the same.",
"maxLength": 1024,
"type": "string"
},
"run_on_all_exchanges": {
"type": "boolean"
},
"run_on_all_pmp": {
"type": "boolean"
},
"run_on_display": {
"type": "boolean"
},
"run_on_mobile": {
"type": "boolean"
},
"run_on_streaming": {
"type": "boolean"
},
"site_restriction_transparent_urls": {
"type": "boolean"
},
"site_selectiveness": {
"type": "string",
"default": "REDUCED",
"description": "REDUCED is currently the only available option",
"enum": [
"REDUCED"
]
},
"start_date": {
"type": "string"
},
"status": {
"type": "boolean"
},
"supply_type": {
"description": "Specify whether impressions will be bought and decisioned by the TerminalOne platform. Use 'RTB' for normal strategies that are bought/decisioned in T1. Use 'RMX_API' to use a tag to track media not purchased through TerminalOne.",
"enum": [
"RTB",
"RMX_API"
],
"type": "string"
},
"targeting_segment_exclude_op": {
"type": "string"
},
"targeting_segment_include_op": {
"type": "string"
},
"type": {
"description": "Specify the type of strategy (re-marketing (REM), goal-based optimization (GBO), audience (AUD))",
"enum": [
"REM",
"GBO",
"AUD"
],
"type": "string"
},
"use_campaign_end": {
"type": "boolean"
},
"use_campaign_start": {
"type": "boolean"
},
"use_mm_freq": {
"description": "\t\nUnused legacy frequency cap setting. Must be set to 'off'. To control frequency capping at the campaign level, set the strategy-level frequency_type attribute to 'no-limit' and set a frequency cap on the campaign entity.",
"type": "boolean"
},
"use_optimization": {
"description": "Enable's T1 optimization algorithm \n(defaults to 'off' if unspecified)",
"type": "boolean"
},
"version": {
"description": "\t\nUsed to protect against simultaneous updates. Refer to \"Optimistic Locking\" in the API overview for more information.",
"type": "integer"
},
"zone_name": {
"type": "string"
}
}
},
"bulk-editor-targeting-post-data": {
"example": {
"all": false,
"collection": "strategies",
"entities": [
1,
2,
3
],
"overwrite_existing_targets": false,
"parent_collection": "campaigns",
"parent_id": 1,
"skip_entities": []
},
"properties": {
"all": {
"type": "boolean"
},
"collection": {
"type": "string"
},
"entities": {
"items": {
"type": "integer"
},
"type": "array"
},
"overwrite_existing_targets": {
"type": "boolean"
},
"parent_collection": {
"type": "string"
},
"parent_id": {
"type": "integer"
},
"skip_entities": {
"items": {
"type": "object"
},
"type": "array"
}
},
"title": "Bulk Editor Targeting Post Data",
"type": "object",
"x-stoplight": {
"id": "bulk-editor-targeting-post-data",
"name": "Bulk Editor Targeting Post Data",
"public": true
}
},
"campaign": {
"example": {
"ad_server_id": 6,
"advertiser_id": 122631,
"agency_fee_pct": 0,
"bid_min_devices": 1,
"connected_id_type": "DETERMINISTIC_ONLY",
"conversion_type": "variable",
"conversion_variable_minutes": 1,
"created_on": "2016-10-19T03:21:53+0000",
"currency_code": "USD",
"custom_attribution_source": "3rd Party Attribution",
"dcs_data_is_campaign_level": false,
"device_graph_only": false,
"end_date": "2016-11-07T23:59:00+0000",
"entity_type": "campaign",
"frequency_amount": 2,
"frequency_interval": "not-applicable",
"frequency_optimization": false,
"frequency_type": "no-limit",
"goal_type": "spend",
"goal_value": "2.5",
"has_custom_attribution": false,
"id": 300982,
"impression_cap_amount": 5000,
"impression_cap_automatic": false,
"impression_cap_type": "asap",
"initial_start_date": "2016-10-19T09:00:00+0000",
"io_name": "",
"io_reference_num": "",
"margin_pct": 0,
"minimize_multi_ads": false,
"name": "MobileAds Test (Round 4)",
"override_suspicious_traffic_filter": false,
"pv_pct": 100,
"restrict_targeting_to_deterministic_id": false,
"restrict_targeting_to_same_device_id": false,
"service_type": "SELF",
"source_campaign_id": 395863,
"spend_cap_amount": 5,
"spend_cap_automatic": false,
"spend_cap_type": "asap",
"start_date": "2016-10-19T09:00:00+0000",
"status": true,
"suspicious_traffic_filter_level": 25,
"total_budget": 40,
"updated_on": "2016-11-01T07:18:56+0000",
"use_default_ad_server": false,
"use_mm_freq": false,
"version": 5,
"zone_name": "Etc/GMT"
},
"title": "Create Campaign",
"type": "object",
"x-stoplight": {
"id": "campaign",
"name": "Create Campaign",
"public": true
},
"properties": {
"accountable_and_addressable": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"ad_server_fee": {
"description": "Fee charged by ad serving vendor",
"type": "integer"
},
"ad_server_id": {
"description": "The ID for a third-party ad server",
"type": "integer"
},
"ad_server_password": {
"type": "string",
"description": "Ad server password, must be equal to or less than 64"
},
"ad_server_username": {
"type": "string",
"description": "Ad server username, must be equal to or less than 64"
},
"ads_txt_verified": {
"type": "string",
"enum": [
"ANY",
"AUTHORIZED_DIRECT_ONLY",
"AUTHORIZED_ONLY"
]
},
"advertiser_id": {
"default": 512321,
"description": "T1 Advertiser ID to which a campaign belongs",
"type": "integer"
},
"agency_fee_pct": {
"type": "number",
"description": "The Agency Fee Percentage (for example: 0.45)"
},
"bid_min_devices": {
"default": 1,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"maximum": 5,
"minimum": 1,
"type": "integer"
},
"connected_id_type": {
"enum": [
"DETERMINISTIC_FIRST",
"DETERMINISTIC_ONLY"
],
"type": "string"
},
"conversion_type": {
"description": "Definition for conversions per user.\n\nevery: Attribute all Merit Events\n\nvariable: Attribute one Merit Event per X minutes - set inconversion_variable_minutes\n\none: Attribute one Merit Event per user (if converstion_type = one, then conversion_variable_minutes (integer) is required).\n\nrequired if `goal_type in ('cpa', 'roi')`\n",
"enum": [
"every",
"one",
"variable"
],
"type": "string"
},
"conversion_variable_minutes": {
"description": "Attribute one Merit Event per X minutes\n\nrequired if `goal_type in ('cpa', 'cpc', 'roi') && conversion_type=one`",
"type": "integer"
},
"cost_passthrough_cpm_enabled": {
"type": "boolean"
},
"cost_passthrough_cpm_value": {
"type": "number"
},
"cost_passthrough_percent_enabled": {
"type": "boolean"
},
"cost_passthrough_percent_value": {
"type": "number"
},
"created_on": {
"type": "string"
},
"currency_code": {
"default": "USD",
"description": "Currency setting for campaign. All strategies under this value inherit the selected currency. Once the campaign launches, it cannot be switched to another currency (aka existing campaigns are locked into USD, and the currency for a new campaign can't be switched once it has launched).",
"type": "string"
},
"custom_attribution_source": {
"type": "string"
},
"dcs_data_is_campaign_level": {
"type": "boolean"
},
"device_graph_only": {
"type": "boolean"
},
"eligible_for_data_sharing": {
"type": "boolean"
},
"end_date": {
"description": "Last date of campaign in GMT",
"type": "string"
},
"frequency_amount": {
"description": "required if `frequency_type=even||asap`",
"type": "integer"
},
"frequency_interval": {
"description": "required if `frequency_type=even||asap`\n",
"type": "string"
},
"frequency_optimization": {
"description": "",
"type": "boolean"
},
"frequency_type": {
"default": "no-limit",
"description": "Distribute impressions across frequency_interval up to frequency_value evenly or asap.",
"enum": [
"asap",
"even",
"no-limit"
],
"type": "string"
},
"goal_alert": {
"type": "number",
"description": "Goal Alert Min:0 Max:100, can be decimal",
"format": "float",
"minimum": 0,
"maximum": 100
},
"goal_category": {
"type": "string",
"description": "goal_category must be one of the following: 'audience', 'engagement', 'response'",
"enum": [
"audience",
"engagement",
"response"
]
},
"goal_type": {
"type": "string",
"description": "Goal type which campaign performance will be measured",
"enum": [
"cpa",
"cpc",
"ctr",
"reach",
"roi",
"spend",
"vcr",
"vcpm",
"viewability_rate"
]
},
"goal_value": {
"description": "Target goal value for campaign respective to the `goal_type` selection.\n\nrequired if `goal_type` in ('cpa','cpc','reach','roi', 'vcr', 'ctr')`\n\nIf `goal_type` is 'vcr' or 'ctr' or 'viewability_rat', `goal_value` is a percentage.\n\nGoal Value max=\"9999999.9999\" min=\"0.01\", unless goal_value is a percentage in which case max=100.00",
"type": "string"
},
"has_custom_attribution": {
"description": "",
"type": "boolean"
},
"id": {
"description": "",
"type": "integer"
},
"impression_cap_amount": {
"description": "Sets the amount of the available impression budget across the remaining number of days across all their strategies.",
"type": "integer"
},
"impression_cap_automatic": {
"description": "",
"type": "boolean"
},
"impression_cap_type": {
"default": "no-limit",
"description": "Type of cap applied to impression budgets.",
"enum": [
"asap",
"even",
"no-limit"
],
"type": "string"
},
"initial_start_date": {
"type": "string"
},
"io_name": {
"type": "string",
"description": "Descriptive name of insertion order",
"maxLength": 256
},
"io_reference_num": {
"type": [
"integer",
"string"
],
"description": "Reference number of insertion order",
"maxLength": 32
},
"is_programmatic_guaranteed": {
"description": "Sets the campaign as a Programmatic Guaranteed campaign. Once set for a campaign, it cannot be changed",
"type": "boolean"
},
"margin_pct": {
"description": "Margin percentage to be applied on campaign spend",
"type": "integer"
},
"merit_pixel_id": {
"description": "Specify Merit Pixel that represents conversion or engagement on CPA or CPE type campaigns\n\nREQUIRED if `goal_type in ('cpa','roi')`\n\nTHIS FIELD IS OBSOLETE",
"type": "integer"
},
"minimize_multi_ads": {
"default": 0,
"description": "Enabling this field will cause T1 to avoid bidding on more than one ad opportunity on a single page view across. Warning: enabling this setting may limit pacing and reduce the available inventory for the campaigns by not bidding on impression opportunities where the URL is not transparent.",
"type": "boolean"
},
"name": {
"description": "Descriptive name of the campaign",
"type": "string"
},
"override_suspicious_traffic_filter": {
"default": 0,
"description": "Enabling this setting allows you to set a campaign-specific level of suspicious traffic filtering using the 'suspicious_traffic_filter_level' property. This will override the T1 default (or organization-level, if configured) suspicious traffic filtering level.",
"type": "boolean"
},
"pacing_alert": {
"description": "",
"type": "number"
},
"pc_window_minutes": {
"description": "Post-click window for attribution. Not to be confused with pv_window_minutes.\n\noptional if `goal_type in ('cpa','roi')`\n",
"type": "integer"
},
"pv_pct": {
"description": "Percentage of post-view windows to be used for attribution\n\noptional if `goal_type in ('cpa','roi')`",
"type": "integer"
},
"pv_window_minutes": {
"description": "Post-view window for attribution \n\nrequired if `goal_type in ('cpa','roi')`",
"type": "integer"
},
"restrict_targeting_to_deterministic_id": {
"type": "boolean"
},
"restrict_targeting_to_same_device_id": {
"type": "boolean"
},
"service_type": {
"description": "Indicate whether campaign will be self-service or managed (managed campaigns will incur manage service fee)",
"enum": [
"MANAGED",
"SELF"
],
"type": "string"
},
"source_campaign_id": {
"type": "integer"
},
"spend_cap_amount": {
"description": "only required if`spend_cap_enabled`is true",
"type": "integer"
},
"spend_cap_automatic": {
"description": "Automatically sets the available spend budget across all strategies through the end date of the campaign.",
"type": "boolean"
},
"spend_cap_type": {
"description": "Type of cap applied to spend budgets.",
"enum": [
"asap",
"even",
"no-limit"
],
"type": "string"
},
"start_date": {
"description": "Date on which the campaign will start (GMT)",
"type": "string"
},
"status": {
"default": false,
"description": "Status of the campaign",
"type": "boolean"
},
"suspicious_traffic_filter_level": {
"description": "A value between 0 and 100 that determines the sensitivity of T1 suspicious traffic filtering capabilities.If the value = 0, all fraud and suspicious traffic filtering is turned off.It will not take effect if 'override_suspicious_traffic_filter_level' is not set.\n\n",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"total_budget": {
"description": "Allocated budget for the campaign",
"type": "integer"
},
"total_impression_budget": {
"description": "",
"type": "integer"
},
"updated_on": {
"type": "string"
},
"use_default_ad_server": {
"type": "boolean"
},
"use_mm_freq": {
"type": "boolean"
},
"version": {
"type": "integer",
"description": "This number increments upon updating. Do not define it upon creation."
},
"zone_name": {
"type": "string",
"default": "America/New_York",
"description": "Indicate the time zone for reporting for the campaign. Default is America/New_York",
"maxLength": 64
}
},
"required": [
"ad_server_id",
"advertiser_id",
"end_date",
"goal_type",
"goal_value",
"impression_cap_automatic",
"name",
"service_type",
"start_date",
"total_budget"
]
},
"campaign-custom-brain-selection": {
"example": {
"active": false,
"campaign_id": -13129825,
"child_count": -35599919,
"entity_type": "dolore ea deserunt",
"full_path": "do",
"id": 46512678,
"is_retired": true,
"load_count": -99526154,
"name": "commodo Lorem reprehenderit qui",
"owner_name": "sunt laboris veniam amet",
"parent_audience_segment_id": 60078089,
"refer_url": "adipisicing consectetur",
"retail_cpm": [
{
"currency_code": "cupidatat fugiat aute qui",
"value": -47610824
}
],
"selection_id": 72439766,
"selection_name": "dolore ",
"selection_type": "Data Pixel",
"uniques": -73623784,
"version": -21888191,
"wholesale_cpm": [
{
"value": -23482783
}
]
},
"properties": {
"active": {
"type": "boolean"
},
"campaign_id": {
"type": "integer"
},
"child_count": {
"description": "Only returned in selection_type 'Audience Target",
"type": "integer"
},
"entity_type": {
"type": "string"
},
"full_path": {
"description": "Only returned in selection_type 'Audience Target",
"type": "string"
},
"id": {
"type": "integer"
},
"is_retired": {
"description": "Only returned in selection_type 'Audience Target",
"type": "boolean"
},
"load_count": {
"type": "integer"
},
"name": {
"type": "string"
},
"owner_name": {
"type": "string"
},
"parent_audience_segment_id": {
"description": "Only returned in selection_type 'Audience Target",
"type": "integer"
},
"refer_url": {
"type": "string"
},
"retail_cpm": {
"description": "Only returned in selection_type 'Audience Target",
"items": {
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"currency_code",
"value"
],
"type": "object"
},
"type": "array"
},
"selection_id": {
"type": "integer"
},
"selection_name": {
"type": "string"
},
"selection_type": {
"enum": [
"Event Pixel",
"Dynamic",
"Audience Target",
"Data Pixel"
],
"type": "string"
},
"uniques": {
"type": "integer"
},
"version": {
"type": "integer"
},
"wholesale_cpm": {
"description": "Only returned in selection_type 'Audience Target",
"items": {
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"title": "Campaign Custom Brain Selection",
"type": "object",
"x-stoplight": {
"id": "campaign-custom-brain-selection",
"name": "Campaign Custom Brain Selection",
"public": true
}
},
"contextual-targeting-segment": {
"example": {
"audience_segment_id": 1505371,
"created_on": "2017-01-24T21:56:26+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 2053020,
"name": "Strategy Audience Segments #2053020",
"restriction": "INCLUDE",
"strategy_id": 1068421,
"updated_on": "2017-01-24T21:56:26+0000",
"version": 0
},
"properties": {
"buyable": {
"type": "boolean"
},
"child_count": {
"description": "The number of audience segments that have this segment as a direct parent.",
"type": "integer"
},
"created_on": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"full_path": {
"type": "string"
},
"id": {
"type": "integer"
},
"meta": {
"type": "object"
},
"name": {
"type": "string"
},
"parent_targeting_segment_id": {
"type": "integer"
},
"retail_cpm": {
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
},
"type": "object"
},
"targeting_vendor_id": {
"type": "integer"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"required": [
"entity_type",
"name"
],
"title": "Contextual Targeting Segment",
"type": "object",
"x-stoplight": {
"id": "contextual-targeting-segment",
"name": "Contextual Targeting Segment",
"public": true
}
},
"contracts-input": {
"example": {
"adaptive_segment_cpm": [
{
"currency_code": "USD",
"value": 0
}
],
"contract_number": 103074,
"currency_code": "USD",
"effective_end_date": "2017-09-01T00:00:00+0000",
"effective_start_date": "2016-09-01T00:00:00+0000",
"entity_type": "contract",
"evidon_privacy_cost_cpm": [
{
"currency_code": "USD",
"value": 0.03
}
],
"exclude_agency_margin": false,
"external_media_tracking_cpm": [
{
"currency_code": "USD",
"value": 0.005
}
],
"fbx_dynamic_cpm": [
{
"currency_code": "USD",
"value": 0.3
}
],
"managed_service_fee_pct": 0,
"managed_service_fee_unit": "PCT_TOTAL_COST",
"name": "Contracts #3385",
"optimization_fee_pct": 0,
"optimization_fee_unit": "PCT_TOTAL_COST",
"organization_id": 100048,
"peer39_channel_fee_cpm": [
{
"currency_code": "USD",
"value": 0.1
}
],
"peer39_custom_fee_cpm": [
{
"currency_code": "USD",
"value": 0.15
}
],
"peer39_quality_fee_cpm": [
{
"currency_code": "USD",
"value": 0.03
}
],
"peer39_safety_fee_cpm": [
{
"currency_code": "USD",
"value": 0.03
}
],
"platform_access_fee_pct": 0,
"platform_access_fee_unit": "PCT_TOTAL_COST",
"platform_monthly_min": 0,
"pmp_optimization_off_fee_cpm": [
{
"currency_code": "USD",
"value": 0
}
],
"pmp_optimization_off_unit": "CPM",
"pmp_optimization_on_fee_cpm": [
{
"currency_code": "USD",
"value": 0
}
],
"pmp_optimization_on_unit": "CPM",
"profit_share_fee_pct": 0,
"spend_cap": 15000,
"t1_as_fee_cpm": [
{
"currency_code": "USD",
"value": 0.02
}
],
"t1_html5_fee_cpm": [
{
"currency_code": "USD",
"value": 0.08
}
],
"t1_vads_fee_cpm": [
{
"currency_code": "USD",
"value": 0.15
}
]
},
"title": "Contracts Input",
"type": "object",
"x-stoplight": {
"id": "contracts-input",
"name": "Contracts Input",
"public": true
},
"properties": {
"adaptive_segment_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"audience_verification_cost": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"connected_id_cost": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"contract_number": {
"type": "integer"
},
"country_tax_withholding_fee_pct": {
"type": "integer"
},
"country_tax_withholding_fee_unit": {
"enum": [
"CPM",
"PCT_TOTAL_COST"
],
"type": "string"
},
"created_on": {
"format": "date-time",
"type": "string"
},
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"effective_end_date": {
"type": "string"
},
"effective_start_date": {
"type": "string"
},
"entity_type": {
"type": "string",
"description": "Should be set to \"contract\""
},
"evidon_privacy_cost_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"exclude_agency_margin": {
"type": "boolean"
},
"external_media_tracking_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"fbx_dynamic_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"financing_cost": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"id": {
"type": "integer"
},
"managed_sevrice_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"managed_service_fee_pct": {
"type": [
"integer",
"number"
],
"description": "This fee is applied to impressions on campaigns where the campaign is set to be \"Managed By\" Managed Service."
},
"managed_service_fee_unit": {
"type": "string",
"description": "This fee is applied to impressions on campaigns where the campaign is set to be \"Managed By\" Managed Service.\n\nAcceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"media_enablement_fee_pct": {
"type": [
"integer",
"number"
],
"description": ""
},
"media_enablement_fee_unit": {
"type": "string",
"description": "Acceptable values are: CPM, FIXED, PCT_TOTAL_COST",
"enum": [
"CPM",
"PCT_TOTAL_COST"
]
},
"name": {
"type": "string"
},
"optimization_fee_pct": {
"type": [
"integer",
"number"
],
"description": "This fee is applied to impressions on campaigns where a strategy has optimization
turned on AND the campaign IS NOT \"Managed Service\"."
},
"optimization_fee_unit": {
"type": "string",
"description": "This fee is applied to impressions on campaigns where a strategy has optimization
turned on AND the campaign IS NOT \"Managed Service\".\n\nAcceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"organization_id": {
"type": "integer"
},
"partnership_rebate_fee_pct": {
"type": "integer"
},
"partnership_rebate_fee_unit": {
"enum": [
"CPM",
"PCT_TOTAL_COST"
],
"type": "string"
},
"peer39_channel_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"peer39_custom_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"peer39_quality_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"peer39_safety_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"platform_access_fee_pct": {
"type": [
"integer",
"number"
],
"description": "This fee is applied for use of T1 on all inventory with exception of User-Sourced PMP."
},
"platform_access_fee_unit": {
"type": "string",
"description": "This fee is applied for use of T1 on all inventory with exception of User-Sourced PMP.\n\nAcceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"platform_monthly_min": {
"type": "integer"
},
"pmp_optimization_off_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"pmp_optimization_off_fee_pct": {
"type": "number"
},
"pmp_optimization_off_unit": {
"type": "string",
"description": "Acceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"pmp_optimization_on_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"pmp_optimization_on_fee_pct": {
"type": "integer"
},
"pmp_optimization_on_unit": {
"type": "string",
"description": "Acceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"profit_share_fee_pct": {
"type": "integer"
},
"programmatic_guaranteed_platform_access_fee_pct": {
"type": [
"integer",
"number"
],
"description": "This fee is applied for use of T1 on all impressions purchased via Programmatic Guaranteed deals."
},
"programmatic_guaranteed_platform_access_fee_unit": {
"type": "string",
"description": "This fee is applied for use of T1 on all impressions purchased via Programmatic Guaranteed deals.\n\nAcceptable values are: CPM, PCT_TOTAL_COST",
"enum": [
"CPM",
"PCT_TOTAL_COST"
]
},
"source_platform_access_fee_pct": {
"type": "integer"
},
"source_platform_access_fee_unit": {
"type": "string",
"description": "This fee is applied for use of T1 on all impressions purchased via Programmatic Guaranteed deals.\n\nAcceptable values are: CPM, PCT_TOTAL_COST",
"enum": [
"CPM",
"PCT_TOTAL_COST"
]
},
"spend_cap": {
"type": "integer"
},
"standard_segment_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"t1_as_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"t1_html5_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"t1_vads_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "integer"
},
"version": {
"type": "integer"
},
"viewability_display_all_imps": {
"type": "number"
},
"viewability_display_sample": {
"type": "number"
},
"viewability_video_all_imps": {
"type": "number"
},
"viewability_video_sample": {
"type": "number"
}
}
},
"contracts-output": {
"example": {
"data": {
"adaptive_segment_cpm": [
{}
],
"contract_number": -34492430,
"currency_code": "Lorem cupidatat qui ullamco",
"effective_end_date": "2017-09-01T00:00:00+0000",
"effective_start_date": "2016-09-01T00:00:00+0000",
"entity_type": "sit labore et Ut adipisicing",
"evidon_privacy_cost_cpm": [
{},
{},
{},
{
"currency_code": "do aute cillum deserunt qui",
"value": -54392635
}
],
"exclude_agency_margin": false,
"external_media_tracking_cpm": [
{},
{}
],
"fbx_dynamic_cpm": [
{},
{},
{
"value": -47958450
},
{},
{}
],
"managed_service_fee_pct": 63292875,
"managed_service_fee_unit": "anim sint",
"name": "irure reprehenderit Excepteur laboris",
"optimization_fee_pct": -85118338,
"optimization_fee_unit": "dolore ipsum pariatur",
"organization_id": -9920526,
"peer39_channel_fee_cpm": [
{},
{
"value": -46124930
},
{
"currency_code": "laborum",
"value": 24673781
},
{}
],
"peer39_custom_fee_cpm": [
{},
{
"currency_code": "non deserunt cupidatat anim"
},
{}
],
"peer39_quality_fee_cpm": [
{
"value": -85179
},
{
"value": -10240689
},
{
"value": -4954655
},
{
"value": -84377398
}
],
"peer39_safety_fee_cpm": [
{},
{},
{},
{}
],
"platform_access_fee_pct": -71104119,
"platform_access_fee_unit": "reprehenderit laborum dolor mollit ullamco",
"platform_monthly_min": -73493003,
"pmp_optimization_off_fee_cpm": [
{
"currency_code": "ut sint ut occaecat"
},
{
"currency_code": "Excepteur ut tempor",
"value": 99751657
}
],
"pmp_optimization_off_unit": "sed esse nulla",
"pmp_optimization_on_fee_cpm": [
{
"currency_code": "ex deserunt p",
"value": 38523577
},
{
"value": -85647761
},
{
"currency_code": "labore commodo consectetur consequat",
"value": -49826722
},
{}
],
"pmp_optimization_on_unit": "Ut",
"profit_share_fee_pct": 41207491,
"spend_cap": -12156130,
"t1_as_fee_cpm": [
{},
{
"value": 99250012
},
{}
],
"t1_html5_fee_cpm": [
{
"currency_code": "velit"
},
{},
{},
{}
],
"t1_vads_fee_cpm": [
{
"value": -835869
},
{},
{
"value": -398843
},
{},
{
"currency_code": "sint ex aliqua irure exercitation"
}
]
},
"uuid": "E119F0A2-B21A-11E9-8F2B-D4AE668E900B",
"meta": {
"called_on": "laborum voluptate dolore",
"count": 27422536,
"etag": "enim id Excepteur magna",
"offset": -47785040,
"status": "amet",
"total_count": -77774937
}
},
"title": "Contracts Output",
"type": "object",
"x-stoplight": {
"id": "contracts-output",
"name": "Contracts Output",
"public": true
},
"properties": {
"data": {
"example": {
"adaptive_segment_cpm": [
{
"currency_code": "USD",
"value": 0
}
],
"contract_number": 103074,
"currency_code": "USD",
"effective_end_date": "2017-09-01T00:00:00+0000",
"effective_start_date": "2016-09-01T00:00:00+0000",
"entity_type": "contract",
"evidon_privacy_cost_cpm": [
{
"currency_code": "USD",
"value": 0.03
}
],
"exclude_agency_margin": false,
"external_media_tracking_cpm": [
{
"currency_code": "USD",
"value": 0.005
}
],
"fbx_dynamic_cpm": [
{
"currency_code": "USD",
"value": 0.3
}
],
"managed_service_fee_pct": 0,
"managed_service_fee_unit": "PCT_TOTAL_COST",
"name": "Contracts #3385",
"optimization_fee_pct": 0,
"optimization_fee_unit": "PCT_TOTAL_COST",
"organization_id": 100048,
"peer39_channel_fee_cpm": [
{
"currency_code": "USD",
"value": 0.1
}
],
"peer39_custom_fee_cpm": [
{
"currency_code": "USD",
"value": 0.15
}
],
"peer39_quality_fee_cpm": [
{
"currency_code": "USD",
"value": 0.03
}
],
"peer39_safety_fee_cpm": [
{
"currency_code": "USD",
"value": 0.03
}
],
"platform_access_fee_pct": 0,
"platform_access_fee_unit": "PCT_TOTAL_COST",
"platform_monthly_min": 0,
"pmp_optimization_off_fee_cpm": [
{
"currency_code": "USD",
"value": 0
}
],
"pmp_optimization_off_unit": "CPM",
"pmp_optimization_on_fee_cpm": [
{
"currency_code": "USD",
"value": 0
}
],
"pmp_optimization_on_unit": "CPM",
"profit_share_fee_pct": 0,
"spend_cap": 15000,
"t1_as_fee_cpm": [
{
"currency_code": "USD",
"value": 0.02
}
],
"t1_html5_fee_cpm": [
{
"currency_code": "USD",
"value": 0.08
}
],
"t1_vads_fee_cpm": [
{
"currency_code": "USD",
"value": 0.15
}
]
},
"title": "Contracts Input",
"type": "object",
"x-stoplight": {
"id": "contracts-input",
"name": "Contracts Input",
"public": true
},
"properties": {
"adaptive_segment_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"audience_verification_cost": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"connected_id_cost": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"contract_number": {
"type": "integer"
},
"country_tax_withholding_fee_pct": {
"type": "integer"
},
"country_tax_withholding_fee_unit": {
"enum": [
"CPM",
"PCT_TOTAL_COST"
],
"type": "string"
},
"created_on": {
"format": "date-time",
"type": "string"
},
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"effective_end_date": {
"type": "string"
},
"effective_start_date": {
"type": "string"
},
"entity_type": {
"type": "string",
"description": "Should be set to \"contract\""
},
"evidon_privacy_cost_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"exclude_agency_margin": {
"type": "boolean"
},
"external_media_tracking_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"fbx_dynamic_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"financing_cost": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"id": {
"type": "integer"
},
"managed_sevrice_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"managed_service_fee_pct": {
"type": [
"integer",
"number"
],
"description": "This fee is applied to impressions on campaigns where the campaign is set to be \"Managed By\" Managed Service."
},
"managed_service_fee_unit": {
"type": "string",
"description": "This fee is applied to impressions on campaigns where the campaign is set to be \"Managed By\" Managed Service.\n\nAcceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"media_enablement_fee_pct": {
"type": [
"integer",
"number"
],
"description": ""
},
"media_enablement_fee_unit": {
"type": "string",
"description": "Acceptable values are: CPM, FIXED, PCT_TOTAL_COST",
"enum": [
"CPM",
"PCT_TOTAL_COST"
]
},
"name": {
"type": "string"
},
"optimization_fee_pct": {
"type": [
"integer",
"number"
],
"description": "This fee is applied to impressions on campaigns where a strategy has optimization
turned on AND the campaign IS NOT \"Managed Service\"."
},
"optimization_fee_unit": {
"type": "string",
"description": "This fee is applied to impressions on campaigns where a strategy has optimization
turned on AND the campaign IS NOT \"Managed Service\".\n\nAcceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"organization_id": {
"type": "integer"
},
"partnership_rebate_fee_pct": {
"type": "integer"
},
"partnership_rebate_fee_unit": {
"enum": [
"CPM",
"PCT_TOTAL_COST"
],
"type": "string"
},
"peer39_channel_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"peer39_custom_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"peer39_quality_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"peer39_safety_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"platform_access_fee_pct": {
"type": [
"integer",
"number"
],
"description": "This fee is applied for use of T1 on all inventory with exception of User-Sourced PMP."
},
"platform_access_fee_unit": {
"type": "string",
"description": "This fee is applied for use of T1 on all inventory with exception of User-Sourced PMP.\n\nAcceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"platform_monthly_min": {
"type": "integer"
},
"pmp_optimization_off_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"pmp_optimization_off_fee_pct": {
"type": "number"
},
"pmp_optimization_off_unit": {
"type": "string",
"description": "Acceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"pmp_optimization_on_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"pmp_optimization_on_fee_pct": {
"type": "integer"
},
"pmp_optimization_on_unit": {
"type": "string",
"description": "Acceptable values are: CPM, FIXED, PCT_TOTAL_COST"
},
"profit_share_fee_pct": {
"type": "integer"
},
"programmatic_guaranteed_platform_access_fee_pct": {
"type": [
"integer",
"number"
],
"description": "This fee is applied for use of T1 on all impressions purchased via Programmatic Guaranteed deals."
},
"programmatic_guaranteed_platform_access_fee_unit": {
"type": "string",
"description": "This fee is applied for use of T1 on all impressions purchased via Programmatic Guaranteed deals.\n\nAcceptable values are: CPM, PCT_TOTAL_COST",
"enum": [
"CPM",
"PCT_TOTAL_COST"
]
},
"source_platform_access_fee_pct": {
"type": "integer"
},
"source_platform_access_fee_unit": {
"type": "string",
"description": "This fee is applied for use of T1 on all impressions purchased via Programmatic Guaranteed deals.\n\nAcceptable values are: CPM, PCT_TOTAL_COST",
"enum": [
"CPM",
"PCT_TOTAL_COST"
]
},
"spend_cap": {
"type": "integer"
},
"standard_segment_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"t1_as_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"t1_html5_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"t1_vads_fee_cpm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"description": "ISO 4217 3-letter currency code",
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"value": {
"type": "integer"
},
"version": {
"type": "integer"
},
"viewability_display_all_imps": {
"type": "number"
},
"viewability_display_sample": {
"type": "number"
},
"viewability_video_all_imps": {
"type": "number"
},
"viewability_video_sample": {
"type": "number"
}
}
},
"uuid": {
"type": "string"
},
"meta": {
"description": "Meta response for all API endpoints",
"properties": {
"called_on": {
"type": "string"
},
"count": {
"type": "integer"
},
"etag": {
"type": "string"
},
"offset": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_count": {
"type": "integer"
}
},
"title": "meta",
"type": "object",
"x-stoplight": {
"id": "t1-meta",
"name": "meta",
"public": true
}
}
}
},
"creative-approval": {
"example": {
"approval_status": "APPROVED",
"atomic_creative_id": 3262059,
"created_on": "2016-11-21T11:00:00+0000",
"deal_status": "APPROVED",
"deal_status_rejected_reason": "",
"entity_type": "creative_approval",
"external_identifier": "",
"id": 57385131,
"name": "Creative Approvals #57385131",
"rejected_reason": "",
"supply_source_id": 4,
"updated_on": "2016-11-22T18:27:29+0000",
"version": 0
},
"properties": {
"approval_status": {
"type": "string"
},
"atomic_creative_id": {
"type": "integer"
},
"created_on": {
"type": "string"
},
"deal_status": {
"type": "string"
},
"deal_status_rejected_reason": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"external_identifier": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"rejected_reason": {
"type": "string"
},
"supply_source_id": {
"type": "integer"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Creative Approval",
"type": "object",
"x-stoplight": {
"id": "creative-approval",
"name": "Creative Approval",
"public": true
}
},
"data-pixel": {
"example": {
"agency_id": 114180,
"cost_cpm": 0,
"created_on": "2016-12-23T16:40:57+0000",
"eligible": true,
"entity_type": "pixel_bundle",
"external_identifier": "1187267801",
"id": 1028881,
"keywords": "",
"name": "eap_auto_7531482511256",
"pixel_type": "data",
"pricing": "CPM",
"provider_id": 1575,
"rmx_conversion_minutes": 1,
"rmx_conversion_type": "one",
"rmx_friendly": false,
"rmx_merit": false,
"status": true,
"tag_type": "image",
"tags": "\n",
"updated_on": "2016-12-23T16:40:57+0000",
"version": 1
},
"properties": {
"agency_id": {
"type": "integer"
},
"cost_cpm": {
"description": "required if pricing='CPM' AND cost_pct_cpm=null",
"type": "integer"
},
"cost_cpts": {
"description": "required if pricing='CPTS'",
"type": "integer"
},
"cost_pct_cpm": {
"description": "required if pricing='CPM' AND cost_cpm=null",
"type": "integer"
},
"created_on": {
"type": "string"
},
"eligible": {
"description": "Indicator eligibility of pixel for targeting",
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"external_identifier": {
"type": "string"
},
"id": {
"type": "integer"
},
"keywords": {
"type": "string"
},
"name": {
"type": "string"
},
"pixel_type": {
"type": "string"
},
"pricing": {
"description": "Pricing model for the data provider. CPM is recommended. CPTS is not recommended and planned for deprecation.",
"type": "string"
},
"provider_id": {
"description": "Data Provider Id",
"type": "integer"
},
"rmx_conversion_minutes": {
"type": "integer"
},
"rmx_conversion_type": {
"type": "string"
},
"rmx_friendly": {
"type": "boolean"
},
"rmx_merit": {
"type": "boolean"
},
"status": {
"type": "boolean"
},
"tag_type": {
"type": "string"
},
"tags": {
"type": "string"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Data Pixel",
"type": "object",
"x-stoplight": {
"id": "data-pixel",
"name": "Data Pixel",
"public": true
}
},
"day-part": {
"example": {
"created_on": "2017-01-24T20:40:37+0000",
"days": "MTRFSU",
"end_hour": 23,
"entity_type": "strategy_day_part",
"id": 1505666,
"name": "Day Parts #1505666",
"start_hour": 0,
"status": false,
"strategy_id": 1068421,
"updated_on": "2017-01-24T20:40:37+0000",
"user_time": true,
"version": 0
},
"properties": {
"created_on": {
"type": "string"
},
"days": {
"type": "string"
},
"end_hour": {
"type": "integer"
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"start_hour": {
"type": "integer"
},
"status": {
"type": "boolean"
},
"strategy_id": {
"type": "integer"
},
"updated_on": {
"type": "string"
},
"user_time": {
"type": "boolean"
},
"version": {
"type": "integer"
}
},
"required": [
"end_hour",
"start_hour",
"strategy_id"
],
"title": "Day Part",
"type": "object",
"x-stoplight": {
"id": "day-part",
"name": "Day Part",
"public": true
}
},
"deal-targeting": {
"properties": {
"all_pmp": {
"type": "boolean"
},
"deal.x.id": {
"type": "integer"
}
},
"title": "Deal Targeting",
"type": "object",
"x-stoplight": {
"id": "deal-targeting",
"name": "Deal Targeting",
"public": true
}
},
"deals": {
"properties": {
"": {
"type": "string"
},
"advertiser_id": {
"type": "integer"
},
"bill_type": {
"enum": [
"EXCHANGE",
"PUBLISHER",
"NONE"
],
"type": "string"
},
"created_on": {
"type": "string"
},
"currency_code": {
"maxLength": 3,
"type": "string"
},
"deal_identifier": {
"maxLength": 256,
"type": "string"
},
"deal_source": {
"enum": [
"USER",
"INTERNAL"
],
"type": "string"
},
"description": {
"maxLength": 4096,
"type": "string"
},
"end_datetime": {
"type": "string"
},
"id": {
"type": "integer"
},
"media_type": {
"enum": [
"DISPLAY",
"VIDEO"
],
"type": "string"
},
"name": {
"maxLength": 256,
"type": "string"
},
"partner_sourced": {
"type": "boolean"
},
"price": {
"type": "number"
},
"price_method": {
"enum": [
"CPM"
],
"type": "string"
},
"price_type": {
"enum": [
"FIXED",
"FLOOR"
],
"type": "string"
},
"publisher_id": {
"type": "integer"
},
"start_datetime": {
"type": "string"
},
"status": {
"type": "boolean"
},
"supply_source_id": {
"type": "integer"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
},
"zone_name": {
"maxLength": 64,
"type": "string"
}
},
"required": [
"name",
"publisher_id",
"supply_source_id",
"start_datetime",
"end_datetime",
"status",
"created_on",
"updated_on",
"zone_name",
"price_type",
"price_method",
"deal_source",
"deal_identifier",
"media_type",
"currency_code",
"bill_type",
"version"
],
"title": "Deals",
"type": "object",
"x-stoplight": {
"id": "deals",
"name": "Deals",
"public": true
}
},
"error-response": {
"properties": {
"errors": {
"items": {
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"title": "Errors",
"type": "array",
"x-stoplight": {
"id": "errors",
"name": "Errors",
"public": true
}
},
"meta": {
"properties": {
"status": {
"enum": [
"error"
],
"type": "string"
}
},
"required": [
"status"
],
"title": "Meta (Error)",
"type": "object",
"x-stoplight": {
"id": "meta-error",
"name": "Meta (Error)",
"public": true
}
}
},
"title": "Error Response",
"type": "object",
"x-stoplight": {
"id": "error-response",
"name": "Error Response",
"public": true
}
},
"errors": {
"items": {
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"title": "Errors",
"type": "array",
"x-stoplight": {
"id": "errors",
"name": "Errors",
"public": true
}
},
"event-pixel": {
"example": {
"advertiser_id": 109139,
"created_on": "2016-10-17T22:23:30+0000",
"eligible": true,
"entity_type": "pixel_bundle",
"external_identifier": "1187321288",
"id": 1082368,
"keywords": "",
"name": "Example - Homepage",
"pixel_type": "event",
"pricing": "CPM",
"rmx_conversion_minutes": 1,
"rmx_conversion_type": "one",
"rmx_friendly": false,
"rmx_merit": false,
"status": true,
"tag_type": "js",
"tags": "",
"updated_on": "2016-10-17T22:23:30+0000",
"version": 1
},
"properties": {
"advertiser_id": {
"type": "integer"
},
"agency_id": {
"type": "integer"
},
"cost_cpm": {
"type": "integer"
},
"created_on": {
"type": "string"
},
"currency": {
"description": "If set, the currency code for revenue events will be read from the specified URL parameter. Refer to Event Pixels on the T1 knowledge base for more information.\nEither currency or currency_fixed must be set.If set, you must set revenue value currency and revenue parameters must be different.",
"enum": [
"S1",
"S2",
"V1",
"V2"
],
"type": "string"
},
"currency_fixed": {
"default": "USD",
"description": "Fixed currency. Set using ISO 4217 currency code.\nhttps://en.wikipedia.org/wiki/ISO_4217",
"type": "string"
},
"eligible": {
"description": "Indicator eligibility of pixel for targeting",
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"external_identifier": {
"type": "string"
},
"id": {
"type": "integer"
},
"keywords": {
"description": "Optional keyword tag that can be applied to the pixel",
"maxLength": 64,
"type": "string"
},
"name": {
"type": "string"
},
"pixel_type": {
"default": "event",
"enum": [
"event"
],
"type": "string"
},
"pricing": {
"default": "CPM",
"description": "Pricing model for the data provider\nCPM is recommended. CPTS is not recommended and planned for deprecation.",
"enum": [
"CPM"
],
"type": "string"
},
"provider_id": {
"type": "integer"
},
"revenue": {
"description": "Identifies the pixel URL parameter in which the revenue value will be passed. Refer to Event Pixels on the T1 knowledge base for more information.",
"enum": [
"S1",
"S2",
"V1",
"V2"
],
"type": "string"
},
"rmx_conversion_minutes": {
"type": "integer"
},
"rmx_conversion_type": {
"type": "string"
},
"rmx_friendly": {
"type": "boolean"
},
"rmx_merit": {
"type": "boolean"
},
"status": {
"default": true,
"description": "Indicates whether a pixel should appear in API calls to the $APIBASE/pixel_bundles endpoint.",
"type": "boolean"
},
"tag_type": {
"description": "Tag type to determine pixel code output",
"enum": [
"image",
"js",
"dfa",
"uat",
"iframe"
],
"type": "string"
},
"tags": {
"type": "string"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"required": [
"advertiser_id",
"name",
"pixel_type",
"tag_type"
],
"title": "Event Pixel",
"type": "object",
"x-stoplight": {
"id": "event-pixel",
"name": "Event Pixel",
"public": true
}
},
"input-concept": {
"properties": {
"advertiser_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"type": "boolean"
}
},
"required": [
"advertiser_id",
"name"
],
"title": "Input Concept",
"type": "object",
"x-stoplight": {
"id": "input-concept",
"name": "Input Concept",
"public": true
}
},
"input-site-placement": {
"example": {
"audience_segment_exclude_op": "OR",
"audience_segment_include_op": "AND",
"bid_aggressiveness": 13,
"bid_price_is_media_only": false,
"budget": [
{
"currency_code": "USD",
"value": 1.43
}
],
"campaign_id": 1234566,
"created_on": "2016-05-04T15:44:54+0000",
"currency_code": "USD",
"effective_goal_value": [
{
"currency_code": "USD",
"value": "93.0000"
}
],
"end_date": "2016-05-06T13:44:49+0000",
"entity_type": "strategy",
"frequency_amount": 3,
"frequency_interval": "month",
"frequency_type": "even",
"goal_type": "reach",
"goal_value": [
{
"currency_code": "USD",
"value": 93
}
],
"id": 1234567,
"max_bid": [
{
"currency_code": "USD",
"value": 1.12
}
],
"media_type": "video",
"name": "strategy with audience segments",
"pacing_amount": [
{
"currency_code": "USD",
"value": 1.93
}
],
"pacing_interval": "hour",
"pacing_type": "even",
"run_on_all_exchanges": true,
"run_on_all_pmp": false,
"run_on_display": true,
"run_on_mobile": true,
"run_on_streaming": false,
"site_restriction_transparent_urls": true,
"site_selectiveness": "REDUCED",
"start_date": "2016-05-05T13:44:49+0000",
"status": false,
"strategy_audience_segments": [
{
"audience_segment_id": 1405158,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g2",
"id": 1132602,
"name": "Strategy Audience Segments #1132602",
"rel": "strategy_audience_segments",
"restriction": "EXCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1358322,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132601,
"name": "Strategy Audience Segments #1132601",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1460324,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132600,
"name": "Strategy Audience Segments #1132600",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
}
],
"supply_type": "RTB",
"targeting_segment_exclude_op": "OR",
"targeting_segment_include_op": "OR",
"type": "REM",
"updated_on": "2016-05-04T15:44:54+0000",
"use_campaign_end": false,
"use_campaign_start": false,
"use_mm_freq": false,
"use_optimization": true,
"version": 2,
"zone_name": "Europe/Paris"
},
"properties": {
"bill_media_to_client": {
"type": "boolean"
},
"deal_source": {
"enum": [
"USER",
"INTERNAL"
],
"type": "string"
},
"display_text": {
"maxLength": 255,
"type": "string"
},
"media_type": {
"enum": [
"display",
"video",
"mobile"
],
"type": "string"
},
"name": {
"maxLength": 64,
"type": "string"
},
"pmp_type": {
"enum": [
"DIRECT",
"PREMIUM"
],
"type": "string"
},
"publisher_site_id": {
"type": "integer"
}
},
"title": "Input Site Placement",
"type": "object",
"x-stoplight": {
"id": "input-site-placement",
"name": "Input Site Placement",
"public": true
}
},
"input-strategy": {
"example": {
"bid_price_is_media_only": "0",
"budget": "aliqua",
"campaign_id": 47950687,
"created_on": "2775-05-26T07:55:00.500Z",
"currency_code": "exercitation cupidatat magna",
"description": "Lorem nisi ",
"end_date": "3180-07-29T14:37:26.540Z",
"frequency_amount": 97568828,
"frequency_interval": "month",
"frequency_optimization": "off",
"frequency_type": "asap",
"goal_type": "cpc",
"goal_value": 89456794,
"impression_pacing_amount": 77467298,
"impression_pacing_interval": "hour",
"impression_pacing_type": "asap",
"max_bid": 17632443,
"max_bid_wm": "elit nulla et",
"media_type": "DISPLAY",
"min_bid": 20534822,
"name": "ex minim eiusmod",
"pacing_amount": 46580404,
"pacing_interval": "hour",
"pacing_type": "asap",
"pixel_target_expr": "velit",
"roi_target": 45897957,
"run_on_all_exchanges": "1",
"run_on_all_pmp": "0",
"run_on_display": "0",
"run_on_mobile": "1",
"run_on_streaming": "on",
"site_restriction_transparent_urls": "off",
"site_selectiveness": "ALL",
"start_date": "3201-02-02T11:35:20.790Z",
"status": true,
"supply_type": "T1_RMX",
"targeting_segment_exclude_op": "qui magna cupidatat",
"targeting_segment_include_op": "fugiat mollit",
"type": "AUD",
"updated_on": "2775-05-26T07:55:00.500Z",
"use_campaign_end": "off",
"use_campaign_start": "off",
"use_mm_freq": "off",
"use_optimization": "off",
"version": 21990818,
"zone_name": "nisi veniam pariatur sint"
},
"title": "Input Strategy",
"type": "object",
"x-stoplight": {
"id": "input-strategy",
"name": "Input Strategy",
"public": true
},
"properties": {
"audience_segment_exclude_op": {
"default": "OR",
"description": "Exclude associated audience segment from targeting",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"audience_segment_include_op": {
"default": "OR",
"description": "Include associated audience segment in targeting",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"bid_aggressiveness": {
"default": 50,
"description": "Only relevant for strategies with goal_type=’reach’. Reflects the target win rate for bid opportunities that match the strategy’s targeting, e.g. setting bid_aggressiveness to 65% instructs T1 to bid at a level for each impression such that it will win ~65% of the time",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"bid_min_devices": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"bid_price_is_media_only": {
"description": "Informs T1 that value entered on the strategygoal_valuemax_bidshould be the amount forthe \"media only\" (bid_price_is_media_only=1)or \"total spend\" (bid_price_is_media_only=0)\ndefault: 1",
"enum": [
"on",
"off",
"1",
"0",
"true",
"false"
],
"type": [
"string",
"boolean"
]
},
"budget": {
"type": "string"
},
"campaign_id": {
"description": "Specify parent campaign of strategy",
"minimum": 0,
"type": "integer"
},
"created_on": {
"format": "date-time",
"type": "string"
},
"currency_code": {
"description": "Currency code for this strategy. Read-only; inherited from the parent campaign.",
"type": "string"
},
"description": {
"maxLength": 1024,
"type": "string"
},
"device_graph_only": {
"type": "boolean"
},
"effective_device_graph_only": {
"type": "integer",
"minimum": 0,
"maximum": 1
},
"end_date": {
"description": "Date which strategy will end.\n\nrequired if `use_campaign_end='off'`\n\nMust not be set if `use_campaign_end is on`\n",
"format": "date-time",
"type": "string"
},
"exchange_type_for_run_on_all": {
"type": "string",
"description": "",
"enum": [
"ALL_ELIGIBLE",
"SELECTED_ONLY",
"SOURCE"
]
},
"feature_compatibility": {
"type": "string",
"maxLength": 1024
},
"frequency_amount": {
"description": "Maximum frequency of impressions per user within interval set on frequency_interval.\n\nrequired if `frequency_type='even'||'asap'`",
"minimum": 0,
"type": "integer"
},
"frequency_interval": {
"description": "Interval applicable for frequency_amount.\n\nrequired if `frequency_type='even'||'asap'`\n",
"enum": [
"day",
"month",
"week",
"hour"
],
"type": "string"
},
"frequency_optimization": {
"description": "Indicates whether the strategy should use a T1 Optimized Frequency Cap. Setting this field to \"Off\" means the user will dictate the flat bid price for each impression.",
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"frequency_type": {
"description": "Distribute impressions across frequency_interval up to frequency_value evenly or asap",
"enum": [
"even",
"asap",
"no-limit"
],
"type": "string"
},
"goal_type": {
"description": "The type of bid price optimization (if any) that the strategy will use when buying impressions, as well as the performance metric against which performance will be measured. Allowed values: cpa, cpc, ctr, reach, roi, spend, vcr, viewability_rate, vcpm. See table in Campaigns that shows which strategy goal types are allowed for each campaign goal type.",
"enum": [
"cpa",
"cpc",
"ctr",
"reach",
"roi",
"spend",
"vcr",
"viewability_rate",
"vcpm"
],
"type": "string"
},
"goal_value": {
"description": "Target goal value for strategy respective to the goal_type selection.\n\nrequired if `goal_type in ('cpa','cpc','reach','roi', 'vcr', 'ctr')`\n\nIf goal type is `vcr` or `ctr`, goal_value is a percentage.",
"minimum": 0,
"type": "number"
},
"impression_pacing_amount": {
"minimum": 0,
"type": "integer"
},
"impression_pacing_interval": {
"default": "day",
"description": "Period of time over which impression pacing is to be distributed",
"enum": [
"day",
"month",
"week",
"hour"
],
"type": "string"
},
"impression_pacing_type": {
"description": "Type of impression pacing applied to strategy.",
"enum": [
"even",
"asap",
"no-limit"
],
"type": "string"
},
"max_bid": {
"minimum": 0,
"type": "number"
},
"max_bid_wm": {
"type": "string"
},
"media_type": {
"description": "Whether the strategy is a display or video strategy",
"enum": [
"DISPLAY",
"VIDEO"
],
"type": "string"
},
"min_bid": {
"minimum": 0,
"type": "number"
},
"name": {
"description": "Descriptive name of strategy",
"maxLength": 128,
"type": "string"
},
"pacing_amount": {
"minimum": 0,
"type": "integer"
},
"pacing_interval": {
"description": "Specify distribution of spend across the pacing_interval",
"enum": [
"hour",
"day"
],
"type": "string"
},
"pacing_type": {
"description": "Specify distribution of spend across the pacing_interval",
"enum": [
"even",
"asap"
],
"type": "string"
},
"pixel_target_expr": {
"description": "Specify pixel targeting for the strategy. Poll must be run to obtain available Pixel IDs. To configure Pixel-Targeting, pixels must have previously been generated. See \"API for Event Pixels and Data Pixels\" for more information on creating and obtaining information on Pixels.\n\n( [pixel_id] INCL_COND [pixel_id] ) AND NOT ( [pixel_id EXCL_COND[pixel_id] )1024 characters maximumnote Although theINCL_CONDandEXCL_CONDis not required to be consistent, the conditional logic between all pixels to be included or excluded must be the same.\nmaxLength: 1024",
"type": "string"
},
"rmx_strategy": {
"type": "object",
"properties": {
"budget_type": {
"type": "string",
"enum": [
"DOLLARS",
"IMPRESSIONS"
]
},
"created_on": {
"type": "string",
"format": "date-time"
},
"dynamic_pricing_option": {
"type": "string",
"enum": [
"AVERAGE",
"STANDARD",
"WIN",
"SPEND"
]
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"learning_budget_pacing": {
"type": "string",
"enum": [
"ASAP",
"EVEN",
"HOURLY",
"DAILY",
"MONTHLY"
]
},
"learning_slider": {
"type": "integer"
},
"name": {
"type": "string"
},
"pacing": {
"type": "string",
"enum": [
"asap",
"deliver_overall_budget_evenly",
"deliver_remaining_budget_evenly",
"hourly_asap",
"hourly_even",
"daily_asap",
"daily_even",
"monthly_asap",
"monthly_even"
]
},
"price": {
"type": "number"
},
"pricing_type": {
"type": "string",
"enum": [
"CPA",
"CPC",
"CPM",
"DYNAMIC"
]
},
"rel": {
"type": "string"
},
"rmx_push_entity_id": {
"type": "integer"
},
"rmx_push_status": {
"type": "string",
"enum": [
"NEW",
"UPDATED",
"IN_PROGRESS",
"PUSH_OK",
"PUSH_FAILED"
]
},
"roi_cpc_target_ctr": {
"type": "string"
},
"roi_cpc_target_ctr_type": {
"type": "string",
"enum": [
"DOLLARS",
"PERCENT"
]
},
"roi_modifier": {
"type": "number"
},
"roi_target_pixels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"created_on": {
"type": "string",
"format": "date-time"
},
"entity_type": {
"type": "string",
"enum": [
"rmx_strategy_roi_target_pixel"
]
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"pixel_bundle_id": {
"type": "integer"
},
"price": {
"type": "number"
},
"rel": {
"type": "string"
},
"rmx_pixel_type": {
"type": "string",
"enum": [
"CLICK",
"IMPRESSION",
"SEGMENT"
]
},
"rmx_strategy_id": {
"type": "integer"
},
"status": {
"type": "boolean"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "integer"
}
}
}
},
"roi_targets": {
"type": "string",
"enum": [
"NONE",
"CPA",
"CPC"
]
},
"status": {
"type": "boolean"
},
"strategy_id": {
"type": "integer"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "integer"
}
}
},
"roi_target": {
"description": "Desired ROI target declared as a multiple of total_spend.\n\nrequired `if goal_type='roi'`",
"minimum": 0,
"type": "integer"
},
"run_on_all_exchanges": {
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"run_on_all_pmp": {
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"run_on_display": {
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"run_on_mobile": {
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"run_on_only_fraud_filtered_exchanges": {
"type": "boolean"
},
"run_on_streaming": {
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"site_restriction_transparent_urls": {
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"site_selectiveness": {
"type": "string",
"default": "REDUCED",
"description": "REDUCED is currently the only available option"
},
"start_date": {
"description": "required if `use_campaign_start='off'` and`can not be updated if strategy has already started`\n\nMust not be set if `use_campaign_start is on`",
"format": "date-time",
"type": "string"
},
"status": {
"type": "boolean"
},
"supply_type": {
"description": "Specify whether impressions will be bought and decisioned by the TerminalOne platform. Use 'RTB' for normal strategies that are bought/decisioned in T1. Use 'RMX_API' to use a tag to track media not purchased through TerminalOne.",
"enum": [
"RTB",
"RMX_API",
"T1_RMX",
"MKT"
],
"type": "string"
},
"targeting_segment_exclude_op": {
"type": "string"
},
"targeting_segment_include_op": {
"type": "string"
},
"type": {
"description": "Specify the type of strategy (re-marketing (REM), goal-based optimization (GBO), audience (AUD))",
"enum": [
"REM",
"GBO",
"AUD"
],
"type": "string"
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"use_campaign_end": {
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"use_campaign_start": {
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"use_mm_freq": {
"description": "Unused legacy frequency cap setting. Must be set to 'off'. To control frequency capping at the campaign level, set the strategy-level frequency_type attribute to 'no-limit' and set a frequency cap on the campaign entity.",
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"use_optimization": {
"description": "Enable's T1 optimization algorithm (defaults to 'off' if unspecified).\n\nrequired if `goal_type!='spend'`",
"enum": [
"on",
"off",
"1",
"0"
],
"type": "string"
},
"version": {
"minimum": 0,
"type": "integer"
},
"zone_name": {
"type": "string"
}
},
"required": [
"campaign_id",
"frequency_type",
"goal_type",
"goal_value",
"name",
"pacing_amount",
"type"
]
},
"input-supply-source": {
"example": {
"audience_segment_exclude_op": "OR",
"audience_segment_include_op": "AND",
"bid_aggressiveness": 13,
"bid_price_is_media_only": false,
"budget": [
{
"currency_code": "USD",
"value": 1.43
}
],
"campaign_id": 1234566,
"created_on": "2016-05-04T15:44:54+0000",
"currency_code": "USD",
"effective_goal_value": [
{
"currency_code": "USD",
"value": "93.0000"
}
],
"end_date": "2016-05-06T13:44:49+0000",
"entity_type": "strategy",
"frequency_amount": 3,
"frequency_interval": "month",
"frequency_type": "even",
"goal_type": "reach",
"goal_value": [
{
"currency_code": "USD",
"value": 93
}
],
"id": 1234567,
"max_bid": [
{
"currency_code": "USD",
"value": 1.12
}
],
"media_type": "VIDEO",
"name": "strategy with audience segments",
"pacing_amount": [
{
"currency_code": "USD",
"value": 1.93
}
],
"pacing_interval": "hour",
"pacing_type": "even",
"run_on_all_exchanges": true,
"run_on_all_pmp": false,
"run_on_display": true,
"run_on_mobile": true,
"run_on_streaming": false,
"site_restriction_transparent_urls": true,
"site_selectiveness": "REDUCED",
"start_date": "2016-05-05T13:44:49+0000",
"status": false,
"strategy_audience_segments": [
{
"audience_segment_id": 1358322,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132601,
"name": "Strategy Audience Segments #1132601",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1405158,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g2",
"id": 1132602,
"name": "Strategy Audience Segments #1132602",
"rel": "strategy_audience_segments",
"restriction": "EXCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1460324,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132600,
"name": "Strategy Audience Segments #1132600",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
}
],
"supply_type": "RTB",
"targeting_segment_exclude_op": "OR",
"targeting_segment_include_op": "OR",
"type": "REM",
"updated_on": "2016-05-04T15:44:54+0000",
"use_campaign_end": false,
"use_campaign_start": false,
"use_mm_freq": false,
"use_optimization": true,
"version": 2,
"zone_name": "Europe/Paris"
},
"properties": {
"accountable_and_addressable": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"attribution_group": {
"type": "string"
},
"bidder_exchange_identifier": {
"type": "integer"
},
"code": {
"type": "string"
},
"distribute": {
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"fraud_filter": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"has_connected_tv": {
"type": "boolean"
},
"has_desktop_video": {
"type": "boolean"
},
"has_display": {
"type": "boolean"
},
"has_mobile_display": {
"type": "boolean"
},
"has_mobile_video": {
"type": "boolean"
},
"has_video": {
"type": "boolean"
},
"is_proservice": {
"type": "boolean"
},
"mm_safe": {
"type": "boolean"
},
"name": {
"type": "string"
},
"pmp_enabled": {
"type": "boolean"
},
"rel": {
"type": "string"
},
"requires_creative_audit": {
"type": "boolean"
},
"rtb_enabled": {
"type": "boolean"
},
"rtb_type": {
"type": "string"
},
"seat_enabled": {
"type": "boolean"
},
"status": {
"type": "boolean"
},
"supply_type": {
"type": "string"
},
"use_pool": {
"type": "boolean"
}
},
"title": "Input Supply Source",
"type": "object",
"x-stoplight": {
"id": "input-supply-source",
"name": "Input Supply Source",
"public": true
}
},
"input_vendor_contract": {
"example": {
"campaign_id": 22035223,
"price": 13971235,
"rate_card_type": "CPM",
"use_mm_contract": false,
"vendor_id": 95836163
},
"properties": {
"campaign_id": {
"description": "Once set, this field can not be changed.",
"type": "integer"
},
"price": {
"type": "number"
},
"rate_card_type": {
"enum": [
"CPM",
"FIXED"
],
"type": "string"
},
"use_mm_contract": {
"type": "boolean"
},
"vendor_id": {
"type": "integer"
}
},
"required": [
"vendor_id",
"campaign_id",
"use_mm_contract"
],
"title": "Input Vendor Contract",
"type": "object",
"x-stoplight": {
"id": "input_vendor_contract",
"name": "Input Vendor Contract",
"public": true
}
},
"meta-error": {
"properties": {
"status": {
"enum": [
"error"
],
"type": "string"
}
},
"required": [
"status"
],
"title": "Meta (Error)",
"type": "object",
"x-stoplight": {
"id": "meta-error",
"name": "Meta (Error)",
"public": true
}
},
"multiResponse": {
"example": {
"data": [
{
"address_1": "occaecat nisi adipisicing labore aliqua",
"address_2": "non dolor",
"adx_seat_account_id": 98907429,
"allow_byo_price": true,
"allow_x_agency_pixels": false,
"city": "id",
"currency_code": "enim mollit exercitation",
"entity_type": "ut elit",
"mm_contact_name": "dolore eiusmod laboris eu",
"phone": "Ut minim nisi et adipisicing",
"state": "Lorem cupidatat dolore n",
"status": true,
"use_evidon_optout": true,
"zip": "aliqua"
},
{
"allow_x_agency_pixels": false,
"contact_name": "Ut fugiat dolor",
"state": "proident adipisicing est aliqua in"
},
{
"city": "voluptate ullamco"
},
{
"contact_name": "qui ex sunt ut",
"state": "ut minim",
"zip": "et adipisicing est ea dolore"
}
],
"meta": {
"called_on": "",
"count": -72242440,
"etag": "elit veniam occaecat",
"offset": 44614629,
"status": "nostrud",
"total_count": 65377386
}
},
"properties": {
"data": {
"items": {
"example": {
"address_1": "1440 Broadway",
"address_2": "4WTC",
"adx_seat_account_id": 95819908,
"allow_byo_price": true,
"allow_x_agency_pixels": true,
"billing_country_code": "US",
"city": "New York",
"contact_name": "Ian Hummel",
"country": "US",
"created_on": "2010-10-19T16:58:05+0000",
"currency_code": "USD",
"dmp_enabled": "enabled",
"entity_type": "organization",
"id": 100048,
"mm_contact_name": "Ian Hummel",
"name": "ACME Org",
"opt_out_connected_id": true,
"opt_out_connected_id_mathid": false,
"org_type": [
"buyer"
],
"override_suspicious_traffic_filter": false,
"phone": "(347) 420-0116",
"restrict_targeting_to_deterministic_id": true,
"restrict_targeting_to_same_device_id": true,
"service_provider_ccpa": true,
"state": "NY",
"status": true,
"suspicious_traffic_filter_level": 25,
"terminated": false,
"updated_on": "2016-11-03T19:39:12+0000",
"use_evidon_optout": true,
"version": 126,
"zip": "10018"
},
"title": "Organization",
"type": "object",
"x-stoplight": {
"id": "organization",
"name": "Organization",
"public": true
},
"properties": {
"accountable_and_addressable": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"address_1": {
"type": "string"
},
"address_2": {
"type": "string"
},
"adx_seat_account_id": {
"description": "Passed to ADX upon creative registration so ADX knows which seat we're registering under.",
"type": "integer"
},
"allow_byo_price": {
"type": "boolean"
},
"allow_x_agency_pixels": {
"description": "This field enables the Data Co-op functionality across all the Advertisers under this organization. Cross-Advertiser Pixel Targeting allows Advertisers to target other Advertiser Event Pixels within their Agency and any other similarly enabled Agency under the same Organization.",
"type": "boolean"
},
"billing_country_code": {
"description": "Country code that is used for billing purposes",
"type": "string"
},
"city": {
"type": "string"
},
"connected_id_type": {
"type": "string",
"enum": [
"DETERMINISTIC_FIRST",
"DETERMINISTIC_ONLY"
]
},
"contact_name": {
"description": "This is the primary contact at the organization regarding contract issues.",
"type": "string"
},
"country": {
"type": "string"
},
"created_on": {
"type": "string"
},
"currency_code": {
"description": "Currency code for the campaign budget and spend, as well as billing",
"type": "string"
},
"dmp_enabled": {
"type": "string"
},
"eligibile_for_data_sharing": {
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"facebook": {
"type": "string"
},
"holding_org_id": {
"type": "integer"
},
"id": {
"type": "integer"
},
"linkedin": {
"type": "string"
},
"mm_contact_name": {
"description": "This is the name of the primary internal MediaMath contact of the Organization.",
"type": "string"
},
"name": {
"description": "The Name of the organization with whom the contract is held. This can be an agency holding company, agency, advertiser, network, or other media or data buying entity.",
"type": "string"
},
"opt_out_connected_id": {
"type": "boolean"
},
"opt_out_connected_id_mathid": {
"type": "boolean"
},
"org_type": {
"type": "array",
"items": {
"type": "string"
}
},
"override_suspicious_traffic_filter": {
"description": "Set flag to 'on’ to be able to override default org wide suspicious traffic filter level ",
"type": "boolean"
},
"phone": {
"type": "string"
},
"restrict_targeting_to_deterministic_id": {
"type": "boolean",
"default": true,
"description": "This is a deprecated field, which now only allows the value 'true'."
},
"restrict_targeting_to_same_device_id": {
"type": "boolean"
},
"state": {
"type": "string"
},
"service_provider_ccpa": {
"type": "boolean",
"description": "Represents whether a service provider agreement was signed by the organization owner in accordance with CCPA"
},
"status": {
"description": "of organization (defaults to off if unspecified)",
"type": "boolean"
},
"suspicious_traffic_filter_level": {
"description": "Specify an organization-wide level of suspicious traffic filtering to use. See the Knowledge Base for additional details about this feature. This setting will only take affect if the organization's override_suspicious_traffic_filter property is set to 'on'.\n\nIf override_suspicious_traffic_filter is enabled and suspicious_traffic_filter_level is set to 0, all fraud and suspicious ",
"type": "integer"
},
"terminated": {
"type": "boolean"
},
"updated_on": {
"type": "string"
},
"use_evidon_optout": {
"description": "Set flag to 'on’ to show an opt out button on the organization's ads (additional CPM fee will apply when on) ",
"type": "boolean"
},
"version": {
"type": "integer"
},
"zip": {
"type": "string"
}
}
},
"type": "array"
},
"meta": {
"description": "Meta response for all API endpoints",
"properties": {
"called_on": {
"type": "string"
},
"count": {
"type": "integer"
},
"etag": {
"type": "string"
},
"offset": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_count": {
"type": "integer"
}
},
"title": "meta",
"type": "object",
"x-stoplight": {
"id": "t1-meta",
"name": "meta",
"public": true
}
}
},
"title": "multiResponse",
"type": "object",
"x-stoplight": {
"id": "multiResponse",
"name": "multiResponse",
"public": true
}
},
"organization": {
"example": {
"address_1": "1440 Broadway",
"address_2": "4WTC",
"adx_seat_account_id": 95819908,
"allow_byo_price": true,
"allow_x_agency_pixels": true,
"billing_country_code": "US",
"city": "New York",
"contact_name": "Ian Hummel",
"country": "US",
"created_on": "2010-10-19T16:58:05+0000",
"currency_code": "USD",
"dmp_enabled": "enabled",
"entity_type": "organization",
"id": 100048,
"mm_contact_name": "Ian Hummel",
"name": "ACME Org",
"opt_out_connected_id": true,
"opt_out_connected_id_mathid": false,
"org_type": [
"buyer"
],
"override_suspicious_traffic_filter": false,
"phone": "(347) 420-0116",
"restrict_targeting_to_deterministic_id": true,
"restrict_targeting_to_same_device_id": true,
"service_provider_ccpa": true,
"state": "NY",
"status": true,
"suspicious_traffic_filter_level": 25,
"terminated": false,
"updated_on": "2016-11-03T19:39:12+0000",
"use_evidon_optout": true,
"version": 126,
"zip": "10018"
},
"title": "Organization",
"type": "object",
"x-stoplight": {
"id": "organization",
"name": "Organization",
"public": true
},
"properties": {
"accountable_and_addressable": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"address_1": {
"type": "string"
},
"address_2": {
"type": "string"
},
"adx_seat_account_id": {
"description": "Passed to ADX upon creative registration so ADX knows which seat we're registering under.",
"type": "integer"
},
"allow_byo_price": {
"type": "boolean"
},
"allow_x_agency_pixels": {
"description": "This field enables the Data Co-op functionality across all the Advertisers under this organization. Cross-Advertiser Pixel Targeting allows Advertisers to target other Advertiser Event Pixels within their Agency and any other similarly enabled Agency under the same Organization.",
"type": "boolean"
},
"billing_country_code": {
"description": "Country code that is used for billing purposes",
"type": "string"
},
"city": {
"type": "string"
},
"connected_id_type": {
"type": "string",
"enum": [
"DETERMINISTIC_FIRST",
"DETERMINISTIC_ONLY"
]
},
"contact_name": {
"description": "This is the primary contact at the organization regarding contract issues.",
"type": "string"
},
"country": {
"type": "string"
},
"created_on": {
"type": "string"
},
"currency_code": {
"description": "Currency code for the campaign budget and spend, as well as billing",
"type": "string"
},
"dmp_enabled": {
"type": "string"
},
"eligibile_for_data_sharing": {
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"facebook": {
"type": "string"
},
"holding_org_id": {
"type": "integer"
},
"id": {
"type": "integer"
},
"linkedin": {
"type": "string"
},
"mm_contact_name": {
"description": "This is the name of the primary internal MediaMath contact of the Organization.",
"type": "string"
},
"name": {
"description": "The Name of the organization with whom the contract is held. This can be an agency holding company, agency, advertiser, network, or other media or data buying entity.",
"type": "string"
},
"opt_out_connected_id": {
"type": "boolean"
},
"opt_out_connected_id_mathid": {
"type": "boolean"
},
"org_type": {
"type": "array",
"items": {
"type": "string"
}
},
"override_suspicious_traffic_filter": {
"description": "Set flag to 'on’ to be able to override default org wide suspicious traffic filter level ",
"type": "boolean"
},
"phone": {
"type": "string"
},
"restrict_targeting_to_deterministic_id": {
"type": "boolean",
"default": true,
"description": "This is a deprecated field, which now only allows the value 'true'."
},
"restrict_targeting_to_same_device_id": {
"type": "boolean"
},
"state": {
"type": "string"
},
"service_provider_ccpa": {
"type": "boolean",
"description": "Represents whether a service provider agreement was signed by the organization owner in accordance with CCPA"
},
"status": {
"description": "of organization (defaults to off if unspecified)",
"type": "boolean"
},
"suspicious_traffic_filter_level": {
"description": "Specify an organization-wide level of suspicious traffic filtering to use. See the Knowledge Base for additional details about this feature. This setting will only take affect if the organization's override_suspicious_traffic_filter property is set to 'on'.\n\nIf override_suspicious_traffic_filter is enabled and suspicious_traffic_filter_level is set to 0, all fraud and suspicious ",
"type": "integer"
},
"terminated": {
"type": "boolean"
},
"updated_on": {
"type": "string"
},
"use_evidon_optout": {
"description": "Set flag to 'on’ to show an opt out button on the organization's ads (additional CPM fee will apply when on) ",
"type": "boolean"
},
"version": {
"type": "integer"
},
"zip": {
"type": "string"
}
}
},
"output-common-meta": {
"example": {
"meta": {
"called_on": "2017-06-02T23:36:05+0000",
"count": 2,
"etag": "5e446abf85396cc1e516a67b2ecd637ee8f8ac34",
"offset": 0,
"status": "ok",
"total_count": 0
}
},
"properties": {
"called_on": {
"type": "string"
},
"count": {
"type": "integer"
},
"etag": {
"type": "string"
},
"offset": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_count": {
"type": "integer"
}
},
"title": "Output Common Meta",
"type": "object",
"x-stoplight": {
"id": "output-common-meta",
"name": "Output Common Meta",
"public": true
}
},
"output-concept": {
"allOf": [
{
"properties": {
"advertiser_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"type": "boolean"
}
},
"required": [
"advertiser_id",
"name"
],
"title": "Input Concept",
"type": "object",
"x-stoplight": {
"id": "input-concept",
"name": "Input Concept",
"public": true
}
},
{
"example": {
"created_on": "4838-01-01T02:34:39.905Z",
"id": 1,
"updated_on": "3214-02-18T04:49:20.878Z",
"version": 46559379
},
"properties": {
"created_on": {
"format": "date-time",
"type": "string"
},
"id": {
"minimum": 0,
"type": "integer"
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Output Common",
"type": "object",
"x-stoplight": {
"id": "output_common",
"name": "Output Common",
"public": true
}
}
],
"title": "Output Concept",
"type": "object",
"x-stoplight": {
"id": "output-concept",
"name": "Output Concept",
"public": true
}
},
"output-site-placement": {
"allOf": [
{
"example": {
"audience_segment_exclude_op": "OR",
"audience_segment_include_op": "AND",
"bid_aggressiveness": 13,
"bid_price_is_media_only": false,
"budget": [
{
"currency_code": "USD",
"value": 1.43
}
],
"campaign_id": 1234566,
"created_on": "2016-05-04T15:44:54+0000",
"currency_code": "USD",
"effective_goal_value": [
{
"currency_code": "USD",
"value": "93.0000"
}
],
"end_date": "2016-05-06T13:44:49+0000",
"entity_type": "strategy",
"frequency_amount": 3,
"frequency_interval": "month",
"frequency_type": "even",
"goal_type": "reach",
"goal_value": [
{
"currency_code": "USD",
"value": 93
}
],
"id": 1234567,
"max_bid": [
{
"currency_code": "USD",
"value": 1.12
}
],
"media_type": "video",
"name": "strategy with audience segments",
"pacing_amount": [
{
"currency_code": "USD",
"value": 1.93
}
],
"pacing_interval": "hour",
"pacing_type": "even",
"run_on_all_exchanges": true,
"run_on_all_pmp": false,
"run_on_display": true,
"run_on_mobile": true,
"run_on_streaming": false,
"site_restriction_transparent_urls": true,
"site_selectiveness": "REDUCED",
"start_date": "2016-05-05T13:44:49+0000",
"status": false,
"strategy_audience_segments": [
{
"audience_segment_id": 1405158,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g2",
"id": 1132602,
"name": "Strategy Audience Segments #1132602",
"rel": "strategy_audience_segments",
"restriction": "EXCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1358322,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132601,
"name": "Strategy Audience Segments #1132601",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1460324,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132600,
"name": "Strategy Audience Segments #1132600",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
}
],
"supply_type": "RTB",
"targeting_segment_exclude_op": "OR",
"targeting_segment_include_op": "OR",
"type": "REM",
"updated_on": "2016-05-04T15:44:54+0000",
"use_campaign_end": false,
"use_campaign_start": false,
"use_mm_freq": false,
"use_optimization": true,
"version": 2,
"zone_name": "Europe/Paris"
},
"properties": {
"bill_media_to_client": {
"type": "boolean"
},
"deal_source": {
"enum": [
"USER",
"INTERNAL"
],
"type": "string"
},
"display_text": {
"maxLength": 255,
"type": "string"
},
"media_type": {
"enum": [
"display",
"video",
"mobile"
],
"type": "string"
},
"name": {
"maxLength": 64,
"type": "string"
},
"pmp_type": {
"enum": [
"DIRECT",
"PREMIUM"
],
"type": "string"
},
"publisher_site_id": {
"type": "integer"
}
},
"title": "Input Site Placement",
"type": "object",
"x-stoplight": {
"id": "input-site-placement",
"name": "Input Site Placement",
"public": true
}
},
{
"example": {
"created_on": "4838-01-01T02:34:39.905Z",
"id": 1,
"updated_on": "3214-02-18T04:49:20.878Z",
"version": 46559379
},
"properties": {
"created_on": {
"format": "date-time",
"type": "string"
},
"id": {
"minimum": 0,
"type": "integer"
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Output Common",
"type": "object",
"x-stoplight": {
"id": "output_common",
"name": "Output Common",
"public": true
}
}
],
"title": "Output Site Placement",
"x-stoplight": {
"id": "output-site-placement",
"name": "Output Site Placement",
"public": true
}
},
"output-strategy": {
"example": {
"audience_segment_exclude_op": "OR",
"audience_segment_include_op": "OR",
"bid_aggressiveness": 50,
"bid_price_is_media_only": true,
"budget": [
{
"currency_code": "USD",
"value": 1095.43
}
],
"campaign_id": 342332,
"created_on": "2017-03-05T16:23:46+0000",
"currency_code": "USD",
"effective_goal_value": [
{
"currency_code": "USD",
"value": "85.0000"
}
],
"end_date": "2017-11-01T03:59:59+0000",
"entity_type": "strategy",
"frequency_amount": 15,
"frequency_interval": "day",
"frequency_optimization": false,
"frequency_type": "even",
"goal_type": "cpa",
"goal_value": [
{
"currency_code": "USD",
"value": 85
}
],
"id": 2059202,
"impression_pacing_interval": "day",
"impression_pacing_type": "no-limit",
"max_bid": [
{
"currency_code": "USD",
"value": 1.19
}
],
"media_type": "DISPLAY",
"min_bid": [
{
"currency_code": "USD",
"value": 0
}
],
"name": "Q7HGQ1YS000_ZIPs",
"pacing_amount": [
{
"currency_code": "USD",
"value": 0.01
}
],
"pacing_interval": "hour",
"pacing_type": "even",
"pixel_target_expr": "NOT ( [1141991] )",
"run_on_all_exchanges": false,
"run_on_all_pmp": false,
"run_on_display": true,
"run_on_mobile": true,
"run_on_streaming": false,
"site_restriction_transparent_urls": false,
"site_selectiveness": "REDUCED",
"status": true,
"supply_type": "RTB",
"targeting_segment_exclude_op": "OR",
"targeting_segment_include_op": "OR",
"type": "GBO",
"updated_on": "2017-10-18T12:44:52+0000",
"use_campaign_end": false,
"use_campaign_start": true,
"use_mm_freq": false,
"use_optimization": true,
"version": 995,
"zone_name": "America/New_York"
},
"title": "Output Strategy",
"type": "object",
"x-stoplight": {
"id": "output-strategy",
"name": "Output Strategy",
"public": true
},
"properties": {
"audience_segment_exclude_op": {
"type": "string",
"enum": [
"AND",
"OR"
],
"description": "Exclude associated audience segment from targeting"
},
"audience_segment_include_op": {
"type": "string",
"enum": [
"AND",
"OR"
],
"description": "Include associated audience segment in targeting"
},
"bid_aggressiveness": {
"type": "integer",
"description": "Only relevant for strategies with goal_type=’reach’. Reflects the target win rate for bid opportunities that match the strategy’s targeting, e.g. setting bid_aggressiveness to 65% instructs T1 to bid at a level for each impression such that it will win ~65% of the time"
},
"bid_min_devices": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"bid_price_is_media_only": {
"type": "boolean",
"description": "Informs T1 that value entered on the strategygoal_valuemax_bidshould be the amount forthe \"media only\" (bid_price_is_media_only=1)or \"total spend\" (bid_price_is_media_only=0)\ndefault: 1"
},
"budget": {
"type": "array",
"description": "Currency code for this strategy. Read-only; inherited from the parent campaign.",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string",
"description": "Currency code for this strategy. Read-only; inherited from the parent campaign."
},
"value": {
"type": "number"
}
}
}
},
"campaign_id": {
"type": "integer",
"description": "Specify parent campaign of strategy"
},
"created_on": {
"type": "string"
},
"currency_code": {
"type": "string",
"description": "ISO 4217 3-letter currency code"
},
"device_graph_only": {
"type": "boolean"
},
"effective_device_graph_only": {
"type": "integer",
"minimum": 0,
"maximum": 1
},
"effective_goal_value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"end_date": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"exchange_type_for_run_on_all": {
"type": "string",
"description": "",
"enum": [
"ALL_ELIGIBLE",
"SELECTED_ONLY",
"SOURCE"
]
},
"feature_compatibility": {
"type": "string",
"maxLength": 1024
},
"frequency_amount": {
"type": "integer",
"description": "Maximum frequency of impressions per user within interval set on frequency_interval.\n\nrequired if `frequency_type='even'||'asap'`"
},
"frequency_interval": {
"type": "string",
"description": "Interval applicable for frequency_amount.\n\nrequired if `frequency_type='even'||'asap'`\n",
"enum": [
"day",
"hour",
"week",
"month",
"campaign",
"not-applicable"
]
},
"frequency_optimization": {
"type": "boolean",
"description": "Indicates whether the strategy should use a T1 Optimized Frequency Cap. Setting this field to \"Off\" means the user will dictate the flat bid price for each impression."
},
"frequency_type": {
"type": "string",
"enum": [
"even",
"asap",
"no-limit"
]
},
"goal_type": {
"type": "string",
"description": "The type of bid price optimization (if any) that the strategy will use when buying impressions, as well as the performance metric against which performance will be measured. Allowed values: roi, cpa, cpc, ctr, vcr, viewability_rate, vcpm, reach, spend. See table in Campaigns that shows which strategy goal types are allowed for each campaign goal type.",
"enum": [
"roi",
"cpa",
"cpc",
"ctr",
"vcr",
"viewability_rate",
"vcpm",
"reach",
"spend"
]
},
"goal_value": {
"type": "array",
"description": "Target goal value for strategy respective to the goal_type selection.\n\nrequired if `goal_type in ('cpa','cpc','reach','roi', 'vcr', 'ctr')`\n\nIf goal type is `vcr` or `ctr`, goal_value is a percentage.",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"id": {
"type": "integer"
},
"impression_pacing_interval": {
"type": "string",
"description": "Period of time over which impression pacing is to be distributed",
"enum": [
"day",
"hour",
"week",
"month",
"campaign",
"not-applicable"
]
},
"impression_pacing_type": {
"type": "string",
"description": "Type of impression pacing applied to strategy.",
"enum": [
"even",
"asap",
"no-limit"
]
},
"max_bid": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"media_type": {
"type": "string",
"description": "Whether the strategy is a display or video strategy",
"enum": [
"VIDEO",
"DISPLAY"
]
},
"min_bid": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"name": {
"type": "string",
"description": "Descriptive name of strategy"
},
"pacing_amount": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"pacing_interval": {
"type": "string",
"description": "Specify distribution of spend across the pacing_interval"
},
"pacing_type": {
"type": "string",
"description": "Specify distribution of spend across the pacing_interval"
},
"pixel_target_expr": {
"type": "string",
"description": "Specify pixel targeting for the strategy. Poll must be run to obtain available Pixel IDs. To configure Pixel-Targeting, pixels must have previously been generated. See \"API for Event Pixels and Data Pixels\" for more information on creating and obtaining information on Pixels.\n\n( [pixel_id] INCL_COND [pixel_id] ) AND NOT ( [pixel_id EXCL_COND[pixel_id] )1024 characters maximumnote Although theINCL_CONDandEXCL_CONDis not required to be consistent, the conditional logic between all pixels to be included or excluded must be the same.\nmaxLength: 1024"
},
"rmx_strategy": {
"type": "object",
"properties": {
"budget_type": {
"type": "string",
"enum": [
"DOLLARS",
"IMPRESSIONS"
]
},
"created_on": {
"type": "string",
"format": "date-time"
},
"dynamic_pricing_option": {
"type": "string",
"enum": [
"AVERAGE",
"STANDARD",
"WIN",
"SPEND"
]
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"learning_budget_pacing": {
"type": "string",
"enum": [
"ASAP",
"EVEN",
"HOURLY",
"DAILY",
"MONTHLY"
]
},
"learning_slider": {
"type": "integer"
},
"name": {
"type": "string"
},
"pacing": {
"type": "string",
"enum": [
"asap",
"deliver_overall_budget_evenly",
"deliver_remaining_budget_evenly",
"hourly_asap",
"hourly_even",
"daily_asap",
"daily_even",
"monthly_asap",
"monthly_even"
]
},
"price": {
"type": "number"
},
"pricing_type": {
"type": "string",
"enum": [
"CPA",
"CPC",
"CPM",
"DYNAMIC"
]
},
"rel": {
"type": "string"
},
"rmx_push_entity_id": {
"type": "integer"
},
"rmx_push_status": {
"type": "string",
"enum": [
"NEW",
"UPDATED",
"IN_PROGRESS",
"PUSH_OK",
"PUSH_FAILED"
]
},
"roi_cpc_target_ctr": {
"type": "string"
},
"roi_cpc_target_ctr_type": {
"type": "string",
"enum": [
"DOLLARS",
"PERCENT"
]
},
"roi_modifier": {
"type": "number"
},
"roi_target_pixels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"created_on": {
"type": "string",
"format": "date-time"
},
"entity_type": {
"type": "string",
"enum": [
"rmx_strategy_roi_target_pixel"
]
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"pixel_bundle_id": {
"type": "integer"
},
"price": {
"type": "number"
},
"rel": {
"type": "string"
},
"rmx_pixel_type": {
"type": "string",
"enum": [
"CLICK",
"IMPRESSION",
"SEGMENT"
]
},
"rmx_strategy_id": {
"type": "integer"
},
"status": {
"type": "boolean"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "integer"
}
}
}
},
"roi_targets": {
"type": "string",
"enum": [
"NONE",
"CPA",
"CPC"
]
},
"status": {
"type": "boolean"
},
"strategy_id": {
"type": "integer"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "integer"
}
}
},
"run_on_all_exchanges": {
"type": "boolean"
},
"run_on_all_pmp": {
"type": "boolean"
},
"run_on_display": {
"type": "boolean"
},
"run_on_mobile": {
"type": "boolean"
},
"run_on_only_fraud_filtered_exchanges": {
"type": "boolean"
},
"run_on_streaming": {
"type": "boolean"
},
"site_restriction_transparent_urls": {
"type": "boolean"
},
"site_selectiveness": {
"type": "string",
"description": "REDUCED is currently the only available option",
"enum": [
"REDUCED"
]
},
"start_date": {
"type": "string"
},
"status": {
"type": "boolean"
},
"supply_type": {
"type": "string",
"description": "Specify whether impressions will be bought and decisioned by the TerminalOne platform. Use 'RTB' for normal strategies that are bought/decisioned in T1. Use 'RMX_API' to use a tag to track media not purchased through TerminalOne.",
"enum": [
"MKT",
"RTB",
"T1_RMX",
"RMX_API"
]
},
"targeting_segment_exclude_op": {
"type": "string"
},
"targeting_segment_include_op": {
"type": "string"
},
"type": {
"type": "string",
"description": "Specify the type of strategy (re-marketing (REM), goal-based optimization (GBO), audience (AUD))",
"enum": [
"REM",
"GBO",
"AUD"
]
},
"updated_on": {
"type": "string"
},
"use_campaign_end": {
"type": "boolean"
},
"use_campaign_start": {
"type": "boolean"
},
"use_mm_freq": {
"type": "boolean",
"description": "Unused legacy frequency cap setting. Must be set to 'off'. To control frequency capping at the campaign level, set the strategy-level frequency_type attribute to 'no-limit' and set a frequency cap on the campaign entity."
},
"use_optimization": {
"type": "boolean",
"description": "Enable's T1 optimization algorithm (defaults to 'off' if unspecified).\n\nrequired if `goal_type!='spend'`"
},
"version": {
"type": "integer"
},
"zone_name": {
"type": "string"
}
}
},
"output-strategy-domain-restriction": {
"example": {
"created_at": "est ullamco minim veniam pariatur",
"domain": "dolor aliqua officia",
"entity_type": "labore",
"id": 1259174,
"name": "mollit ipsum dolor minim",
"rel": "consectetur in qui",
"restriction": "EXCLUDE",
"strategy_id": 10057258,
"target_type": "dolor aliquip sunt ea Lorem",
"updated_on": "cupidatat nostrud officia",
"version": 31898334
},
"properties": {
"created_at": {
"type": "string"
},
"domain": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"id": {
"minimum": 0,
"type": "integer"
},
"name": {
"type": "string"
},
"rel": {
"type": "string"
},
"restriction": {
"enum": [
"INCLUDE",
"EXCLUDE"
],
"type": "string"
},
"strategy_id": {
"minimum": 0,
"type": "integer"
},
"target_type": {
"type": "string"
},
"updated_on": {
"type": "string"
},
"version": {
"minimum": 0,
"type": "integer"
}
},
"title": "Output Strategy Domain Restriction",
"type": "object",
"x-stoplight": {
"id": "output-strategy-domain-restriction",
"name": "Output Strategy Domain Restriction",
"public": true
}
},
"output-strategy-site-list": {
"example": {
"assigned": false,
"campaign_assigned": false,
"created_on": "2017-05-07T14:24:52+0000",
"entity_type": "site_lists_for_strategy",
"filename": "ArtemisAlliance_MQB_Impact_below10.csv",
"id": 103095,
"name": "ArtemisAlliance_MQB_Impact_below10",
"organization_id": 101017,
"restriction": "EXCLUDE",
"sites_count": 855,
"sites_count_domain": 855,
"status": true,
"strategy_assigned": false,
"strategy_id": 2316681,
"updated_on": "2017-05-07T14:24:52+0000",
"version": 0
},
"properties": {
"assigned": {
"type": "boolean"
},
"campaign_assigned": {
"type": "boolean"
},
"created_on": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"filename": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"organization_id": {
"type": "integer"
},
"restriction": {
"type": "string"
},
"sites_count": {
"type": "integer"
},
"sites_count_domain": {
"type": "integer"
},
"status": {
"type": "boolean"
},
"strategy_assigned": {
"type": "boolean"
},
"strategy_id": {
"type": "integer"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Output Strategy Site List",
"type": "object",
"x-stoplight": {
"id": "output-strategy-site-list",
"name": "Output Strategy Site List",
"public": true
}
},
"output-strategy-site-lists": {
"properties": {
"data": {
"items": {
"example": {
"assigned": false,
"campaign_assigned": false,
"created_on": "2017-05-07T14:24:52+0000",
"entity_type": "site_lists_for_strategy",
"filename": "ArtemisAlliance_MQB_Impact_below10.csv",
"id": 103095,
"name": "ArtemisAlliance_MQB_Impact_below10",
"organization_id": 101017,
"restriction": "EXCLUDE",
"sites_count": 855,
"sites_count_domain": 855,
"status": true,
"strategy_assigned": false,
"strategy_id": 2316681,
"updated_on": "2017-05-07T14:24:52+0000",
"version": 0
},
"properties": {
"assigned": {
"type": "boolean"
},
"campaign_assigned": {
"type": "boolean"
},
"created_on": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"filename": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"organization_id": {
"type": "integer"
},
"restriction": {
"type": "string"
},
"sites_count": {
"type": "integer"
},
"sites_count_domain": {
"type": "integer"
},
"status": {
"type": "boolean"
},
"strategy_assigned": {
"type": "boolean"
},
"strategy_id": {
"type": "integer"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Output Strategy Site List",
"type": "object",
"x-stoplight": {
"id": "output-strategy-site-list",
"name": "Output Strategy Site List",
"public": true
}
},
"type": "array"
},
"uuid": {
"type": "string"
},
"meta": {
"example": {
"meta": {
"called_on": "2017-06-02T23:36:05+0000",
"count": 2,
"etag": "5e446abf85396cc1e516a67b2ecd637ee8f8ac34",
"offset": 0,
"status": "ok",
"total_count": 0
}
},
"properties": {
"called_on": {
"type": "string"
},
"count": {
"type": "integer"
},
"etag": {
"type": "string"
},
"offset": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_count": {
"type": "integer"
}
},
"title": "Output Common Meta",
"type": "object",
"x-stoplight": {
"id": "output-common-meta",
"name": "Output Common Meta",
"public": true
}
}
},
"title": "Output Strategy Site Lists",
"type": "object",
"x-stoplight": {
"id": "output-strategy-site-lists",
"name": "Output Strategy Site Lists",
"public": true
}
},
"output-strategy-supplies": {
"example": {
"budget": [
{
"currency_code": "BBD",
"value": 45211449
},
{
"currency_code": "MYR",
"value": 35095015
}
],
"campaign_id": 57944009,
"effective_goal_value": [
{},
{
"currency_code": "ut"
}
],
"frequency_amount": -67621845,
"frequency_interval": "est eu non Duis",
"frequency_type": "exercitation",
"goal_type": "ctr",
"goal_value": [
{
"value": 30107357
},
{},
{},
{
"currency_code": "adipisicing dolor pariatur elit"
}
],
"id": "in sed adipisicing officia sunt",
"impression_pacing_interval": "sint deserunt fugiat",
"max_bid": 31218606,
"min_bid": 76144435,
"name": "eu",
"pacing_amount": [
{
"currency_code": "USD",
"value": 62837980
},
{
"currency_code": "CDF",
"value": 57022846
},
{
"currency_code": "GNF",
"value": 74611370
}
],
"pacing_interval": "laborum ex reprehenderit fugiat ipsum",
"run_on_display": true,
"site_selectiveness": "dolore",
"start_date": "qui fugiat officia occaecat",
"targeting_segment_include_op": "occaecat incididunt",
"type": "qui est culpa",
"version": 7965970,
"zone_name": "non dolore do"
},
"title": "Output Strategy Supplies",
"type": "object",
"x-stoplight": {
"id": "output-strategy-supplies",
"name": "Output Strategy Supplies",
"public": true
},
"properties": {
"data": {
"allOf": [
{
"example": {
"audience_segment_exclude_op": "OR",
"audience_segment_include_op": "OR",
"bid_aggressiveness": 50,
"bid_price_is_media_only": true,
"budget": [
{
"currency_code": "USD",
"value": 1095.43
}
],
"campaign_id": 342332,
"created_on": "2017-03-05T16:23:46+0000",
"currency_code": "USD",
"effective_goal_value": [
{
"currency_code": "USD",
"value": "85.0000"
}
],
"end_date": "2017-11-01T03:59:59+0000",
"entity_type": "strategy",
"frequency_amount": 15,
"frequency_interval": "day",
"frequency_optimization": false,
"frequency_type": "even",
"goal_type": "cpa",
"goal_value": [
{
"currency_code": "USD",
"value": 85
}
],
"id": 2059202,
"impression_pacing_interval": "day",
"impression_pacing_type": "no-limit",
"max_bid": [
{
"currency_code": "USD",
"value": 1.19
}
],
"media_type": "DISPLAY",
"min_bid": [
{
"currency_code": "USD",
"value": 0
}
],
"name": "Q7HGQ1YS000_ZIPs",
"pacing_amount": [
{
"currency_code": "USD",
"value": 0.01
}
],
"pacing_interval": "hour",
"pacing_type": "even",
"pixel_target_expr": "NOT ( [1141991] )",
"run_on_all_exchanges": false,
"run_on_all_pmp": false,
"run_on_display": true,
"run_on_mobile": true,
"run_on_streaming": false,
"site_restriction_transparent_urls": false,
"site_selectiveness": "REDUCED",
"status": true,
"supply_type": "RTB",
"targeting_segment_exclude_op": "OR",
"targeting_segment_include_op": "OR",
"type": "GBO",
"updated_on": "2017-10-18T12:44:52+0000",
"use_campaign_end": false,
"use_campaign_start": true,
"use_mm_freq": false,
"use_optimization": true,
"version": 995,
"zone_name": "America/New_York"
},
"title": "Output Strategy",
"type": "object",
"x-stoplight": {
"id": "output-strategy",
"name": "Output Strategy",
"public": true
},
"properties": {
"audience_segment_exclude_op": {
"type": "string",
"enum": [
"AND",
"OR"
],
"description": "Exclude associated audience segment from targeting"
},
"audience_segment_include_op": {
"type": "string",
"enum": [
"AND",
"OR"
],
"description": "Include associated audience segment in targeting"
},
"bid_aggressiveness": {
"type": "integer",
"description": "Only relevant for strategies with goal_type=’reach’. Reflects the target win rate for bid opportunities that match the strategy’s targeting, e.g. setting bid_aggressiveness to 65% instructs T1 to bid at a level for each impression such that it will win ~65% of the time"
},
"bid_min_devices": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"bid_price_is_media_only": {
"type": "boolean",
"description": "Informs T1 that value entered on the strategygoal_valuemax_bidshould be the amount forthe \"media only\" (bid_price_is_media_only=1)or \"total spend\" (bid_price_is_media_only=0)\ndefault: 1"
},
"budget": {
"type": "array",
"description": "Currency code for this strategy. Read-only; inherited from the parent campaign.",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string",
"description": "Currency code for this strategy. Read-only; inherited from the parent campaign."
},
"value": {
"type": "number"
}
}
}
},
"campaign_id": {
"type": "integer",
"description": "Specify parent campaign of strategy"
},
"created_on": {
"type": "string"
},
"currency_code": {
"type": "string",
"description": "ISO 4217 3-letter currency code"
},
"device_graph_only": {
"type": "boolean"
},
"effective_device_graph_only": {
"type": "integer",
"minimum": 0,
"maximum": 1
},
"effective_goal_value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"end_date": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"exchange_type_for_run_on_all": {
"type": "string",
"description": "",
"enum": [
"ALL_ELIGIBLE",
"SELECTED_ONLY",
"SOURCE"
]
},
"feature_compatibility": {
"type": "string",
"maxLength": 1024
},
"frequency_amount": {
"type": "integer",
"description": "Maximum frequency of impressions per user within interval set on frequency_interval.\n\nrequired if `frequency_type='even'||'asap'`"
},
"frequency_interval": {
"type": "string",
"description": "Interval applicable for frequency_amount.\n\nrequired if `frequency_type='even'||'asap'`\n",
"enum": [
"day",
"hour",
"week",
"month",
"campaign",
"not-applicable"
]
},
"frequency_optimization": {
"type": "boolean",
"description": "Indicates whether the strategy should use a T1 Optimized Frequency Cap. Setting this field to \"Off\" means the user will dictate the flat bid price for each impression."
},
"frequency_type": {
"type": "string",
"enum": [
"even",
"asap",
"no-limit"
]
},
"goal_type": {
"type": "string",
"description": "The type of bid price optimization (if any) that the strategy will use when buying impressions, as well as the performance metric against which performance will be measured. Allowed values: roi, cpa, cpc, ctr, vcr, viewability_rate, vcpm, reach, spend. See table in Campaigns that shows which strategy goal types are allowed for each campaign goal type.",
"enum": [
"roi",
"cpa",
"cpc",
"ctr",
"vcr",
"viewability_rate",
"vcpm",
"reach",
"spend"
]
},
"goal_value": {
"type": "array",
"description": "Target goal value for strategy respective to the goal_type selection.\n\nrequired if `goal_type in ('cpa','cpc','reach','roi', 'vcr', 'ctr')`\n\nIf goal type is `vcr` or `ctr`, goal_value is a percentage.",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"id": {
"type": "integer"
},
"impression_pacing_interval": {
"type": "string",
"description": "Period of time over which impression pacing is to be distributed",
"enum": [
"day",
"hour",
"week",
"month",
"campaign",
"not-applicable"
]
},
"impression_pacing_type": {
"type": "string",
"description": "Type of impression pacing applied to strategy.",
"enum": [
"even",
"asap",
"no-limit"
]
},
"max_bid": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"media_type": {
"type": "string",
"description": "Whether the strategy is a display or video strategy",
"enum": [
"VIDEO",
"DISPLAY"
]
},
"min_bid": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"name": {
"type": "string",
"description": "Descriptive name of strategy"
},
"pacing_amount": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"pacing_interval": {
"type": "string",
"description": "Specify distribution of spend across the pacing_interval"
},
"pacing_type": {
"type": "string",
"description": "Specify distribution of spend across the pacing_interval"
},
"pixel_target_expr": {
"type": "string",
"description": "Specify pixel targeting for the strategy. Poll must be run to obtain available Pixel IDs. To configure Pixel-Targeting, pixels must have previously been generated. See \"API for Event Pixels and Data Pixels\" for more information on creating and obtaining information on Pixels.\n\n( [pixel_id] INCL_COND [pixel_id] ) AND NOT ( [pixel_id EXCL_COND[pixel_id] )1024 characters maximumnote Although theINCL_CONDandEXCL_CONDis not required to be consistent, the conditional logic between all pixels to be included or excluded must be the same.\nmaxLength: 1024"
},
"rmx_strategy": {
"type": "object",
"properties": {
"budget_type": {
"type": "string",
"enum": [
"DOLLARS",
"IMPRESSIONS"
]
},
"created_on": {
"type": "string",
"format": "date-time"
},
"dynamic_pricing_option": {
"type": "string",
"enum": [
"AVERAGE",
"STANDARD",
"WIN",
"SPEND"
]
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"learning_budget_pacing": {
"type": "string",
"enum": [
"ASAP",
"EVEN",
"HOURLY",
"DAILY",
"MONTHLY"
]
},
"learning_slider": {
"type": "integer"
},
"name": {
"type": "string"
},
"pacing": {
"type": "string",
"enum": [
"asap",
"deliver_overall_budget_evenly",
"deliver_remaining_budget_evenly",
"hourly_asap",
"hourly_even",
"daily_asap",
"daily_even",
"monthly_asap",
"monthly_even"
]
},
"price": {
"type": "number"
},
"pricing_type": {
"type": "string",
"enum": [
"CPA",
"CPC",
"CPM",
"DYNAMIC"
]
},
"rel": {
"type": "string"
},
"rmx_push_entity_id": {
"type": "integer"
},
"rmx_push_status": {
"type": "string",
"enum": [
"NEW",
"UPDATED",
"IN_PROGRESS",
"PUSH_OK",
"PUSH_FAILED"
]
},
"roi_cpc_target_ctr": {
"type": "string"
},
"roi_cpc_target_ctr_type": {
"type": "string",
"enum": [
"DOLLARS",
"PERCENT"
]
},
"roi_modifier": {
"type": "number"
},
"roi_target_pixels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"created_on": {
"type": "string",
"format": "date-time"
},
"entity_type": {
"type": "string",
"enum": [
"rmx_strategy_roi_target_pixel"
]
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"pixel_bundle_id": {
"type": "integer"
},
"price": {
"type": "number"
},
"rel": {
"type": "string"
},
"rmx_pixel_type": {
"type": "string",
"enum": [
"CLICK",
"IMPRESSION",
"SEGMENT"
]
},
"rmx_strategy_id": {
"type": "integer"
},
"status": {
"type": "boolean"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "integer"
}
}
}
},
"roi_targets": {
"type": "string",
"enum": [
"NONE",
"CPA",
"CPC"
]
},
"status": {
"type": "boolean"
},
"strategy_id": {
"type": "integer"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "integer"
}
}
},
"run_on_all_exchanges": {
"type": "boolean"
},
"run_on_all_pmp": {
"type": "boolean"
},
"run_on_display": {
"type": "boolean"
},
"run_on_mobile": {
"type": "boolean"
},
"run_on_only_fraud_filtered_exchanges": {
"type": "boolean"
},
"run_on_streaming": {
"type": "boolean"
},
"site_restriction_transparent_urls": {
"type": "boolean"
},
"site_selectiveness": {
"type": "string",
"description": "REDUCED is currently the only available option",
"enum": [
"REDUCED"
]
},
"start_date": {
"type": "string"
},
"status": {
"type": "boolean"
},
"supply_type": {
"type": "string",
"description": "Specify whether impressions will be bought and decisioned by the TerminalOne platform. Use 'RTB' for normal strategies that are bought/decisioned in T1. Use 'RMX_API' to use a tag to track media not purchased through TerminalOne.",
"enum": [
"MKT",
"RTB",
"T1_RMX",
"RMX_API"
]
},
"targeting_segment_exclude_op": {
"type": "string"
},
"targeting_segment_include_op": {
"type": "string"
},
"type": {
"type": "string",
"description": "Specify the type of strategy (re-marketing (REM), goal-based optimization (GBO), audience (AUD))",
"enum": [
"REM",
"GBO",
"AUD"
]
},
"updated_on": {
"type": "string"
},
"use_campaign_end": {
"type": "boolean"
},
"use_campaign_start": {
"type": "boolean"
},
"use_mm_freq": {
"type": "boolean",
"description": "Unused legacy frequency cap setting. Must be set to 'off'. To control frequency capping at the campaign level, set the strategy-level frequency_type attribute to 'no-limit' and set a frequency cap on the campaign entity."
},
"use_optimization": {
"type": "boolean",
"description": "Enable's T1 optimization algorithm (defaults to 'off' if unspecified).\n\nrequired if `goal_type!='spend'`"
},
"version": {
"type": "integer"
},
"zone_name": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"site_placements": {
"type": "array",
"items": {
"allOf": [
{
"example": {
"audience_segment_exclude_op": "OR",
"audience_segment_include_op": "AND",
"bid_aggressiveness": 13,
"bid_price_is_media_only": false,
"budget": [
{
"currency_code": "USD",
"value": 1.43
}
],
"campaign_id": 1234566,
"created_on": "2016-05-04T15:44:54+0000",
"currency_code": "USD",
"effective_goal_value": [
{
"currency_code": "USD",
"value": "93.0000"
}
],
"end_date": "2016-05-06T13:44:49+0000",
"entity_type": "strategy",
"frequency_amount": 3,
"frequency_interval": "month",
"frequency_type": "even",
"goal_type": "reach",
"goal_value": [
{
"currency_code": "USD",
"value": 93
}
],
"id": 1234567,
"max_bid": [
{
"currency_code": "USD",
"value": 1.12
}
],
"media_type": "video",
"name": "strategy with audience segments",
"pacing_amount": [
{
"currency_code": "USD",
"value": 1.93
}
],
"pacing_interval": "hour",
"pacing_type": "even",
"run_on_all_exchanges": true,
"run_on_all_pmp": false,
"run_on_display": true,
"run_on_mobile": true,
"run_on_streaming": false,
"site_restriction_transparent_urls": true,
"site_selectiveness": "REDUCED",
"start_date": "2016-05-05T13:44:49+0000",
"status": false,
"strategy_audience_segments": [
{
"audience_segment_id": 1405158,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g2",
"id": 1132602,
"name": "Strategy Audience Segments #1132602",
"rel": "strategy_audience_segments",
"restriction": "EXCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1358322,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132601,
"name": "Strategy Audience Segments #1132601",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1460324,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132600,
"name": "Strategy Audience Segments #1132600",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
}
],
"supply_type": "RTB",
"targeting_segment_exclude_op": "OR",
"targeting_segment_include_op": "OR",
"type": "REM",
"updated_on": "2016-05-04T15:44:54+0000",
"use_campaign_end": false,
"use_campaign_start": false,
"use_mm_freq": false,
"use_optimization": true,
"version": 2,
"zone_name": "Europe/Paris"
},
"properties": {
"bill_media_to_client": {
"type": "boolean"
},
"deal_source": {
"enum": [
"USER",
"INTERNAL"
],
"type": "string"
},
"display_text": {
"maxLength": 255,
"type": "string"
},
"media_type": {
"enum": [
"display",
"video",
"mobile"
],
"type": "string"
},
"name": {
"maxLength": 64,
"type": "string"
},
"pmp_type": {
"enum": [
"DIRECT",
"PREMIUM"
],
"type": "string"
},
"publisher_site_id": {
"type": "integer"
}
},
"title": "Input Site Placement",
"type": "object",
"x-stoplight": {
"id": "input-site-placement",
"name": "Input Site Placement",
"public": true
}
},
{
"example": {
"created_on": "4838-01-01T02:34:39.905Z",
"id": 1,
"updated_on": "3214-02-18T04:49:20.878Z",
"version": 46559379
},
"properties": {
"created_on": {
"format": "date-time",
"type": "string"
},
"id": {
"minimum": 0,
"type": "integer"
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Output Common",
"type": "object",
"x-stoplight": {
"id": "output_common",
"name": "Output Common",
"public": true
}
}
],
"title": "Output Site Placement",
"x-stoplight": {
"id": "output-site-placement",
"name": "Output Site Placement",
"public": true
}
}
},
"supply_sources": {
"type": "array",
"items": {
"allOf": [
{
"example": {
"created_on": "4838-01-01T02:34:39.905Z",
"id": 1,
"updated_on": "3214-02-18T04:49:20.878Z",
"version": 46559379
},
"properties": {
"created_on": {
"format": "date-time",
"type": "string"
},
"id": {
"minimum": 0,
"type": "integer"
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Output Common",
"type": "object",
"x-stoplight": {
"id": "output_common",
"name": "Output Common",
"public": true
}
},
{
"example": {
"audience_segment_exclude_op": "OR",
"audience_segment_include_op": "AND",
"bid_aggressiveness": 13,
"bid_price_is_media_only": false,
"budget": [
{
"currency_code": "USD",
"value": 1.43
}
],
"campaign_id": 1234566,
"created_on": "2016-05-04T15:44:54+0000",
"currency_code": "USD",
"effective_goal_value": [
{
"currency_code": "USD",
"value": "93.0000"
}
],
"end_date": "2016-05-06T13:44:49+0000",
"entity_type": "strategy",
"frequency_amount": 3,
"frequency_interval": "month",
"frequency_type": "even",
"goal_type": "reach",
"goal_value": [
{
"currency_code": "USD",
"value": 93
}
],
"id": 1234567,
"max_bid": [
{
"currency_code": "USD",
"value": 1.12
}
],
"media_type": "VIDEO",
"name": "strategy with audience segments",
"pacing_amount": [
{
"currency_code": "USD",
"value": 1.93
}
],
"pacing_interval": "hour",
"pacing_type": "even",
"run_on_all_exchanges": true,
"run_on_all_pmp": false,
"run_on_display": true,
"run_on_mobile": true,
"run_on_streaming": false,
"site_restriction_transparent_urls": true,
"site_selectiveness": "REDUCED",
"start_date": "2016-05-05T13:44:49+0000",
"status": false,
"strategy_audience_segments": [
{
"audience_segment_id": 1358322,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132601,
"name": "Strategy Audience Segments #1132601",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1405158,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g2",
"id": 1132602,
"name": "Strategy Audience Segments #1132602",
"rel": "strategy_audience_segments",
"restriction": "EXCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1460324,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132600,
"name": "Strategy Audience Segments #1132600",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
}
],
"supply_type": "RTB",
"targeting_segment_exclude_op": "OR",
"targeting_segment_include_op": "OR",
"type": "REM",
"updated_on": "2016-05-04T15:44:54+0000",
"use_campaign_end": false,
"use_campaign_start": false,
"use_mm_freq": false,
"use_optimization": true,
"version": 2,
"zone_name": "Europe/Paris"
},
"properties": {
"accountable_and_addressable": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"attribution_group": {
"type": "string"
},
"bidder_exchange_identifier": {
"type": "integer"
},
"code": {
"type": "string"
},
"distribute": {
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"fraud_filter": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"has_connected_tv": {
"type": "boolean"
},
"has_desktop_video": {
"type": "boolean"
},
"has_display": {
"type": "boolean"
},
"has_mobile_display": {
"type": "boolean"
},
"has_mobile_video": {
"type": "boolean"
},
"has_video": {
"type": "boolean"
},
"is_proservice": {
"type": "boolean"
},
"mm_safe": {
"type": "boolean"
},
"name": {
"type": "string"
},
"pmp_enabled": {
"type": "boolean"
},
"rel": {
"type": "string"
},
"requires_creative_audit": {
"type": "boolean"
},
"rtb_enabled": {
"type": "boolean"
},
"rtb_type": {
"type": "string"
},
"seat_enabled": {
"type": "boolean"
},
"status": {
"type": "boolean"
},
"supply_type": {
"type": "string"
},
"use_pool": {
"type": "boolean"
}
},
"title": "Input Supply Source",
"type": "object",
"x-stoplight": {
"id": "input-supply-source",
"name": "Input Supply Source",
"public": true
}
}
],
"title": "Output Supply Source",
"x-stoplight": {
"id": "output-supply-source",
"name": "Output Supply Source",
"public": true
}
}
}
}
}
]
},
"uuid": {
"type": "string"
},
"meta": {
"example": {
"meta": {
"called_on": "2017-06-02T23:36:05+0000",
"count": 2,
"etag": "5e446abf85396cc1e516a67b2ecd637ee8f8ac34",
"offset": 0,
"status": "ok",
"total_count": 0
}
},
"properties": {
"called_on": {
"type": "string"
},
"count": {
"type": "integer"
},
"etag": {
"type": "string"
},
"offset": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_count": {
"type": "integer"
}
},
"title": "Output Common Meta",
"type": "object",
"x-stoplight": {
"id": "output-common-meta",
"name": "Output Common Meta",
"public": true
}
}
}
},
"output-strategy-target": {
"example": {
"active": true,
"entity_type": "strategy_target",
"exclude": false,
"id": 2078859,
"name": "Strategy Targets #2078859",
"strategy_id": 969797,
"target_dimension_id": 7,
"target_op": "OR"
},
"properties": {
"active": {
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"exclude": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"strategy_id": {
"type": "integer"
},
"target_dimension_id": {
"type": "integer"
},
"target_op": {
"type": "string"
}
},
"title": "Output Strategy Target",
"type": "object",
"x-stoplight": {
"id": "output-strategy-target",
"name": "Output Strategy Target",
"public": true
}
},
"output-strategy-target-values": {
"example": {
"data": [
{
"active": true,
"entity_type": "strategy_target",
"exclude": false,
"id": 2078859,
"name": "Strategy Targets #2078859",
"strategy_id": 969797,
"target_dimension": {
"code": "REGN",
"entity_type": "target_dimension",
"id": 7,
"name": "Geography",
"rel": "target_dimension"
},
"target_dimension_id": 7,
"target_op": "OR",
"target_values": [
{
"code": "us",
"entity_type": "target_value",
"id": 251,
"is_targetable": true,
"name": "United States",
"rel": "target_values",
"target_dimension_id": 7,
"value": 60231
},
{
"code": "qa",
"entity_type": "target_value",
"id": 205,
"is_targetable": true,
"name": "Qatar",
"rel": "target_values",
"target_dimension_id": 7,
"value": 60185
}
]
},
{
"active": true,
"entity_type": "strategy_target",
"exclude": true,
"id": 2078860,
"name": "Strategy Targets #2078860",
"strategy_id": 969797,
"target_dimension": {
"code": "DVCE",
"entity_type": "target_dimension",
"id": 24,
"name": "Device",
"rel": "target_dimension"
},
"target_dimension_id": 24,
"target_op": "OR",
"target_values": [
{
"code": "Smartphone",
"entity_type": "target_value",
"id": 301524,
"is_targetable": true,
"name": "Smartphone",
"rel": "target_values",
"target_dimension_id": 24,
"value": 41000
},
{
"code": "Other",
"entity_type": "target_value",
"id": 301526,
"is_targetable": true,
"name": "Other Mobile Device",
"rel": "target_values",
"target_dimension_id": 24,
"value": 44000
},
{
"code": "Tablet",
"entity_type": "target_value",
"id": 301525,
"is_targetable": true,
"name": "Tablet",
"rel": "target_values",
"target_dimension_id": 24,
"value": 42000
}
]
}
],
"meta": {
"called_on": "2017-06-02T20:03:00+0000",
"count": 2,
"etag": "5e446abf85396cc1e516a67b2ecd637ee8f8ac34",
"offset": 0,
"status": "ok",
"total_count": 0
}
},
"properties": {
"data": {
"items": {
"allOf": [
{
"example": {
"active": true,
"entity_type": "strategy_target",
"exclude": false,
"id": 2078859,
"name": "Strategy Targets #2078859",
"strategy_id": 969797,
"target_dimension_id": 7,
"target_op": "OR"
},
"properties": {
"active": {
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"exclude": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"strategy_id": {
"type": "integer"
},
"target_dimension_id": {
"type": "integer"
},
"target_op": {
"type": "string"
}
},
"title": "Output Strategy Target",
"type": "object",
"x-stoplight": {
"id": "output-strategy-target",
"name": "Output Strategy Target",
"public": true
}
},
{
"properties": {
"target_dimension": {
"example": {
"code": "REGN",
"entity_type": "target_dimension",
"id": 7,
"name": "Geography",
"rel": "target_dimension"
},
"properties": {
"code": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"rel": {
"type": "string"
}
},
"title": "Output Target Dimension",
"type": "object",
"x-stoplight": {
"id": "output-target-dimension",
"name": "Output Target Dimension",
"public": true
}
}
},
"type": "object"
},
{
"properties": {
"target_values": {
"items": {
"example": {
"code": "Smartphone",
"entity_type": "target_value",
"id": 301524,
"is_targetable": true,
"name": "Smartphone",
"rel": "target_values",
"target_dimension_id": 24,
"value": 41000
},
"properties": {
"code": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_targetable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rel": {
"type": "string"
},
"target_dimension_id": {
"type": "integer"
},
"value": {
"type": "integer"
}
},
"title": "Output Target Value",
"type": "object",
"x-stoplight": {
"id": "output-target-value",
"name": "Output Target Value",
"public": true
}
},
"type": "array"
}
},
"type": "object"
}
]
},
"type": "array"
},
"meta": {
"example": {
"meta": {
"called_on": "2017-06-02T23:36:05+0000",
"count": 2,
"etag": "5e446abf85396cc1e516a67b2ecd637ee8f8ac34",
"offset": 0,
"status": "ok",
"total_count": 0
}
},
"properties": {
"called_on": {
"type": "string"
},
"count": {
"type": "integer"
},
"etag": {
"type": "string"
},
"offset": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_count": {
"type": "integer"
}
},
"title": "Output Common Meta",
"type": "object",
"x-stoplight": {
"id": "output-common-meta",
"name": "Output Common Meta",
"public": true
}
}
},
"title": "Output Strategy Target Values",
"type": "object",
"x-stoplight": {
"id": "output-strategy-target-values",
"name": "Output Strategy Target Values",
"public": true
},
"description": "Note: There should be a UUID in here before meta"
},
"output-supply-source": {
"allOf": [
{
"example": {
"created_on": "4838-01-01T02:34:39.905Z",
"id": 1,
"updated_on": "3214-02-18T04:49:20.878Z",
"version": 46559379
},
"properties": {
"created_on": {
"format": "date-time",
"type": "string"
},
"id": {
"minimum": 0,
"type": "integer"
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Output Common",
"type": "object",
"x-stoplight": {
"id": "output_common",
"name": "Output Common",
"public": true
}
},
{
"example": {
"audience_segment_exclude_op": "OR",
"audience_segment_include_op": "AND",
"bid_aggressiveness": 13,
"bid_price_is_media_only": false,
"budget": [
{
"currency_code": "USD",
"value": 1.43
}
],
"campaign_id": 1234566,
"created_on": "2016-05-04T15:44:54+0000",
"currency_code": "USD",
"effective_goal_value": [
{
"currency_code": "USD",
"value": "93.0000"
}
],
"end_date": "2016-05-06T13:44:49+0000",
"entity_type": "strategy",
"frequency_amount": 3,
"frequency_interval": "month",
"frequency_type": "even",
"goal_type": "reach",
"goal_value": [
{
"currency_code": "USD",
"value": 93
}
],
"id": 1234567,
"max_bid": [
{
"currency_code": "USD",
"value": 1.12
}
],
"media_type": "VIDEO",
"name": "strategy with audience segments",
"pacing_amount": [
{
"currency_code": "USD",
"value": 1.93
}
],
"pacing_interval": "hour",
"pacing_type": "even",
"run_on_all_exchanges": true,
"run_on_all_pmp": false,
"run_on_display": true,
"run_on_mobile": true,
"run_on_streaming": false,
"site_restriction_transparent_urls": true,
"site_selectiveness": "REDUCED",
"start_date": "2016-05-05T13:44:49+0000",
"status": false,
"strategy_audience_segments": [
{
"audience_segment_id": 1358322,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132601,
"name": "Strategy Audience Segments #1132601",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1405158,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g2",
"id": 1132602,
"name": "Strategy Audience Segments #1132602",
"rel": "strategy_audience_segments",
"restriction": "EXCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
},
{
"audience_segment_id": 1460324,
"created_on": "2016-05-04T15:44:55+0000",
"entity_type": "strategy_audience_segment",
"group_identifier": "g1",
"id": 1132600,
"name": "Strategy Audience Segments #1132600",
"rel": "strategy_audience_segments",
"restriction": "INCLUDE",
"strategy_id": 1234567,
"updated_on": "2016-05-04T15:44:55+0000",
"version": 0
}
],
"supply_type": "RTB",
"targeting_segment_exclude_op": "OR",
"targeting_segment_include_op": "OR",
"type": "REM",
"updated_on": "2016-05-04T15:44:54+0000",
"use_campaign_end": false,
"use_campaign_start": false,
"use_mm_freq": false,
"use_optimization": true,
"version": 2,
"zone_name": "Europe/Paris"
},
"properties": {
"accountable_and_addressable": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"attribution_group": {
"type": "string"
},
"bidder_exchange_identifier": {
"type": "integer"
},
"code": {
"type": "string"
},
"distribute": {
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"fraud_filter": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"has_connected_tv": {
"type": "boolean"
},
"has_desktop_video": {
"type": "boolean"
},
"has_display": {
"type": "boolean"
},
"has_mobile_display": {
"type": "boolean"
},
"has_mobile_video": {
"type": "boolean"
},
"has_video": {
"type": "boolean"
},
"is_proservice": {
"type": "boolean"
},
"mm_safe": {
"type": "boolean"
},
"name": {
"type": "string"
},
"pmp_enabled": {
"type": "boolean"
},
"rel": {
"type": "string"
},
"requires_creative_audit": {
"type": "boolean"
},
"rtb_enabled": {
"type": "boolean"
},
"rtb_type": {
"type": "string"
},
"seat_enabled": {
"type": "boolean"
},
"status": {
"type": "boolean"
},
"supply_type": {
"type": "string"
},
"use_pool": {
"type": "boolean"
}
},
"title": "Input Supply Source",
"type": "object",
"x-stoplight": {
"id": "input-supply-source",
"name": "Input Supply Source",
"public": true
}
}
],
"title": "Output Supply Source",
"x-stoplight": {
"id": "output-supply-source",
"name": "Output Supply Source",
"public": true
}
},
"output-target-dimension": {
"example": {
"code": "REGN",
"entity_type": "target_dimension",
"id": 7,
"name": "Geography",
"rel": "target_dimension"
},
"properties": {
"code": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"rel": {
"type": "string"
}
},
"title": "Output Target Dimension",
"type": "object",
"x-stoplight": {
"id": "output-target-dimension",
"name": "Output Target Dimension",
"public": true
}
},
"output-target-value": {
"example": {
"code": "Smartphone",
"entity_type": "target_value",
"id": 301524,
"is_targetable": true,
"name": "Smartphone",
"rel": "target_values",
"target_dimension_id": 24,
"value": 41000
},
"properties": {
"code": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"is_targetable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"rel": {
"type": "string"
},
"target_dimension_id": {
"type": "integer"
},
"value": {
"type": "integer"
}
},
"title": "Output Target Value",
"type": "object",
"x-stoplight": {
"id": "output-target-value",
"name": "Output Target Value",
"public": true
}
},
"output_common": {
"example": {
"created_on": "4838-01-01T02:34:39.905Z",
"id": 1,
"updated_on": "3214-02-18T04:49:20.878Z",
"version": 46559379
},
"properties": {
"created_on": {
"format": "date-time",
"type": "string"
},
"id": {
"minimum": 0,
"type": "integer"
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Output Common",
"type": "object",
"x-stoplight": {
"id": "output_common",
"name": "Output Common",
"public": true
}
},
"output_vendor_contract": {
"allOf": [
{
"example": {
"created_on": "4838-01-01T02:34:39.905Z",
"id": 1,
"updated_on": "3214-02-18T04:49:20.878Z",
"version": 46559379
},
"properties": {
"created_on": {
"format": "date-time",
"type": "string"
},
"id": {
"minimum": 0,
"type": "integer"
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"version": {
"type": "integer"
}
},
"title": "Output Common",
"type": "object",
"x-stoplight": {
"id": "output_common",
"name": "Output Common",
"public": true
}
},
{
"example": {
"campaign_id": 22035223,
"price": 13971235,
"rate_card_type": "CPM",
"use_mm_contract": false,
"vendor_id": 95836163
},
"properties": {
"campaign_id": {
"description": "Once set, this field can not be changed.",
"type": "integer"
},
"price": {
"type": "number"
},
"rate_card_type": {
"enum": [
"CPM",
"FIXED"
],
"type": "string"
},
"use_mm_contract": {
"type": "boolean"
},
"vendor_id": {
"type": "integer"
}
},
"required": [
"vendor_id",
"campaign_id",
"use_mm_contract"
],
"title": "Input Vendor Contract",
"type": "object",
"x-stoplight": {
"id": "input_vendor_contract",
"name": "Input Vendor Contract",
"public": true
}
}
],
"title": "Output Vendor Contract",
"x-stoplight": {
"id": "output_vendor_contract",
"name": "Output Vendor Contract",
"public": true
}
},
"pixel": {
"example": {
"advertiser_id": 109139,
"created_on": "2016-10-17T22:23:30+0000",
"eligible": true,
"entity_type": "pixel_bundle",
"external_identifier": "1187321288",
"id": 1082368,
"keywords": "",
"name": "Example - Homepage",
"pixel_type": "event",
"pricing": "CPM",
"rmx_conversion_minutes": 1,
"rmx_conversion_type": "one",
"rmx_friendly": false,
"rmx_merit": false,
"status": true,
"tag_type": "js",
"tags": "",
"updated_on": "2016-10-17T22:23:30+0000",
"version": 1
},
"properties": {
"advertiser_id": {
"type": "integer"
},
"cost_cpm": {
"type": "number"
},
"cost_pct_cpm": {
"type": "number"
},
"created_on": {
"type": "string"
},
"currency": {
"description": "If set, the currency code for revenue events will be read from the specified URL parameter. Refer to Event Pixels on the T1 knowledge base for more information.\nEither currency or currency_fixed must be set.If set, you must set revenue value currency and revenue parameters must be different.",
"enum": [
"S1",
"S2",
"V1",
"V2"
],
"type": "string"
},
"currency_fixed": {
"default": "USD",
"description": "Fixed currency. Set using ISO 4217 currency code.\nhttps://en.wikipedia.org/wiki/ISO_4217",
"type": "string"
},
"eligible": {
"description": "Indicator eligibility of pixel for targeting",
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"external_identifier": {
"type": "string"
},
"id": {
"type": "integer"
},
"keywords": {
"description": "Optional keyword tag that can be applied to the pixel",
"maxLength": 64,
"type": "string"
},
"name": {
"type": "string"
},
"pixel_type": {
"default": "event",
"enum": [
"data",
"dynamic",
"event",
"segment"
],
"type": "string"
},
"pricing": {
"default": "CPM",
"description": "Pricing model for the data provider\nCPM is recommended. CPTS is not recommended and planned for deprecation.",
"enum": [
"CPM"
],
"type": "string"
},
"revenue": {
"description": "Identifies the pixel URL parameter in which the revenue value will be passed. Refer to Event Pixels on the T1 knowledge base for more information.",
"enum": [
"S1",
"S2",
"V1",
"V2"
],
"type": "string"
},
"rmx_conversion_minutes": {
"type": "integer"
},
"rmx_conversion_type": {
"enum": [
"one"
],
"type": "string"
},
"rmx_friendly": {
"type": "boolean"
},
"rmx_merit": {
"type": "boolean"
},
"rmx_pc_window_minutes": {
"type": "integer"
},
"rmx_pv_window_minutes": {
"type": "integer"
},
"status": {
"default": true,
"description": "Indicates whether a pixel should appear in API calls to the $APIBASE/pixel_bundles endpoint.",
"type": "boolean"
},
"tag_type": {
"description": "Tag type to determine pixel code output",
"enum": [
"dfa",
"iframe",
"image",
"js",
"uat"
],
"type": "string"
},
"tags": {
"type": "string"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"required": [
"advertiser_id",
"eligible",
"name",
"pixel_type",
"tag_type"
],
"title": "Pixel",
"type": "object",
"x-stoplight": {
"id": "pixel",
"name": "Pixel",
"public": true
}
},
"read-singular-campaign": {
"example": {
"ad_server_id": 6,
"advertiser_id": 122631,
"agency_fee_pct": 0,
"connected_id_type": "DETERMINISTIC_ONLY",
"conversion_type": "variable",
"conversion_variable_minutes": 1,
"cost_passthrough_cpm_enabled": false,
"cost_passthrough_percent_enabled": false,
"created_on": "2016-10-19T03:21:53+0000",
"currency_code": "USD",
"dcs_data_is_campaign_level": false,
"end_date": "2016-11-07T23:59:00+0000",
"entity_type": "campaign",
"frequency_interval": "not-applicable",
"frequency_optimization": false,
"frequency_type": "no-limit",
"goal_type": "spend",
"goal_value": [
{
"currency_code": "USD",
"value": 2.5
}
],
"has_custom_attribution": false,
"id": 300982,
"impression_cap_amount": 5000,
"impression_cap_automatic": false,
"impression_cap_type": "asap",
"initial_start_date": "2016-10-19T09:00:00+0000",
"io_name": "",
"io_reference_num": "",
"is_programmatic_guaranteed": false,
"margin_pct": 0,
"minimize_multi_ads": false,
"name": "MobileAds Test (Round 4)",
"override_suspicious_traffic_filter": false,
"pv_pct": 100,
"restrict_targeting_to_deterministic_id": false,
"restrict_targeting_to_same_device_id": false,
"service_type": "SELF",
"spend_cap_amount": [
{
"currency_code": "USD",
"value": 5
}
],
"spend_cap_automatic": false,
"spend_cap_type": "asap",
"start_date": "2016-10-19T09:00:00+0000",
"status": true,
"suspicious_traffic_filter_level": 25,
"total_budget": [
{
"currency_code": "USD",
"value": 40
}
],
"updated_on": "2016-11-01T07:18:56+0000",
"use_default_ad_server": false,
"use_mm_freq": false,
"version": 5,
"zone_name": "Etc/GMT"
},
"title": "Read Singular Campaign",
"type": "object",
"x-stoplight": {
"id": "read-singular-campaign",
"name": "Read Singular Campaign",
"public": true
},
"properties": {
"ad_server_fee": {
"description": "Fee charged by ad serving vendor",
"type": "integer"
},
"ad_server_id": {
"description": "The ID for a third-party ad server",
"type": "integer"
},
"advertiser_id": {
"default": 512312,
"description": "T1 Advertiser ID to which a campaign belongs",
"type": "integer"
},
"agency_fee_pct": {
"type": "integer"
},
"conversion_type": {
"description": "Definition for conversions per user.\n\nevery: Attribute all Merit Events\n\nvariable: Attribute one Merit Event per X minutes - set inconversion_variable_minutes\n\none: Attribute one Merit Event per user (if converstion_type = one, then conversion_variable_minutes (integer) is required).\n\nrequired if `goal_type in ('cpa', 'roi')`\n",
"enum": [
"every",
"one",
"variable"
],
"type": "string"
},
"conversion_variable_minutes": {
"description": "Attribute one Merit Event per X minutes\n\nrequired if `goal_type in ('cpa', 'cpc', 'roi') && conversion_type=one`",
"type": "integer"
},
"created_on": {
"type": "string"
},
"currency_code": {
"default": "USD",
"description": "Currency setting for campaign. All strategies under this value inherit the selected currency. Once the campaign launches, it cannot be switched to another currency (aka existing campaigns are locked into USD, and the currency for a new campaign can't be switched once it has launched).",
"type": "string"
},
"dcs_data_is_campaign_level": {
"type": "boolean"
},
"end_date": {
"description": "Last date of campaign in GMT",
"type": "string"
},
"entity_type": {
"type": "string"
},
"frequency_amount": {
"description": "required if `frequency_type=even||asap`",
"type": "integer"
},
"frequency_interval": {
"description": "required if `frequency_type=even||asap`\n",
"type": "string"
},
"frequency_optimization": {
"type": "boolean"
},
"frequency_type": {
"default": "no-limit",
"description": "Distribute impressions across frequency_interval up to frequency_value evenly or asap.",
"enum": [
"even",
"asap",
"no-limit"
],
"type": "string"
},
"goal_type": {
"type": "string",
"description": "Goal type which campaign performance will be measured",
"enum": [
"cpa",
"cpc",
"ctr",
"reach",
"roi",
"spend",
"vcpm",
"vcr",
"viewability_rate"
]
},
"goal_value": {
"description": "Target goal value for campaign respective to the goal_type selection.\n\nrequired if `goal_type in ('cpa','cpc','reach','roi')`",
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"has_custom_attribution": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"impression_cap_amount": {
"description": "Sets the amount of the available impression budget across the remaining number of days across all their strategies.",
"type": "integer"
},
"impression_cap_automatic": {
"enum": [
"on",
"off",
true,
false
],
"type": [
"string",
"boolean"
]
},
"impression_cap_type": {
"default": "no-limit",
"description": "Type of cap applied to impression budgets.",
"enum": [
"even",
"asap",
"no-limit"
],
"type": "string"
},
"initial_start_date": {
"type": "string"
},
"io_name": {
"description": "Descriptive name of insertion order",
"type": "string"
},
"io_reference_num": {
"description": "Reference number of insertion order",
"type": [
"string",
"integer"
]
},
"margin_pct": {
"description": "Margin percentage to be applied on campaign spend",
"type": "integer"
},
"merit_pixel_id": {
"description": "Specify Merit Pixel that represents conversion or engagement on CPA or CPE type campaigns\n\nREQUIRED if `goal_type in ('cpa','roi')`",
"type": "integer"
},
"minimize_multi_ads": {
"default": false,
"description": "Enabling this field will cause T1 to avoid bidding on more than one ad opportunity on a single page view across. Warning: enabling this setting may limit pacing and reduce the available inventory for the campaigns by not bidding on impression opportunities where the URL is not transparent.",
"type": "boolean"
},
"name": {
"description": "Descriptive name of the campaign",
"type": "string"
},
"override_suspicious_traffic_filter": {
"default": false,
"description": "Enabling this setting allows you to set a campaign-specific level of suspicious traffic filtering using the 'suspicious_traffic_filter_level' property. This will override the T1 default (or organization-level, if configured) suspicious traffic filtering level.",
"type": "boolean"
},
"pc_window_minutes": {
"description": "Post-click window for attribution. Not to be confused with pv_window_minutes.\n\noptional if `goal_type in ('cpa','roi')`\n",
"type": "integer"
},
"pv_pct": {
"description": "Percentage of post-view windows to be used for attribution\n\noptional if `goal_type in ('cpa','roi')`",
"type": "integer"
},
"pv_window_minutes": {
"description": "Post-view window for attribution \n\nrequired if `goal_type in ('cpa','roi')`",
"type": "integer"
},
"restrict_targeting_to_deterministic_id": {
"type": "boolean"
},
"restrict_targeting_to_same_device_id": {
"type": "boolean"
},
"service_type": {
"description": "Indicate whether campaign will be self-service or managed (managed campaigns will incur manage service fee)",
"enum": [
"SELF",
"MANAGED"
],
"type": "string"
},
"spend_cap_amount": {
"description": "only required if`spend_cap_enabled`is true",
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"spend_cap_automatic": {
"description": "Automatically sets the available spend budget across all strategies through the end date of the campaign.",
"type": "boolean"
},
"spend_cap_type": {
"description": "Type of cap applied to spend budgets.",
"enum": [
"even",
"asap",
"no-limit"
],
"type": "string"
},
"start_date": {
"description": "Date on which the campaign will start (GMT)",
"type": "string"
},
"status": {
"default": false,
"description": "Status of the campaign",
"type": [
"boolean",
"string"
]
},
"suspicious_traffic_filter_level": {
"description": "A value between 0 and 100 that determines the sensitivity of T1 suspicious traffic filtering capabilities.If the value = 0, all fraud and suspicious traffic filtering is turned off.It will not take effect if 'override_suspicious_traffic_filter_level' is not set.\n\n",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"total_budget": {
"description": "Allocated budget for the campaign",
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"updated_on": {
"type": "string"
},
"use_default_ad_server": {
"type": "boolean"
},
"use_mm_freq": {
"type": "boolean"
},
"version": {
"type": "integer"
},
"zone_name": {
"default": "America/New_York",
"description": "Indicate the time zone for reporting for the campaign",
"type": "string"
}
},
"required": [
"ad_server_id",
"advertiser_id",
"end_date",
"goal_type",
"goal_value",
"impression_cap_automatic",
"name",
"service_type",
"start_date",
"total_budget"
]
},
"singleResponse": {
"properties": {
"data": {
"example": {
"address_1": "1440 Broadway",
"address_2": "4WTC",
"adx_seat_account_id": 95819908,
"allow_byo_price": true,
"allow_x_agency_pixels": true,
"billing_country_code": "US",
"city": "New York",
"contact_name": "Ian Hummel",
"country": "US",
"created_on": "2010-10-19T16:58:05+0000",
"currency_code": "USD",
"dmp_enabled": "enabled",
"entity_type": "organization",
"id": 100048,
"mm_contact_name": "Ian Hummel",
"name": "ACME Org",
"opt_out_connected_id": true,
"opt_out_connected_id_mathid": false,
"org_type": [
"buyer"
],
"override_suspicious_traffic_filter": false,
"phone": "(347) 420-0116",
"restrict_targeting_to_deterministic_id": true,
"restrict_targeting_to_same_device_id": true,
"service_provider_ccpa": true,
"state": "NY",
"status": true,
"suspicious_traffic_filter_level": 25,
"terminated": false,
"updated_on": "2016-11-03T19:39:12+0000",
"use_evidon_optout": true,
"version": 126,
"zip": "10018"
},
"title": "Organization",
"type": "object",
"x-stoplight": {
"id": "organization",
"name": "Organization",
"public": true
},
"properties": {
"accountable_and_addressable": {
"default": false,
"description": "Pre-release field that may not be visible to all users and that should not be used until official announcement of the feature.",
"type": "boolean"
},
"address_1": {
"type": "string"
},
"address_2": {
"type": "string"
},
"adx_seat_account_id": {
"description": "Passed to ADX upon creative registration so ADX knows which seat we're registering under.",
"type": "integer"
},
"allow_byo_price": {
"type": "boolean"
},
"allow_x_agency_pixels": {
"description": "This field enables the Data Co-op functionality across all the Advertisers under this organization. Cross-Advertiser Pixel Targeting allows Advertisers to target other Advertiser Event Pixels within their Agency and any other similarly enabled Agency under the same Organization.",
"type": "boolean"
},
"billing_country_code": {
"description": "Country code that is used for billing purposes",
"type": "string"
},
"city": {
"type": "string"
},
"connected_id_type": {
"type": "string",
"enum": [
"DETERMINISTIC_FIRST",
"DETERMINISTIC_ONLY"
]
},
"contact_name": {
"description": "This is the primary contact at the organization regarding contract issues.",
"type": "string"
},
"country": {
"type": "string"
},
"created_on": {
"type": "string"
},
"currency_code": {
"description": "Currency code for the campaign budget and spend, as well as billing",
"type": "string"
},
"dmp_enabled": {
"type": "string"
},
"eligibile_for_data_sharing": {
"type": "boolean"
},
"entity_type": {
"type": "string"
},
"facebook": {
"type": "string"
},
"holding_org_id": {
"type": "integer"
},
"id": {
"type": "integer"
},
"linkedin": {
"type": "string"
},
"mm_contact_name": {
"description": "This is the name of the primary internal MediaMath contact of the Organization.",
"type": "string"
},
"name": {
"description": "The Name of the organization with whom the contract is held. This can be an agency holding company, agency, advertiser, network, or other media or data buying entity.",
"type": "string"
},
"opt_out_connected_id": {
"type": "boolean"
},
"opt_out_connected_id_mathid": {
"type": "boolean"
},
"org_type": {
"type": "array",
"items": {
"type": "string"
}
},
"override_suspicious_traffic_filter": {
"description": "Set flag to 'on’ to be able to override default org wide suspicious traffic filter level ",
"type": "boolean"
},
"phone": {
"type": "string"
},
"restrict_targeting_to_deterministic_id": {
"type": "boolean",
"default": true,
"description": "This is a deprecated field, which now only allows the value 'true'."
},
"restrict_targeting_to_same_device_id": {
"type": "boolean"
},
"state": {
"type": "string"
},
"service_provider_ccpa": {
"type": "boolean",
"description": "Represents whether a service provider agreement was signed by the organization owner in accordance with CCPA"
},
"status": {
"description": "of organization (defaults to off if unspecified)",
"type": "boolean"
},
"suspicious_traffic_filter_level": {
"description": "Specify an organization-wide level of suspicious traffic filtering to use. See the Knowledge Base for additional details about this feature. This setting will only take affect if the organization's override_suspicious_traffic_filter property is set to 'on'.\n\nIf override_suspicious_traffic_filter is enabled and suspicious_traffic_filter_level is set to 0, all fraud and suspicious ",
"type": "integer"
},
"terminated": {
"type": "boolean"
},
"updated_on": {
"type": "string"
},
"use_evidon_optout": {
"description": "Set flag to 'on’ to show an opt out button on the organization's ads (additional CPM fee will apply when on) ",
"type": "boolean"
},
"version": {
"type": "integer"
},
"zip": {
"type": "string"
}
}
},
"meta": {
"description": "Meta response for all API endpoints",
"properties": {
"called_on": {
"type": "string"
},
"count": {
"type": "integer"
},
"etag": {
"type": "string"
},
"offset": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_count": {
"type": "integer"
}
},
"title": "meta",
"type": "object",
"x-stoplight": {
"id": "t1-meta",
"name": "meta",
"public": true
}
}
},
"title": "singleResponse",
"type": "object",
"x-stoplight": {
"id": "singleResponse",
"name": "singleResponse",
"public": true
}
},
"site-list": {
"example": {
"created_on": "2016-03-17T17:17:28+0000",
"entity_type": "site_list",
"filename": "Book1.csv",
"id": 69140,
"name": "app_test",
"organization_id": 100048,
"restriction": "INCLUDE",
"sites_count": 34,
"sites_count_app": 34,
"status": true,
"updated_on": "2016-03-17T17:17:28+0000",
"version": 0
},
"properties": {
"created_on": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"filename": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"organization_id": {
"type": "integer"
},
"restriction": {
"type": "string"
},
"sites_count": {
"type": "integer"
},
"sites_count_app": {
"type": "integer"
},
"status": {
"type": "boolean"
},
"updated_on": {
"type": "string"
},
"version": {
"type": "integer"
}
},
"required": [
"filename",
"name",
"organization_id",
"status"
],
"title": "Site List",
"type": "object",
"x-stoplight": {
"id": "site-list",
"name": "Site List",
"public": true
}
},
"strategy-concept": {
"example": {
"concept_id": 1127836,
"created_on": "2017-03-16T20:06:29+0000",
"entity_type": "strategy_concept",
"id": 4955635,
"name": "Strategy Concepts #4955635",
"status": true,
"strategy_id": 2126063,
"updated_on": "2017-03-16T20:06:29+0000",
"version": 0,
"weighting": "NONE"
},
"title": "Strategy Concept",
"type": "object",
"x-stoplight": {
"id": "strategy-concept",
"name": "Strategy Concept",
"public": true
},
"properties": {
"concept_id": {
"minimum": 0,
"type": "integer"
},
"created_on": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"id": {
"minimum": 0,
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"type": "boolean"
},
"strategy_id": {
"minimum": 0,
"type": "integer"
},
"updated_on": {
"type": "string"
},
"version": {
"minimum": 0,
"type": "integer"
},
"weighting": {
"type": "string"
}
}
},
"t1-meta": {
"description": "Meta response for all API endpoints",
"properties": {
"called_on": {
"type": "string"
},
"count": {
"type": "integer"
},
"etag": {
"type": "string"
},
"offset": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_count": {
"type": "integer"
}
},
"title": "meta",
"type": "object",
"x-stoplight": {
"id": "t1-meta",
"name": "meta",
"public": true
}
},
"update-audience-targeting": {
"title": "Update Audience Targeting",
"type": "object",
"x-stoplight": {
"id": "update-audience-targeting",
"name": "Update Audience Targeting",
"public": true
},
"properties": {
"exclude_op": {
"type": "string",
"enum": [
"OR"
]
},
"include_op": {
"type": "string",
"enum": [
"AND"
]
},
"segments.x.group_identifier": {
"description": "Usually automatically assigned, provides a mechanism for advanced grouping of related segments ",
"maxLength": 18,
"type": "string"
},
"segments.x.id": {
"description": "Add audience segment to strategy if positive id is supplied. Delete audience segment from strategy if negative.",
"type": "integer"
},
"segments.x.restriction": {
"enum": [
"INCLUDE",
"EXCLUDE"
],
"type": "string"
}
},
"description": "When updating audience segment targeting, calls are made to:\n* .../api/v2.0/strategies/[strategy_id]/audience_segments\n\nWhile viewing expected audience sizing and cost calculations, calls are made to:\n* .../api/v2.0/strategies/[strategy_id]/audience_segments/size\n* .../api/v2.0/strategies/[strategy_id]/audience_segments/cpm\n"
},
"update-budget-flight": {
"properties": {
"end_date": {
"format": "date-time",
"type": "string"
},
"start_date": {
"format": "date-time",
"type": "string"
},
"total_budget": {
"type": "number"
},
"total_impression_budget": {
"type": "integer"
},
"version": {
"type": "integer"
}
},
"title": "Update Budget Flight",
"type": "object",
"x-stoplight": {
"id": "update-budget-flight",
"name": "Update Budget Flight",
"public": true
}
},
"update-contextual-targeting": {
"properties": {
"exclude_op": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"include_op": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"segments.x.id": {
"description": "Add contextual segment to strategy if positive id is supplied. Delete contextual segment from strategy if negative.",
"type": "integer"
},
"segments.x.operator": {
"enum": [
"AND",
"OR"
],
"type": "string"
},
"segments.x.restriction": {
"enum": [
"INCLUDE",
"EXCLUDE"
],
"type": "string"
},
"segments.x.user_cpm": {
"type": "string"
}
},
"title": "Update Contextual Targeting",
"type": "object",
"x-stoplight": {
"id": "update-contextual-targeting",
"name": "Update Contextual Targeting",
"public": true
}
},
"update-strategy-concepts": {
"properties": {
"concepts.[x].id": {
"type": "integer"
},
"concepts.[x].percent": {
"maximum": 100,
"minimum": 0,
"type": "number"
},
"concepts.[x].weighting": {
"enum": [
"IMPRESSION",
"BUDGET"
],
"type": "string"
}
},
"required": [
"concepts.[x].id",
"concepts.[x].percent",
"concepts.[x].weighting"
],
"title": "Update Strategy Concepts",
"type": "object",
"x-stoplight": {
"id": "update-strategy-concepts",
"name": "Update Strategy Concepts",
"public": true
}
},
"update-vendor-contract": {
"example": {
"campaign_id": 22035223,
"price": 13971235,
"rate_card_type": "CPM",
"use_mm_contract": false,
"vendor_id": 95836163
},
"properties": {
"campaign_id": {
"description": "Once set, this field can not be changed.",
"minimum": 0,
"type": "integer"
},
"price": {
"type": "number"
},
"rate_card_type": {
"enum": [
"CPM",
"FIXED"
],
"type": "string"
},
"use_mm_contract": {
"type": "boolean"
},
"vendor_id": {
"minimum": 0,
"type": "integer"
},
"version": {
"type": "integer"
}
},
"title": "Update Vendor Contract",
"type": "object",
"x-stoplight": {
"id": "update-vendor-contract",
"name": "Update Vendor Contract",
"public": true
}
},
"atomic-creative2": {
"type": "object",
"title": "Atomic Creative2",
"description": "Atomic Creative2",
"properties": {
"ad_format": {
"type": "string",
"enum": [
"DISPLAY",
"EXPANDABLE",
"MOBILE"
]
},
"advertiser_id": {
"type": "integer"
},
"approval_status": {
"type": "string",
"enum": [
"PENDING",
"APPROVED",
"REJECTED"
]
},
"built": {
"type": "integer"
},
"built_by_user_id": {
"type": "integer"
},
"concept_id": {
"type": "integer"
},
"created_on": {
"type": "string",
"format": "date-time"
},
"expansion_direction": {
"type": "string"
},
"expansion_trigger": {
"type": "string",
"enum": [
"AUTOMATIC",
"MOUSEOVER",
"CLICK"
]
},
"external_identifier": {
"type": "string"
},
"file_type": {
"type": "string",
"enum": [
"gif",
"html5",
"jpg",
"png",
"swf",
"tif",
"tiff",
"unknown",
"vast",
"zip"
]
},
"has_sound": {
"type": "integer"
},
"height": {
"type": "integer"
},
"id": {
"type": "string"
},
"is_https": {
"type": "integer"
},
"is_mraid": {
"type": "integer"
},
"is_multi_creative": {
"type": "integer"
},
"last_modified": {
"type": "string",
"format": "date-time"
},
"last_payload_modified": {
"type": "string",
"format": "date-time"
},
"media_type": {
"type": "string",
"enum": [
"DISPLAY",
"VIDEO",
"MOBILE"
]
},
"name": {
"type": "string"
},
"rejected_reason": {
"type": "string"
},
"rich_media": {
"type": "integer"
},
"sizmek_creative_status": {
"type": "string"
},
"sizmek_tag_status": {
"type": "string"
},
"status": {
"type": "integer"
},
"t1as": {
"type": "integer"
},
"tag": {
"type": "string"
},
"tag_type": {
"type": "string",
"enum": [
"FRAME_SCRIPT",
"SCRIPT_NOSCRIPT",
"IFRAME_SCRIPT",
"IFRAME_NOSCRIPT",
"IFRAME_IMG",
"SCRIPT",
"NOSCRIPT",
"IFRAME",
"IMG"
]
},
"tpas_ad_tag_name": {
"type": "string"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"vast_version": {
"type": "integer"
},
"width": {
"type": "integer"
}
}
},
"settings": {
"type": "object",
"properties": {},
"title": "Settings Endpoint",
"description": "The entities (creatives,organizations,advertisers,agencies,campaigns) have settings endpoints. \n\nA settings endpoint allows users to define arbitrary key-value pairs in order to change components of their configuration. Though arbitrary keys are allowed only defined values will create an effect. "
},
"new-model": {
"type": "object",
"properties": {}
},
"new-model-1": {
"type": "object",
"properties": {}
},
"Meta-3": {
"type": "object",
"properties": {
"called_on": {
"type": "string"
},
"etag": {
"type": "string"
},
"status": {
"type": "string"
}
},
"title": "Meta-3"
},
"Meta-7": {
"type": "object",
"properties": {
"called_on": {
"type": "string"
},
"count": {
"type": "integer"
},
"etag": {
"type": "string"
},
"next_page": {
"type": "string"
},
"offset": {
"type": "integer"
},
"status": {
"type": "string"
},
"total_count": {
"type": "integer"
}
}
},
"new-model-2": {
"example": {
"entity_type": "user",
"id": 9,
"name": "TerminalOne"
},
"properties": {
"access_internal_fees": {
"type": "boolean"
},
"active": {
"type": "boolean"
},
"created_on": {
"format": "date-time",
"type": "string"
},
"creator_id": {
"type": "integer"
},
"edit_campaigns": {
"type": "boolean"
},
"edit_data_definition": {
"type": "boolean"
},
"edit_margins_and_performance": {
"type": "boolean"
},
"edit_segments": {
"type": "boolean"
},
"email": {
"format": "email",
"type": "string"
},
"entity_type": {
"enum": [
"user"
],
"type": "string"
},
"fax": {
"type": "string"
},
"first_name": {
"type": "string"
},
"id": {
"type": "integer"
},
"labs_enable_rmx": {
"type": "boolean"
},
"last_login_on": {
"type": "string"
},
"last_name": {
"type": "string"
},
"link_ldap": {
"type": "boolean"
},
"link_saml": {
"type": "boolean"
},
"mobile": {
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"password_reset_sent": {
"format": "date-time",
"type": "string"
},
"password_reset_token": {
"type": "string"
},
"phone": {
"type": "string"
},
"role": {
"enum": [
"ADMIN",
"MANAGER",
"REPORTER"
],
"type": "string"
},
"scope": {
"enum": [
"GLOBAL",
"SELECT"
],
"type": "string"
},
"sso_auth_sent": {
"format": "date-time",
"type": "string"
},
"sso_auth_token": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"enum": [
"ADVERTISER",
"AGENCY",
"INTERNAL",
"VPAN"
],
"type": "string"
},
"updated_on": {
"format": "date-time",
"type": "string"
},
"username": {
"type": "string"
},
"version": {
"type": "integer"
},
"view_data_definition": {
"type": "boolean"
},
"view_dmp_reports": {
"type": "boolean"
},
"view_organizations": {
"type": "boolean"
},
"view_segments": {
"type": "boolean"
}
},
"title": "User",
"type": "object",
"x-stoplight": {
"id": "user",
"name": "user",
"public": true
}
},
"strategy": {
"example": {
"audience_segment_exclude_op": "OR",
"audience_segment_include_op": "OR",
"bid_aggressiveness": 50,
"bid_price_is_media_only": true,
"budget": [
{
"currency_code": "USD",
"value": 1095.43
}
],
"campaign_id": 342332,
"created_on": "2017-03-05T16:23:46+0000",
"currency_code": "USD",
"effective_goal_value": [
{
"currency_code": "USD",
"value": "85.0000"
}
],
"end_date": "2017-11-01T03:59:59+0000",
"entity_type": "strategy",
"frequency_amount": 15,
"frequency_interval": "day",
"frequency_optimization": false,
"frequency_type": "even",
"goal_type": "cpa",
"goal_value": [
{
"currency_code": "USD",
"value": 85
}
],
"id": 2059202,
"impression_pacing_interval": "day",
"impression_pacing_type": "no-limit",
"max_bid": [
{
"currency_code": "USD",
"value": 1.19
}
],
"media_type": "DISPLAY",
"min_bid": [
{
"currency_code": "USD",
"value": 0
}
],
"name": "Q7HGQ1YS000_ZIPs",
"pacing_amount": [
{
"currency_code": "USD",
"value": 0.01
}
],
"pacing_interval": "hour",
"pacing_type": "even",
"pixel_target_expr": "NOT ( [1141991] )",
"run_on_all_exchanges": false,
"run_on_all_pmp": false,
"run_on_display": true,
"run_on_mobile": true,
"run_on_streaming": false,
"site_restriction_transparent_urls": false,
"site_selectiveness": "REDUCED",
"status": true,
"supply_type": "RTB",
"targeting_segment_exclude_op": "OR",
"targeting_segment_include_op": "OR",
"type": "GBO",
"updated_on": "2017-10-18T12:44:52+0000",
"use_campaign_end": false,
"use_campaign_start": true,
"use_mm_freq": false,
"use_optimization": true,
"version": 995,
"zone_name": "America/New_York"
},
"title": "Strategy",
"type": "object",
"x-stoplight": {
"id": "strategy",
"name": "Strategy",
"public": true
},
"properties": {
"ads_txt_verified": {
"type": "string",
"description": "Specify parent campaign of strategy",
"enum": [
"ANY",
"AUTHORIZED_DIRECT_ONLY",
"AUTHORIZED_ONLY"
]
},
"audience_segment_exclude_op": {
"type": "string",
"enum": [
"AND",
"OR"
],
"description": "Exclude associated audience segment from targeting"
},
"audience_segment_include_op": {
"type": "string",
"enum": [
"AND",
"OR"
],
"description": "Include associated audience segment in targeting"
},
"bid_aggressiveness": {
"type": "integer",
"description": "Only relevant for strategies with goal_type=’reach’. Reflects the target win rate for bid opportunities that match the strategy’s targeting, e.g. setting bid_aggressiveness to 65% instructs T1 to bid at a level for each impression such that it will win ~65% of the time"
},
"bid_min_devices": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"bid_price_is_media_only": {
"type": "boolean",
"description": "Informs T1 that value entered on the strategygoal_valuemax_bidshould be the amount forthe \"media only\" (bid_price_is_media_only=1)or \"total spend\" (bid_price_is_media_only=0)\ndefault: 1"
},
"budget": {
"type": "array",
"description": "Currency code for this strategy. Read-only; inherited from the parent campaign.",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string",
"description": "Currency code for this strategy. Read-only; inherited from the parent campaign."
},
"value": {
"type": "number"
}
}
}
},
"campaign_id": {
"type": "integer",
"description": "Specify parent campaign of strategy"
},
"cost_passthrough_cpm_enabled": {
"type": "boolean"
},
"cost_passthrough_cpm_value": {
"type": "number"
},
"cost_passthrough_percent_enabled": {
"type": "boolean"
},
"cost_passthrough_percent_value": {
"type": "number"
},
"created_on": {
"type": "string"
},
"currency_code": {
"type": "string",
"description": "ISO 4217 3-letter currency code"
},
"description": {
"type": "string"
},
"device_graph_only": {
"type": "boolean"
},
"effective_ads_txt_verified": {
"type": "string",
"enum": [
"ANY",
"AUTHORIZED_ONLY",
"AUTHORIZED_DIRECT_ONLY"
]
},
"effective_device_graph_only": {
"type": "integer",
"minimum": 0,
"maximum": 1
},
"effective_goal_value": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"end_date": {
"type": "string"
},
"entity_type": {
"type": "string"
},
"exchange_type_for_run_on_all": {
"type": "string",
"description": "",
"enum": [
"ALL_ELIGIBLE",
"SELECTED_ONLY",
"SOURCE"
]
},
"feature_compatibility": {
"type": "string",
"maxLength": 1024
},
"frequency_amount": {
"type": "integer",
"description": "Maximum frequency of impressions per user within interval set on frequency_interval.\n\nrequired if `frequency_type='even'||'asap'`"
},
"frequency_interval": {
"type": "string",
"description": "Interval applicable for frequency_amount.\n\nrequired if `frequency_type='even'||'asap'`\n",
"enum": [
"day",
"hour",
"week",
"month",
"campaign",
"not-applicable"
]
},
"frequency_optimization": {
"type": "boolean",
"description": "Indicates whether the strategy should use a T1 Optimized Frequency Cap. Setting this field to \"Off\" means the user will dictate the flat bid price for each impression."
},
"frequency_type": {
"type": "string",
"enum": [
"even",
"asap",
"no-limit"
]
},
"goal_type": {
"type": "string",
"description": "The type of bid price optimization (if any) that the strategy will use when buying impressions, as well as the performance metric against which performance will be measured. Allowed values: roi, cpa, cpc, ctr, vcr, viewability_rate, vcpm, reach, spend. See table in Campaigns that shows which strategy goal types are allowed for each campaign goal type.",
"enum": [
"roi",
"cpa",
"cpc",
"ctr",
"vcr",
"viewability_rate",
"vcpm",
"reach",
"spend"
]
},
"goal_value": {
"type": "array",
"description": "Target goal value for strategy respective to the goal_type selection.\n\nrequired if `goal_type in ('cpa','cpc','reach','roi', 'vcr', 'ctr')`\n\nIf goal type is `vcr` or `ctr`, goal_value is a percentage.",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"id": {
"type": "integer"
},
"impression_pacing_amount": {
"type": "integer",
"description": "Value related to the pacing interval over which impression pacing is to be distributed"
},
"impression_pacing_interval": {
"type": "string",
"description": "Period of time over which impression pacing is to be distributed",
"enum": [
"day",
"hour",
"week",
"month",
"campaign",
"not-applicable"
]
},
"impression_pacing_type": {
"type": "string",
"description": "Type of impression pacing applied to strategy.",
"enum": [
"even",
"asap",
"no-limit"
]
},
"max_bid": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"max_bid_wm": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"media_type": {
"type": "string",
"description": "Whether the strategy is a display or video strategy",
"enum": [
"VIDEO",
"DISPLAY"
]
},
"min_bid": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
},
"name": {
"type": "string",
"description": "Descriptive name of strategy"
},
"pacing_amount": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
}
}
},
"pacing_interval": {
"type": "string",
"description": "Specify distribution of spend across the pacing_interval"
},
"pacing_optimization_amount": {
"type": "number",
"description": "Specify value related to pacing_interval optimization type"
},
"pacing_optimization_type": {
"type": "string",
"description": "Specify type of spend across the pacing_interval optimization: impression or monterary"
},
"pacing_type": {
"type": "string",
"description": "Specify distribution of spend across the pacing_interval"
},
"pixel_target_expr": {
"type": "string",
"description": "Specify pixel targeting for the strategy. Poll must be run to obtain available Pixel IDs. To configure Pixel-Targeting, pixels must have previously been generated. See \"API for Event Pixels and Data Pixels\" for more information on creating and obtaining information on Pixels.\n\n( [pixel_id] INCL_COND [pixel_id] ) AND NOT ( [pixel_id EXCL_COND[pixel_id] )1024 characters maximumnote Although theINCL_CONDandEXCL_CONDis not required to be consistent, the conditional logic between all pixels to be included or excluded must be the same.\nmaxLength: 1024"
},
"rmx_strategy": {
"type": "object",
"properties": {
"budget": {
"type": "number"
},
"budget_type": {
"type": "string",
"enum": [
"DOLLARS",
"IMPRESSIONS"
]
},
"cpa_pixel_bundle_id": {
"type": "integer"
},
"cpa_pixel_type": {
"type": "string",
"enum": [
"CLICK",
"IMPRESSION"
]
},
"created_on": {
"type": "string",
"format": "date-time"
},
"dynamic_pricing_option": {
"type": "string",
"enum": [
"AVERAGE",
"STANDARD",
"WIN",
"SPEND"
]
},
"entity_type": {
"type": "string"
},
"id": {
"type": "integer"
},
"imp_budget": {
"type": "number"
},
"learning_budget": {
"type": "number"
},
"learning_budget_pacing": {
"type": "string",
"enum": [
"ASAP",
"EVEN",
"HOURLY",
"DAILY",
"MONTHLY"
]
},
"learning_slider": {
"type": "integer"
},
"name": {
"type": "string"
},
"pacing": {
"type": "string",
"enum": [
"asap",
"deliver_overall_budget_evenly",
"deliver_remaining_budget_evenly",
"hourly_asap",
"hourly_even",
"daily_asap",
"daily_even",
"monthly_asap",
"monthly_even"
]
},
"price": {
"type": "number"
},
"pricing_type": {
"type": "string",
"enum": [
"CPA",
"CPC",
"CPM",
"DYNAMIC"
]
},
"rel": {
"type": "string"
},
"rmxapi_io_identifier": {
"type": "integer"
},
"rmxapi_li_identifier": {
"type": "integer"
},
"rmx_push_entity_id": {
"type": "integer"
},
"rmx_push_status": {
"type": "string",
"enum": [
"NEW",
"UPDATED",
"IN_PROGRESS",
"PUSH_OK",
"PUSH_FAILED"
]
},
"roi_cpc_target_ctr": {
"type": "string"
},
"roi_cpc_target_ctr_type": {
"type": "string",
"enum": [
"DOLLARS",
"PERCENT"
]
},
"roi_modifier": {
"type": "number"
},
"roi_target_pixels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"created_on": {
"type": "string",
"format": "date-time"
},
"entity_type": {
"type": "string",
"enum": [
"rmx_strategy_roi_target_pixel"
]
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"pixel_bundle_id": {
"type": "integer"
},
"price": {
"type": "number"
},
"rel": {
"type": "string"
},
"rmx_pixel_type": {
"type": "string",
"enum": [
"CLICK",
"IMPRESSION",
"SEGMENT"
]
},
"rmx_strategy_id": {
"type": "integer"
},
"status": {
"type": "boolean"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "integer"
}
}
}
},
"roi_targets": {
"type": "string",
"enum": [
"NONE",
"CPA",
"CPC"
]
},
"status": {
"type": "boolean"
},
"strategy_id": {
"type": "integer"
},
"updated_on": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "integer"
}
}
},
"roi_target": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"value": {
"type": "number"
}
}
},
"run_on_all_exchanges": {
"type": "boolean"
},
"run_on_all_pmp": {
"type": "boolean"
},
"run_on_display": {
"type": "boolean"
},
"run_on_mobile": {
"type": "boolean"
},
"run_on_only_fraud_filtered_exchanges": {
"type": "boolean"
},
"run_on_streaming": {
"type": "boolean"
},
"site_restriction_transparent_urls": {
"type": "boolean"
},
"site_selectiveness": {
"type": "string",
"description": "REDUCED is currently the only available option",
"enum": [
"REDUCED"
]
},
"source_only": {
"type": "boolean"
},
"start_date": {
"type": "string"
},
"status": {
"type": "boolean"
},
"supply_type": {
"type": "string",
"description": "Specify whether impressions will be bought and decisioned by the TerminalOne platform. Use 'RTB' for normal strategies that are bought/decisioned in T1. Use 'RMX_API' to use a tag to track media not purchased through TerminalOne.",
"enum": [
"MKT",
"RTB",
"T1_RMX",
"RMX_API"
]
},
"targeting_segment_exclude_op": {
"type": "string"
},
"targeting_segment_include_op": {
"type": "string"
},
"type": {
"type": "string",
"description": "Specify the type of strategy (re-marketing (REM), goal-based optimization (GBO), audience (AUD))",
"enum": [
"REM",
"GBO",
"AUD"
]
},
"updated_on": {
"type": "string"
},
"use_bid_shading": {
"type": "boolean"
},
"use_campaign_end": {
"type": "boolean"
},
"use_campaign_start": {
"type": "boolean"
},
"use_mm_freq": {
"type": "boolean",
"description": "Unused legacy frequency cap setting. Must be set to 'off'. To control frequency capping at the campaign level, set the strategy-level frequency_type attribute to 'no-limit' and set a frequency cap on the campaign entity."
},
"use_optimization": {
"type": "boolean",
"description": "Enable's T1 optimization algorithm (defaults to 'off' if unspecified).\n\nrequired if `goal_type!='spend'`"
},
"version": {
"type": "integer",
"description": "This number increments whenever the strategy is updated. Do not define it upon creation."
},
"value": {
"type": "integer"
},
"zone_name": {
"type": "string"
}
}
}
},
"host": "api.mediamath.com",
"info": {
"description": "# Entity Hierarchy\n\n