Create Scenario

Endpoint

scenarios

Allows a user to retrieve information about a specific scenario request.

Limitations

Clients may create up to 1,000 scenarios per 24 hours.
- This count resets at 12:00AM US Eastern Time each day.

Type

POST

Request Parameters

Required
- motionworks_scenario_id - A unique identifier for the request. If the same identifier is used, data will be overwritten.
- customer_id - please contact us for your customer id
- customer_scenario_id - a customer provided identifier for customer use
- timezone - the timezone of the defined period
- place_ids - an array of specific place ids that are being measured
- periods - an array of specific time periods the places should be measured for
Optional
- project: The identifier of a specific project as obtained from the project list endpoint. Provide as a URL parameter to the request

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 -X POST 'https://intermx-prod.apigee.net/v1/measures/placecast/scenario' \
--header 'Content-Type: application/json' \
--header 'apikey: {YOUR API KEY HERE}' \
--data '{
  "name": "Atlantic City Boardwalk - 2024-01-02",
  "description": "Atlantic City Boardwalk - 2024-01-02",
  "motionworks_scenario_id": "C42AA2BB-173F-423E-9AFF-518BB9D7486C",
  "periods": [
    {
      "period_name": "2024-01-02 12:00 AM - 2024-01-02 11:45 PM",
      "start_time": "2024-01-02T05:00:00+00:00",
      "end_time": "2024-01-03T04: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_name": "Atlantic City Boardwalk - 2024-01-02",
    "customer_scenario_info": "Atlantic City Boardwalk Info - 2024-01-02",
    "customer_scenario_id": "C42AA2BB-173F-423E-9AFF-518BB9D7486C"
  },
  "timezone": "America/New_York",
  "runtime_version": "2.3",
  "include_cohort_metrics": true,
  "include_confidence_interval": true
}'

Example Response

{
    "status": "success",
    "api-message": "Atlantic City Boardwalk - 2024-01-02' added successfully to Project 'Sandbox'",
    "message": "Scenario 'Atlantic City Boardwalk - 2024-01-02' added successfully to Project 'Sandbox'",
    "data": {
        "id": {
            "project": "64b5968db4b3cd0012d66b50",
            "scenario": "6812e0f57661f800126de44b"
        },
        "name": "Atlantic City Boardwalk - 2024-01-02"
    }
}