{ "basePath": "/api/v2.0", "definitions": { "ad_server": { "example": { "entity_type": "ad_server", "id": 9, "name": "TerminalOne" }, "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "title": "Ad Server", "type": "object", "x-stoplight": { "id": "ad_server", "name": "ad_server", "public": true } }, "advertiser": { "example": { "ad_server_fee": 34190098, "ad_server_id": 59910688, "agency_id": 68414621, "allow_x_strat_optimization": true, "billing_contact_id": -91849290, "created_on": "Excepteur non et in commodo", "domain": "magna ut labore", "frequency_amount": -56525012, "name": "nostrud eu ea dolor", "updated_on": "esse commodo aliquip id", "vertical_id": -66867024 }, "properties": { "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" }, "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": { "description": "Interval applicable for frequency_amount.\n\nRequired if `frequency_typeis even or asap`.", "enum": [ "hour", "day", "week", "month", "not-applicable" ], "type": "string" }, "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": "Enter id for the Advertiser's Vertical - see Advertiser Vertical table below", "type": "integer" } }, "required": [ "agency_id", "domain", "ad_server_id", "vertical_id", "name" ], "title": "Advertiser", "type": "object", "x-stoplight": { "id": "advertiser", "name": "Advertiser", "public": true } }, "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 }, "properties": { "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" }, "created_on": { "type": "string" }, "dmp_enabled": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "status": { "type": "boolean" }, "updated_on": { "type": "string" }, "version": { "type": "integer" } }, "title": "Agency", "type": "object", "x-stoplight": { "id": "agency", "name": "Agency", "public": true } }, "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" }, "properties": { "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "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", "type": "string" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "is_relevant": { "type": "boolean" }, "name": { "type": "string" }, "start_date": { "type": "string" }, "total_budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "updated_on": { "type": "string" }, "version": { "type": "integer" }, "zone_name": { "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", "type": "string" } }, "title": "Budget Flight", "type": "object", "x-stoplight": { "id": "budget-flight", "name": "Budget Flight", "public": true } }, "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": [ { "collection": "strategies", "tag": "details" }, { "add": { "collection": "concepts", "id": 100001 }, "collection": "strategies", "tag": "concepts" }, { "add": { "collection": "concepts", "id": 100002 }, "collection": "strategies", "tag": "concepts" }, { "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", "overwrite": { "collection": "target_values", "exclude": false, "id": 100001 }, "tag": "location" }, { "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": true, "id": 100002 }, "tag": "location" }, { "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": false, "id": 100003 }, "tag": "location" } ], "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" }, "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", "items": {}, "type": [ "array", "number" ] }, "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", "items": {}, "type": [ "array", "integer" ] }, "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", "items": {}, "type": [ "array", "integer" ] }, "media_type": { "description": "Whether the strategy is a display or video strategy.", "enum": [ "DISPLAY", "VIDEO" ], "type": "string" }, "min_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "description": "Descriptive name of strategy", "maxLength": 64, "type": "string" }, "pacing_amount": { "description": "Specify max amount strategy can spend within pacing_interval", "items": {}, "type": [ "array", "integer" ] }, "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": { "default": "REDUCED", "description": "Specifies whether to use a T1 site list\nREDUCED: TerminalOne blocklist applied\nMATHSELECT_250: MathSelect250 whitelist\nEXCLUDE_UGC\nALL: Unfiltered exchange inventory", "enum": [ "MATHSELECT_250", "REDUCED", "EXCLUDE_UGC", "ALL" ], "type": "string" }, "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" } }, "title": "Bulk Editing Actions Update", "type": "object", "x-stoplight": { "id": "bulk-editing-actions-update", "name": "Bulk Editing Actions Update", "public": true } }, "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, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "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", "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": { "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": 512321, "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", "description": "Boolean values must be 'on', '1', '0', or 'off'" }, "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": [ "even", "asap", "no-limit" ], "type": "string" }, "goal_type": { "description": "Goal type which campaign performance will be measured", "enum": [ "roi", "cpa", "cpc", "reach", "spend", "vcr", "ctr" ], "type": "string" }, "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`, goal_value is a percentage.", "type": "string" }, "has_custom_attribution": { "description": "", "type": "boolean" }, "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": [ "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" ] }, "is_programmatic_guaranteed": { "type": "string", "description": "Sets the campaign as a Programmatic Guaranteed campaign. Once set for a campaign, it cannot be changed", "enum": [ "on", "off", 1, 0 ] }, "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": "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.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "restrict_targeting_to_same_device_id": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "spend_cap_automatic": { "description": "Automatically sets the available spend budget across all strategies through the end date of the campaign.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "updated_on": { "type": "string" }, "use_default_ad_server": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "use_mm_freq": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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" ] }, "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-03-21T00: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 } ] }, "properties": { "adaptive_segment_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "contract_number": { "type": "integer" }, "currency_code": { "type": "string" }, "effective_end_date": { "type": "string" }, "effective_start_date": { "type": "string" }, "entity_type": { "type": "string" }, "evidon_privacy_cost_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "exclude_agency_margin": { "type": "boolean" }, "external_media_tracking_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "fbx_dynamic_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "managed_service_fee_pct": { "type": "integer" }, "managed_service_fee_unit": { "type": "string" }, "name": { "type": "string" }, "optimization_fee_pct": { "type": "integer" }, "optimization_fee_unit": { "type": "string" }, "organization_id": { "type": "integer" }, "peer39_channel_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_custom_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_quality_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_safety_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "platform_access_fee_pct": { "type": "integer" }, "platform_access_fee_unit": { "type": "string" }, "platform_monthly_min": { "type": "integer" }, "pmp_optimization_off_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_off_unit": { "type": "string" }, "pmp_optimization_on_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_on_unit": { "type": "string" }, "profit_share_fee_pct": { "type": "integer" }, "spend_cap": { "type": "integer" }, "t1_as_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_html5_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_vads_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" } }, "title": "Contracts Input", "type": "object", "x-stoplight": { "id": "contracts-input", "name": "Contracts Input", "public": true } }, "contracts-output": { "example": { "data": { "adaptive_segment_cpm": [ {} ], "contract_number": -34492430, "currency_code": "Lorem cupidatat qui ullamco", "effective_end_date": "aliquip", "effective_start_date": "nisi voluptate n", "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" } ] }, "meta": { "called_on": "laborum voluptate dolore", "count": 27422536, "etag": "enim id Excepteur magna", "offset": -47785040, "status": "amet", "total_count": -77774937 } }, "properties": { "data": { "example": { "adaptive_segment_cpm": [ { "currency_code": "USD", "value": 0 } ], "contract_number": 103074, "currency_code": "USD", "effective_end_date": "2017-03-21T00: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 } ] }, "properties": { "adaptive_segment_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "contract_number": { "type": "integer" }, "currency_code": { "type": "string" }, "effective_end_date": { "type": "string" }, "effective_start_date": { "type": "string" }, "entity_type": { "type": "string" }, "evidon_privacy_cost_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "exclude_agency_margin": { "type": "boolean" }, "external_media_tracking_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "fbx_dynamic_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "managed_service_fee_pct": { "type": "integer" }, "managed_service_fee_unit": { "type": "string" }, "name": { "type": "string" }, "optimization_fee_pct": { "type": "integer" }, "optimization_fee_unit": { "type": "string" }, "organization_id": { "type": "integer" }, "peer39_channel_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_custom_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_quality_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_safety_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "platform_access_fee_pct": { "type": "integer" }, "platform_access_fee_unit": { "type": "string" }, "platform_monthly_min": { "type": "integer" }, "pmp_optimization_off_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_off_unit": { "type": "string" }, "pmp_optimization_on_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_on_unit": { "type": "string" }, "profit_share_fee_pct": { "type": "integer" }, "spend_cap": { "type": "integer" }, "t1_as_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_html5_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_vads_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" } }, "title": "Contracts Input", "type": "object", "x-stoplight": { "id": "contracts-input", "name": "Contracts Input", "public": true } }, "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": "Contracts Output", "type": "object", "x-stoplight": { "id": "contracts-output", "name": "Contracts Output", "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" }, "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" }, "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" }, "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" }, "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_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" }, "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" }, "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. See [Knowledge Base](https://kb.mediamath.com/wiki/display/NT1KB/Strategies+Details+Tab#StrategiesDetailsTab-OptimizedFrequencyCap) for more information.", "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: 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" ], "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" }, "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_streaming": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "site_restriction_transparent_urls": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "site_selectiveness": { "default": "REDUCED", "description": "Specifies whether to use a T1 site list REDUCED: TerminalOne blocklist applied MATHSELECT_250: MathSelect250 whitelist EXCLUDE_UGC ALL: Unfiltered exchange inventory", "enum": [ "MATHSELECT_250", "REDUCED", "EXCLUDE_UGC", "ALL" ], "type": "string" }, "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" ], "title": "Input Strategy", "type": "object", "x-stoplight": { "id": "input-strategy", "name": "Input Strategy", "public": true } }, "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": 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": { "attribution_group": { "type": "string" }, "bidder_exchange_identifier": { "type": "integer" }, "code": { "type": "string" }, "distribute": { "type": "boolean" }, "entity_type": { "type": "string" }, "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": [ { "city": "voluptate ullamco" }, { "contact_name": "qui ex sunt ut", "state": "ut minim", "zip": "et adipisicing est ea dolore" }, { "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" } ], "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, "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" }, "properties": { "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" }, "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" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "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": { "items": { "type": "string" }, "type": "array" }, "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" }, "restrict_targeting_to_same_device_id": { "type": "boolean" }, "state": { "type": "string" }, "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" } }, "title": "Organization", "type": "object", "x-stoplight": { "id": "organization", "name": "Organization", "public": true } }, "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, "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" }, "properties": { "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" }, "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" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "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": { "items": { "type": "string" }, "type": "array" }, "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" }, "restrict_targeting_to_same_device_id": { "type": "boolean" }, "state": { "type": "string" }, "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" } }, "title": "Organization", "type": "object", "x-stoplight": { "id": "organization", "name": "Organization", "public": true } }, "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": [ { "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 } }, { "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 } } ], "title": "Output Concept", "type": "object", "x-stoplight": { "id": "output-concept", "name": "Output Concept", "public": true } }, "output-site-placement": { "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": 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 } } ], "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" }, "properties": { "audience_segment_exclude_op": { "type": "string" }, "audience_segment_include_op": { "type": "string" }, "bid_aggressiveness": { "type": "integer" }, "bid_price_is_media_only": { "type": "boolean" }, "budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "type": "string" }, "effective_goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "frequency_amount": { "type": "integer" }, "frequency_interval": { "type": "string" }, "frequency_optimization": { "type": "boolean" }, "frequency_type": { "type": "string" }, "goal_type": { "type": "string" }, "goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "id": { "type": "integer" }, "impression_pacing_interval": { "type": "string" }, "impression_pacing_type": { "type": "string" }, "max_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "media_type": { "type": "string" }, "min_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "pacing_amount": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "pacing_interval": { "type": "string" }, "pacing_type": { "type": "string" }, "pixel_target_expr": { "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" }, "status": { "type": "boolean" }, "supply_type": { "type": "string" }, "targeting_segment_exclude_op": { "type": "string" }, "targeting_segment_include_op": { "type": "string" }, "type": { "type": "string" }, "updated_on": { "type": "string" }, "use_campaign_end": { "type": "boolean" }, "use_campaign_start": { "type": "boolean" }, "use_mm_freq": { "type": "boolean" }, "use_optimization": { "type": "boolean" }, "version": { "type": "integer" }, "zone_name": { "type": "string" } }, "title": "Output Strategy", "type": "object", "x-stoplight": { "id": "output-strategy", "name": "Output Strategy", "public": true } }, "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" }, "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" }, "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" }, "properties": { "audience_segment_exclude_op": { "type": "string" }, "audience_segment_include_op": { "type": "string" }, "bid_aggressiveness": { "type": "integer" }, "bid_price_is_media_only": { "type": "boolean" }, "budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "type": "string" }, "effective_goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "frequency_amount": { "type": "integer" }, "frequency_interval": { "type": "string" }, "frequency_optimization": { "type": "boolean" }, "frequency_type": { "type": "string" }, "goal_type": { "type": "string" }, "goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "id": { "type": "integer" }, "impression_pacing_interval": { "type": "string" }, "impression_pacing_type": { "type": "string" }, "max_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "media_type": { "type": "string" }, "min_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "pacing_amount": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "pacing_interval": { "type": "string" }, "pacing_type": { "type": "string" }, "pixel_target_expr": { "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" }, "status": { "type": "boolean" }, "supply_type": { "type": "string" }, "targeting_segment_exclude_op": { "type": "string" }, "targeting_segment_include_op": { "type": "string" }, "type": { "type": "string" }, "updated_on": { "type": "string" }, "use_campaign_end": { "type": "boolean" }, "use_campaign_start": { "type": "boolean" }, "use_mm_freq": { "type": "boolean" }, "use_optimization": { "type": "boolean" }, "version": { "type": "integer" }, "zone_name": { "type": "string" } }, "title": "Output Strategy", "type": "object", "x-stoplight": { "id": "output-strategy", "name": "Output Strategy", "public": true } }, { "properties": { "site_placements": { "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": 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 } } ], "title": "Output Site Placement", "x-stoplight": { "id": "output-site-placement", "name": "Output Site Placement", "public": true } }, "type": "array" }, "supply_sources": { "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": 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": { "attribution_group": { "type": "string" }, "bidder_exchange_identifier": { "type": "integer" }, "code": { "type": "string" }, "distribute": { "type": "boolean" }, "entity_type": { "type": "string" }, "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 } }, "type": "array" } }, "type": "object" } ] }, "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 Supplies", "type": "object", "x-stoplight": { "id": "output-strategy-supplies", "name": "Output Strategy Supplies", "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 } }, "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": 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": { "attribution_group": { "type": "string" }, "bidder_exchange_identifier": { "type": "integer" }, "code": { "type": "string" }, "distribute": { "type": "boolean" }, "entity_type": { "type": "string" }, "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" }, "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" }, "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", "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, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" }, "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": { "description": "Goal type which campaign performance will be measured", "enum": [ "roi", "cpa", "cpc", "reach", "spend" ], "type": "string" }, "goal_value": { "description": "Target goal value for campaign respective to the goal_type selection.\n\nrequired if `goal_type in ('cpa','cpc','reach','roi')`", "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "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", "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "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", "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "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" ], "title": "Read Singular Campaign", "type": "object", "x-stoplight": { "id": "read-singular-campaign", "name": "Read Singular Campaign", "public": true } }, "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, "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" }, "properties": { "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" }, "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" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "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": { "items": { "type": "string" }, "type": "array" }, "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" }, "restrict_targeting_to_same_device_id": { "type": "boolean" }, "state": { "type": "string" }, "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" } }, "title": "Organization", "type": "object", "x-stoplight": { "id": "organization", "name": "Organization", "public": true } }, "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" }, "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" } }, "title": "Strategy Concept", "type": "object", "x-stoplight": { "id": "strategy-concept", "name": "Strategy Concept", "public": true } }, "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": { "properties": { "exclude_op": { "enum": [ "AND", "OR" ], "type": "string" }, "include_op": { "enum": [ "AND", "OR" ], "type": "string" }, "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" } }, "title": "Update Audience Targeting", "type": "object", "x-stoplight": { "id": "update-audience-targeting", "name": "Update Audience Targeting", "public": true } }, "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 } } }, "host": "api.mediamath.com", "info": { "description": "# Entity Heirarchy\n\n
\n\n\n![MediaMath Overview](https://mediamath.github.io/api-docs/images/T1-Entity-Heirarchy.png \"MediaMath Overview\")\n\n
\n\n- [Retrieving Entities](#retrieving-entities)\n - [Retrieving Single Entities](#retrieving-single-entities)\n - [Including Related Entities](#including-related-entities)\n - [Retrieving Multiple Entities](#retrieving-multiple-entities)\n - [Including Entity Properties](#including-entity-properties)\n - [Sorting](#sorting)\n - [Querying for entities](#querying-for-entities)\n - [Retrieving Multiple Specific Entities by ID](#retrieving-multiple-specific-entities-by-id)\n - [Substring search](#substring-search)\n - [Filtering based on IDs of related entities](#filtering-based-on-ids-of-related-entities)\n - [Filtering based on hierarchical relationships](#filtering-based-on-hierarchical-relationships)\n - [Filtering based on linkage relationships](#filtering-based-on-linkage-relationships)\n- [Creating New Entities](#creating-new-entities)\n- [Updating Entities](#updating-entities)\n - [Update Timeframes](#update-timeframes)\n - [Retrieving Entity Changelogs](#retrieving-entity-changelogs)\n\n\n\n## Retrieving Entities\n\nIndividual entities and collections of entities can be retrieved using HTTP `GET` requests to their respective API endpoints:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/organizations\n```\n\n``` response\n\n\n \n \n \n \n\n```\n\nResponses are made up of a `result` element at the root of the document, which contains a `status` element indicating the status of the API response. If the request was for a single entity, the `result` element will contain a single `entity` element; otherwise, it will contain an `entities` element containing `entity` elements representing the requested entities.\n\n### Retrieving Single Entities\n\nTo retrieve an entity by ID, issue a `GET` request to the entity API base followed by the entity ID, as in this example:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/strategies/515578\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n [ . . . ]\n \n \n\n```\n\n#### Including Related Entities\n\nSome entities contain references to other entities to which they are related. For example, a strategy belongs to a single campaign; when you retrieve a strategy entity, it will include a `campaign_id` property. You can include details about this kind of related entity inside the entity you're requesting by appending the `with` parameter to the URL you request. Pass the name (singular) of the entity you're interested in as the value of the `with` parameter:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/strategies/515578?with=campaign\n```\n\n``` response\n\n\n \n \n \n \n [ . . . ]\n \n \n [ . . . ]\n \n \n\n```\n\nTo retrieve details about multiple entities directly related to the top-level entity you're requesting, use multiple `with` parameters:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/advertisers/125819?with=agency&with=vertical\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n [ . . . ]\n \n \n\n```\n\nYou can also retrieve details about entities related to the related entities themselves. To do this, pass a comma-separated list of entity names in a `with` parameter:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/strategies/515578?with=campaign,advertiser\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n [ . . . ]\n \n \n \n [ . . . ]\n \n \n [ . . . ]\n \n \n\n```\n\n### Retrieving Multiple Entities\n\nTo retrieve multiple entities in a single call, issue a GET request to the API endpoint for the entity you’re interested in. Lists of entities are paginated by default, and the maximum number of entities per page is 100. Use the `page_limit` parameter to specify how many entities to retrieve, and the `page_offset` parameter to specify the index of the first element in the collection to retrieve (*not* the page number).\n\n``` request\nGET https://api.mediamath.com/api/v2.0/strategies?page_limit=5&page_offset=10\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n```\n\n#### Including Entity Properties\n\nWhen requesting a collection of entities, the default output will return only the `name`, `id`, and `type` properties of the entity, as shown in the above example. To include all properties of entities returned by collection endpoints, include the `full` parameter in the URL query string. Set the `full` parameter to a comma-separated list of entities to include full properties for. For example, this query returns the requested strategies, and uses the `with` parameter to include their associated campaign, advertiser, agency, and organization. By setting `full=strategy,campaign`, it only includes full properties for the strategy and campaign entities:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/strategies?page_limit=2&with=campaign,advertiser,agency,organization&full=strategy,campaign\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n [ additional campaign properties ]\n \n \n \n \n \n \n [ additional strategy properties ]\n \n \n \n \n \n \n \n \n \n \n \n \n \n [ additional campaign properties ]\n \n \n \n \n \n \n \n [ additional strategy properties ]\n \n \n \n\n```\n\nTo include all properties for all entities returned by the API call, use `full=*`:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/strategies?page_limit=2&full=*\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n [ additional strategy properties ]\n \n \n \n \n \n \n \n \n [ additional strategy properties ]\n \n \n \n\n```\n\n#### Sorting\n\nInclude a `sort_by` parameter in a requst for multiple entitites to sort the entities by a named property:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/strategies?page_limit=5&sort_by=name\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n\n```\n\nTo sort in descending order, use a `-` sign before the parameter to sort on, e.g. `sort_by=-name`. To sort by multiple properties, pass a comma-separated list of properties in the `sort_by` parameter. For example, `sort_by=name,-total_budget` would return a list of entities sorted by name ascending, then, for entities with the same name, by budget descending.\n\n#### Querying for entities\n\nTo retrieve elements that have properties matching certain expressions, you can use the `q` parameter. Query predicates are composed of three parts:\n\n- the property being searched upon;\n- the operator; and\n- the value to match.\n\nSupported operators include:\n\n- `==` (numeric equality or case-sensitive string identity)\n- `!=` (numeric inequality or case-sensitive string non-identity)\n- `=:` (case-insensitive match, allows substring using \\* wildcards)\n- `<` (less than)\n- `<=` (less than or equal to)\n- `>` (greater than)\n- `>=` (greater than or equal to)\n\nSuppose the user is interested in those campaigns whose `name` is `Lambda Campaign Spend`. In this case, the comparison of \"exact match\" would be expressed by an `==` operator. **Note that query strings must be URL-encoded:**\n\n``` request\nGET https://api.mediamath.com/api/v2.0/campaigns?q=name%3D%3DLambda%20Campaign%20Spend\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n\n```\n\nTo combine multiple expressions in a query string, use an ampersand (`&`). For example, to retrieve all campaigns with the `name` of `Test Campaign` and a `total_budget` greater than or equal to $10,000, you could compose the query string `name==Test Campaign&total_budget>=10000`. The URL-encoded request would look like this:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/campaigns?q=name%3D%3DTest%20Campaign%26total_budget%3E%3D10000\n```\n\n``` response\n\n\n \n \n \n \n \n \n\n```\n\n#### Retrieving Multiple Specific Entities by ID\n\nThe 'q=' syntax also supports fetching a list of entities of the same type specified by their entity ID numbers. The general formula for this is:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/strategies?q=(123,234,456)\n```\n\n``` response\n\n\n \n \n \n \n \n \n\n```\n\nEntity IDs are limited to the range 1 through 2147483647. Requesting a `q=()` ID outside that range will result in a 400 response.\n\n#### Substring search\n\nAdding a search string between angled brackets to the 'q=' parameter will perform a substring match across all string fields of an entity.\n\n``` request\nGET https://api.mediamath.com/api/v2.0/users?q=\n```\n\n``` response\n\n\n \n \n \n \n \n \n\n```\n\n#### Filtering based on IDs of related entities\n\nWe often want to limit the data returned by an API GET call to those records which display a particular relationship to instances of other business objects. Such a relationship may be one of **hierarchy** – where an object is a descendent of a \"higher-level\" type of object – or one of **linkage** – where an object is linked to a particular instance of a completely different type of business object. In either case, the user wants to limit the selection of objects returned to a particular subset of those business objects.\n\nTo accomplish this, you can insert a `/limit` component in the URL of a request for multiple entities. This allows you to filter the data returned according to a hierarchical relationship, a linkage relationship, or a combination of both.\n\n##### Filtering based on hierarchical relationships\n\nThe main hierarchical relationship in the Execution and Management API is the one between organizations, advertisers, agencies, advertisers, campaigns, and strategies, respectively. When requesting a collection of entities in this hierarchy, you can use a `limit` URL component to retrieve only entities belonging to a specific parent. For example, to retrieve campaigns belonging to the advertiser with ID `126`, you could issue the following request:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/campaigns/limit/advertiser=126\n```\n\n``` response\n\n\n \n \n \n \n \n\n```\n\nYou can use `.` in `/limit` URL components to filter based on entities higher up the hierarchy. For example, to retrieve campaigns for all advertisers in agency ID `914`, you could issue this request:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/campaigns/limit/advertiser.agency=914\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n```\n\n#### Filtering based on linkage relationships\n\nSome entities are linked to other entities through other entities that are related to both. For example, a `vendor_contract` entity represents a relationship between a `campaign` entity and a `vendor` entity. To retrieve all campaigns using a specific vendor, then, you can issue a request like this:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/campaigns/limit/vendor_contracts.vendor=515\n```\n\n``` response\n\n\n \n \n \n \n \n [ . . . ]\n \n \n\n```\n\nNote that, for `/limit` URL components involving linkage relationships, **the plural form of the linkage entity must be used** — `/limit/vendor_contracts`, not `/limit/vendor_contract`.\n\n## Creating New Entities\n\nEntities in the MediaMath Execution and Management API are created by issuing a `POST` request to the entity's API endpoint. Entity properties should be sent as URL-encoded parameters in the POST body. The pages in this documentation describing individual entities include details on which properties must be specified when creating new entities. For example, creating a new [Agency](/docs/read/execution_and_management_api/Agencies) requires a `name` parameter and an `organization_id` parameter.\n\n``` request\nPOST https://api.mediamath.com/api/v2.0/agencies\n\nname=Demo Agency&organization_id=100048\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n\n```\n\nIf all required parameters are valid, the server returns a new entity with its own `id` and `version` parameters. You can then access the entity at `https://api.mediamath.com/api/v2.0/[type]/[id]`, where `[type]` represents the entity type (`agency`, in this example) and `[id]` is the entity ID.\n\n## Updating Entities\n\nTo update an entity, you'll first need to know the current `version` property of the entity. You can access this by issuing a GET request to the entity's URL:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/agencies/104981\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n\n```\n\nThen, issue a POST request to the entity's URL, including the `version` parameter and any properties you'd like to update:\n\n``` request\nPOST https://api.mediamath.com/api/v2.0/agencies/104981\n\nname=Demo Agency Updated&version=0\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n\n```\n\nAfter validating the updated parameters, the server responds with the details of the updated entity. Note that the `version` parameter is updated, to prevent multiple clients from updating the same version of an entity at once.\n\nDo not include the entity's ID in the POST body, as it is already implicit from the URL and cannot be modified.\n\n### Update Timeframes\n\nUpdates to entities have to be propogated to the Bidders in order for them to affect how MediaMath bids for opportunities. Regular updates have an average latency of 1.5 hours. Updates of fields of entities below are *fast tracked* and update within 5 minutes.\n\n**Campaigns:**\n\n- id\n- end_date\n- start_date\n- status\n- total_budget\n\n**Strategies:**\n\n- budget\n- end_date\n- goal_value\n- id\n- max_bid\n- min_bid\n- pacing_amount\n- pacing_interval\n- pacing_type\n- start_date\n- status\n\n**USD Budget Flights:**\n\n- campaign_id\n- end_date\n- id\n- start_date\n- total_budget\n- total_budget_usd\n\n\n### Retrieving Entity Changelogs\n\nCertain entities allow you to retrieve a list of changes made to the entity over time. The endpoint only shows 90 days worth of history. To retrieve changelog data, make a request of the following form:\n\n``` endpoint\nGET https://api.mediamath.com/api/v2.0/[collection]/[id]/history\n```\n\nFor example, to retrieve the update history for the agency shown above, you could issue the following request:\n\n``` request\nGET https://api.mediamath.com/api/v2.0/agencies/104981/history\n```\n\n``` response\n\n\n \n \n \n \n \n \n \n \n \n \n \n\n```", "title": "Campaign Management API", "version": "2.0", "x-stoplight": { "id": "mediamath/specs/execution-and-management" }, "contact": { "name": "developers@mediamath.com", "email": "developers@mediamath.com", "url": "https://apidocs.mediamath.com" } }, "parameters": { "trait:jsonResponse:Accept": { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, "trait:limit:page_limit": { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, "trait:limit:page_offset": { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, "trait:querying:q": { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, "trait:returnAdditionalEntityProperties:full": { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, "trait:returnAdditionalEntityProperties:with": { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" }, "trait:sorting:sort_by": { "description": "name", "in": "query", "items": { "type": "string" }, "name": "sort_by", "required": false, "type": "string" } }, "paths": { "/session": { "get": { "operationId": "GET_api-v2-0-session", "summary": "Get Current User Session Information", "description": "This path is used to gather information on your current session, or for services to validate sessions against the main authentication service.", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "session": { "type": "object", "properties": { "current_time": { "type": "string" }, "expires": { "type": "string" }, "sessionid": { "type": "string" } } } } }, "meta": { "type": "object", "properties": { "status": { "type": "string" } } } } } } }, "tags": [ "Users" ] } }, "/permissions": { "get": { "operationId": "GET_api-v2-0-permissions", "summary": "Get Current User Permissions Information", "description": "This path is used to gather information on your current session, or for services to validate sessions against the main authentication service.", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "session": { "type": "object", "properties": { "current_time": { "type": "string" }, "expires": { "type": "string" }, "sessionid": { "type": "string" } } } } }, "meta": { "type": "object", "properties": { "status": { "type": "string" } } } } } } }, "tags": [ "Session Management" ] } }, "/ad_servers": { "get": { "operationId": "findAdServers", "parameters": [ { "in": "header", "name": "Via", "type": "string" }, { "in": "header", "name": "Connect-Time", "type": "integer" }, { "in": "header", "name": "Total-Route-Time", "type": "integer" }, { "in": "header", "name": "Authorization", "type": "string" }, { "in": "header", "name": "Accept", "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "examples": { "text/xml": { "data": [ { "entity_type": "ad_server", "id": 1, "name": "Atlas" } ], "meta": { "called_on": "2016-11-22T22:28:43+0000", "count": 10, "etag": "a9c20b20b765ef513c783148dde9b8f3b5dc3baf", "offset": 0, "status": "ok", "total_count": 10 } } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "example": { "entity_type": "ad_server", "id": 9, "name": "TerminalOne" }, "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "title": "Ad Server", "type": "object", "x-stoplight": { "id": "ad_server", "name": "ad_server", "public": true } } }, "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 } } } } } }, "security": [ { "oauth2": [] } ], "summary": "Get list of supported ad servers", "tags": [ "Ad Servers" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "findAdServers", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get list of supported ad servers" } }, "/ad_servers/{id}": { "get": { "description": "Returns a single adserver by ID", "operationId": "findParticularAdServer", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "status": { "code": "auth_required", "content": "Authentication Required", "reason": "not_logged_in" } } }, "schema": { "properties": { "data": { "example": { "entity_type": "ad_server", "id": 9, "name": "TerminalOne" }, "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "title": "Ad Server", "type": "object", "x-stoplight": { "id": "ad_server", "name": "ad_server", "public": true } }, "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 } } }, "type": "object" } } }, "security": [ { "oauth2": [] } ], "summary": "Get information about a particular adserver", "tags": [ "Ad Servers" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "findParticularAdServer", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer" } ] }, "/advertisers": { "get": { "operationId": "find-advertisers", "parameters": [ { "in": "header", "name": "Connect-Time", "type": "integer" }, { "in": "header", "name": "Total-Route-Time", "type": "integer" }, { "in": "header", "name": "Via", "type": "string" }, { "in": "header", "name": "Authorization", "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "examples": { "text/xml": { "data": [ { "entity_type": "advertiser", "id": 176745, "name": "Vox" } ], "meta": { "called_on": "2016-11-22T22:28:41+0000", "count": 100, "etag": "31c7651a31e3dc0a5e8b7a29bb0a0f5cc399cb09", "next_page": "https://api.mediamath.com/api/v2.0/advertisers?page_offset=100&api_key=noapikey", "offset": 0, "status": "ok", "total_count": 528 } } }, "schema": { "properties": { "data": { "items": { "example": { "ad_server_fee": 34190098, "ad_server_id": 59910688, "agency_id": 68414621, "allow_x_strat_optimization": true, "billing_contact_id": -91849290, "created_on": "Excepteur non et in commodo", "domain": "magna ut labore", "frequency_amount": -56525012, "name": "nostrud eu ea dolor", "updated_on": "esse commodo aliquip id", "vertical_id": -66867024 }, "properties": { "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" }, "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": { "description": "Interval applicable for frequency_amount.\n\nRequired if `frequency_typeis even or asap`.", "enum": [ "hour", "day", "week", "month", "not-applicable" ], "type": "string" }, "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": "Enter id for the Advertiser's Vertical - see Advertiser Vertical table below", "type": "integer" } }, "required": [ "agency_id", "domain", "ad_server_id", "vertical_id", "name" ], "title": "Advertiser", "type": "object", "x-stoplight": { "id": "advertiser", "name": "Advertiser", "public": true } }, "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 } } }, "type": "object" } } }, "security": [ { "oauth2": [] } ], "summary": "Get list of advertisers", "tags": [ "Advertisers" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "find-advertisers", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get list of advertisers" }, "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Create a new advertiser entity reserved for T1 admins", "operationId": "createAdvertiser", "parameters": [ { "in": "formData", "name": "minimize_multi_ads", "type": "boolean" }, { "enum": [ "asap", "even", "no-limit" ], "in": "formData", "name": "frequency_type", "type": "string" }, { "enum": [ "hour", "day", "week", "month", "not-applicable" ], "in": "formData", "name": "frequency_interval", "type": "string" }, { "in": "formData", "name": "status", "type": "boolean" }, { "in": "formData", "name": "dmp_enabled", "type": "string" }, { "in": "formData", "name": "agency_id", "required": true, "type": "integer" }, { "in": "formData", "name": "allow_x_strat_optimization", "type": "boolean" }, { "in": "formData", "name": "domain", "required": true, "type": "string" }, { "in": "formData", "name": "ad_server_id", "required": true, "type": "integer" }, { "in": "formData", "name": "updated_on", "type": "string" }, { "in": "formData", "name": "vertical_id", "required": true, "type": "integer" }, { "in": "formData", "name": "created_on", "type": "string" }, { "in": "formData", "name": "name", "required": true, "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "201": { "description": "the newly created Organization", "schema": { "properties": { "data": { "example": { "ad_server_fee": 34190098, "ad_server_id": 59910688, "agency_id": 68414621, "allow_x_strat_optimization": true, "billing_contact_id": -91849290, "created_on": "Excepteur non et in commodo", "domain": "magna ut labore", "frequency_amount": -56525012, "name": "nostrud eu ea dolor", "updated_on": "esse commodo aliquip id", "vertical_id": -66867024 }, "properties": { "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" }, "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": { "description": "Interval applicable for frequency_amount.\n\nRequired if `frequency_typeis even or asap`.", "enum": [ "hour", "day", "week", "month", "not-applicable" ], "type": "string" }, "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": "Enter id for the Advertiser's Vertical - see Advertiser Vertical table below", "type": "integer" } }, "required": [ "agency_id", "domain", "ad_server_id", "vertical_id", "name" ], "title": "Advertiser", "type": "object", "x-stoplight": { "id": "advertiser", "name": "Advertiser", "public": true } }, "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 } } }, "type": "object" } }, "default": { "description": "Error" } }, "security": [ { "oauth2": [] } ], "summary": "Create a new advertiser", "tags": [ "Advertisers" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "createAdvertiser", "mock": { "enabled": false, "statusCode": 200 }, "public": true } } }, "/advertisers/{id}": { "get": { "description": "Returns a single advertiser by ID", "operationId": "findParticularAdvertiser", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "ad_server_id": -15783314, "agency_id": -34507492, "domain": "sunt ea", "name": "ut cillum nostrud laborum enim", "vertical_id": 7187749 }, "meta": { "called_on": "ut", "count": -61439425, "etag": "dolore magna eu ut", "offset": -10419643, "status": "Excepteur dolor et", "total_count": -83183080 } } }, "schema": { "properties": { "data": { "example": { "ad_server_fee": 34190098, "ad_server_id": 59910688, "agency_id": 68414621, "allow_x_strat_optimization": true, "billing_contact_id": -91849290, "created_on": "Excepteur non et in commodo", "domain": "magna ut labore", "frequency_amount": -56525012, "name": "nostrud eu ea dolor", "updated_on": "esse commodo aliquip id", "vertical_id": -66867024 }, "properties": { "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" }, "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": { "description": "Interval applicable for frequency_amount.\n\nRequired if `frequency_typeis even or asap`.", "enum": [ "hour", "day", "week", "month", "not-applicable" ], "type": "string" }, "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": "Enter id for the Advertiser's Vertical - see Advertiser Vertical table below", "type": "integer" } }, "required": [ "agency_id", "domain", "ad_server_id", "vertical_id", "name" ], "title": "Advertiser", "type": "object", "x-stoplight": { "id": "advertiser", "name": "Advertiser", "public": true } }, "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 } } }, "type": "object" } } }, "security": [ { "oauth2": [] } ], "summary": "Get information about a particular advertiser", "tags": [ "Advertisers" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "findParticularAdvertiser", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Update an advertiser entity reserved for T1 admins", "operationId": "updateAdvertiser", "parameters": [ { "in": "formData", "name": "minimize_multi_ads", "type": "boolean" }, { "enum": [ "asap", "even", "no-limit" ], "in": "formData", "name": "frequency_type", "type": "string" }, { "enum": [ "hour", "day", "week", "month", "not-applicable" ], "in": "formData", "name": "frequency_interval", "type": "string" }, { "in": "formData", "name": "status", "type": "boolean" }, { "in": "formData", "name": "dmp_enabled", "type": "string" }, { "in": "formData", "name": "agency_id", "required": true, "type": "integer" }, { "in": "formData", "name": "allow_x_strat_optimization", "type": "boolean" }, { "in": "formData", "name": "domain", "required": true, "type": "string" }, { "in": "formData", "name": "ad_server_id", "required": true, "type": "integer" }, { "in": "formData", "name": "updated_on", "type": "string" }, { "in": "formData", "name": "vertical_id", "required": true, "type": "integer" }, { "in": "formData", "name": "created_on", "type": "string" }, { "in": "formData", "name": "version", "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "the newly created Organization", "schema": { "properties": { "data": { "example": { "ad_server_fee": 34190098, "ad_server_id": 59910688, "agency_id": 68414621, "allow_x_strat_optimization": true, "billing_contact_id": -91849290, "created_on": "Excepteur non et in commodo", "domain": "magna ut labore", "frequency_amount": -56525012, "name": "nostrud eu ea dolor", "updated_on": "esse commodo aliquip id", "vertical_id": -66867024 }, "properties": { "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" }, "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": { "description": "Interval applicable for frequency_amount.\n\nRequired if `frequency_typeis even or asap`.", "enum": [ "hour", "day", "week", "month", "not-applicable" ], "type": "string" }, "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": "Enter id for the Advertiser's Vertical - see Advertiser Vertical table below", "type": "integer" } }, "required": [ "agency_id", "domain", "ad_server_id", "vertical_id", "name" ], "title": "Advertiser", "type": "object", "x-stoplight": { "id": "advertiser", "name": "Advertiser", "public": true } }, "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 } } }, "type": "object" } }, "default": { "description": "Error" } }, "security": [ { "oauth2": [] } ], "summary": "Update an existing advertiser", "tags": [ "Advertisers" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "updateAdvertiser", "mock": { "enabled": false, "statusCode": 200 }, "public": true } } }, "/agencies": { "get": { "operationId": "FindAgencies", "parameters": [ { "in": "header", "name": "Authorization", "type": "string" }, { "in": "header", "name": "Connect-Time", "type": "integer" }, { "in": "header", "name": "Via", "type": "string" }, { "in": "header", "name": "Total-Route-Time", "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "examples": { "text/xml": { "data": [ { "entity_type": "agency", "id": 115549, "name": "Publisher Testing" } ], "meta": { "called_on": "2016-11-22T22:28:40+0000", "count": 100, "etag": "341534688c6a983e808d369c9341e5cc245ec2ee", "next_page": "https://api.mediamath.com/api/v2.0/agencies?page_offset=100&api_key=noapikey", "offset": 0, "status": "ok", "total_count": 352 } } }, "schema": { "properties": { "data": { "items": { "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 }, "properties": { "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" }, "created_on": { "type": "string" }, "dmp_enabled": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "status": { "type": "boolean" }, "updated_on": { "type": "string" }, "version": { "type": "integer" } }, "title": "Agency", "type": "object", "x-stoplight": { "id": "agency", "name": "Agency", "public": true } }, "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 } } }, "type": "object" } } }, "security": [ { "oauth2": [] } ], "summary": "Get a list of agencies in T1", "tags": [ "Agencies" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "FindAgencies", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get a list of agencies in T1" }, "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Create a new agency entity", "operationId": "createAgency", "parameters": [ { "in": "formData", "name": "organization_id", "required": true, "type": "integer" }, { "in": "formData", "name": "status", "type": "boolean" }, { "in": "formData", "name": "allow_x_adv_pixels", "type": "boolean" }, { "in": "formData", "name": "allow_x_adv_optimization", "type": "boolean" }, { "in": "formData", "name": "updated_on", "type": "string" }, { "in": "formData", "name": "created_on", "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "201": { "description": "the newly created Organization", "schema": { "properties": { "data": { "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 }, "properties": { "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" }, "created_on": { "type": "string" }, "dmp_enabled": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "status": { "type": "boolean" }, "updated_on": { "type": "string" }, "version": { "type": "integer" } }, "title": "Agency", "type": "object", "x-stoplight": { "id": "agency", "name": "Agency", "public": true } }, "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 } } }, "type": "object" } }, "default": { "description": "Error" } }, "security": [ { "oauth2": [] } ], "summary": "Create a new agency", "tags": [ "Agencies" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "createAgency", "mock": { "enabled": false, "statusCode": 200 }, "public": true } } }, "/agencies/{id}": { "get": { "operationId": "FindAgency", "parameters": [ { "in": "header", "name": "Authorization", "type": "string" }, { "in": "header", "name": "Connect-Time", "type": "integer" }, { "in": "header", "name": "Via", "type": "string" }, { "in": "header", "name": "Total-Route-Time", "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "examples": { "text/xml": { "data": { "allow_x_adv_optimization": true, "allow_x_adv_pixels": true, "created_on": "ea in sint magna ut", "dmp_enabled": "elit", "entity_type": "in proident culpa", "id": -29383631, "name": "elit officia laboris", "organization_id": -68426687, "status": true, "updated_on": "est Ut adipisicing", "version": -46809892 }, "meta": { "called_on": "quis et culpa", "count": -52517556, "etag": "sed commodo", "offset": 11757318, "status": "laborum occaecat", "total_count": 87290090 } } }, "schema": { "properties": { "data": { "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 }, "properties": { "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" }, "created_on": { "type": "string" }, "dmp_enabled": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "status": { "type": "boolean" }, "updated_on": { "type": "string" }, "version": { "type": "integer" } }, "title": "Agency", "type": "object", "x-stoplight": { "id": "agency", "name": "Agency", "public": true } }, "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 } } }, "type": "object" } } }, "security": [ { "oauth2": [] } ], "summary": "Get information about particular agency in T1", "tags": [ "Agencies" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "FindAgency", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get information about particular agency in T1" }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Update an agency entity reserved for T1 admins", "operationId": "updateAgency", "parameters": [ { "in": "formData", "name": "organization_id", "required": true, "type": "integer" }, { "in": "formData", "name": "status", "type": "boolean" }, { "in": "formData", "name": "allow_x_adv_pixels", "type": "boolean" }, { "in": "formData", "name": "allow_x_adv_optimization", "type": "boolean" }, { "in": "formData", "name": "updated_on", "type": "string" }, { "in": "formData", "name": "created_on", "type": "string" }, { "in": "formData", "name": "version", "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "the newly created Organization", "schema": { "properties": { "data": { "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 }, "properties": { "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" }, "created_on": { "type": "string" }, "dmp_enabled": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "status": { "type": "boolean" }, "updated_on": { "type": "string" }, "version": { "type": "integer" } }, "title": "Agency", "type": "object", "x-stoplight": { "id": "agency", "name": "Agency", "public": true } }, "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 } } }, "type": "object" } }, "default": { "description": "Error" } }, "security": [ { "oauth2": [] } ], "summary": "Update an existing agency", "tags": [ "Advertisers" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "updateAdvertiser", "mock": { "enabled": false, "statusCode": 200 }, "public": true } } }, "/atomic_creatives": { "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST_atomic_creatives", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "examples": { "text/xml": { "data": [ { "entity_type": "atomic_creative", "id": 3263857, "name": "Expandable Test" } ], "meta": { "called_on": "2016-11-22T22:28:38+0000", "count": 100, "etag": "828840bb1eb89002d20a90d1505610e5c0f70218", "next_page": "https://api.mediamath.com/api/v2.0/atomic_creatives?page_offset=100&api_key=noapikey", "offset": 0, "status": "ok", "total_count": 27109 } } }, "schema": { "properties": { "data": { "items": { "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "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" } }, "type": "object" } }, "type": "object" } }, "401": { "description": "", "examples": { "text/xml": { "errors": [ { "message": "The access token expired" } ], "meta": { "called_on": "2016-11-22T22:23:23+0000", "status": "auth_error" } } }, "schema": { "properties": { "errors": { "items": { "properties": { "message": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "properties": { "called_on": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "Upload Single Creative to 3PAS", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_atomiccreatives-", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Upload Single Creative to 3PAS" } }, "/hyperlocal/geopulse/designs/{design_id}": { "get": { "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Design ID used in the API call", "example": "38697e15-9e9e-4917-b55b-6431b99392f4" }, "name": { "type": "string", "example": "\"LA Car Dealerships\"", "description": "Design name" }, "type": { "type": "string", "example": "\"proximity\"", "description": "proximity or audience" }, "status": { "type": "string", "description": "in_design, requested, rejected, building, failed, or built", "enum": [ "in_design", "requested", "rejected", "building", "failed", "built" ], "minLength": 5, "maxLength": 9, "example": "in_design" }, "created_at": { "type": "string", "format": "date-time", "description": "When the design was created", "example": "2016-01-06T17:11:17.000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2016-01-06T17:11:17.000Z", "description": "When the latest design edit occurred" }, "design_size": { "type": "integer", "description": "(Deprecated) An internal value that estimates how complex this design may be to build on a relative scale. Not intended to be user facing", "example": 12 }, "most_recent_build": { "type": "string", "format": "uuid", "example": "ac5925c7-e727-45b5-848b-c2532dc84db7", "description": "Most recent build's ID, as a GUID" }, "owner_id": { "type": "string", "format": "uuid", "example": "eea9f6ef-c9f3-430a-8db0-d89e8476aebd", "description": "User ID of the design's owner, as a GUID" }, "owner_org_id": { "type": "string", "format": "uuid", "description": "Organzation ID of the design's owner, as a GUID", "example": "d4e49049-07fd-4c67-8325-1c803a8d1857" }, "owner_name": { "type": "string", "description": "Design owner's wmail", "example": "\"user1@factual.com\"" }, "price_cpm": { "type": "object", "description": "Price of the design in CPM. Base represents the price of this design when used to target impressions from most countries. Additional regional variations are coming soon.", "properties": { "base": { "type": "string", "description": "Base represents the price of this design when used to target impressions from most countries. The string is the price (a number) as a string.", "example": "0.75" } } }, "active_builds": { "type": "integer", "description": "The number of builds associated with this design that have been deployed to a partner's On-Prem software", "example": 1 }, "is_shared_to_current_user": { "type": "boolean", "description": "Has the current design been shared with the current user?", "example": false }, "is_shared_to_current_org": { "type": "boolean", "description": "Has the current design been shared with the current user's whole organizaton?", "example": false }, "sets": { "type": "array", "items": { "type": "object", "properties": { "set_id": { "type": "string", "format": "uuid", "description": "ID of the set, as a GUID", "example": "d151ea2c-9879-460c-a169-77a0de9ec3c5" }, "set_name": { "type": "string", "description": "Set name", "example": "\"Used Car Dealers\"" }, "targeting_code": { "type": "string", "description": "Set's targeting code", "example": "\"cars_1000m\"" }, "sources": { "type": "null" } } } }, "set_ids": { "type": "array", "format": "uuid", "description": "All of the seti ID's associated with the design", "items": { "type": "string" } }, "collaborators": { "type": "array", "description": "Users or orgs to grant access to", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "\"user\" or \"org\"", "enum": [ "user", "org" ], "minLength": 3, "maxLength": 4, "example": "user" }, "id": { "type": "string", "format": "uuid", "description": "Collaborator's user or org ID (GUID)", "example": "eea9f6ef-c9f3-430a-8db0-d89e8476aebd" }, "label": { "type": "string", "example": "\"user1@factual.com\"", "description": "Org name or user email" }, "permission": { "type": "array", "items": { "type": "object", "properties": { "view": { "type": "boolean", "description": "Collaborator has design read access", "example": true }, "edit": { "type": "boolean", "description": "Collaborator has design write access", "example": true } } } } } } }, "version": { "type": "string", "description": "#, in quotes", "example": "2.1" }, "data_sources": { "type": "array", "example": [ "factual_dap" ], "items": { "type": "string" } } } } } }, "version": { "type": "number" }, "status": { "type": "string", "enum": [ "ok", "error" ] } } }, "examples": { "application/json": { "version": 4, "status": "ok", "response": { "data": { "type": "audience", "name": "Brouhaha_Factual", "created_at": "2019-05-13T16:00:03.565Z", "updated_at": "2019-05-13T18:58:44.402Z", "design_size": 0, "most_recent_build": "437dc202-de34-9562-ce42-328368dcae4d", "owner_id": "93fbc340-be34-68a3-574a-7783cbcd3458", "owner_org_id": "fecd67a5-389e-9741-98ac-6975dcedbc30", "owner_name": "partnerservices+mediamath@factual.com", "price_cpm": { "base": "1.50" }, "version": "2.1", "data_sources": [ "factual_dap" ], "active_builds": 1, "sets": [ { "set_id": "8957ce40-fb6c-473b-8730-347dc8ed6b5", "set_name": "New Audience Segment", "sources": {}, "targeting_code": "Brouhaha_1_Factual" } ], "set_ids": [ "89bf6740-f7dc-bc45-8531-34f9642dc6b5" ], "collaborators": [ { "type": "user", "id": "93fa7845-de45-45eb-b7a5-0937ca0a0851", "label": "partnerservices+mediamath@factual.com", "permissions": { "view": true, "edit": true } } ], "is_shared_to_current_user": false, "is_shared_to_current_org": false, "id": "6bb29056-f06e-96e0-a23c-2fb973d2d23e", "status": "built" } } } } } }, "description": "Returns all details about a specific Proximity or Audience design. This endpoint only accepts GET requests. Replace (design Id) with the id of the design for which you are requesting information.\n\nSample endpoint: /hyperlocal/geopulse/designs/(design Id)\n\nSample usage: /hyperlocal/geopulse/designs/223e8f0e-ab5f-69e0-8a3d-a7ce62945768", "summary": "Get design details for a specific design", "parameters": [ { "in": "path", "name": "design_id", "type": "string", "required": true, "description": "Design ID, which is a GUID" } ], "operationId": "get_geo_designs_did", "tags": [ "Geopulse" ] } }, "/atomic_creatives/{id}": { "get": { "description": "#### Retrieve Secure/SSL Creative Scan and K-size Results\nThough users should still self-declare the security status of a creative (`atomic_creatives.is_https`), TerminalOne offers automated scanning/validation of the tag. The results of the automated scans are stored in `atomic_creative_ssl_validators` (high level metadata, i.e. is the creative secure, and what is the total k-size loaded) and `atomic_creative_detected_tag_urls` (individual http request URLs detected, broken out by secure and non-secure).\n\nIn cases where there is a conflict (i.e. self declared `atomic_creatives.is_https` was '1', but `atomic_creative_ssl_validators.is_https` = 'NO'), the validator results are honored for creative approvals (AdX, Appnexus, Yahoo Exchange) and bidding.\n\nIn cases where the validator results in an `is_https=UNKNOWN`, `ERROR` or `INACTIVE` result, the self declared atomic_creatives.is_https value are honored for creative approvals and bidding.", "operationId": "GET_atomic_creatives-id", "parameters": [ { "enum": [ "atomic_creative_ssl_validators", "atomic_creative_detected_tag_urls" ], "in": "query", "name": "with", "type": "string" }, { "in": "header", "name": "Via", "type": "string" }, { "in": "header", "name": "Total-Route-Time", "type": "integer" }, { "in": "header", "name": "Connect-Time", "type": "integer" }, { "in": "header", "name": "Authorization", "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "examples": { "text/xml": { "data": [ { "ad_format": "est adipisicing et reprehenderit", "ad_server_type": "Duis minim", "advertiser_id": -4230310, "approval_status": "PENDING", "built": true, "built_by_user_id": -26146376, "click_through_url": "est voluptate", "click_url": "nulla Excepteur commodo esse", "concept_id": -40586178, "creative_import_file_id": 30533385, "edited_tag": "exercitation consequat", "expand": "RD", "expansion_direction": "velit reprehenderit", "external_identifier": "in", "file_type": "swf", "has_sound": true, "height": -51947191, "id": -78865297, "is_https": false, "is_mraid": false, "is_multi_creative": true, "last_modified": "veniam do", "name": "Ut ad esse", "rich_media": false, "t1as": false, "tag": "eiusmod non", "tag_type": "NOSCRIPT", "tpas_ad_tag_name": "sit occaecat", "updated_on": "nostrud aute", "version": -1055606, "width": 78925043 }, { "ad_server_type": "cupidatat", "advertiser_id": 59274710, "built": true, "built_by_user_id": -47182635, "click_through_url": "amet ex", "concept_id": -68062913, "creative_import_file_id": 55692970, "expand": "R", "expansion_direction": "mollit sunt proident ut", "external_identifier": "qui dolor", "file_type": "zip", "height": 42720471, "id": -71087506, "is_https": true, "last_modified": "minim non", "media_type": "mobile", "name": "laboris ipsum veniam dolore exercitation", "rich_media": false, "status": true, "tag": "fugia", "tag_type": "SCRIPT", "tpas_ad_tag_name": "occaecat incididunt eiusmod es", "updated_on": "culpa", "width": -97519501 }, { "ad_format": "aliqua eu", "ad_server_type": "adipisicing fugiat velit", "advertiser_id": 64835510, "creative_import_file_id": 42159928, "expansion_trigger": "MOUSEOVER", "external_identifier": "cupidatat", "file_type": "swf", "height": 90566487, "id": 7182314, "is_multi_creative": false, "name": "et ut laborum ea", "t1as": false, "tag": "ut", "tag_type": "IMG", "tpas_ad_tag_name": "sint aliqua", "width": -24348175 }, { "ad_server_type": "nostrud aliqua Duis", "advertiser_id": -26342963, "external_identifier": "dolore Lorem fugiat ipsum ", "file_type": "jpg", "height": 6856137, "name": "ut Excepteur", "tag": "voluptate est", "tag_type": "NOSCRIPT", "width": 2365086 } ], "meta": { "called_on": "dolore consectetur", "count": -57894717, "etag": "dolor officia ut", "next_page": "irure tempor in esse sunt", "offset": -77577318, "status": "cupidatat voluptate", "total_count": 14902187 } } }, "schema": { "properties": { "data": { "items": { "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 } }, "type": "array" }, "meta": { "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" } }, "type": "object" } }, "type": "object" } }, "401": { "description": "", "examples": { "text/xml": { "errors": [ { "message": "The access token expired" } ], "meta": { "called_on": "2016-11-22T22:23:23+0000", "status": "auth_error" } } }, "schema": { "properties": { "errors": { "items": { "properties": { "message": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "properties": { "called_on": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "Get Atomic Creative", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_atomiccreatives-id", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST_atomic_creatives-id", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "application/xml" ], "responses": { "200": { "description": "", "examples": { "application/xml": { "data": [ { "entity_type": "atomic_creative", "id": 3263857, "name": "Expandable Test" } ], "meta": { "called_on": "2016-11-22T22:28:38+0000", "count": 100, "etag": "828840bb1eb89002d20a90d1505610e5c0f70218", "next_page": "https://api.mediamath.com/api/v2.0/atomic_creatives?page_offset=100&api_key=noapikey", "offset": 0, "status": "ok", "total_count": 27109 } } }, "schema": { "properties": { "data": { "items": { "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "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" } }, "type": "object" } }, "type": "object" } }, "401": { "description": "", "examples": { "application/xml": { "errors": [ { "message": "The access token expired" } ], "meta": { "called_on": "2016-11-22T22:23:23+0000", "status": "auth_error" } } }, "schema": { "properties": { "errors": { "items": { "properties": { "message": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "properties": { "called_on": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "Update Atomic Creative", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_atomiccreatives-id", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Update Atomic Creative" } }, "/atomic_creatives/{id}/creative_approvals": { "get": { "operationId": "GET_atomic_creatives-id-creative_approvals", "parameters": [ { "in": "header", "name": "Via", "type": "string" }, { "in": "header", "name": "Total-Route-Time", "type": "integer" }, { "in": "header", "name": "Connect-Time", "type": "integer" }, { "in": "header", "name": "Authorization", "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "examples": { "text/xml": { "data": [ { "entity_type": "atomic_creative", "id": 3263857, "name": "Expandable Test" } ], "meta": { "called_on": "2016-11-22T22:28:38+0000", "count": 100, "etag": "828840bb1eb89002d20a90d1505610e5c0f70218", "next_page": "https://api.mediamath.com/api/v2.0/atomic_creatives?page_offset=100&api_key=noapikey", "offset": 0, "status": "ok", "total_count": 27109 } } }, "schema": { "properties": { "data": { "items": { "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "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" } }, "type": "object" } }, "type": "object" } }, "401": { "description": "", "examples": { "text/xml": { "errors": [ { "message": "The access token expired" } ], "meta": { "called_on": "2016-11-22T22:23:23+0000", "status": "auth_error" } } }, "schema": { "properties": { "errors": { "items": { "properties": { "message": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "properties": { "called_on": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "List Creative Approvals", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_atomiccreatives-id-creativeapprovals", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "List Creative Approvals" }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ] }, "/atomic_creatives/{id}/creative_approvals/{approval_id}": { "get": { "operationId": "GET_atomic_creatives-id-creative_approvals-approval_id", "parameters": [ { "in": "header", "name": "Via", "type": "string" }, { "in": "header", "name": "Total-Route-Time", "type": "integer" }, { "in": "header", "name": "Connect-Time", "type": "integer" }, { "in": "header", "name": "Authorization", "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "examples": { "text/xml": { "data": [ { "entity_type": "atomic_creative", "id": 3263857, "name": "Expandable Test" } ], "meta": { "called_on": "2016-11-22T22:28:38+0000", "count": 100, "etag": "828840bb1eb89002d20a90d1505610e5c0f70218", "next_page": "https://api.mediamath.com/api/v2.0/atomic_creatives?page_offset=100&api_key=noapikey", "offset": 0, "status": "ok", "total_count": 27109 } } }, "schema": { "properties": { "data": { "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 } }, "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 } } }, "type": "object" } }, "401": { "description": "", "examples": { "text/xml": { "errors": [ { "message": "The access token expired" } ], "meta": { "called_on": "2016-11-22T22:23:23+0000", "status": "auth_error" } } }, "schema": { "properties": { "errors": { "items": { "properties": { "message": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "properties": { "called_on": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "Get Creative Approval", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_atomiccreatives-id-creativeapprovals-approvalid", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Creative Approval" }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "approval_id", "required": true, "type": "string" } ] }, "/atomic_creatives/{id}/reset_edited_tag": { "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST_atomic_creatives-id-reset_edited_tag", "parameters": [ { "in": "formData", "name": "version", "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "examples": { "text/xml": { "data": [ { "entity_type": "atomic_creative", "id": 3263857, "name": "Expandable Test" } ], "meta": { "called_on": "2016-11-22T22:28:38+0000", "count": 100, "etag": "828840bb1eb89002d20a90d1505610e5c0f70218", "next_page": "https://api.mediamath.com/api/v2.0/atomic_creatives?page_offset=100&api_key=noapikey", "offset": 0, "status": "ok", "total_count": 27109 } } }, "schema": { "properties": { "data": { "items": { "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "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" } }, "type": "object" } }, "type": "object" } }, "401": { "description": "", "examples": { "text/xml": { "errors": [ { "message": "The access token expired" } ], "meta": { "called_on": "2016-11-22T22:23:23+0000", "status": "auth_error" } } }, "schema": { "properties": { "errors": { "items": { "properties": { "message": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "properties": { "called_on": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "Reset a Creative's Edited Tag", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_atomiccreatives-id-reseteditedtag", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Reset a Creative's Edited Tag" } }, "/audience_segments": { "get": { "description": "The `audience_segments` API is used to target strategies based on third-party segments. \n\nTargeting audience segments is a two-step process:\n\n1. Find available audience segments in T1\n1. Assign audience segments to a strategy\n\n__Find Available Audience Segments__\n\nThe audience segments are organized as a taxonomy (tree) in T1. In order to retrieve audience segments, start with the top-level nodes, then recursively fetch child nodes for each level thus retrieved.\n\nThe first level in the audience segments taxonomy contains a root node for each data provider available in T1.\n\nOnce the audience segment id for an entity at the root node is known, it is possible to get information on the child audience segments of that entity.\n\nSecond-level nodes themselves have child audience segments, so the process can be repeated as needed.\n\n\n\n_Formerly, Audence Segments could also be used to apply contextual targeting provided by Integral Ad Science; however, this was deprecated. Please see `targeting_segments` for instructions to apply contextual targeting._", "operationId": "get-audience-segments", "parameters": [ { "in": "query", "name": "custom_brain_enabled", "type": "boolean" }, { "in": "query", "name": "only_brain_enabled", "type": "boolean" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "description": "name", "in": "query", "items": { "type": "string" }, "name": "sort_by", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": [ { "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 } ], "meta": { "called_on": "2017-01-24T21:57:41+0000", "count": 1, "etag": "6fad707fdd713f81006db73015bd3bdaa577bb0f", "offset": 0, "status": "ok", "total_count": 0 } } }, "schema": { "properties": { "": { "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 } }, "data": { "items": { "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 } }, "type": "array" } }, "type": "object" } } }, "summary": "List All Possible Audience Segments", "tags": [ "Targeting" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "get-audience-segments", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/campaigns": { "get": { "operationId": "GET_campaigns", "parameters": [ { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "description": "name", "in": "query", "items": { "type": "string" }, "name": "sort_by", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" } ], "produces": [ "application/vnd.mediamath.unsupported+json" ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.unsupported+json": { "data": [ { "ad_server_id": 6, "advertiser_id": 194387, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "created_on": "2017-08-09T16:08:27+0000", "currency_code": "USD", "dcs_data_is_campaign_level": false, "end_date": "2017-09-08T23:59:00+0000", "entity_type": "campaign", "frequency_interval": "not-applicable", "frequency_optimization": false, "frequency_type": "no-limit", "goal_type": "cpa", "goal_value": [ { "currency_code": "USD", "value": 10 } ], "has_custom_attribution": false, "id": 1252, "impression_cap_automatic": true, "impression_cap_type": "no-limit", "initial_start_date": "2017-08-16T00:00:00+0000", "margin_pct": 0, "merit_pixel_id": 1212069, "minimize_multi_ads": true, "name": "TestCampaign", "override_suspicious_traffic_filter": false, "pc_window_minutes": 43200, "pv_pct": 100, "pv_window_minutes": 43200, "restrict_targeting_to_deterministic_id": true, "restrict_targeting_to_same_device_id": true, "service_type": "SELF", "spend_cap_automatic": true, "spend_cap_type": "no-limit", "start_date": "2017-08-16T00:00:00+0000", "status": false, "suspicious_traffic_filter_level": 25, "total_budget": [ { "currency_code": "USD", "value": 10000 } ], "updated_on": "2017-08-09T16:08:27+0000", "use_default_ad_server": false, "use_mm_freq": false, "version": 0, "zone_name": "Etc/GMT" }, { "ad_server_id": 6, "advertiser_id": 194829, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "created_on": "2017-08-09T16:04:55+0000", "currency_code": "USD", "dcs_data_is_campaign_level": false, "end_date": "2017-10-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": 1 } ], "has_custom_attribution": false, "id": 1232, "impression_cap_automatic": false, "impression_cap_type": "no-limit", "initial_start_date": "2017-08-09T16:30:00+0000", "io_name": "", "io_reference_num": "", "margin_pct": 0, "minimize_multi_ads": false, "name": "TestCampaign1", "override_suspicious_traffic_filter": false, "pv_pct": 100, "restrict_targeting_to_deterministic_id": true, "restrict_targeting_to_same_device_id": true, "service_type": "SELF", "spend_cap_automatic": true, "spend_cap_type": "asap", "start_date": "2017-08-09T16:30:00+0000", "status": true, "suspicious_traffic_filter_level": 25, "total_budget": [ { "currency_code": "USD", "value": 2000 } ], "total_impression_budget": 100000, "updated_on": "2017-08-09T16:06:06+0000", "use_default_ad_server": false, "use_mm_freq": false, "version": 2, "zone_name": "Etc/GMT" } ], "meta": { "called_on": "2017-08-09T16:11:19+0000", "count": 2, "etag": "fde40fad168261593a0d998001742c09bccf7475", "next_page": "https://api.mediamath.com/api/v2.0/campaigns/?api_key=&full=*&page_limit=2&page_offset=2", "offset": 0, "status": "ok", "total_count": 123 } } }, "schema": { "properties": { "data": { "items": { "example": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" }, "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": { "description": "Goal type which campaign performance will be measured", "enum": [ "roi", "cpa", "cpc", "reach", "spend" ], "type": "string" }, "goal_value": { "description": "Target goal value for campaign respective to the goal_type selection.\n\nrequired if `goal_type in ('cpa','cpc','reach','roi')`", "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "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", "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "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", "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "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" ], "title": "Read Singular Campaign", "type": "object", "x-stoplight": { "id": "read-singular-campaign", "name": "Read Singular Campaign", "public": true } }, "type": "array" }, "meta": { "properties": { "called_on": { "type": "string" }, "count": { "type": "integer" }, "etag": { "type": "string" }, "offset": { "type": "integer" }, "status": { "type": "string" }, "total_count": { "type": "integer" } }, "type": "object" } }, "type": "object" } }, "401": { "description": "", "examples": { "application/vnd.mediamath.unsupported+json": "\n\n The access token expired\n The access token expired\n The access token expired\n" }, "schema": { "type": "object" } } }, "security": [ { "oauth2": [] } ], "summary": "List Campaigns", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "List Campaigns" }, "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST-campaigns", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "201": { "description": "", "schema": { "example": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "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", "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": { "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": 512321, "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", "description": "Boolean values must be 'on', '1', '0', or 'off'" }, "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": [ "even", "asap", "no-limit" ], "type": "string" }, "goal_type": { "description": "Goal type which campaign performance will be measured", "enum": [ "roi", "cpa", "cpc", "reach", "spend", "vcr", "ctr" ], "type": "string" }, "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`, goal_value is a percentage.", "type": "string" }, "has_custom_attribution": { "description": "", "type": "boolean" }, "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": [ "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" ] }, "is_programmatic_guaranteed": { "type": "string", "description": "Sets the campaign as a Programmatic Guaranteed campaign. Once set for a campaign, it cannot be changed", "enum": [ "on", "off", 1, 0 ] }, "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": "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.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "restrict_targeting_to_same_device_id": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "spend_cap_automatic": { "description": "Automatically sets the available spend budget across all strategies through the end date of the campaign.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "updated_on": { "type": "string" }, "use_default_ad_server": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "use_mm_freq": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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" ] } } }, "summary": "Create Campaign", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST-campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Create Campaign" } }, "/campaigns/{campaign_id}": { "get": { "operationId": "GET_campaign", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" }, "meta": { "called_on": "2016-11-23T19:15:16+0000", "etag": "3b15a5d063e860c3c33e2621207a12f940db04f9", "status": "ok" } } }, "schema": { "properties": { "data": { "example": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" }, "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": { "description": "Goal type which campaign performance will be measured", "enum": [ "roi", "cpa", "cpc", "reach", "spend" ], "type": "string" }, "goal_value": { "description": "Target goal value for campaign respective to the goal_type selection.\n\nrequired if `goal_type in ('cpa','cpc','reach','roi')`", "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "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", "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "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", "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "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" ], "title": "Read Singular Campaign", "type": "object", "x-stoplight": { "id": "read-singular-campaign", "name": "Read Singular Campaign", "public": true } }, "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 } } }, "type": "object" } } }, "summary": "Get Campaign", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Campaign" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "Update-campaigns", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" }, "meta": { "called_on": "2016-11-23T19:15:16+0000", "etag": "3b15a5d063e860c3c33e2621207a12f940db04f9", "status": "ok" } } }, "schema": { "properties": { "data": { "example": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "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", "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": { "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": 512321, "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", "description": "Boolean values must be 'on', '1', '0', or 'off'" }, "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": [ "even", "asap", "no-limit" ], "type": "string" }, "goal_type": { "description": "Goal type which campaign performance will be measured", "enum": [ "roi", "cpa", "cpc", "reach", "spend", "vcr", "ctr" ], "type": "string" }, "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`, goal_value is a percentage.", "type": "string" }, "has_custom_attribution": { "description": "", "type": "boolean" }, "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": [ "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" ] }, "is_programmatic_guaranteed": { "type": "string", "description": "Sets the campaign as a Programmatic Guaranteed campaign. Once set for a campaign, it cannot be changed", "enum": [ "on", "off", 1, 0 ] }, "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": "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.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "restrict_targeting_to_same_device_id": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "spend_cap_automatic": { "description": "Automatically sets the available spend budget across all strategies through the end date of the campaign.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "updated_on": { "type": "string" }, "use_default_ad_server": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "use_mm_freq": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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" ] }, "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 } } }, "type": "object" } } }, "summary": "Update Campaign", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Update Campaign" } }, "/campaigns/{campaign_id}/budget_flights": { "get": { "operationId": "List-Budget-Flights", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": [ { "entity_type": "budget_flight", "id": 283192, "name": "Budget Flights #283192" } ], "meta": { "called_on": "2016-11-30T22:11:11+0000", "count": 1, "etag": "e7eefe28e8f0ee9adff6962dcfebeb3fe181aba8", "offset": 0, "status": "ok", "total_count": 1 } } }, "schema": { "properties": { "data": { "items": { "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" }, "properties": { "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "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", "type": "string" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "is_relevant": { "type": "boolean" }, "name": { "type": "string" }, "start_date": { "type": "string" }, "total_budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "updated_on": { "type": "string" }, "version": { "type": "integer" }, "zone_name": { "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", "type": "string" } }, "title": "Budget Flight", "type": "object", "x-stoplight": { "id": "budget-flight", "name": "Budget Flight", "public": true } }, "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 } } }, "type": "object" } } }, "summary": "List Budget Flights", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "List Budget Flights" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "integer" } ], "post": { "operationId": "CreateBudgetFlight", "parameters": [ { "in": "body", "name": "body", "schema": { "properties": { "end_date": { "type": "string" }, "start_date": { "type": "string" }, "total_budget": { "type": [ "integer", "number" ] }, "total_impression_budget": { "description": "Allocated impression budget for the campaign.\t", "type": "integer" } }, "required": [ "start_date", "end_date", "total_budget" ], "type": "object" } }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" }, "meta": { "called_on": "2016-11-23T19:15:16+0000", "etag": "3b15a5d063e860c3c33e2621207a12f940db04f9", "status": "ok" } } }, "schema": { "properties": { "data": { "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" }, "properties": { "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "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", "type": "string" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "is_relevant": { "type": "boolean" }, "name": { "type": "string" }, "start_date": { "type": "string" }, "total_budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "updated_on": { "type": "string" }, "version": { "type": "integer" }, "zone_name": { "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", "type": "string" } }, "title": "Budget Flight", "type": "object", "x-stoplight": { "id": "budget-flight", "name": "Budget Flight", "public": true } }, "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 } } }, "type": "object" } } }, "summary": "Create Budget Flight", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Create Budget Flight" } }, "/campaigns/{campaign_id}/budget_flights/bulk": { "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "integer" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "bulk-create-budget-flights", "parameters": [ { "in": "formData", "name": "budget_flights.[x].start_date", "required": true, "type": "string" }, { "in": "formData", "name": "budget_flights.[x].end_date", "required": true, "type": "string" }, { "in": "formData", "name": "budget_flights.[x].total_budget", "required": true, "type": "integer" }, { "description": "Allocated impression budget for the campaign.\t", "in": "formData", "name": "budget_flights.[x].total_impression_budget", "type": "integer" }, { "in": "formData", "name": "budget_flights.[x].version", "type": "integer" }, { "description": "Update existing flight if positive id is supplied. Delete existing flight if negative. If id is not supplied, create new flight.", "in": "formData", "name": "budget_flights.[x].id", "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": [ { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" } ], "meta": { "called_on": "2016-11-23T19:15:16+0000", "etag": "3b15a5d063e860c3c33e2621207a12f940db04f9", "status": "ok" } } }, "schema": { "properties": { "data": { "items": { "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" }, "properties": { "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "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", "type": "string" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "is_relevant": { "type": "boolean" }, "name": { "type": "string" }, "start_date": { "type": "string" }, "total_budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "updated_on": { "type": "string" }, "version": { "type": "integer" }, "zone_name": { "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", "type": "string" } }, "title": "Budget Flight", "type": "object", "x-stoplight": { "id": "budget-flight", "name": "Budget Flight", "public": true } }, "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 } } }, "type": "object" } } }, "summary": "Bulk Create Budget Flights", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Bulk Create Budget Flights" } }, "/campaigns/{campaign_id}/budget_flights/{id}": { "get": { "operationId": "Get-Budget-Flight", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" }, "meta": { "called_on": "2016-11-23T19:15:16+0000", "etag": "3b15a5d063e860c3c33e2621207a12f940db04f9", "status": "ok" } } }, "schema": { "properties": { "data": { "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" }, "properties": { "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "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", "type": "string" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "is_relevant": { "type": "boolean" }, "name": { "type": "string" }, "start_date": { "type": "string" }, "total_budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "updated_on": { "type": "string" }, "version": { "type": "integer" }, "zone_name": { "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", "type": "string" } }, "title": "Budget Flight", "type": "object", "x-stoplight": { "id": "budget-flight", "name": "Budget Flight", "public": true } }, "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 } } }, "type": "object" } } }, "summary": "Get Budget Flight", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Budget Flight" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "integer" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST-update-budget-flight", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "properties": { "data": { "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" }, "properties": { "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "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", "type": "string" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "is_relevant": { "type": "boolean" }, "name": { "type": "string" }, "start_date": { "type": "string" }, "total_budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "updated_on": { "type": "string" }, "version": { "type": "integer" }, "zone_name": { "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", "type": "string" } }, "title": "Budget Flight", "type": "object", "x-stoplight": { "id": "budget-flight", "name": "Budget Flight", "public": true } }, "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 } } }, "type": "object" } } }, "summary": "Update Budget Flight", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST-update-budget-flight", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Update Budget Flight" } }, "/campaigns/{campaign_id}/budget_flights/{id}/delete": { "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "integer" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST_campaigns-campaign_id-budget_flights-id-delete", "parameters": [ { "in": "formData", "name": "version", "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" }, "meta": { "called_on": "2016-11-23T19:15:16+0000", "etag": "3b15a5d063e860c3c33e2621207a12f940db04f9", "status": "ok" } } }, "schema": { "properties": { "data": { "example": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "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", "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": { "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": 512321, "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", "description": "Boolean values must be 'on', '1', '0', or 'off'" }, "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": [ "even", "asap", "no-limit" ], "type": "string" }, "goal_type": { "description": "Goal type which campaign performance will be measured", "enum": [ "roi", "cpa", "cpc", "reach", "spend", "vcr", "ctr" ], "type": "string" }, "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`, goal_value is a percentage.", "type": "string" }, "has_custom_attribution": { "description": "", "type": "boolean" }, "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": [ "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" ] }, "is_programmatic_guaranteed": { "type": "string", "description": "Sets the campaign as a Programmatic Guaranteed campaign. Once set for a campaign, it cannot be changed", "enum": [ "on", "off", 1, 0 ] }, "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": "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.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "restrict_targeting_to_same_device_id": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "spend_cap_automatic": { "description": "Automatically sets the available spend budget across all strategies through the end date of the campaign.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "updated_on": { "type": "string" }, "use_default_ad_server": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "use_mm_freq": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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" ] }, "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 } } }, "type": "object" } } }, "summary": "Delete Budget Flights", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_campaigns-campaignid-budgetflights-id-delete", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Delete Budget Flights" } }, "/campaigns/{campaign_id}/bulk_edits": { "get": { "operationId": "GET_campaigns-campaign_id-bulk_edits", "responses": { "default": { "description": "", "schema": {} } }, "summary": "List Bulk Editors", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_campaigns-campaignid-bulkedits", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "List Bulk Editors" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" } ], "post": { "description": "The query param `create_and_execute` defines if we have to pass the data parameter in the request body. If this query param is set to `true` or `1` then we must pass the data in the request body", "operationId": "POST_campaigns-campaign_id-bulk_edits", "parameters": [ { "in": "query", "name": "create_and_execute", "type": "boolean" } ], "responses": { "default": { "description": "", "schema": {} } }, "summary": "Create Bulk Editor", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_campaigns-campaignid-bulkedits", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/campaigns/{campaign_id}/bulk_edits/{bulk_editor_id}/actions": { "delete": { "operationId": "DELETE_campaigns-campaign_id-bulk_edits-bulk_editor_id-actions", "parameters": [ { "default": "(1,2,3)", "in": "query", "name": "action_ids", "type": "string" }, { "default": "concepts", "description": "", "in": "query", "name": "tag", "type": "string" } ], "responses": { "default": { "description": "", "schema": {} } }, "summary": "Delete Bulk Editor Actions", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "DELETE_campaigns-campaignid-bulkedits-bulkeditorid-actions", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Delete Bulk Editor Actions" }, "get": { "operationId": "GET_campaigns-campaign_id-bulk_edits-bulk_editor_id-actions", "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": "[\n {\n \"collection\": \"strategies\",\n \"update\": {\n \"pixel_target_exrp_targeting_operator\": \"AND\"\n },\n \"tag\": \"details\",\n \"action_id\": 1\n }, {\n \"collection\": \"strategies\",\n \"update\": {\n \"time_zone\": \"Casablanca\",\n },\n \"tag\": \"details\",\n \"action_id\": 2\n }, {\n \"collection\": \"strategies\",\n \"add\": {\n \"collection\": \"concepts\",\n \"id\": 100001\n },\n \"tag\": \"concepts\",\n \"action_id\": 3\n }, {\n \"collection\": \"strategies\",\n \"add\": {\n \"collection\": \"concepts\",\n \"id\": 100002\n },\n \"tag\": \"concepts\",\n \"action_id\": 4\n }, {\n \"collection\": \"strategies\",\n \"remove\": {\n \"collection\": \"target_values\",\n \"id\": 100001\n },\n \"tag\": \"location\",\n \"action_id\": 5\n }, {\n \"collection\": \"strategies\",\n \"remove\": {\n \"collection\": \"target_values\",\n \"id\": 100002\n },\n \"tag\": \"location\",\n \"action_id\": 6\n }, {\n \"collection\": \"strategies\",\n \"remove\": {\n \"collection\": \"target_values\",\n \"id\": 100003\n },\n \"tag\": \"location\",\n \"action_id\": 7\n }, {\n \"collection\": \"strategies\",\n \"overwrite\": {\n \"collection\": \"target_values\",\n \"id\": 100001,\n \"exclude\": false\n },\n \"tag\": \"location\",\n \"action_id\": 8\n }, {\n \"collection\": \"strategies\",\n \"overwrite\": {\n \"collection\": \"target_values\",\n \"id\": 100002,\n \"exclude\": true\n },\n \"tag\": \"location\",\n \"action_id\": 9\n }, {\n \"collection\": \"strategies\",\n \"overwrite\": {\n \"collection\": \"target_values\",\n \"id\": 100003,\n \"exclude\": false\n },\n \"tag\": \"location\",\n \"action_id\": 10\n }\n]" }, "schema": { "items": { "example": [ { "collection": "strategies", "tag": "details" }, { "add": { "collection": "concepts", "id": 100001 }, "collection": "strategies", "tag": "concepts" }, { "add": { "collection": "concepts", "id": 100002 }, "collection": "strategies", "tag": "concepts" }, { "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", "overwrite": { "collection": "target_values", "exclude": false, "id": 100001 }, "tag": "location" }, { "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": true, "id": 100002 }, "tag": "location" }, { "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": false, "id": 100003 }, "tag": "location" } ], "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 } }, "type": "array" } } }, "summary": "Get Bulk Editor Actions", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_campaigns-campaignid-bulkedits-bulkeditorid-actions", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Bulk Editor Actions" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" }, { "in": "path", "name": "bulk_editor_id", "required": true, "type": "string" } ], "post": { "operationId": "POST_campaigns-campaign_id-bulk_edits-bulk_editor_id-actions", "parameters": [ { "in": "body", "name": "body", "schema": { "items": { "example": [ { "collection": "strategies", "tag": "details" }, { "add": { "collection": "concepts", "id": 100001 }, "collection": "strategies", "tag": "concepts" }, { "add": { "collection": "concepts", "id": 100002 }, "collection": "strategies", "tag": "concepts" }, { "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", "overwrite": { "collection": "target_values", "exclude": false, "id": 100001 }, "tag": "location" }, { "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": true, "id": 100002 }, "tag": "location" }, { "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": false, "id": 100003 }, "tag": "location" } ], "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 } }, "type": "array" } } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": "[\n {\n \"collection\": \"strategies\",\n \"update\": {\n \"pixel_target_exrp_targeting_operator\": \"AND\"\n },\n \"tag\": \"details\",\n \"action_id\": 1\n }, {\n \"collection\": \"strategies\",\n \"update\": {\n \"time_zone\": \"Casablanca\",\n },\n \"tag\": \"details\",\n \"action_id\": 2\n }, {\n \"collection\": \"strategies\",\n \"add\": {\n \"collection\": \"concepts\",\n \"id\": 100001\n },\n \"tag\": \"concepts\",\n \"action_id\": 3\n }, {\n \"collection\": \"strategies\",\n \"add\": {\n \"collection\": \"concepts\",\n \"id\": 100002\n },\n \"tag\": \"concepts\",\n \"action_id\": 4\n }, {\n \"collection\": \"strategies\",\n \"remove\": {\n \"collection\": \"target_values\",\n \"id\": 100001\n },\n \"tag\": \"location\",\n \"action_id\": 5\n }, {\n \"collection\": \"strategies\",\n \"remove\": {\n \"collection\": \"target_values\",\n \"id\": 100002\n },\n \"tag\": \"location\",\n \"action_id\": 6\n }, {\n \"collection\": \"strategies\",\n \"remove\": {\n \"collection\": \"target_values\",\n \"id\": 100003\n },\n \"tag\": \"location\",\n \"action_id\": 7\n }, {\n \"collection\": \"strategies\",\n \"overwrite\": {\n \"collection\": \"target_values\",\n \"id\": 100001,\n \"exclude\": false\n },\n \"tag\": \"location\",\n \"action_id\": 8\n }, {\n \"collection\": \"strategies\",\n \"overwrite\": {\n \"collection\": \"target_values\",\n \"id\": 100002,\n \"exclude\": true\n },\n \"tag\": \"location\",\n \"action_id\": 9\n }, {\n \"collection\": \"strategies\",\n \"overwrite\": {\n \"collection\": \"target_values\",\n \"id\": 100003,\n \"exclude\": false\n },\n \"tag\": \"location\",\n \"action_id\": 10\n }\n]" }, "schema": { "items": { "example": [ { "collection": "strategies", "tag": "details" }, { "add": { "collection": "concepts", "id": 100001 }, "collection": "strategies", "tag": "concepts" }, { "add": { "collection": "concepts", "id": 100002 }, "collection": "strategies", "tag": "concepts" }, { "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", "overwrite": { "collection": "target_values", "exclude": false, "id": 100001 }, "tag": "location" }, { "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": true, "id": 100002 }, "tag": "location" }, { "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": false, "id": 100003 }, "tag": "location" } ], "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 } }, "type": "array" } } }, "summary": "Create Bulk Editor Actions", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_campaigns-campaignid-bulkedits-bulkeditorid-actions", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Create Bulk Editor Actions" } }, "/campaigns/{campaign_id}/bulk_edits/{bulk_editor_id}/execute": { "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" }, { "in": "path", "name": "bulk_editor_id", "required": true, "type": "string" } ], "post": { "description": "Marks the Bulk Editor as ready for execution. The bulk editor will be executed after the staging processes for all of the actions are finished.", "operationId": "POST_campaigns-campaign_id-bulk_edits-bulk_editor_id-execute", "responses": { "default": { "description": "", "schema": {} } }, "summary": "Stage Bulk Editor for Execution", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_campaigns-campaignid-bulkedits-bulkeditorid-execute", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/campaigns/{campaign_id}/bulk_edits/{bulk_editor_id}/status": { "get": { "operationId": "GET_campaigns-campaign_id-bulk_edits-bulk_editor_id-status", "parameters": [ { "description": "This flag causes the targets and actions fields to be omitted from the response.\n\n1 or 0", "in": "query", "name": "dynamic_only", "type": "boolean" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "actions": [ { "action_id": 1, "collection": "strategies", "tag": "details" }, { "action_id": 2, "collection": "strategies", "tag": "details" }, { "action_id": 3, "add": { "collection": "concepts", "id": 100001 }, "collection": "strategies", "tag": "concepts" }, { "action_id": 4, "add": { "collection": "concepts", "id": 100002 }, "collection": "strategies", "tag": "concepts" }, { "action_id": 5, "collection": "strategies", "remove": { "collection": "target_values", "id": 100001 }, "tag": "location" }, { "action_id": 6, "collection": "strategies", "remove": { "collection": "target_values", "id": 100002 }, "tag": "location" }, { "action_id": 7, "collection": "strategies", "remove": { "collection": "target_values", "id": 100003 }, "tag": "location" }, { "action_id": 8, "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": false, "id": 100001 }, "tag": "location" }, { "action_id": 9, "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": true, "id": 100002 }, "tag": "location" }, { "action_id": 10, "collection": "strategies", "overwrite": { "collection": "target_values", "exclude": false, "id": 100003 }, "tag": "location" } ], "editor_error": "", "editor_id": 1, "editor_status": "open", "execution_errors": [ { "action": "add", "collection": "strategy", "error_message": "weighting types must all be the same", "id": 1, "subcollection": "concepts" }, { "action": "overwrite", "collection": "strategy", "error_message": "weighting percentages must add up to 100%", "id": 2, "subcollection": "concepts" } ], "execution_status": "pending", "targets": [ { "collection": "strategies", "entities": [ { "entity_id": 100001, "target_id": 1 }, { "entity_id": 100002, "target_id": 2 }, { "entity_id": 100003, "target_id": 2 }, { "entity_id": 100004, "target_id": 2 } ] } ] } }, "schema": { "properties": { "actions": { "items": { "properties": { "action_id": { "type": "integer" }, "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" }, "type": "array" }, "editor_error": { "type": "string" }, "editor_id": { "type": "integer" }, "editor_status": { "type": "string" }, "execution_errors": { "items": { "properties": { "action": { "type": "string" }, "collection": { "type": "string" }, "error_message": { "type": "string" }, "id": { "type": "integer" }, "subcollection": { "type": "string" } }, "type": "object" }, "type": "array" }, "execution_status": { "type": "string" }, "targets": { "items": { "properties": { "collection": { "type": "string" }, "entities": { "items": { "properties": { "entity_id": { "type": "integer" }, "target_id": { "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "summary": "Get Bulk Editor Status", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_campaigns-campaignid-bulkedits-bulkeditorid-status", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Bulk Editor Status" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" }, { "in": "path", "name": "bulk_editor_id", "required": true, "type": "string" } ] }, "/campaigns/{campaign_id}/bulk_edits/{bulk_editor_id}/targets": { "delete": { "description": "Deactivates targets in the Bulk Editor\n\n#### Data Format\n\n```\ntarget_ids=(1,2,3)\n```\n\n```\ncollection=strategies&entity_ids=(100001,100002,100003)\n```\n\n```\ncollection=strategies&parent_collection=campaigns&parent_id=100001&all=true\n```\n\n```\ncollection=strategies&parent_collection=campaigns&parent_id=100001&all=true&skip_entities=(100001)\n```\n\nThese four versions of the query data are available to make target deletion\nconvenient and analogous to the target creation.\n\nThe `target_ids` should be a list of `target_id` numbers as seen in the GET\n`targets` data.\n\nThe `collection` should be the name of the target collection and the\n`entity_ids` should be a list of `entity_id` numbers as seen in the GET\n`targets` data.\n\nThe `parent_collection` and `parent_id` fields are required if the `all` field\nis set to true. The `skip_entities` field may be used in this case as well.\n\nThis endpoint returns a `status` response on success or a standard Adama error\nmessage in case of failure.", "operationId": "DELETE_campaigns-campaign_id-bulk_edits-bulk_editor_id-targets", "parameters": [ { "default": "(1,2,3)", "in": "query", "name": "action_ids", "type": "string" }, { "default": "concepts", "description": "", "in": "query", "name": "tag", "type": "string" } ], "responses": { "default": { "description": "", "schema": {} } }, "summary": "Delete Bulk Editor Targets", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "DELETE_campaigns-campaignid-bulkedits-bulkeditorid-targets", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } }, "get": { "operationId": "GET_campaigns-campaign_id-bulk_edits-bulk_editor_id-targets", "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": [ { "collection": "strategies", "entities": [ { "entity_id": 100001, "target_id": 1 }, { "entity_id": 100002, "target_id": 2 }, { "entity_id": 100003, "target_id": 2 }, { "entity_id": 100004, "target_id": 2 } ] } ] }, "schema": { "items": { "properties": { "collection": { "type": "string" }, "entities": { "items": { "properties": { "entity_id": { "type": "integer" }, "target_id": { "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } } }, "summary": "Get Bulk Editor Targets", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_campaigns-campaignid-bulkedits-bulkeditorid-targets", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Bulk Editor Targets" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" }, { "in": "path", "name": "bulk_editor_id", "required": true, "type": "string" } ], "post": { "operationId": "POST_campaigns-campaign_id-bulk_edits-bulk_editor_id-targets", "parameters": [ { "in": "body", "name": "body", "schema": { "items": { "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 } }, "type": "array" } } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": [ { "collection": "strategies", "update": { "pixel_target_exrp_targeting_operator": "AND" }, "tag": "details", "action_id": 1 }, { "collection": "strategies", "update": { "time_zone": "Casablanca" }, "tag": "details", "action_id": 2 }, { "collection": "strategies", "add": { "collection": "concepts", "id": 100001 }, "tag": "concepts", "action_id": 3 }, { "collection": "strategies", "add": { "collection": "concepts", "id": 100002 }, "tag": "concepts", "action_id": 4 }, { "collection": "strategies", "remove": { "collection": "target_values", "id": 100001 }, "tag": "location", "action_id": 5 }, { "collection": "strategies", "remove": { "collection": "target_values", "id": 100002 }, "tag": "location", "action_id": 6 }, { "collection": "strategies", "remove": { "collection": "target_values", "id": 100003 }, "tag": "location", "action_id": 7 }, { "collection": "strategies", "overwrite": { "collection": "target_values", "id": 100001, "exclude": false }, "tag": "location", "action_id": 8 }, { "collection": "strategies", "overwrite": { "collection": "target_values", "id": 100002, "exclude": true }, "tag": "location", "action_id": 9 }, { "collection": "strategies", "overwrite": { "collection": "target_values", "id": 100003, "exclude": false }, "tag": "location", "action_id": 10 } ] }, "schema": { "items": { "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 } }, "type": "array" } } }, "summary": "Create Bulk Editor Targets", "tags": [ "Campaign Bulk Editor" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_campaigns-campaignid-bulkedits-bulkeditorid-targets", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Create Bulk Editor Targets" } }, "/campaigns/{campaign_id}/copy": { "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" } ], "post": { "description": "**Settings that don't get copied over:**\n1. Vendor Agreements \n2. Budget Flights\n3. Campaign's Brain\n4. Creative Concepts", "operationId": "copy-campaign", "parameters": [ { "in": "body", "name": "body", "schema": { "properties": { "end_date": { "type": "string" }, "name": { "type": "string" }, "start_date": { "type": "string" } }, "type": "object" } }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" } ], "responses": { "201": { "description": "", "schema": { "example": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "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", "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": { "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": 512321, "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", "description": "Boolean values must be 'on', '1', '0', or 'off'" }, "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": [ "even", "asap", "no-limit" ], "type": "string" }, "goal_type": { "description": "Goal type which campaign performance will be measured", "enum": [ "roi", "cpa", "cpc", "reach", "spend", "vcr", "ctr" ], "type": "string" }, "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`, goal_value is a percentage.", "type": "string" }, "has_custom_attribution": { "description": "", "type": "boolean" }, "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": [ "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" ] }, "is_programmatic_guaranteed": { "type": "string", "description": "Sets the campaign as a Programmatic Guaranteed campaign. Once set for a campaign, it cannot be changed", "enum": [ "on", "off", 1, 0 ] }, "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": "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.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "restrict_targeting_to_same_device_id": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "spend_cap_automatic": { "description": "Automatically sets the available spend budget across all strategies through the end date of the campaign.", "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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": "integer" }, "updated_on": { "type": "string" }, "use_default_ad_server": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "use_mm_freq": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "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" ] } } }, "summary": "Copy Campaign", "tags": [ "Campaign Duplication" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "copy-campaign", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/campaigns/{campaign_id}/custom_brain_selections": { "get": { "operationId": "list-custom-brain-selections", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": [ { "entity_type": "budget_flight", "id": 283192, "name": "Budget Flights #283192" } ], "meta": { "called_on": "2016-11-30T22:11:11+0000", "count": 1, "etag": "e7eefe28e8f0ee9adff6962dcfebeb3fe181aba8", "offset": 0, "status": "ok", "total_count": 1 } } }, "schema": { "properties": { "data": { "items": { "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 } }, "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 } } }, "type": "object" } } }, "summary": "List Custom Brain Selections", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "List Custom Brain Selections" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" } ] }, "/campaigns/{campaign_id}/custom_brain_selections/bulk": { "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "To set custom audiences in the brain for a campaign, construct a POST request as follows, inserting an id for each segment the campaign should include (up to 20)", "operationId": "edit-custom-brain", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "ad_server_id": 6, "advertiser_id": 122631, "agency_fee_pct": 0, "conversion_type": "variable", "conversion_variable_minutes": 1, "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": "", "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" }, "meta": { "called_on": "2016-11-23T19:15:16+0000", "etag": "3b15a5d063e860c3c33e2621207a12f940db04f9", "status": "ok" } } }, "schema": { "properties": { "data": { "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 } }, "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 } } }, "type": "object" } } }, "summary": "Edit Custom Brain Selections", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-campaigns", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/campaigns/{campaign_id}/site_lists": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "GET_campaigns-campaign_id-site_lists", "responses": { "default": { "description": "", "schema": {} } }, "summary": "List Campaign Site Lists", "tags": [ "Site Lists" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_campaigns-campaignid-sitelists", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "List Campaign Site Lists" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST_campaigns-campaign_id-site_lists", "parameters": [ { "in": "formData", "name": "site_lists.1.id", "type": "string" }, { "in": "formData", "name": "site_lists.1.assigned", "type": "string" } ], "responses": { "default": { "description": "", "schema": {} } }, "summary": "Assign Site List to Campaign", "tags": [ "Site Lists" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_campaigns-campaignid-sitelists", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Assign Site List to Campaign" } }, "/campaigns/{campaign_id}/total_spend": { "get": { "consumes": [ "application/json" ], "operationId": "GET_campaigns-id-total_spend", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "", "examples": { "application/json": { "data": { "aggregate": { "function": "sum", "name": "total_spend", "value": "0.00" }, "entity_type": "campaign", "id": 2644723, "name": "test" }, "meta": { "status": "ok" } } }, "schema": { "properties": { "data": { "properties": { "aggregate": { "properties": { "function": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "security": [ { "oauth2": [] } ], "summary": "Get Campaign Total Spend", "tags": [ "Campaigns" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_campaigns-id-totalspend", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Campaign Total Spend" }, "parameters": [ { "in": "path", "name": "campaign_id", "required": true, "type": "string" } ] }, "/concepts": { "get": { "operationId": "GET_concepts", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "schema": { "properties": { "data": { "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 } }, { "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 } } ], "title": "Output Concept", "type": "object", "x-stoplight": { "id": "output-concept", "name": "Output Concept", "public": true } }, "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 } } }, "type": "object" } } }, "summary": "List Concepts", "tags": [ "Concepts" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_concepts", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "List Concepts" }, "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST-concepts", "responses": { "201": { "description": "", "schema": { "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 } }, { "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 } } ], "title": "Output Concept", "type": "object", "x-stoplight": { "id": "output-concept", "name": "Output Concept", "public": true } } } }, "security": [ { "oauth2": [] } ], "summary": "Create Concept", "tags": [ "Concepts" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST-concepts", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Create Concept" } }, "/concepts/{concept_id}": { "get": { "operationId": "GET_concepts-concept_id", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "produces": [ "text/xml" ], "responses": { "200": { "description": "", "schema": { "properties": { "data": { "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 } }, { "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 } } ], "title": "Output Concept", "type": "object", "x-stoplight": { "id": "output-concept", "name": "Output Concept", "public": true } }, "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 } } }, "type": "object" } } }, "summary": "Get Concept", "tags": [ "Concepts" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_concepts-conceptid", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Concept" }, "parameters": [ { "in": "path", "name": "concept_id", "required": true, "type": "string" } ] }, "/contracts": { "get": { "operationId": "LIST-contracts", "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": [ { "name": "non officia aute nisi" }, {}, {}, { "entity_type": "ullamco laborum", "id": 79660451 } ], "meta": { "called_on": "nostrud", "count": -5324977, "etag": "labore voluptate", "offset": -9906643, "status": "nostrud dolore", "total_count": 18836323 } } }, "schema": { "properties": { "data": { "items": { "properties": { "entity_type": { "type": "string" }, "id": { "minimum": 1, "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "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 } } }, "type": "object" } } }, "summary": "List Contracts", "tags": [ "Contracts" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "LIST-contracts", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "List Contracts" }, "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST-contracts", "responses": { "201": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "adaptive_segment_cpm": [ { "currency_code": "USD", "value": 0 } ], "contract_number": 103074, "created_on": "2016-08-29T19:54:25+0000", "currency_code": "USD", "effective_end_date": "2017-03-21T00: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 } ], "id": 3385, "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 } ], "updated_on": "2016-08-29T19:54:25+0000", "version": 8 }, "meta": { "called_on": "2017-03-03T20:08:20+0000", "etag": "2a64a9a52d66302464fe557340b33ec849028460", "status": "ok" } } }, "schema": { "example": { "data": { "adaptive_segment_cpm": [ {} ], "contract_number": -34492430, "currency_code": "Lorem cupidatat qui ullamco", "effective_end_date": "aliquip", "effective_start_date": "nisi voluptate n", "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" } ] }, "meta": { "called_on": "laborum voluptate dolore", "count": 27422536, "etag": "enim id Excepteur magna", "offset": -47785040, "status": "amet", "total_count": -77774937 } }, "properties": { "data": { "example": { "adaptive_segment_cpm": [ { "currency_code": "USD", "value": 0 } ], "contract_number": 103074, "currency_code": "USD", "effective_end_date": "2017-03-21T00: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 } ] }, "properties": { "adaptive_segment_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "contract_number": { "type": "integer" }, "currency_code": { "type": "string" }, "effective_end_date": { "type": "string" }, "effective_start_date": { "type": "string" }, "entity_type": { "type": "string" }, "evidon_privacy_cost_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "exclude_agency_margin": { "type": "boolean" }, "external_media_tracking_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "fbx_dynamic_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "managed_service_fee_pct": { "type": "integer" }, "managed_service_fee_unit": { "type": "string" }, "name": { "type": "string" }, "optimization_fee_pct": { "type": "integer" }, "optimization_fee_unit": { "type": "string" }, "organization_id": { "type": "integer" }, "peer39_channel_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_custom_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_quality_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_safety_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "platform_access_fee_pct": { "type": "integer" }, "platform_access_fee_unit": { "type": "string" }, "platform_monthly_min": { "type": "integer" }, "pmp_optimization_off_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_off_unit": { "type": "string" }, "pmp_optimization_on_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_on_unit": { "type": "string" }, "profit_share_fee_pct": { "type": "integer" }, "spend_cap": { "type": "integer" }, "t1_as_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_html5_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_vads_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" } }, "title": "Contracts Input", "type": "object", "x-stoplight": { "id": "contracts-input", "name": "Contracts Input", "public": true } }, "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": "Contracts Output", "type": "object", "x-stoplight": { "id": "contracts-output", "name": "Contracts Output", "public": true } } } }, "summary": "Create Contracts", "tags": [ "Contracts" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST-contracts", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Create Contracts" } }, "/contracts/{contract_id}": { "delete": { "operationId": "DELETE-contracts", "parameters": [ { "in": "path", "name": "contract_id", "required": true, "type": "integer" } ], "responses": { "204": { "description": "", "schema": { "type": "object" } } }, "summary": "Delete Contracts", "tags": [ "Contracts" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "DELETE-contracts", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Delete Contracts" }, "get": { "operationId": "GET-contracts", "parameters": [ { "in": "path", "name": "contract_id", "required": true, "type": "integer" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "adaptive_segment_cpm": [ { "currency_code": "USD", "value": 0 } ], "contract_number": 103074, "created_on": "2016-08-29T19:54:25+0000", "currency_code": "USD", "effective_end_date": "2017-03-21T00: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 } ], "id": 3385, "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 } ], "updated_on": "2016-08-29T19:54:25+0000", "version": 8 }, "meta": { "called_on": "2017-03-03T20:08:20+0000", "etag": "2a64a9a52d66302464fe557340b33ec849028460", "status": "ok" } } }, "schema": { "example": { "data": { "adaptive_segment_cpm": [ {} ], "contract_number": -34492430, "currency_code": "Lorem cupidatat qui ullamco", "effective_end_date": "aliquip", "effective_start_date": "nisi voluptate n", "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" } ] }, "meta": { "called_on": "laborum voluptate dolore", "count": 27422536, "etag": "enim id Excepteur magna", "offset": -47785040, "status": "amet", "total_count": -77774937 } }, "properties": { "data": { "example": { "adaptive_segment_cpm": [ { "currency_code": "USD", "value": 0 } ], "contract_number": 103074, "currency_code": "USD", "effective_end_date": "2017-03-21T00: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 } ] }, "properties": { "adaptive_segment_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "contract_number": { "type": "integer" }, "currency_code": { "type": "string" }, "effective_end_date": { "type": "string" }, "effective_start_date": { "type": "string" }, "entity_type": { "type": "string" }, "evidon_privacy_cost_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "exclude_agency_margin": { "type": "boolean" }, "external_media_tracking_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "fbx_dynamic_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "managed_service_fee_pct": { "type": "integer" }, "managed_service_fee_unit": { "type": "string" }, "name": { "type": "string" }, "optimization_fee_pct": { "type": "integer" }, "optimization_fee_unit": { "type": "string" }, "organization_id": { "type": "integer" }, "peer39_channel_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_custom_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_quality_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_safety_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "platform_access_fee_pct": { "type": "integer" }, "platform_access_fee_unit": { "type": "string" }, "platform_monthly_min": { "type": "integer" }, "pmp_optimization_off_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_off_unit": { "type": "string" }, "pmp_optimization_on_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_on_unit": { "type": "string" }, "profit_share_fee_pct": { "type": "integer" }, "spend_cap": { "type": "integer" }, "t1_as_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_html5_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_vads_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" } }, "title": "Contracts Input", "type": "object", "x-stoplight": { "id": "contracts-input", "name": "Contracts Input", "public": true } }, "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": "Contracts Output", "type": "object", "x-stoplight": { "id": "contracts-output", "name": "Contracts Output", "public": true } } } }, "summary": "Get Contracts", "tags": [ "Contracts" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-contracts", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Contracts" }, "parameters": [ { "in": "path", "name": "contract_id", "required": true, "type": "string" } ], "put": { "operationId": "PUT-contracts", "parameters": [ { "in": "path", "name": "contract_id", "required": true, "type": "integer" }, { "in": "body", "name": "body", "schema": { "properties": {}, "type": "object" }, "x-examples": { "application/json": "" } } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "adaptive_segment_cpm": [ { "currency_code": "USD", "value": 0 } ], "contract_number": 103074, "created_on": "2016-08-29T19:54:25+0000", "currency_code": "USD", "effective_end_date": "2017-03-21T00: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 } ], "id": 3385, "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 } ], "updated_on": "2016-08-29T19:54:25+0000", "version": 8 }, "meta": { "called_on": "2017-03-03T20:08:20+0000", "etag": "2a64a9a52d66302464fe557340b33ec849028460", "status": "ok" } } }, "schema": { "example": { "data": { "adaptive_segment_cpm": [ {} ], "contract_number": -34492430, "currency_code": "Lorem cupidatat qui ullamco", "effective_end_date": "aliquip", "effective_start_date": "nisi voluptate n", "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" } ] }, "meta": { "called_on": "laborum voluptate dolore", "count": 27422536, "etag": "enim id Excepteur magna", "offset": -47785040, "status": "amet", "total_count": -77774937 } }, "properties": { "data": { "example": { "adaptive_segment_cpm": [ { "currency_code": "USD", "value": 0 } ], "contract_number": 103074, "currency_code": "USD", "effective_end_date": "2017-03-21T00: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 } ] }, "properties": { "adaptive_segment_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "contract_number": { "type": "integer" }, "currency_code": { "type": "string" }, "effective_end_date": { "type": "string" }, "effective_start_date": { "type": "string" }, "entity_type": { "type": "string" }, "evidon_privacy_cost_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "exclude_agency_margin": { "type": "boolean" }, "external_media_tracking_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "fbx_dynamic_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "managed_service_fee_pct": { "type": "integer" }, "managed_service_fee_unit": { "type": "string" }, "name": { "type": "string" }, "optimization_fee_pct": { "type": "integer" }, "optimization_fee_unit": { "type": "string" }, "organization_id": { "type": "integer" }, "peer39_channel_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_custom_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_quality_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "peer39_safety_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "platform_access_fee_pct": { "type": "integer" }, "platform_access_fee_unit": { "type": "string" }, "platform_monthly_min": { "type": "integer" }, "pmp_optimization_off_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_off_unit": { "type": "string" }, "pmp_optimization_on_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pmp_optimization_on_unit": { "type": "string" }, "profit_share_fee_pct": { "type": "integer" }, "spend_cap": { "type": "integer" }, "t1_as_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_html5_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "t1_vads_fee_cpm": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" } }, "title": "Contracts Input", "type": "object", "x-stoplight": { "id": "contracts-input", "name": "Contracts Input", "public": true } }, "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": "Contracts Output", "type": "object", "x-stoplight": { "id": "contracts-output", "name": "Contracts Output", "public": true } } } }, "summary": "Update Contracts", "tags": [ "Contracts" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "PUT-contracts", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Update Contracts" } }, "/creative_assets/approve": { "post": { "consumes": [ "multipart/form-data" ], "description": "## Second T1AS API call\n\n`POST $API_BASE/creative_assets/approve`\n\nURL encoded body parameters\n```\nis_https=1\nadvertiserid=178\nlandingPage.1=http://ad.vendor.com/clicktracker/?id=1234\nclick_url.1=http://theactuallandingpage.com\nprimary.1=DSP_PRO_160x600_v1.swf\nbackup.1=DSP_PRO_160x600_v1.jpg\nconcept.1=638\n```", "operationId": "POST_creative_assets-approve", "parameters": [ { "in": "formData", "name": "is_https", "type": "integer" }, { "in": "formData", "name": "advertiserid", "required": true, "type": "integer" }, { "in": "formData", "name": "landingPage.[x]", "required": true, "type": "string" }, { "in": "formData", "name": "click_url.[x]", "type": "string" }, { "in": "formData", "name": "primary.[x]", "required": true, "type": "string" }, { "in": "formData", "name": "backup.[x]", "type": "string" }, { "in": "formData", "name": "concept.[x]", "type": "integer" } ], "produces": [ "application/xml" ], "responses": { "200": { "description": "", "examples": { "application/xml": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \">\n \n \">\n \">\n \n \n \n \n" } } }, "summary": "Approve Creatives to T1AS", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_creativeassets-approve", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/creative_assets/upload": { "post": { "consumes": [ "multipart/form-data" ], "description": "Upload of creatives to the Terminal One Ad Server is accomplished by two variants of the creative_assets API call.\n\n**First T1AS API call**\n\n`POST $API_BASE/creative_assets/upload`\n\n```\nContent-Disposition: form-data; name=\"[file name]\"; filename=\"[file name]\"\nContent-Type: [file MIME type]\n\n[binary file content]\n```", "operationId": "POST_creative_assets-upload", "produces": [ "application/xml" ], "responses": { "200": { "description": "", "examples": { "application/xml": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" } } }, "summary": "Upload Creatives to T1AS", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_creativeassets-upload", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/creatives/approve": { "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST_creatives-approve", "parameters": [ { "description": "form-data; name=\"[file name]\"; filename=\"[file name]\"", "in": "formData", "name": "is_https", "type": "boolean" }, { "description": "[file MIME type]", "in": "formData", "name": "advertiserid", "type": "string" }, { "in": "formData", "name": "landingpage.1", "type": "string" }, { "in": "formData", "name": "click_url.1", "type": "string" }, { "in": "formData", "name": "primary.1", "type": "string" }, { "in": "formData", "name": "backup.1", "type": "string" }, { "in": "formData", "name": "concept.1", "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "default": { "description": "", "schema": {} } }, "summary": "Approve Uploaded Creatives to T1AS", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_creatives-approve", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": false }, "description": "Approve Uploaded Creatives to T1AS" } }, "/creatives/upload": { "post": { "consumes": [ "multipart/form-data" ], "description": "The Bulk 3PAS process is used to upload files which hold multiple Creatives formatted per the specifications of a particular 3rd party ad server. The Creatives thus uploaded are associated with a particular Advertiser.\n\nDuring the upload process, TerminalOne macros are automatically added to the Creative's HTML depending on the 3rd party ad server. The Bulk Tag Uploader currently supports ad tags from Doubleclick DFA, Atlas, Mediaplex and MediaMind only. The Doubleclick DFA (DART for Advertisers) ad tag file must be in text format. The Atlas ad tag file must be in HTML format. The MediaMind ad tag file must be in text format. The Mediaplex ad tag file must be in text format.\n\nThe 3PAS process entails *multiple* API calls so that the user can (a) upload a file containing one or more ad tags; and (b) make a final selection of tags to be saved.\n\n\n\n**Request:** `POST $API_BASE/creatives/upload`\n\n*multipart/form-data request body*\n```\nContent-Disposition: form-data; name=\"[file name]\"; filename=\"[file name]\"\nContent-Type: [file MIME type]\n\n[binary file content]\n```\nArguments required in body of POST: content, filename\n\nThis call parses the file to extract ad tags and their metadata according to Ad Server-specific rules. A batch_id is assigned for each upload and is returned in the XML output.\n\nFor the purpose of demonstrating the structure of the XML output, let us assume that:\n\n* The user tried to upload a file named \"SMALL\" consisting of 10 separate ad tags or \"placements\"; and\n* Each of these 10 placements was considered \"valid\" according to the Ad Server-specific rules.\n\n\n```\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n```\n\nIn the XML output above, the key nodes are as follows:\n\n```\n\n```\n\nEach upload is assigned a timestamp which will serve as the batch_id in subsequent API calls. total indicates the total number of placements found in the incoming file. valid and invalid indicate the subset of the total placements considered either valid or invalid, respectively.\n\n```\n\n \n \n \n \n \n \n\n```\n\nThe placements attribute holds two elements: valid and invalid.\n\n```\n\n```\n\nEach valid placement has properties, expressed as key-value pairs, extracted from the uploaded file, plus a batch_indexassigned by the 3PAS process and a valid property.\n\n### Save Bulk Created Assets\n\nThe #endpoint:ecoyHXiYC9EpYp5m4 call saves particular creatives out of a given batch to the T1 database.", "operationId": "POST_creatives-upload", "parameters": [ { "description": "form-data; name=\"[file name]\"; filename=\"[file name]\"", "in": "formData", "name": "Content-Disposition", "type": "string" }, { "description": "[file MIME type]", "in": "formData", "name": "Content-Type", "type": "string" }, { "in": "formData", "name": "", "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "default": { "description": "", "schema": {} } }, "summary": "Bulk Upload Creatives to 3PAS", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_creatives-upload", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/creatives/upload/{batch_id}": { "parameters": [ { "in": "path", "name": "batch_id", "required": true, "type": "string" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "This is the second API call needed in the Bulk 3PAS process saves particular creatives out of a given batch to the T1 database.\n\n [POST $API_BASE/creatives/upload/[batch_id]](#endpoint:ecoyHXiYC9EpYp5m4)\n\nArguments required in body of POST: `advertiser_id`, `batch_index[,batch_index,...]`\n\nExample, where we suppose that the user chose to store only the first two of the ten valid placements:\n\n`POST $API_BASE/creatives/upload/1394547012`\n```\nbatch_index=1\nbatch_index=2\nadvertiser_id=001\n```\n\nThis produces the following XML output:\n\n```\n\n\n \n \n \n \n \n\n```\n\nYou may also specify a concept ID and landing page (atomic_creatives's click_url) through this call for each batch_index that you provide. For example:\n\n`POST $API_BASE/creatives/upload/1394547012`\n```\nbatch_index=1\nbatch_index=2\nadvertiser_id=001\nconcept_1=2341\nconcept_2=512\nclick_url_2=http://www.example.net\n```", "operationId": "POST_creatives-upload-batch_id", "parameters": [ { "description": "", "in": "formData", "name": "batch_index", "type": "string" }, { "description": "", "in": "formData", "name": "advertiser_id", "type": "string" }, { "in": "formData", "name": "concept_1", "type": "string" }, { "in": "formData", "name": "click_url_1", "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "default": { "description": "", "schema": {} } }, "summary": "Save Bulk Uploaded Creatives to 3PAS", "tags": [ "Creatives" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_creatives-upload-batchid", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/login": { "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "# Cookie Authentication\n\nThe cookie authentication API call is part of the Execution and Management API module. To authenticate using a username and password, issue a POST request to the following API endpoint:\n\n`POST https://api.mediamath.com/api/v2.0/login`\nInclude the following parameters as application/x-www-form-urlencoded form data:\n\n- `user`:\t\tUsername of an active user in the T1 environment\n- `password`:\t\tPassword of an active user in the T1 environment\n\nThe sessionid attribute contains a session ID that you should include with future requests. It should be passed in the cookie header: `Cookie:\"adama_session=e9b2175c1d5f69dc077ac1fdf6fd5bb5470704ab\"` for all subsequent requests in the session.\n\nThis API endpoint should not be used. Instead, [please use OAuth2 Authentication](https://apidocs.mediamath.com/auth).", "operationId": "POST_login", "parameters": [ { "in": "formData", "name": "user", "required": true, "type": "string" }, { "in": "formData", "name": "password", "required": true, "type": "string" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "", "examples": { "application/json": { "data": { "entity_type": "user", "id": 16271, "name": "sandboxapidemo@mediamath.com", "session": { "current_time": "2016-11-28T21:52:22", "expires": "2016-11-29T21:52:22", "sessionid": "e9b2175c1d5f69dc077ac1fdf6fd5bb5470702ab" } }, "entity": { "id": 18044, "name": "fsargent", "type": "user" }, "meta": { "status": "ok" }, "session": { "current_time": "2016-11-29T22:06:50", "expires": "2016-11-30T22:06:50", "sessionid": "e3fd1d77619b3ff0fe80efce1b1eb6ec93b13a8b" }, "status": { "code": "ok" } } }, "schema": { "properties": { "data": { "properties": { "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "session": { "properties": { "current_time": { "type": "string" }, "expires": { "type": "string" }, "sessionid": { "type": "string" } }, "type": "object" } }, "type": "object" }, "entity": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "meta": { "properties": { "status": { "type": "string" } }, "type": "object" }, "session": { "properties": { "current_time": { "type": "string" }, "expires": { "type": "string" }, "sessionid": { "type": "string" } }, "type": "object" }, "status": { "properties": { "code": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "Login via Cookie Authentication", "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_login", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "deprecated": true, "tags": [ "Users" ] } }, "/hyperlocal/geopulse/builds/{build_id}/request": { "post": { "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "external_build": { "type": "boolean" }, "design_size": { "type": "integer" }, "most_recent_build": { "type": "string" }, "owner_id": { "type": "string" }, "owner_org_id": { "type": "string" }, "owner_name": { "type": "string" }, "price_cpm": { "type": "object", "properties": { "base": { "type": "string" } } }, "active_builds": { "type": "integer" }, "is_shared_to_current_user": { "type": "boolean" }, "is_shared_to_current_org": { "type": "boolean" }, "sets": { "type": "array", "items": { "type": "object", "properties": { "set_id": { "type": "string" }, "set_name": { "type": "string" }, "targeting_code": { "type": "string" } } } }, "set_ids": { "type": "array", "items": { "type": "string" } }, "collaborators": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "permission": { "type": "array", "items": { "type": "object", "properties": { "view": { "type": "string" }, "edit": { "type": "string" } } } } } } } } } }, "meta": { "type": "object", "properties": { "status": { "type": "string" } } } } }, "examples": { "application/json": { "data": [ { "id": "38697e15-9e9e-4917-b55b-6431b99392f4", "name": "LA Car Dealerships", "type": "proximity", "status": "in_design", "created_at": "2016-01-06T17:11:17.000Z", "updated_at": "2016-01-06T17:11:17.000Z", "external_build": false, "design_size": 12, "most_recent_build": "ac5925c7-e727-45b5-848b-c2532dc84db7", "owner_id": "eea9f6ef-c9f3-430a-8db0-d89e8476aebd", "owner_org_id": "d4e49049-07fd-4c67-8325-1c803a8d1857", "owner_name": "user1@factual.com", "price_cpm": { "base": "0.75" }, "active_builds": 1, "is_shared_to_current_user": false, "is_shared_to_current_org": false, "sets": [ { "set_id": "d151ea2c-9879-460c-a169-77a0de9ec3c5", "set_name": "Used Car Dealers", "targeting_code": "cars_1000m" } ], "set_ids": [ "d151ea2c-9879-460c-a169-77a0de9ec3c0" ], "collaborators": [ { "type": "user", "id": "eea9f6ef-c9f3-430a-8db0-d89e8476aebd", "label": "user1@factual.com", "permission": [ { "view": "true", "edit": "true" } ] } ] } ], "meta": { "status": "OK" } } } } }, "description": "Retrieves a single specified build design. Request that a build be deployed to a partner's infrastructure. Note that this API represents a request to a Geopulse Administrator who must subsequently activate the request (or reject it). If a build already has an associated deployment on a given target org's infrastructure, it cannot be requested to that org. For a single design, only one build may have an activated deployment on a given target org's infrastructure at any time (e.g. if Design XYZ has 4 builds, a given target org can only have one of those builds deployed at any time.)\n\nGeopulse Administrators can see pending requests by using the deployment list API. If the deployment request was successful, it will return with a status \"OK\". Sample call:\n\nPOST /hyperlocal/geopulse/builds/03c94217-5e84-4ac9-93dc-b13094623c65/request HTTP/1.1\nHost: api.mediamath.com\nContent-Type: application/x-www-form-urlencoded\nContent-Length: 90\n\nmessage=this+is+for+a+geotargeting+campaign&targetId=fc395d35-6f04-4d15-462a-254b716d0472", "summary": "Get specified build design", "parameters": [ { "in": "path", "name": "build_id", "type": "integer", "required": true, "description": "Build ID, as a GUID" }, { "in": "query", "name": "message", "type": "string", "description": " message to send with the deployment request if you would like Factual to know additional metadata" }, { "in": "query", "name": "targetId", "type": "string", "required": true, "description": "Deployment target ID, as a GUID" } ], "operationId": "post_geo_builds_bid_request", "tags": [ "Geopulse" ] } }, "/hyperlocal/geopulse/designs/{design_id}/request": { "post": { "responses": { "200": { "description": "The response upon success is limited to \"200 OK\" (no body).", "schema": { "type": "object", "properties": {} } } }, "summary": "Process a design & make a targeting file", "description": "Adds T1 organization visibility tagging and requests the build of a design. Sends a request to Factual that this design be processed and a targeting file be produced from it. Requesting a build will put the design into status “requested” and render the design un-editable until the build is either completed or rejected by Factual. Note that a request build call is only valid for designs of status “in_design”, “rejected”, or “built”. The response upon success is limited to \"200 OK\" (no body).", "parameters": [ { "in": "path", "name": "design_id", "type": "string", "required": true }, { "in": "query", "name": "reason", "type": "string", "required": true, "description": "Text description of the reason for this build request" } ], "operationId": "post_geo_designs_did_request", "tags": [ "Geopulse" ] } }, "/hyperlocal/geopulse/designs": { "get": { "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "version": { "type": "integer" }, "status": { "type": "string", "enum": [ "ok", "error" ] }, "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "audience", "proximity" ] }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "design_size": { "type": "integer" }, "most_recent_build": { "type": [ "string", "null" ], "format": "uuid" }, "owner_id": { "type": "string", "format": "uuid" }, "owner_org_id": { "type": "string", "format": "uuid" }, "owner_name": { "type": "string" }, "price_cpm": { "type": "object", "properties": { "base": { "type": "string" } } }, "version": { "type": "string" }, "data_sources": { "type": "array", "items": { "type": "string" } }, "active_builds": { "type": "integer" }, "sets": { "type": "array", "items": { "type": "object", "properties": { "set_id": { "type": "string", "format": "uuid" }, "set_name": { "type": "string" }, "sources": { "type": "null" }, "targeting_code": { "type": "string" } } } }, "set_ids": { "type": "array", "format": "uuid", "items": { "type": "string" } }, "collaborators": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "org" ] }, "id": { "type": "string", "format": "uuid" }, "label": { "type": "string", "description": "Company name or user email" }, "permissions": { "type": "object", "properties": { "view": { "type": "boolean" }, "edit": { "type": "boolean" } } } } } }, "is_shared_to_current_user": { "type": "boolean" }, "is_shared_to_current_org": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "in_design", "requested", "rejected", "building", "failed", "built" ] } } } }, "included_row_count": { "type": "integer" }, "total_row_count": { "type": "integer" } } } } }, "examples": { "application/json": { "version": 4, "status": "ok", "response": { "data": [ { "type": "audience", "name": "Rock around the Block Data", "created_at": "2019-05-13T16:41:15.433Z", "updated_at": "2019-05-14T14:10:30.451Z", "design_size": 0, "most_recent_build": "d275decd-8a6b-947c-b749-cf59cde32ac8", "owner_id": "93de4640-f538-fd59-b7a5-7693da0a96c8", "owner_org_id": "fee4e2a5-852e-056d-98ac-66e7bd42bc30", "owner_name": "partnerservices+mediamath@factual.com", "price_cpm": { "base": "1.50" }, "version": "2.1", "data_sources": [ "factual_dap" ], "active_builds": 1, "sets": [ { "set_id": "8f7bd572-5631-48b9-9a6c-1f74fce4523e", "set_name": "New Audience Segment", "sources": {}, "targeting_code": "Rock around the Block 19" } ], "set_ids": [ "8f7b7c22-5631-48b9-9c6c-1f74bc641a3e" ], "collaborators": [ { "type": "user", "id": "93fa9740-f873-45eb-b7a5-9631ca0a9741", "label": "partnerservices+mediamath@factual.com", "permissions": { "view": true, "edit": true } } ], "is_shared_to_current_user": false, "is_shared_to_current_org": false, "id": "e6bc522b-841d-4c14-ae61-fd73d2bc63c3", "status": "built" }, { "type": "proximity", "name": "Ultimate Frisbee Games ", "created_at": "2019-05-13T19:27:03.457Z", "updated_at": "2019-05-13T21:13:11.173Z", "design_size": 0, "most_recent_build": "dbc4ed89-9531-408c-9741-b83bbc525be7", "owner_id": "b486941f-b7c3-bc57-97f5-eb6edc67b8b5", "owner_org_id": "febcd5a5-389e-8461-98ac-6bc569ddbc30", "owner_name": "someguy@someplace.com", "price_cpm": { "base": "0.75" }, "version": "2.1", "data_sources": [ "PLACES_DATA" ], "active_builds": 1, "sets": [ { "set_id": "5687d35f-0a95-bcd5-ba4c-2badbc726ba2", "set_name": "Here We Go", "sources": {}, "targeting_code": "Yup here we go,_109" } ], "set_ids": [ "56cbc62f-0a95-bc75-cd67-2badff9375a2" ], "collaborators": [ { "type": "user", "id": "b489416f-375a-49ab-97f5-ebbc62fa48b5", "label": "somegal@someplace.com", "permissions": { "view": true, "edit": true } } ], "is_shared_to_current_user": false, "is_shared_to_current_org": false, "id": "6264bcb0-bc73-892b-9ab0-d108bc75ca3b", "status": "built" }, { "type": "proximity", "name": "Human Genome Targeting", "created_at": "2019-05-13T20:32:45.409Z", "updated_at": "2019-05-13T21:01:16.529Z", "design_size": 0, "most_recent_build": "434bc9be-45be-96bc-9ab5-40edbc740203", "owner_id": "f8d9561b-b5e5-9052-bc64-873ebdc7d5d3", "owner_org_id": "fe87caa5-782e-89ba-45ac-66e763a1bc30", "owner_name": "dna@crisprcreme.com", "price_cpm": { "base": "0.75" }, "version": "2.1", "data_sources": [ "PLACES_DATA" ], "active_builds": 1, "sets": [ { "set_id": "77bd6431-bc75-963c-9738-53cec7894a47", "set_name": "Human genome - Moscow", "sources": {}, "targeting_code": "Human Genome - Moscow" } ], "set_ids": [ "7734bc31-be75-470c-9520-53cec7bc6447" ], "collaborators": [ { "type": "user", "id": "f834be4b-3de5-0941-a3a5-87385adba5d3", "label": "someone@somewhere.com", "permissions": { "view": true, "edit": true } } ], "is_shared_to_current_user": false, "is_shared_to_current_org": false, "id": "05e386a9-62b3-46c7-be42-8a4ca673ebdd", "status": "built" }, { "type": "audience", "name": "Brouhaha_Factual", "created_at": "2019-05-13T16:00:03.565Z", "updated_at": "2019-05-13T18:58:44.402Z", "design_size": 0, "most_recent_build": "4356de02-6e1d-4b3e-a462-3287bb447e4d", "owner_id": "93fa9740-f538-45eb-b7a5-7783ca0a1688", "owner_org_id": "fee4e2a5-389e-4120-98ac-669cd21dbc30", "owner_name": "partnerservices+mediamath@factual.com", "price_cpm": { "base": "1.50" }, "version": "2.1", "data_sources": [ "factual_dap" ], "active_builds": 1, "sets": [ { "set_id": "25ab4f40-f7bd-489b-4523-34fcd4745cb5", "set_name": "New Audience Segment", "sources": {}, "targeting_code": "Brouhaha_Factual" } ], "set_ids": [ "896fe670-f7dc-451b-9642-34fcd4ebc675" ], "collaborators": [ { "type": "user", "id": "979bc740-85bc-76ba-e6a5-9031ca0a1688", "label": "partnerservices+mediamath@factual.com", "permissions": { "view": true, "edit": true } } ], "is_shared_to_current_user": false, "is_shared_to_current_org": false, "id": "686dab3d-f05e-31e0-a92c-2fbbc452d23e", "status": "built" } ], "included_row_count": 3, "total_row_count": 834 } } } } }, "parameters": [ { "in": "query", "name": "limit", "type": "string", "description": "Maximum row count to return" }, { "in": "query", "name": "offset", "type": "string", "description": "Offset from first row to show" }, { "in": "query", "name": "owner", "type": "string", "description": "Design creator's ID (GUID)" }, { "in": "query", "name": "owner_org_id", "type": "string", "description": "Org ID of design creator (GUID)" }, { "in": "query", "name": "q", "type": "string", "description": "Full-text search string" }, { "in": "query", "name": "type", "type": "string", "enum": [ "proximity", "audience" ] }, { "in": "query", "name": "visibility", "type": "string" } ], "operationId": "get_geo_designs", "tags": [ "Geopulse" ], "description": "Returns all details about any Proximity or Audience designs for which you have been granted visibility.", "summary": "Display design details" } }, "/hyperlocal/geopulse/deployment_targets": { "get": { "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "version": { "type": "integer" }, "status": { "type": "string", "enum": [ "ok", "error" ] }, "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } } } } } } }, "examples": { "application/json": { "version": 4, "status": "ok", "response": { "data": [ { "id": "3e5d356e-3e2a-37c1-bc75-285ecdab3ed5", "name": "Widget Company (Proximity)" } ] } }, "new": { "version": 4, "status": "error", "type": "Auth", "message": "The API key provided is invalid." } } } }, "summary": "Retrieves the deployment target ID or IDs.", "description": "Retrieves the deployment target ID or IDs.", "operationId": "geopulse_deployment_targets", "tags": [ "Geopulse" ] } }, "/hyperlocal/geopulse/deployments": { "get": { "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "version": { "type": "integer" }, "status": { "type": "string", "enum": [ "ok", "error" ] }, "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "design_id": { "type": "string", "format": "uuid" }, "type": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "design_name": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "target": { "type": "string" }, "target_id": { "type": "string", "format": "uuid" }, "tags": { "type": "array", "items": { "type": "object" } }, "build_id": { "type": "string", "format": "uuid" }, "build_name": { "type": "string", "format": "uuid" }, "filesize": { "type": "string" }, "build_org": { "type": "string" }, "build_org_id": { "type": "string", "format": "uuid" }, "price_cpm": { "type": "object", "properties": { "base": { "type": "number" } } }, "builder": { "type": "string", "format": "email" }, "requester": { "type": "string", "format": "email" }, "build_date": { "type": "string", "format": "date-time" }, "deployer": { "type": "string", "format": "email" }, "updated_at": { "type": "string", "format": "date-time" }, "approved_at": { "type": "string", "format": "date-time" }, "new_build": { "type": "boolean" }, "sets": { "type": "array", "items": { "type": "object", "properties": { "set_id": { "type": "string", "format": "uuid" }, "set_name": { "type": "string" }, "targeting_code": { "type": "string" } } } } } } }, "included_row_count": { "type": "integer" }, "total_row_count": { "type": "integer" } } }, "": { "type": "string" } } }, "examples": { "application/json": { "version": 4, "status": "ok", "response": { "data": [ { "design_id": "af8ce3d7-db3e-4849-ba95-99361e82b34c", "type": "proximity", "id": "a1cf85fb-1101-9352-b5ed-b298a90e2c44", "design_name": "395cdbd1-bd2e-0027-ac6d-903b24750ea1", "status": "activated", "target": "MediaMath (Proximity)", "target_id": "3d048cfe-b5cd-48b4-bc91-bae35ef2b85a", "tags": [], "build_id": "506e4f93-3547-0752-a3f9-2dc61ae7d963", "build_name": "062cdea1-bd2e-0893-6d6d-194b64840ea1", "filesize": "286", "build_org": "mediamath", "build_org_id": "bce4e2a5-963e-9572-98ac-92e7eb1dbc30", "price_cpm": { "base": "0.00" }, "builder": "somebody@mediamath.com", "requester": "z.beeblebrox@hhgttg.pub", "build_date": "2019-05-14T18:03:15.385Z", "deployer": "front-eng+org-admin-bot@factual.com", "updated_at": "2019-05-14T18:05:17.394Z", "approved_at": "2019-05-14T18:03:16.066Z", "new_build": true, "sets": [ { "set_id": "5e540963-9562-4c02-b19c-bc7d2ba1e32d", "set_name": "the set", "targeting_code": "the_set" } ] }, { "design_id": "0204dca4-0894-458de-bd31-ae9524d3b3ea", "type": "proximity", "id": "d2a62e1b-067b-84d9-8f8f-560ad09641c4", "design_name": "A Wonderful Adventure in Space and Time", "status": "activated", "target": "MediaMath (Proximity)", "target_id": "3d952cfe-b5be-47b4-bc82-def78cb2b63a", "tags": [], "build_id": "76559f4c-8562-9517-a841-7f928c856e91", "build_name": "Our First Adventure", "filesize": "3107", "build_org": "mediamath", "build_org_id": "cda4e2a5-850e-8463-46ac-91e7eb1abe30", "price_cpm": { "base": "0.00" }, "builder": "ausername@mediamath.com", "requester": "t.mcmillan@hhgttg.pub", "build_date": "2019-05-14T16:56:16.665Z", "deployer": "front-eng+org-admin-bot@factual.com", "updated_at": "2019-05-14T17:00:17.851Z", "approved_at": "2019-05-14T16:56:17.343Z", "new_build": true, "sets": [ { "set_id": "461cda11-8ec6-7842-9dec-f56fe42e7ca3", "set_name": "Beware of the Tigers", "targeting_code": "Vogon Destructo Fleet" } ] }, { "design_id": "1028dc44-d255-4d3f-b793-c38ce1d1364e", "type": "proximity", "id": "47fbc57f-0fbf-be81-94a9-5c97d20c9f3c", "design_name": "Grendl", "status": "activated", "target": "MediaMath (Proximity)", "target_id": "3d6cb3fe-b5be-b74a-bc82-ba7531dc925a", "tags": [], "build_id": "67176c20-c117-bc74-8852-b06842adce32", "build_name": "Have a Danish for Breakfast", "filesize": "2970", "build_org": "mediamath", "build_org_id": "fe68bca5-389e-8741-98ac-66e7873ebc30", "price_cpm": { "base": "0.00" }, "builder": "georgie@somewhere.org", "requester": "smallberries@yoyodinepropulsion.com", "build_date": "2019-05-11T01:14:14.429Z", "deployer": "front-eng+org-admin-bot@factual.com", "updated_at": "2019-05-11T01:20:18.033Z", "approved_at": "2019-05-11T01:14:15.392Z", "new_build": true, "sets": [ { "set_id": "e8d65c23-c190-75a4-891a-03eb87643d38", "set_name": "Grendl 2", "targeting_code": "Grendl 3" } ] } ], "included_row_count": 3, "total_row_count": 99 } } } } }, "summary": "List deployment target ID's", "description": "The deployment target ID or IDs is one or more GUIDs and must be included in the design build request. This endpoint only accepts GET requests. Sample endpoint call: /hyperlocal/geopulse/deployments?type=proximity&status=activated\n\n", "parameters": [ { "in": "query", "name": "limit", "type": "number", "description": "Maximum row count to return" }, { "in": "query", "name": "offset", "type": "number", "description": "Offset from first row to show" }, { "in": "query", "name": "q", "type": "string", "description": "full-text search string" }, { "in": "query", "name": "type", "type": "string", "description": "Design type: {audience, proximity}" }, { "in": "query", "name": "target_type", "type": "string", "description": "Deployment target type (OnPrem, LIDS, etc.)" }, { "in": "query", "name": "visibility", "type": "string", "description": "comma-delimited array of designs to filter out for non-visibility grant-wise" }, { "in": "query", "name": "status", "type": "string", "description": "Deployment status; can hold multiple comma-delimited strings of: activated, deactivated, requested" }, { "in": "query", "name": "min_size", "type": "number", "description": "Min. targeting file size for deployment build" }, { "in": "query", "name": "max_size", "type": "number", "description": "Max. targeting file size for deployment build" }, { "in": "query", "name": "start_date", "type": "integer", "description": "Starting timestamp to filter deployments by time of approval" }, { "in": "query", "name": "end_date", "type": "integer", "description": "Ending timestamp to filter deployments by time of approval" }, { "in": "query", "name": "new_build", "type": "boolean", "description": "Are deployments for the original design build?" }, { "in": "query", "name": "sort", "type": "string", "description": "Design sort method: updated_at, approved_at, build_date, or build_size", "enum": [ "build_date", "requested_at", "last_build_size" ] } ], "operationId": "get_geo_deployments", "tags": [ "Geopulse" ] } }, "/nemo/attachment": { "post": { "responses": { "200": { "description": "The response has a data section telling you ID's (logically called \"id\") for each target.id pairing with a strategy_id.", "examples": { "application/json": { "data": [ { "id": 33721501, "operator": "OR", "restriction": "INCLUDE", "strategy_id": 4191720, "target_id": 7161 }, { "id": 33721502, "operator": "OR", "restriction": "INCLUDE", "strategy_id": 4191720, "target_id": 7162 }, { "id": 33721503, "operator": "OR", "restriction": "INCLUDE", "strategy_id": 4191720, "target_id": 7167 } ], "meta": { "status": "success" } } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "operator": { "type": "string", "enum": [ "AND", "OR" ] }, "restriction": { "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ] }, "strategy_id": { "type": "integer" }, "target_id": { "type": "integer" } } } }, "meta": { "type": "object", "properties": { "status": { "type": "string" } } } } } } }, "parameters": [ { "in": "query", "name": "strategy_id", "type": "integer" }, { "in": "query", "name": "dimension", "type": "string", "description": "Actually it is a char(4) so no need for quotes", "minLength": 4, "maxLength": 4, "enum": [ "WURF" ] }, { "in": "body", "name": "body", "schema": { "type": "object", "properties": { "strategy_id": { "type": "integer" }, "target.id": { "type": "array", "description": "each integer is an OS Version ID", "items": { "type": "integer" } }, "restriction": { "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ] }, "operator": { "type": "string", "enum": [ "AND", "OR" ] } } }, "x-examples": { "application/json": { "strategy_id": 4122220, "target.id": [ 7161, 7162, 7167 ], "restriction": "INCLUDE", "operator": "OR" }, "new": { "strategy_id": 4122220, "target.id": [ 7161, 7162, 7167 ], "restriction": "INCLUDE", "opetor": "OR" } }, "description": "Nice and short! There are only 4 elements needed for the body:\n1. Your strategy_id that you'll be mapping your OS versions to.\n2. An array of OS versions (target.id) of targeting concern\n3. Whether you want to include or exclude (restriction) the OS versions of target concern\n4. Whether this OS list is being ANDed or ORed (operator)." } ], "description": "This POST API lets you to assign OS versions and brand devices to your specified strategy. This can be used to include or exclude OS versions and brand devices that you can AND or OR together.\n\nBefore you POST /attachment, you will need to create a target to attach it to. You can then create a new target for our Hyperlocal (Factual) design. An example of the sequence commands is illustrated below.\n\nHere, the target (id=37) is created first using POST /target connected to the the Hyperlocal parent Target ID (1), then target_id 37 is attached as a new Target for our Hyperlocal (Factual) design by using the POST /attachment:\n\n```\nPOST /target { \n parent_id: 1,\n name: Factual Design 138,\n mediamath_organization_id: 100170,\n factual_id: 1f5b35bd-0cbd-4176-9ec3-37e5dd9cc567,\n}\n\n{ ...\n id: 37,\n path: 1.37,\n name: Factual Design 138,\n mediamath_organization_id: 100170,\n factual_id: 1f5b35bd-0cbd-4176-9ec3-37e5dd9cc567,\n ...\n} \n\n.\n.\n.\n\nPOST /attachment {\n target_id: 37,\n strategy_id: 11010,\n restriction: INCLUDE,\n operator: AND\n} ,\n\n{ ...", "summary": "Assign OS version(s) and brand device(s) to a strategy", "operationId": "post_nemo_attachment", "tags": [ "Nemo" ] }, "get": { "responses": { "200": { "description": "The response tells you ID's for each OS version as part of a strategy ID you specify.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "created_on": { "type": "string", "format": "date-time" }, "id": { "type": "integer" }, "operator": { "type": "string", "enum": [ "AND", "OR" ] }, "or_better": { "type": "null" }, "restriction": { "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ] }, "strategy_id": { "type": "integer" }, "target_id": { "type": "integer" }, "updated_on": { "type": "string", "format": "date-time" }, "version": { "type": "null" }, "": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "count": { "type": "integer" }, "next_page": { "type": [ "null", "string" ] }, "offset": { "type": "integer" }, "sort_by": { "type": "null" }, "status": { "type": "string" }, "total_count": { "type": "integer" } } } } }, "examples": { "application/json": { "data": [ { "created_on": "2018-12-13 17:44:33.275608+00", "id": 21358503, "operator": "OR", "or_better": {}, "restriction": "INCLUDE", "strategy_id": 4129520, "target_id": 7296, "updated_on": "2018-12-13 17:44:33.275608+00", "version": {} }, { "created_on": "2018-12-13 17:38:36.664053+00", "id": 21738699, "operator": "OR", "or_better": {}, "restriction": "INCLUDE", "strategy_id": 4139120, "target_id": 3964, "updated_on": "2018-12-13 17:38:36.664053+00", "version": {} } ], "meta": { "count": 2, "next_page": "http://nemo-app-production.campaigns.mediamath.com:5000/attachment&page=2", "offset": 0, "sort_by": {}, "status": "success", "total_count": 2 } } } } }, "description": "This GET API displays the applied OS Version(s) and brand device(s) and browser version(s) connected to your specified targeting ID. This is a helpful check to ensure the success of your assignment POST, or to simply query the values there if you are uncertain about their current setting. These filters can be inclusive or exclusive, and can be ANDed or ORed together.", "summary": "Show applied OS version/brand device/browser version targeting", "parameters": [ { "in": "query", "name": "strategy_id", "type": "integer" }, { "in": "query", "name": "dimension", "type": "string", "description": "Actually it is a char(4) with no quotes. dimension_code is only not null 3 times: when it is ITPA, HYPL or WURF. Use dimension_code instead at /nemo/attachment.", "maxLength": 4, "minLength": 4, "enum": [ "WURF" ], "pattern": "WURF" }, { "in": "query", "name": "id", "type": "integer" }, { "in": "query", "name": "created_on", "type": "string", "format": "date-time" }, { "in": "query", "name": "updated_on", "type": "string", "format": "date-time" }, { "in": "query", "name": "target_id", "type": "integer" }, { "in": "query", "name": "page", "type": "integer", "description": "While you can't use offset here (despite being in the response), you can use page to push by multiples of the count in the response." }, { "in": "query", "name": "sort_by", "type": "string", "enum": [ "id", "target_id", "operator", "restriction", "strategy_id", "or_better", "version", "created_on", "updated_on" ] } ], "operationId": "get_nemo_attachment", "tags": [ "Nemo" ] } }, "/nemo/target": { "get": { "responses": { "200": { "description": "Shows targets: IPTA (for id=0), HYPL (for id=1), or their children (higher id's).\nOr, through WURFL values, shows browsers, OS's, or brands/devices (some of those higher id's).", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "array", "description": "Maximum array depth is 5", "items": { "type": "object", "properties": { "child_count_visible": { "type": "integer", "description": "Number of immediate children where visible=1 (<= child_count)" }, "created_on": { "type": "string", "format": "date-time" }, "factual_id": { "type": "null" }, "id": { "type": "integer" }, "mediamath_organization_id": { "type": "null" }, "target_inet": { "type": "null" }, "visible": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 1 }, "data": { "type": "array", "description": "Maximum array depth is 5", "items": { "type": "object", "properties": { "child_count": { "type": "integer" }, "visible_overridden": { "type": [ "integer", "null" ] }, "path": { "type": "string" }, "parent_id": { "type": "integer" }, "updated_on": { "type": "string" }, "name": { "type": "string" }, "dimension_code": { "type": "null" }, "bidder_frequency": { "type": [ "integer", "null" ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "visible": { "type": [ "integer", "null" ] }, "bidder_frequency": { "type": [ "integer", "null" ] }, "child_count": { "type": "integer" }, "child_count_visible": { "type": "integer" }, "created_on": { "type": "string" }, "dimension_code": { "type": "null" }, "factual_id": { "type": "null" }, "id": { "type": "integer" }, "mediamath_organization_id": { "type": "null" }, "name": { "type": "string" }, "parent_id": { "type": "integer" }, "path": { "type": "string" }, "target_inet": { "type": "null" }, "updated_on": { "type": "string" }, "visible_overridden": { "type": [ "integer", "null" ] } } } }, "mediamath_organization_id": { "type": "null" }, "child_count_visible": { "type": "integer" }, "visible": { "type": [ "integer", "null" ] }, "created_on": { "type": "string" }, "factual_id": { "type": "null" }, "id": { "type": "integer" }, "target_inet": { "type": "null" } } } }, "bidder_frequency": { "type": "null" }, "child_count": { "type": "integer", "description": "Number of immediate children (>= child_count_visible)" }, "dimension_code": { "type": "null" }, "name": { "type": "string", "example": "WURFL/OS/Android/OS Version/10.0.2", "description": "At its longest (5 parameters with slashes as separators), it is: \"WURFL\", \"OS\", [OS Type], \"OS Version\", [OS Version]" }, "parent_id": { "type": "integer", "description": "id field in the parent node" }, "path": { "type": "string" }, "updated_on": { "type": "string", "format": "date-time" }, "visible_overridden": { "type": [ "integer", "null" ] } } } }, "bidder_frequency": { "type": "null" }, "child_count": { "type": "integer", "description": "Number of immediate children (>= child_count_visible)", "example": 35 }, "child_count_visible": { "type": "integer", "description": "Number of immediate children where visible=1 (<= child_count)" }, "created_on": { "type": "string", "format": "date-time", "example": "2016-01-06T17:11:17.000Z", "description": "Record creation time-datestamp" }, "dimension_code": { "type": [ "string", "null" ], "default": "WURF", "enum": [ "WURF" ] }, "factual_id": { "type": [ "null", "string" ] }, "id": { "type": "integer", "description": "Tree node ID", "example": 1523874 }, "mediamath_organization_id": { "type": "null" }, "name": { "type": [ "string", "null" ], "pattern": "WURFL", "description": "slash-delimited tree node descriptor, up to 5 deep. 1=WURFL, 2={Brand,Browser,OS}, 3=Specific name of parameter 2, 4={Device,Browser Version,OS Version}, 5=Specific parameter 4.", "example": "\"WURFL/Brand/Apple/Device/iPhone 7 Plus\"" }, "parent_id": { "type": [ "null", "integer" ], "description": "id parameter of the parent node", "example": 2240 }, "path": { "type": "string", "description": "period-delimited list of id's from the tree base to the current node", "example": "\"1437.7158.7450.7451\"" }, "target_inet": { "type": "null" }, "updated_on": { "type": "string", "format": "date-time", "example": "2016-01-06T17:11:17.000Z", "description": "Record update time-datestamp" }, "visible": { "type": [ "integer", "null" ], "enum": [ 0, 1, {} ], "description": "the existing value as read from the Nemo database" }, "visible_overridden": { "type": [ "null", "integer" ], "enum": [ 0, 1, {} ], "description": "if manually set, the MediaMath taxonomy administrator has decided to override all future visibility suggestions with this value. This value is \"sticky\" meaning that the override setting is persisted \"forever\" until a taxonomy administrator changes it, or sets it back to undefined." } } } }, "meta": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] }, "count": { "type": "integer" }, "total_count": { "type": "integer" }, "offset": { "type": "integer" } } } } }, "examples": { "application/json": { "data": [ { "parent_id": 7158, "target_inet": {}, "path": "1437.7158.3070762", "bidder_frequency": 30, "updated_on": "2018-12-06 20:23:21.14179+00", "factual_id": {}, "mediamath_organization_id": {}, "visible": 0, "visible_overridden": 0, "child_count_visible": 0, "dimension_code": {}, "child_count": 1, "name": "WURFL/OS/TV OS", "created_on": "2018-12-05 19:44:36.283392+00", "id": 3070762 }, { "mediamath_organization_id": {}, "factual_id": {}, "updated_on": "2018-12-06 20:23:21.01207+00", "bidder_frequency": 111412, "path": "1437.7158.7159", "target_inet": {}, "parent_id": 7158, "id": 7159, "created_on": "2017-04-27 20:44:11.433567+00", "name": "WURFL/OS/macOS", "child_count": 37, "dimension_code": {}, "child_count_visible": 7, "visible_overridden": 0, "visible": 1 }, { "bidder_frequency": 11782, "updated_on": "2018-12-06 20:23:21.064478+00", "parent_id": 7158, "target_inet": {}, "path": "1437.7158.3070782", "factual_id": {}, "mediamath_organization_id": {}, "visible_overridden": 0, "child_count_visible": 0, "dimension_code": {}, "visible": 0, "created_on": "2018-12-05 19:44:36.385894+00", "id": 3070782, "name": "WURFL/OS/Fire OS", "child_count": 5 }, { "bidder_frequency": 3018, "updated_on": "2018-12-06 20:23:21.133826+00", "parent_id": 7158, "path": "1437.7158.3070764", "target_inet": {}, "mediamath_organization_id": {}, "factual_id": {}, "visible_overridden": 0, "dimension_code": {}, "child_count_visible": 0, "visible": 0, "created_on": "2018-12-05 19:44:36.292764+00", "id": 3070764, "name": "WURFL/OS/Roku OS", "child_count": 17 }, { "updated_on": "2018-12-06 20:23:21.150051+00", "bidder_frequency": 1, "parent_id": 7158, "target_inet": {}, "path": "1437.7158.7345", "factual_id": {}, "mediamath_organization_id": {}, "visible_overridden": 0, "dimension_code": {}, "child_count_visible": 0, "visible": 0, "created_on": "2017-04-27 20:44:12.433745+00", "id": 7345, "child_count": 2, "name": "WURFL/OS/Symbian S60" }, { "parent_id": 7158, "target_inet": {}, "path": "1437.7158.7184", "updated_on": "2018-12-06 20:23:21.878122+00", "bidder_frequency": 1240672, "factual_id": {}, "mediamath_organization_id": {}, "visible": 1, "visible_overridden": 0, "child_count_visible": 9, "dimension_code": {}, "name": "WURFL/OS/Android", "child_count": 117, "created_on": "2017-04-27 20:44:11.585639+00", "id": 7184 }, { "visible": 1, "dimension_code": {}, "child_count_visible": 2, "visible_overridden": 0, "child_count": 10, "name": "WURFL/OS/Windows", "id": 7335, "created_on": "2017-04-27 20:44:12.376912+00", "path": "1437.7158.7335", "target_inet": {}, "parent_id": 7158, "bidder_frequency": 840340, "updated_on": "2018-12-06 20:23:21.921457+00", "mediamath_organization_id": {}, "factual_id": {} }, { "target_inet": {}, "path": "1437.7158.3070692", "parent_id": 7158, "bidder_frequency": 4, "updated_on": "2018-12-06 20:23:21.933891+00", "mediamath_organization_id": {}, "factual_id": {}, "visible": 0, "dimension_code": {}, "child_count_visible": 0, "visible_overridden": 0, "child_count": 2, "name": "WURFL/OS/Chromecast", "id": 3070692, "created_on": "2018-12-05 19:44:35.260199+00" }, { "factual_id": {}, "mediamath_organization_id": {}, "parent_id": 7158, "path": "1437.7158.3070686", "target_inet": {}, "updated_on": "2018-12-06 20:23:21.95877+00", "bidder_frequency": 338, "child_count": 5, "name": "WURFL/OS/Tizen", "created_on": "2018-12-05 19:44:35.233524+00", "id": 3070686, "visible": 0, "visible_overridden": 0, "dimension_code": {}, "child_count_visible": 0 }, { "bidder_frequency": 7, "updated_on": "2018-12-06 20:23:21.975123+00", "path": "1437.7158.7331", "target_inet": {}, "parent_id": 7158, "mediamath_organization_id": {}, "factual_id": {}, "dimension_code": {}, "child_count_visible": 0, "visible_overridden": 0, "visible": 0, "id": 7331, "created_on": "2017-04-27 20:44:12.358058+00", "name": "WURFL/OS/RIM Tablet OS", "child_count": 3 }, { "factual_id": {}, "mediamath_organization_id": {}, "parent_id": 7158, "target_inet": {}, "path": "1437.7158.7450", "bidder_frequency": 16, "updated_on": "2018-12-06 20:23:21.967162+00", "child_count": 1, "name": "WURFL/OS/Xbox OS", "created_on": "2017-04-27 20:44:12.996595+00", "id": 7450, "visible": 0, "visible_overridden": 0, "child_count_visible": 0, "dimension_code": {} }, { "child_count": 8, "name": "WURFL/OS/BlackBerry", "created_on": "2017-04-27 20:44:12.028038+00", "id": 7267, "visible": 0, "visible_overridden": 0, "child_count_visible": 0, "dimension_code": {}, "factual_id": {}, "mediamath_organization_id": {}, "parent_id": 7158, "target_inet": {}, "path": "1437.7158.7267", "bidder_frequency": 148, "updated_on": "2018-12-06 20:23:22.0039+00" }, { "mediamath_organization_id": {}, "factual_id": {}, "updated_on": "2018-12-06 20:23:22.228179+00", "bidder_frequency": 9, "target_inet": {}, "path": "1437.7158.3070681", "parent_id": 7158, "id": 3070681, "created_on": "2018-12-05 19:44:35.170737+00", "child_count": 3, "name": "WURFL/OS/KaiOS", "child_count_visible": 0, "dimension_code": {}, "visible_overridden": 0, "visible": 0 }, { "updated_on": "2018-12-06 20:23:22.212198+00", "bidder_frequency": 41956, "parent_id": 7158, "target_inet": {}, "path": "1437.7158.7275", "factual_id": {}, "mediamath_organization_id": {}, "visible_overridden": 0, "dimension_code": {}, "child_count_visible": 0, "visible": 0, "created_on": "2017-04-27 20:44:12.067825+00", "id": 7275, "child_count": 61, "name": "WURFL/OS/Mac OS X" }, { "visible": 0, "dimension_code": {}, "child_count_visible": 0, "visible_overridden": 0, "name": "WURFL/OS/Windows Phone", "child_count": 20, "id": 7348, "created_on": "2017-04-27 20:44:12.448641+00", "path": "1437.7158.7348", "target_inet": {}, "parent_id": 7158, "updated_on": "2018-12-06 20:23:21.041453+00", "bidder_frequency": 2534, "mediamath_organization_id": {}, "factual_id": {} }, { "visible_overridden": 0, "dimension_code": {}, "child_count_visible": 8, "visible": 1, "created_on": "2017-04-27 20:44:12.561618+00", "id": 7369, "name": "WURFL/OS/iOS", "child_count": 111, "bidder_frequency": 695174, "updated_on": "2018-12-06 20:23:21.524287+00", "parent_id": 7158, "target_inet": {}, "path": "1437.7158.7369", "mediamath_organization_id": {}, "factual_id": {} } ], "meta": { "total_count": 16, "count": 16, "offset": 0, "sort_by": {}, "next_page": {}, "status": "success" } }, "new": {} } } }, "summary": "Show targets (WURFL, Hyperlocal, IP Target)", "description": "If you query this with id=0, you'll get the node for IP Targeting with a dimension code of \"IPTA\".\nIf you query this with id=1, you'll get the node for Hyperlocal with a dimension code of \"HYPL\".\nOf course, you can also query for 0 or 1 as a parent_id.\n\nYou can also access a list of the Brands, OS's, and Browsers by querying with dimension_code=WURF.\nYou can then use the resulting id as the parent_id in your next query to display the WURFL Browser list root id (currently showing 38 browsers), the WURFL OS list root id (currently showing 16 OS's), and the WURFL brand list root id (currently showing 775 device brands). \nUsing the id-as-parent_id trick once again, you can get id lists for those browsers, OS's and brands. Do it again and you can display a list of OS versions under that OS, devices under that brand, or browser versions under that browser.\n\nIf you don't specify an id, you'll get a list existing targets up to the default count of 1000 records with offset of 0. You cannot redefine count or offset when you call /nemo/target, but can use page to offset by multiples of 1000.\n\nNote: \"Currently\" above refers to May 15, 2019.\n\n=====================================================================================================\n\nThe following could be used to fetch all the Hyperlocal Targets who are children of the Hyperlocal parent record (id 1):\n```\nGET /target?id=1\n\n{\n \"data\" : [\n {\n \"updated_on\" : \"2016-06-07 02:06:58.068356+00\",\n \"created_on\" : \"2016-06-07 02:06:58.068356+00\",\n \"path\" : null,\n \"name\" : \"Hyperlocal\",\n \"factual_id\" : null,\n \"mediamath_organization_id\" : null,\n \"parent_id\" : null,\n \"id\" : 1\n }\n ],\n \"meta\" : {\n \"count\" : 1,\n \"total_count\" : 1,\n \"offset\" : 0,\n \"status\" : \"success\"\n }\n}\n```\n\nYou can then create a new target for our Hyperlocal (Factual) design as id=37, then attach that Target 37 to a MediaMath strategy ID:\n\nSo now that we know the Hyperlocal parent Target ID (1), we create a new Target for our Hyperlocal (Factual) design:\n\n```\nPOST /target { \n parent_id: 1,\n name: Factual Design 138,\n mediamath_organization_id: 100170,\n factual_id: 1f5b06bd-0cbd-4306-9ec3-37e5dd9cc780,\n}\n\n{ ...\n id: 37,\n path: 1.37,\n name: Factual Design 138,\n mediamath_organization_id: 100170,\n factual_id: 1f5b06bd-0cbd-4306-9ec3-37e5dd9cc780,\n ...\n} \n\n.\n.\n.\n\nPOST /attachment {\n target_id: 37,\n strategy_id: 11010,\n restriction: INCLUDE,\n operator: AND\n} ,\n\n{ ...\n id: 42,\n ...\n}\n```\n\nYou've now created Attachment ID 42.\n", "operationId": "get_nemo_target", "parameters": [ { "in": "body", "name": "body", "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "count": { "type": "integer" }, "status": { "type": "string" }, "total_count": { "type": "integer" }, "offset": { "type": "integer" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "parent_id": { "type": [ "null", "integer" ] }, "factual_id": { "type": [ "null", "string" ], "format": "uuid" }, "name": { "type": "string" }, "created_on": { "type": "string" }, "path": { "type": [ "null", "string" ], "description": "id's from the tree's root, period-delimited" }, "mediamath_organization_id": { "type": [ "null", "integer" ] }, "updated_on": { "type": "string" }, "id": { "type": "integer", "description": "Hyperlocal target (child of the Hyperlocal parent record). Every target will have this as the parent_id.", "example": 1 } } } } } }, "x-examples": { "application/json": { "meta": { "count": 3, "status": "success", "total_count": 3, "offset": 0 }, "data": [ { "parent_id": {}, "factual_id": {}, "name": "Hyperlocal", "created_on": "2016-06-07 02:06:58.068356+00", "path": {}, "mediamath_organization_id": {}, "updated_on": "2016-06-07 02:06:58.068356+00", "id": 1 }, { "parent_id": {}, "factual_id": {}, "name": "Hyperlocal", "created_on": "2016-06-07 02:07:58.068356+00", "path": {}, "mediamath_organization_id": {}, "updated_on": "2016-06-07 02:07:58.068356+00", "id": 2 }, { "parent_id": {}, "factual_id": {}, "name": "Hyperlocal", "created_on": "2016-06-07 02:08:58.068356+00", "path": {}, "mediamath_organization_id": {}, "updated_on": "2016-06-07 02:08:58.068356+00", "id": 3 } ] } } }, { "in": "query", "name": "id", "type": "integer", "description": "All IP Targets are children of the IP Targeting parent record, which has id 0; so all IP Targets have parent_id=0" }, { "in": "query", "name": "sort_by", "type": "string", "enum": [ "id", "path", "updated_on", "created_on", "parent_id", "target_inet", "name", "dimension_code", "child_count" ] }, { "in": "query", "name": "page", "type": "integer", "description": "Effectively changing the output's offset by *count* for each page" }, { "in": "query", "name": "parent_id", "type": "integer" }, { "in": "query", "name": "factual_id", "type": "integer" }, { "in": "query", "name": "dimension_code", "type": "string", "enum": [ "HYPL", "WURF", "IPTA" ], "description": "dimension_code is only not null 3 times: when it is ITPA, HYPL or WURF. Use dimension instead at /nemo/target." }, { "in": "query", "name": "created_on", "type": "string", "format": "date-time" }, { "in": "query", "name": "updated_on", "type": "string", "format": "date-time" }, { "in": "query", "name": "target_inet", "type": "string" }, { "in": "query", "name": "path", "type": "string" } ], "tags": [ "Nemo" ] }, "post": { "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] } } }, "data": { "type": "object", "properties": { "parent_id": { "type": "integer" }, "created_on": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "factual_id": { "type": "null" }, "path": { "type": "string", "description": "id's from the tree's root, period-delimited" }, "mediamath_organization_id": { "type": "null" }, "id": { "type": "integer" }, "updated_on": { "type": "string", "format": "date-time" } } } } }, "examples": { "application/json": { "meta": { "status": "success" }, "data": { "parent_id": 1, "created_on": "2016-07-27 18:19:29.373051+00", "name": "My Test Target", "factual_id": {}, "path": "1.161", "mediamath_organization_id": {}, "id": 161, "updated_on": "2016-07-27 18:19:29.373051+00" } } } } }, "parameters": [ { "in": "body", "name": "body", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_id": { "type": "integer" }, "mediamath_organization_id": { "type": "integer" }, "factual_id": { "type": "string", "format": "uuid" } } }, "x-examples": { "application/json": { "name": "Factual Design 138", "parent_id": 1, "mediamath_organization_id": 100170, "factual_id": "1f5b06bd-0cbd-4306-9ec3-37e5dd9cc780" } } } ], "operationId": "post_nemo_target", "tags": [ "Nemo" ], "summary": "Create new target(s)", "description": "The following leads in POSTing to a target:\n\nThe whole procedure below could be used to fetch all the Hyperlocal Targets who are children of the Hyperlocal parent record (id 1):\n\n```\nGET /target?id=1\n\n{\n \"data\" : [\n {\n \"updated_on\" : \"2016-06-07 02:06:58.068356+00\",\n \"created_on\" : \"2016-06-07 02:06:58.068356+00\",\n \"path\" : null,\n \"name\" : \"Hyperlocal\",\n \"factual_id\" : null,\n \"mediamath_organization_id\" : null,\n \"parent_id\" : null,\n \"id\" : 1\n }\n ],\n \"meta\" : {\n \"count\" : 1,\n \"total_count\" : 1,\n \"offset\" : 0,\n \"status\" : \"success\"\n }\n}\n```\n\nYou can then create a new target for our Hyperlocal (Factual) design as id=37, then attach that Target 37 to a MediaMath strategy ID:\n\nSo now that we know the Hyperlocal parent Target ID (1), we create a new Target for our Hyperlocal (Factual) design:\n\n```\nPOST /target { \n parent_id: 1,\n name: Factual Design 138,\n mediamath_organization_id: 100170,\n factual_id: 1f5b06bd-0cbd-4306-9ec3-37e5dd9cc780,\n}\n\n{ ...\n id: 37,\n path: 1.37,\n name: Factual Design 138,\n mediamath_organization_id: 100170,\n factual_id: 1f5b06bd-0cbd-4306-9ec3-37e5dd9cc780,\n ...\n} \n\n.\n.\n.\n\nPOST /attachment {\n target_id: 37,\n strategy_id: 11010,\n restriction: INCLUDE,\n operator: AND\n} ,\n\n{ ..." } }, "/nemo/attachment/bulk": { "post": { "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "status": { "type": "string" } } }, "data": { "type": "object", "properties": { "parent_id": { "type": "integer" }, "created_on": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "factual_id": { "type": "null" }, "path": { "type": "string", "description": "id's from the tree's root, period-delimited" }, "mediamath_organization_id": { "type": "null" }, "id": { "type": "integer" }, "updated_on": { "type": "string", "format": "date-time" } } } } }, "examples": { "application/json": { "meta": { "status": "success" }, "data": { "parent_id": 1, "created_on": "2016-07-27 18:19:29.373051+00", "name": "My Test Target", "factual_id": {}, "path": "1.161", "mediamath_organization_id": {}, "id": 161, "updated_on": "2016-07-27 18:19:29.373051+00" } } } } }, "summary": "Nemo API to support bulk editing", "description": "Nemo API to support bulk editing", "operationId": "post_nemo_attach_bulk", "tags": [ "Nemo" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "object", "properties": { "strategy_id": { "type": "integer" }, "action": { "type": "string", "enum": [ "add", "remove", "overwrite" ] }, "filter": { "type": "string", "enum": [ "ip-addresses", "hyperlocal", "wurfl", "foo" ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "target_id": { "type": "integer" }, "restriction": { "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ] }, "operator": { "type": "string", "enum": [ "AND", "OR" ] } } } } } }, "x-examples": { "application/json": { "strategy_id": 1, "action": "overwrite", "filter": "ip-addresses", "attachments": [ { "target_id": 100, "restriction": "INCLUDE", "operator": "OR" }, { "target_id": 111, "restriction": "EXCLUDE", "operator": "OR" }, { "target_id": 122, "restriction": "EXCLUDE", "operator": "OR" } ] } } } ] } }, "/nemo/attachment/{copy:...}": { "post": { "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "operator": { "type": "string", "enum": [ "AND", "OR" ] }, "restriction": { "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ] }, "strategy_id": { "type": "integer" }, "target_id": { "type": "integer" } } } }, "meta": { "type": "object", "properties": { "status": { "type": "string" } } } } }, "examples": { "application/json": { "data": [ { "id": 21721501, "operator": "OR", "restriction": "INCLUDE", "strategy_id": 4122220, "target_id": 7161 }, { "id": 21721502, "operator": "OR", "restriction": "INCLUDE", "strategy_id": 4122220, "target_id": 7162 }, { "id": 21721503, "operator": "OR", "restriction": "INCLUDE", "strategy_id": 4122220, "target_id": 7167 } ], "meta": { "status": "success" } } } } }, "summary": "Bulk campaign/strategy duplication", "description": "Bulk campaign/strategy duplication, BUT YOU MUST REMOVE /copy WHEN USING THIS. There's really no slash before copy, but this is the only way API Docs can display it. copy is the start of the body.\n\nThis special endpoint exists to support Adama's \"campaign duplication\" and \"strategy duplication\" features. To copy all Nemo Attachments on strategy ID 12345 to strategy ID 20000, and 45678 to 50000, you would make this call to Nemo:\n\n```\nPOST /attachment { \n copy: [ \n {\n from_strategy_id: 12345,\n to_strategy_id: 20000\n }, \n {\n from_strategy_id: 45678,\n to_strategy_id: 50000\n }\n}\n```\nYou can supply as many pairs of from and to strategy IDs as you like.\n\nUpon success, Nemo returns the full detail of all new Attachments that were created.", "operationId": "nemo_attachment_copy", "tags": [ "Nemo" ], "parameters": [ { "in": "body", "name": "body", "schema": { "type": "object", "properties": { "copy": { "type": "array", "items": { "type": "object", "properties": { "from_strategy_id": { "type": "integer", "description": "starting strategy ID number", "example": 12345 }, "to_strategy_id": { "type": "integer", "description": "ending strategy ID number", "example": 20000 } } } } } }, "x-examples": { "application/json": { "copy": [ { "from_strategy_id": 12345, "to_strategy_id": 20000 }, { "from_strategy_id": 45678, "to_strategy_id": 50000 } ] } } } ] } }, "/nemo/target/{target_id}": { "get": { "responses": { "200": { "description": "", "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "success", "error" ] } } }, "data": { "type": "object", "properties": { "dimension_code": { "type": [ "null", "string" ], "enum": [ "WURF", "IPTA", "HYPL" ] }, "name": { "type": [ "null", "string" ] }, "bidder_frequency": { "type": "null" }, "visible_overridden": { "type": "null" }, "child_count": { "type": "integer" }, "path": { "type": "string", "pattern": "^[0-9.]$" }, "updated_on": { "type": "string", "format": "date-time" }, "parent_id": { "type": "integer" }, "visible": { "type": "null" }, "id": { "type": "integer" }, "factual_id": { "type": [ "null", "string" ], "format": "uuid" }, "created_on": { "type": "string", "format": "date-time" }, "target_inet": { "type": "string" }, "mediamath_organization_id": { "type": [ "null", "integer" ] }, "child_count_visible": { "type": "integer" } } } } }, "examples": { "application/json": { "meta": { "status": "success" }, "data": { "target_inet": {}, "path": "1.33423", "parent_id": 1, "updated_on": "2017-05-10 18:51:40.103565+00", "bidder_frequency": {}, "mediamath_organization_id": 10048, "factual_id": "85548578d-c270-96ba-b296-67aad6e98648", "visible": {}, "child_count_visible": 0, "dimension_code": {}, "visible_overridden": {}, "child_count": 0, "name": "test_example", "id": 33423, "created_on": "2016-09-19 16:26:38.605841+00" } } } } }, "parameters": [ { "in": "path", "name": "target_id", "type": "integer", "required": true }, { "in": "body", "name": "body", "schema": { "type": "object" }, "x-examples": { "application/json": {} } } ], "operationId": "nemo_target_tid", "tags": [ "Nemo" ], "description": "Display resource deal details related to a specific target", "summary": "Display deal details in a target" } }, "/organizations": { "get": { "description": "The Organizations endpoint returns a list of Organization objects matching the (optional) query.", "operationId": "findOrganizations", "parameters": [ { "description": "max number of organizations to return in response", "format": "int64", "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Offset to use for pagination", "format": "int64", "in": "query", "minimum": 0, "name": "page_offset", "required": false, "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "A list of Organizations", "examples": { "application/vnd.mediamath.v1+json": { "called_on": "2016-11-22 19:25:30.052654+00", "data": [ { "entity_type": "organization", "id": 100048, "name": "ACME Org" } ], "entities": { "count": 1, "entity": [ { "id": 100048, "name": "ACME Org", "type": "organization" } ], "start": 0 }, "etag": "1932fd4aee4969d888cccdc188be9291f5a8d4ec", "meta": { "called_on": "2016-11-22T22:29:31+0000", "count": 1, "etag": "7b82a45b2092965a38efa53b6dd5bf0102858c41", "offset": 0, "status": "ok", "total_count": 1 }, "status": { "code": "ok", "content": "Authentication Required", "reason": "not_logged_in" } } }, "schema": { "example": { "data": [ { "city": "voluptate ullamco" }, { "contact_name": "qui ex sunt ut", "state": "ut minim", "zip": "et adipisicing est ea dolore" }, { "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" } ], "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, "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" }, "properties": { "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" }, "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" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "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": { "items": { "type": "string" }, "type": "array" }, "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" }, "restrict_targeting_to_same_device_id": { "type": "boolean" }, "state": { "type": "string" }, "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" } }, "title": "Organization", "type": "object", "x-stoplight": { "id": "organization", "name": "Organization", "public": true } }, "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 } } }, "default": { "description": "Error" } }, "security": [ { "oauth2": [] } ], "summary": "List Organizations", "tags": [ "Organizations" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "findOrganizations", "mock": { "enabled": false, "statusCode": 200 }, "public": true } } }, "/organizations/{id}": { "get": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "Returns a single organization by ID, if the user has access.", "operationId": "findOrgByID", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "a single Organization", "examples": { "application/vnd.mediamath.v1+json": { "data": { "address_1": "cupidatat Ut ex ", "address_2": "culpa consectetur ea id", "adx_seat_account_id": 48333066, "allow_byo_price": false, "allow_x_agency_pixels": false, "billing_country_code": "anim sit", "city": "minim", "contact_name": "ad", "country": "nisi", "created_on": "exercitation ", "currency_code": "est", "dmp_enabled": "occaecat pariatur", "entity_type": "deserunt Duis esse tempor", "id": 56693827, "mm_contact_name": "voluptate minim Duis dol", "name": "Duis", "opt_out_connected_id": false, "opt_out_connected_id_mathid": true, "org_type": [ "sit ut consequat incididunt aute", "pariatur nulla ullamco velit occaecat", "nisi in", "dolor aliqua elit sit do", "sunt dolor" ], "override_suspicious_traffic_filter": true, "phone": "in Duis mollit tempor", "restrict_targeting_to_deterministic_id": true, "restrict_targeting_to_same_device_id": false, "state": "Lorem sunt do", "status": false, "suspicious_traffic_filter_level": -24892798, "terminated": true, "updated_on": "nisi velit", "use_evidon_optout": true, "version": 57235379, "zip": "aute" }, "meta": { "called_on": "laboris non", "count": 17905876, "etag": "labore q", "offset": 77513443, "status": "est ipsum anim", "total_count": 53726728 } } }, "schema": { "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, "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" }, "properties": { "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" }, "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" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "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": { "items": { "type": "string" }, "type": "array" }, "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" }, "restrict_targeting_to_same_device_id": { "type": "boolean" }, "state": { "type": "string" }, "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" } }, "title": "Organization", "type": "object", "x-stoplight": { "id": "organization", "name": "Organization", "public": true } }, "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 } } }, "default": { "description": "Error" } }, "security": [ { "oauth2": [] } ], "summary": "Get Organization", "tags": [ "Organizations" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "findOrgByID", "mock": { "enabled": false, "statusCode": 200 }, "public": true } }, "parameters": [ { "description": "ID of organization to fetch", "format": "int64", "in": "path", "name": "id", "required": true, "type": "integer" } ], "post": { "consumes": [ "multipart/form-data", "application/x-www-form-urlencoded" ], "description": "Update an existing T1 Organization - reserved for T1 admins", "operationId": "updateOrganization", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "the updated organization", "schema": { "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, "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" }, "properties": { "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" }, "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" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "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": { "items": { "type": "string" }, "type": "array" }, "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" }, "restrict_targeting_to_same_device_id": { "type": "boolean" }, "state": { "type": "string" }, "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" } }, "title": "Organization", "type": "object", "x-stoplight": { "id": "organization", "name": "Organization", "public": true } }, "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 } } }, "default": { "description": "Error" } }, "security": [ { "oauth2": [] } ], "summary": "Update an existing organization", "tags": [ "Organizations" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "updateOrganization", "mock": { "enabled": false, "statusCode": 200 }, "public": true } } }, "/pixel_bundles": { "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "POST_pixel_bundles", "parameters": [ { "in": "formData", "name": "advertiser_id", "required": true, "type": "integer" }, { "description": "Indicator eligibility of pixel for targeting", "in": "formData", "name": "eligible", "type": "boolean" }, { "in": "formData", "name": "entity_type", "type": "string" }, { "in": "formData", "name": "external_identifier", "type": "string" }, { "description": "Optional keyword tag that can be applied to the pixel", "in": "formData", "maxLength": 64, "name": "keywords", "type": "string" }, { "in": "formData", "name": "name", "required": true, "type": "string" }, { "default": "event", "enum": [ "event" ], "in": "formData", "name": "pixel_type", "required": true, "type": "string" }, { "default": "CPM", "description": "Pricing model for the data provider\nCPM is recommended. CPTS is not recommended and planned for deprecation.", "enum": [ "CPM" ], "in": "formData", "name": "pricing", "type": "string" }, { "in": "formData", "name": "rmx_conversion_minutes", "type": "integer" }, { "in": "formData", "name": "rmx_conversion_type", "type": "string" }, { "in": "formData", "name": "rmx_friendly", "type": "boolean" }, { "in": "formData", "name": "rmx_merit", "type": "boolean" }, { "default": true, "description": "Indicates whether a pixel should appear in API calls to the $APIBASE/pixel_bundles endpoint.", "in": "formData", "name": "status", "type": "boolean" }, { "description": "Tag type to determine pixel code output", "enum": [ "image", "js", "dfa", "uat", "iframe" ], "in": "formData", "name": "tag_type", "required": true, "type": "string" }, { "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" ], "in": "formData", "name": "currency", "type": "string" }, { "default": "USD", "description": "Fixed currency. Set using ISO 4217 currency code.\nhttps://en.wikipedia.org/wiki/ISO_4217", "in": "formData", "name": "currency_fixed", "type": "string" }, { "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" ], "in": "formData", "name": "revenue", "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "properties": { "data": { "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" }, "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" }, "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" }, "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 } }, "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 } } }, "type": "object" } } }, "summary": "Create Event Pixel", "tags": [ "Pixels" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_pixelbundles-", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Create Event Pixel" } }, "/pixel_bundles/{id}": { "get": { "consumes": [ "text/plain" ], "operationId": "GET_pixel_bundles-id", "parameters": [ { "in": "body", "name": "body", "schema": { "type": "string" } }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "schema": { "properties": { "data": { "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" }, "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" }, "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", "eligible", "name", "pixel_type", "tag_type" ], "title": "Pixel", "type": "object", "x-stoplight": { "id": "pixel", "name": "Pixel", "public": true } }, "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 } } }, "type": "object" } } }, "summary": "Get Pixel Bundle", "tags": [ "Pixels" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_pixelbundles-id", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Pixel Bundle" }, "parameters": [ { "in": "path", "name": "id", "required": true, "type": "integer" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "### Set Pixel Targeting on a Strategy\n\nTo set pixel targeting on a strategy, you must compose a valid string for the strategy's `pixel_target_expr` property.\n\nThe string holds parenthesized expressions for pixels to be included and pixels to be excluded. The most general form of this expression is:\n\n```\n([PIXEL_TO_INCLUDE] AND [ANOTHER_PIXEL_TO_INCLUDE] AND ...) AND NOT ([PIXEL_TO_EXCLUDE] OR [ANOTHER_PIXEL_TO_EXCLUDE] ...) \n```\nNote that each pixel ID number is enclosed in square brackets: 12345.\n\nNote that the pixels to be included appear in a parenthesized list joined by logical AND operators: `([[12345]] AND [[34567]])`.\n\nNote that the pixels to be excluded appear in a parenthesized list joined by logical OR operators: `([[67890]] OR [[89012]])`.\n\nNote that the INCLUDE and EXCLUDE lists are joined by logical AND NOT:\n\n`([12345] AND [34567]) AND NOT ([67890] OR [89012])`\n\n\nRequest\n`POST $API_BASE/strategies/100001`\n\nURL Encoded POST Body Parameters\n`pixel_target_expr=([100001]) AND NOT ([100002] OR [100003])`\n```\nversion=10\n\n\n \n \n \n \n \n \n \n \n \n\n```", "operationId": "POST_pixel_bundles-id", "parameters": [ { "in": "formData", "name": "pixel_target_expr", "type": "string" }, { "in": "formData", "name": "version", "type": "number" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" } ], "responses": { "default": { "description": "", "schema": {} } }, "summary": "Pixel Targeting on a Strategy", "tags": [ "Pixels" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_pixelbundles-id", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/site_lists": { "get": { "operationId": "GET_site_lists", "responses": { "default": { "description": "", "schema": {} } }, "summary": "List Site Lists", "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_sitelists", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "tags": [ "Site Lists" ], "description": "List Site Lists" } }, "/site_lists/{site_list_id}": { "get": { "operationId": "GET_site_lists-site_list_id", "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": [ { "created_on": "2017-06-05T16:29:27+0000", "entity_type": "site_list", "filename": "test", "id": 12345, "name": "test", "organization_id": 100008, "restriction": "EXCLUDE", "sites_count": 7, "sites_count_domain": 7, "status": true, "updated_on": "2017-06-05T16:29:27+0000", "version": 0 } ], "meta": { "called_on": "2017-12-08T22:00:00+0000", "count": 100, "etag": "628a11fb4a47477dadc1bcee01c949cc9cbd0b31", "next_page": "https://api.mediamath.com/api/v2.0/site_lists?page_offset=100&api_key=wa3k7dsb83svrp289f8u3acg", "offset": 0, "status": "ok", "total_count": 271 } } }, "schema": { "properties": { "data": { "items": { "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 } }, "type": "array" }, "meta": { "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" } }, "type": "object" } }, "type": "object" } } }, "summary": "Get Site List", "tags": [ "Site Lists" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_sitelists-sitelistid", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Site List" }, "parameters": [ { "in": "path", "name": "site_list_id", "required": true, "type": "string" } ] }, "/site_lists/{site_list_id}/assignments": { "get": { "operationId": "GET_site_lists-site_list_id-assignments", "parameters": [ { "default": "*", "in": "query", "name": "full", "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": [ { "associated_campaign_id": 251203, "collection": "campaign", "entity_id": 251203, "entity_type": "site_list_assignment", "id": 251203, "name": "test_campaign_spend_2.126.1", "site_list_id": 69140 }, { "associated_campaign_id": 234798, "collection": "strategy", "entity_id": 1115032, "entity_type": "site_list_assignment", "id": 11616667, "name": "SPRT-78909", "site_list_id": 69140 }, { "associated_campaign_id": 234798, "collection": "strategy", "entity_id": 1115016, "entity_type": "site_list_assignment", "id": 11621191, "name": "App Passbacks", "site_list_id": 69140 } ], "meta": { "called_on": "2016-12-08T22:19:45+0000", "count": 3, "etag": "caae9e41753a2cc6130f3bc121924b518a1fdd27", "offset": 0, "status": "ok", "total_count": 3 } } }, "schema": { "properties": { "data": { "items": { "properties": { "associated_campaign_id": { "type": "integer" }, "collection": { "type": "string" }, "entity_id": { "type": "integer" }, "entity_type": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "site_list_id": { "type": "integer" } }, "type": "object" }, "type": "array" }, "meta": { "properties": { "called_on": { "type": "string" }, "count": { "type": "integer" }, "etag": { "type": "string" }, "offset": { "type": "integer" }, "status": { "type": "string" }, "total_count": { "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "summary": "Get Site List Assignments (Campaigns and Strategies)", "tags": [ "Site Lists" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_sitelists-sitelistid-assignments", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Site List Assignments (Campaigns and Strategies)" }, "parameters": [ { "in": "path", "name": "site_list_id", "required": true, "type": "string" } ] }, "/site_lists/{site_list_id}/domains": { "parameters": [ { "in": "path", "name": "site_list_id", "required": true, "type": "string" } ], "post": { "description": "Given a SiteList ID, this API allow you to insert or update one or more domain names associated with the SiteList. If a domain is already on the list, it is de-duplicated.", "operationId": "POST_site_lists-site_list_id-domains", "parameters": [ { "default": "*", "in": "query", "name": "full", "type": "string" }, { "in": "body", "name": "body", "schema": { "example": "domain=abc.com\ndomain=def.com", "properties": { "domain": { "type": "string" } }, "type": "object" }, "x-examples": { "application/json": { "domain": "domain=abc.com\ndomain=def.com" } } } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "meta": { "status": "ok" } } }, "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "status": { "type": "string" } } } } } }, "400": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "errors": [ { "message": "BADDOMAIN doesn't look like a domain" } ], "meta": { "called_on": "2016-12-08T22:23:24+0000", "status": "invalid" } } }, "schema": { "properties": { "errors": { "items": { "properties": { "message": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "properties": { "called_on": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "Update Site List Domains", "tags": [ "Site Lists" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST_sitelists-sitelistid-domains", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/site_lists/{site_list_id}/download.csv": { "get": { "operationId": "GET_site_lists-site_list_id-download-csv", "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": [ { "entity_type": "site_list", "id": 69138, "name": "App test1" } ], "meta": { "called_on": "2016-12-08T22:00:00+0000", "count": 100, "etag": "628a11fb4a47477dadc1bcee01c949cc9cbd0b31", "next_page": "https://api.mediamath.com/api/v2.0/site_lists?page_offset=100&api_key=wa3k7dsb83svrp289f8u3acg", "offset": 0, "status": "ok", "total_count": 271 } } }, "schema": { "type": "object" } } }, "summary": "Download Site List", "tags": [ "Site Lists" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET_sitelists-sitelistid-downloadcsv", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Download Site List" }, "parameters": [ { "in": "path", "name": "site_list_id", "required": true, "type": "string" } ] }, "/strategies": { "get": { "operationId": "LIST-strategies", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" }, { "description": "name", "in": "query", "items": { "type": "string" }, "name": "sort_by", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "properties": { "data": { "items": { "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" }, "properties": { "audience_segment_exclude_op": { "type": "string" }, "audience_segment_include_op": { "type": "string" }, "bid_aggressiveness": { "type": "integer" }, "bid_price_is_media_only": { "type": "boolean" }, "budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "type": "string" }, "effective_goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "frequency_amount": { "type": "integer" }, "frequency_interval": { "type": "string" }, "frequency_optimization": { "type": "boolean" }, "frequency_type": { "type": "string" }, "goal_type": { "type": "string" }, "goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "id": { "type": "integer" }, "impression_pacing_interval": { "type": "string" }, "impression_pacing_type": { "type": "string" }, "max_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "media_type": { "type": "string" }, "min_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "pacing_amount": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "pacing_interval": { "type": "string" }, "pacing_type": { "type": "string" }, "pixel_target_expr": { "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" }, "status": { "type": "boolean" }, "supply_type": { "type": "string" }, "targeting_segment_exclude_op": { "type": "string" }, "targeting_segment_include_op": { "type": "string" }, "type": { "type": "string" }, "updated_on": { "type": "string" }, "use_campaign_end": { "type": "boolean" }, "use_campaign_start": { "type": "boolean" }, "use_mm_freq": { "type": "boolean" }, "use_optimization": { "type": "boolean" }, "version": { "type": "integer" }, "zone_name": { "type": "string" } }, "title": "Output Strategy", "type": "object", "x-stoplight": { "id": "output-strategy", "name": "Output Strategy", "public": true } }, "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 } } }, "type": "object" } }, "401": { "description": "", "examples": { "application/vnd.mediamath.v1+json": "\n\n The access token expired\n The access token expired\n The access token expired\n" }, "schema": { "type": "object" } } }, "security": [ { "oauth2": [] } ], "summary": "List Strategies", "tags": [ "Strategies" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "LIST-strategies", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "List Strategies" }, "post": { "consumes": [ "application/x-www-form-urlencoded" ], "description": "The construction of a Strategy requires a combination of API calls in order for it to run properly and generate traffic. To launch a strategy, the minimum configuration is to construct a Strategy shell with Creative Concepts assigned.\n\nPrior to creating a Strategy via the API, a Campaign object must have been created. The Campaign ID will be necessary when constructing a Strategy. See the Campaigns page for information regarding creating or retrieving information for a Campaign.\n\nTo construct a strategy shell, construct a POST to the above API endpoint with the following fields from the table below.\n\n## Strategy Goal Types\n**ROI** (return on investment) - An ROI goal type means the algorithm maximizes the return on ad spend at the ROI goal value. Only available if revenue is being passed into the campaign merit pixel.\n\n**CPA** (cost per acquisition) - A CPA goal type means that the algorithm maximizes acquisitions at the CPA goal value. Typically used for direct response strategies driving acquisitions where acquisition is defined as a measurable purchase event. \n\n**CPC** (cost per click) - A CPC goal type means that the algorithm maximizes clicks at the CPC goal value. This is typically used to generate clicks.\n\n**CPM Reach** - A CPM Reach goal type means that the algorithm maximizes audience reached. This strategy type is typically used for brand or awareness targeting of a specific audience, or in the case of site remarketing.\n\n**CPM Spend** - uses no optimization. It simply bids the maximum bid for every impression. This is typically used when the user wishes to bid a fixed amount for particular target such as a DMA or a data pixel segment.\n\n![Strategy Goal Type Image](https://kb.mediamath.com/wiki/download/attachments/15696681/image2017-3-17%2018%3A29%3A14.png?version=1&modificationDate=1489789948000&api=v2)", "operationId": "create-strategy", "responses": { "201": { "description": "", "schema": { "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" }, "properties": { "audience_segment_exclude_op": { "type": "string" }, "audience_segment_include_op": { "type": "string" }, "bid_aggressiveness": { "type": "integer" }, "bid_price_is_media_only": { "type": "boolean" }, "budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "type": "string" }, "effective_goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "frequency_amount": { "type": "integer" }, "frequency_interval": { "type": "string" }, "frequency_optimization": { "type": "boolean" }, "frequency_type": { "type": "string" }, "goal_type": { "type": "string" }, "goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "id": { "type": "integer" }, "impression_pacing_interval": { "type": "string" }, "impression_pacing_type": { "type": "string" }, "max_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "media_type": { "type": "string" }, "min_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "pacing_amount": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "pacing_interval": { "type": "string" }, "pacing_type": { "type": "string" }, "pixel_target_expr": { "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" }, "status": { "type": "boolean" }, "supply_type": { "type": "string" }, "targeting_segment_exclude_op": { "type": "string" }, "targeting_segment_include_op": { "type": "string" }, "type": { "type": "string" }, "updated_on": { "type": "string" }, "use_campaign_end": { "type": "boolean" }, "use_campaign_start": { "type": "boolean" }, "use_mm_freq": { "type": "boolean" }, "use_optimization": { "type": "boolean" }, "version": { "type": "integer" }, "zone_name": { "type": "string" } }, "title": "Output Strategy", "type": "object", "x-stoplight": { "id": "output-strategy", "name": "Output Strategy", "public": true } } } }, "security": [ { "oauth2": [] } ], "summary": "Create Strategy", "tags": [ "Strategies" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "POST-strategies", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/strategies/bulk_copy": { "post": { "description": "**Settings that don't get copied over:**\n1. Vendor Agreements \n2. Budget Flights\n3. Campaign's Brain\n4. Creative Concepts", "operationId": "bulk-copy-strategies", "parameters": [ { "in": "body", "name": "body", "schema": { "properties": { "from_campaign_id": { "type": "integer" }, "strategies.[x].audience_targeting": { "type": "boolean" }, "strategies.[x].contextual_targeting": { "type": "boolean" }, "strategies.[x].creative_assignment": { "type": "boolean" }, "strategies.[x].id": { "type": "integer" }, "strategies.[x].name": { "type": "string" }, "strategies.[x].pixel_targeting": { "type": "boolean" }, "strategies.[x].site_lists": { "type": "boolean" }, "strategies.[x].strategy_targeting": { "type": "boolean" }, "strategies.[x].supply_management": { "type": "boolean" }, "strategies.[x].video_targeting": { "type": "boolean" }, "to_campaign_id": { "type": "integer" } }, "type": "object" } }, { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" } ], "responses": { "201": { "description": "", "schema": { "properties": { "data": { "items": { "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" }, "properties": { "audience_segment_exclude_op": { "type": "string" }, "audience_segment_include_op": { "type": "string" }, "bid_aggressiveness": { "type": "integer" }, "bid_price_is_media_only": { "type": "boolean" }, "budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "type": "string" }, "effective_goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "frequency_amount": { "type": "integer" }, "frequency_interval": { "type": "string" }, "frequency_optimization": { "type": "boolean" }, "frequency_type": { "type": "string" }, "goal_type": { "type": "string" }, "goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "id": { "type": "integer" }, "impression_pacing_interval": { "type": "string" }, "impression_pacing_type": { "type": "string" }, "max_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "media_type": { "type": "string" }, "min_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "pacing_amount": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "pacing_interval": { "type": "string" }, "pacing_type": { "type": "string" }, "pixel_target_expr": { "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" }, "status": { "type": "boolean" }, "supply_type": { "type": "string" }, "targeting_segment_exclude_op": { "type": "string" }, "targeting_segment_include_op": { "type": "string" }, "type": { "type": "string" }, "updated_on": { "type": "string" }, "use_campaign_end": { "type": "boolean" }, "use_campaign_start": { "type": "boolean" }, "use_mm_freq": { "type": "boolean" }, "use_optimization": { "type": "boolean" }, "version": { "type": "integer" }, "zone_name": { "type": "string" } }, "title": "Output Strategy", "type": "object", "x-stoplight": { "id": "output-strategy", "name": "Output Strategy", "public": true } }, "type": "array" } }, "type": "object" } } }, "summary": "Strategies Bulk Copy", "tags": [ "Campaign Duplication" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "bulk-copy-strategies", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true } } }, "/strategies/{strategy_id}": { "get": { "operationId": "GET-strategies", "parameters": [ { "default": "application/vnd.mediamath.v1+json", "in": "header", "name": "Accept", "required": false, "type": "string" }, { "in": "query", "maximum": 100, "minimum": 1, "name": "page_limit", "required": false, "type": "integer" }, { "description": "Index of the first element in the collection to retrieve", "in": "query", "name": "page_offset", "required": false, "type": "integer" }, { "in": "query", "items": { "type": "string" }, "name": "q", "required": false, "type": "string" }, { "default": "", "description": "To include all properties for all entities returned by the API call, use `full=*:`", "in": "query", "items": { "type": "string" }, "name": "full", "required": false, "type": "string" }, { "in": "query", "items": { "type": "string" }, "name": "with", "required": false, "type": "string" } ], "responses": { "200": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "data": { "audience_segment_exclude_op": "OR", "audience_segment_include_op": "OR", "bid_aggressiveness": 50, "bid_price_is_media_only": "true", "budget": [ { "currency_code": "USD", "value": 3 } ], "campaign_id": 308822, "created_on": "2016-11-14T20:42:04+0000", "currency_code": "USD", "effective_goal_value": [ { "currency_code": "USD", "value": "45.0000" } ], "entity_type": "strategy", "frequency_amount": 0, "frequency_interval": "not-applicable", "frequency_optimization": true, "frequency_type": "no-limit", "goal_type": "cpa", "goal_value": [ { "currency_code": "USD", "value": 45 } ], "id": 1749878, "impression_pacing_interval": "day", "impression_pacing_type": "no-limit", "max_bid": [ { "currency_code": "USD", "value": 100 } ], "media_type": "VIDEO", "min_bid": [ { "currency_code": "USD", "value": 0 } ], "name": "sptest #19", "pacing_amount": [ { "currency_code": "USD", "value": 3 } ], "pacing_interval": "day", "pacing_type": "even", "pixel_target_expr": "( [615918] OR [681418] OR [750306] ) AND NOT ( [934079] )", "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": false, "site_selectiveness": "REDUCED", "status": false, "supply_type": "RTB", "targeting_segment_exclude_op": "OR", "targeting_segment_include_op": "OR", "type": "AUD", "updated_on": "2016-11-14T20:42:04+0000", "use_campaign_end": true, "use_campaign_start": true, "use_mm_freq": false, "use_optimization": true, "version": 0, "zone_name": "Etc/GMT" }, "meta": { "called_on": "2016-11-29T22:20:07+0000", "etag": "320eea3a4e6adb08a83d18b01fd7be95db64c460", "status": "ok" } } }, "schema": { "properties": { "data": { "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" }, "properties": { "audience_segment_exclude_op": { "type": "string" }, "audience_segment_include_op": { "type": "string" }, "bid_aggressiveness": { "type": "integer" }, "bid_price_is_media_only": { "type": "boolean" }, "budget": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "campaign_id": { "type": "integer" }, "created_on": { "type": "string" }, "currency_code": { "type": "string" }, "effective_goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "end_date": { "type": "string" }, "entity_type": { "type": "string" }, "frequency_amount": { "type": "integer" }, "frequency_interval": { "type": "string" }, "frequency_optimization": { "type": "boolean" }, "frequency_type": { "type": "string" }, "goal_type": { "type": "string" }, "goal_value": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "id": { "type": "integer" }, "impression_pacing_interval": { "type": "string" }, "impression_pacing_type": { "type": "string" }, "max_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "media_type": { "type": "string" }, "min_bid": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "integer" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "pacing_amount": { "items": { "properties": { "currency_code": { "type": "string" }, "value": { "type": "number" } }, "type": "object" }, "type": "array" }, "pacing_interval": { "type": "string" }, "pacing_type": { "type": "string" }, "pixel_target_expr": { "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" }, "status": { "type": "boolean" }, "supply_type": { "type": "string" }, "targeting_segment_exclude_op": { "type": "string" }, "targeting_segment_include_op": { "type": "string" }, "type": { "type": "string" }, "updated_on": { "type": "string" }, "use_campaign_end": { "type": "boolean" }, "use_campaign_start": { "type": "boolean" }, "use_mm_freq": { "type": "boolean" }, "use_optimization": { "type": "boolean" }, "version": { "type": "integer" }, "zone_name": { "type": "string" } }, "title": "Output Strategy", "type": "object", "x-stoplight": { "id": "output-strategy", "name": "Output Strategy", "public": true } }, "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 } } }, "type": "object" } }, "404": { "description": "", "examples": { "application/vnd.mediamath.v1+json": { "called_on": "2016-11-24 09:49:52.997582+00", "error": { "content": "Not found" }, "errors": [ "Not found" ], "status": { "code": "not_found", "content": "Not found" } } }, "schema": { "properties": { "called_on": { "type": "string" }, "error": { "properties": { "content": { "type": "string" } }, "type": "object" }, "errors": { "items": { "type": "string" }, "type": "array" }, "status": { "properties": { "code": { "type": "string" }, "content": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "security": [ { "oauth2": [] } ], "summary": "Get Strategies", "tags": [ "Strategies" ], "x-stoplight": { "afterScript": {}, "beforeScript": {}, "id": "GET-strategies", "mock": { "dynamic": false, "enabled": false, "statusCode": 200 }, "public": true }, "description": "Get Strategies" }, "parameters": [ { "in": "path", "name": "strategy_id", "required": true, "type": "string" } ], "post": { "consumes": [ "application/x-www-form-urlencoded" ], "operationId": "create-strategies", "parameters": [ { "in": "path", "name": "strategy_id", "required": true, "type": "integer" } ], "responses": { "201": { "description": "", "examples": { "application/json": { "audience_segment_exclude_op": "OR", "audience_segment_include_op": "AND", "bid_aggressiveness": 63, "bid_price_is_media_only": "on", "budget": "dolor a", "campaign_id": 3189728, "created_on": "1979-09-06T00:50:02.418Z", "currency_code": "irure aliquip", "description": "in", "end_date": "1965-08-22T13:15:32.717Z", "frequency_amount": 66721343, "frequency_interval": "week", "frequency_optimization": "1", "frequency_type": "asap", "goal_type": "reach", "goal_value": 8236056.804507008, "impression_pacing_amount": 2331828, "impression_pacing_interval": "week", "impression_pacing_type": "even", "max_bid": 64594323.00122461, "max_bid_wm": "dolore ", "media_type": "DISPLAY", "min_bid": 6933970.308039572, "name": "pariatur in aliquip", "pacing_amount": 85186377, "pacing_interval": "hour", "pacing_type": "even", "pixel_target_expr": "do ea fugiat irure", "roi_target": 32289185, "run_on_all_exchanges": "on", "run_on_all_pmp": "off", "run_on_display": "1", "run_on_mobile": "off", "run_on_streaming": "1", "site_restriction_transparent_urls": "off", "site_selectiveness": "EXCLUDE_UGC", "start_date": "1947-10-20T11:49:35.662Z", "status": true, "supply_type": "RMX_API", "targeting_segment_exclude_op": "mollit incididunt voluptate pariatur", "targeting_segment_include_op": "incididunt", "type": "REM", "updated_on": "2010-10-02T12:12:31.833Z", "use_campaign_end": "on", "use_campaign_start": "off", "use_mm_freq": "off", "use_optimization": "on", "version": 23403629, "zone_name": "aute id dolor" } }, "schema": { "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" }, "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_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" }, "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" }, "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. See [Knowledge Base](https://kb.mediamath.com/wiki/display/NT1KB/Strategies+Details+Tab#StrategiesDetailsTab-OptimizedFrequencyCap) for more information.", "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: 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" ], "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" }, "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_streaming": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "site_restriction_transparent_urls": { "enum": [ "on", "off", "1", "0" ], "type": "string" }, "site_selectiveness": { "default": "REDUCED", "description": "Specifies whether to use a T1 site list REDUCED: TerminalOne blocklist applied MATHSELECT_250: MathSelect250 whitelist EXCLUDE_UGC ALL: Unfiltered exchange inventory", "enum": [ "MATHSELECT_250", "REDUCED", "EXCLUDE_UGC", "ALL" ], "type": "string" }, "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",