Endpoint
scenarios/{scenario_id}
Allows a user to retrieve information about a specific scenario request.
Type
GET
Request Parameters
- Required
{scenario_id}: The identifier of a specific scenario obtained from the scenario list endpoint, provided as part of the request URL.
Responses
-
200 OK: Successfully retrieved the scenario -
404 Not Found: Scenario with the specified ID does not exist
The response is a JSON object with properties related to the requested scenario.
Example Request
curl --location 'https://intermx-prod.apigee.net/v1/scenarios/67fc957b1390410012509651' \
--header 'apikey: {YOUR API KEY HERE}'Example Response
{
"name": "Atlantic City Boardwalk - 2024-01-02",
"description": "Atlantic City Boardwalk - 2024-01-02",
"motionworks_scenario_id": "06C937FB-ED5A-4BE1-B6F9-57A8BA28FE4A",
"modified": "2025-04-14T04:56:27+00:00",
"created": "2025-04-14T04:56:27+00:00",
"periods": [
{
"period_name": "1/2/2024 12:00 AM - 1/2/2024 11:45 PM",
"start_time": "2024-01-02T00:00:00+00:00",
"end_time": "2024-01-02T23:45:00+00:00"
}
],
"place_ids": [
"276411"
],
"cohort": {
"geography_ids": [
"XX2020NATNUS"
],
"motionworks_segment_id": "23b327e2-b9f2-4d23-9930-ac1f8621a75a"
},
"customer": {
"customer_id": "203",
"customer_name": "All Points Media",
"customer_scenario_id": "828e9f5d7cbb42c68cfdb94d71ce7d00ae1483f6",
"customer_scenario_name": "Atlantic City Boardwalk - 2024-01-02",
"customer_scenario_info": "Atlantic City Boardwalk Info - 2024-01-02"
},
"runtime_version": "2.3",
"include_cohort_metrics": true,
"include_confidence_interval": true,
"timezone": "America/New_York"
}