Set Dynamics Requests

This dataset contains the attributes of each package and request, along with the statistics returned from the search summary API at the time of analysis.

Suggest Edits

Set Dynamics scenarios are submitted as JSON requests that define the advertising inventory, target audience, geographic market, and analysis parameters. Each request triggers a comprehensive reach and frequency analysis.

Request Structure

{
    "scenarioId": "68b0eab98022bb2512102ff6",
    "name": "IP-202578-174234 2023",
    "description": "Scenario created via API",
    "periods": {
        "name": "IP-202578-174234 2023",
        "start_date": "2023-08-28",
        "end_date": "2024-09-01"
    },
    "customer": {
        "customer_id": 30,
        "customer_name": "Motionworks",
        "customer_scenario_id": "686d588ab93ebc0012b869b2",
        "customer_scenario_name": "IP-202578-174234",
        "customer_scenario_info": "{\"customer_name\":\"test_name\",\"customer_email\":\"[email protected]\"}"
    },
    "type_list": ["lts_freq_per_period"],
    "cohort": {
        "customer_segment_id": 9330,
        "customer_base_segment_id": 9330,
        "geography_ids": ["US2020XDMA532"],
        "measuresRelease": 20250501
    },
    "effective_freq_list": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 20, 50, 100],
    "duration_list": [28],
    "geopath_spot_list": ["148535", "148642", "148738", "30454535", "30833275"]
}

Schema

Name	Description	Type	Example
scenarioId	Unique identifier for the scenario, generated by the system	string	68b0eab98022bb2512102ff6
name	User-defined name for the scenario	string	IP-202578-174234 2023
description	User-defined description for the scenario	string	Scenario created via API
type_list	Array of out-of-home exposure measures to include in analysis. Multiple measures can be requested simultaneously. Valid values: • "visits_freq_per_period": Visits - Basic presence measurement • "circ_freq_per_period": Circulation - Visits adjusted for occupancy • "ots_freq_per_period": Opportunity to See - Circulation adjusted for dwell time • "lts_freq_per_period": Likelihood to See - OTS adjusted by VAI • "traffic_freq_per_period": Deprecated, use visits_freq_per_period Default: ["visits_freq_per_period"] if omitted	array of strings	["lts_freq_per_period"]
periods.name	User-defined identifier for the analysis period	string	IP-202578-174234 2023
periods.start_date	Analysis start date (YYYY-MM-DD). Must be a Monday; adjusted to preceding Monday if not	string	2023-08-28
periods.end_date	Analysis end date (YYYY-MM-DD). Must be a Sunday; adjusted to following Sunday if not	string	2024-09-01
customer.customer_id	Motionworks customer identification number	integer	30
customer. customer_name	Customer organization name	string	Motionworks
customer. customer_scenario_id	Unique identifier for this scenario, used for tracking and reference	string	686d588ab93ebc0012b869b2
customer. customer_scenario_name	Human-readable name for the scenario	string	IP-202578-174234
customer. customer_scenario_info	Additional notes or description about the scenario, often containing customer contact information as JSON string	string	{"customer_name":"test_name","customer_email":"[email protected]"}
cohort. customer_segment_id	Consumer demographic segment to analyze. Can be total population or specific consumer interests	integer	9330
cohort. customer_base_segment_id	Base age segment for analysis (0+, 5+, 18+, 21+)	integer	9330
cohort. geography_ids	Array of geographic markets to include in analysis. Can be counties, DMAs, metros, or national. Examples: ["GLOBAL"] for national, ["US2020XDMA532"] for single DMA, multiple counties for regional	array of strings	["US2020XDMA532"]
cohort. measuresRelease	Measures release version identifier for data consistency	integer	20250501
effective_freq_list	Frequency thresholds for effective reach calculation (e.g., reach at 3+ frequency). Default: [1,2,3,4,5,6,7,8,9,10,11,20,50,100]	array of integers	[1,2,3,4,5,6,7,8,9,10,11,20,50,100]
duration_list	Analysis periods in days within the overall time window. Must be multiples of 7 days (1 Week). Valid values: [7,14,21,28]. Default: [28]	array of integers	[28]
geopath_spot_list	List of Geopath spot IDs to include in the scenario. Spots represent individual advertising displays from the Geopath inventory	array of strings	["148535","148642","148738"]

Validation Rules

Date alignment: Start dates are adjusted to Mondays, end dates to Sundays
Duration constraints: All duration values must be ≤ total period length
Geographic validity: All geography IDs must exist in the Motionworks geography library
Spot availability: All spot IDs must be active in the current Geopath inventory
Segment compatibility: Segment IDs must be valid for the specified customer

Submission

Requests are submitted as JSONL files via cloud data storage. Each line in the JSONL file represents a separate scenario request. Multiple scenarios can be processed in a single batch submission.

Updated 18 days ago