Endpoint
scenarios/{scenario_id}
Allows a user to retrieve measurement data about a specific scenario.
Limitations
Rate Limit - A maximum of 10 requests per minute
Caching Policy
Once a Placecast™ Select scenario is created, the results do not change.
To reduce unnecessary load and avoid throttling, clients should cache the results after the first successful retrieval.
Type
POST
Request Parameters
- Required
{scenario_id}: The identifier of a specific scenario obtained from the scenario list endpoint, provided as a JSON object.
Responses
-
200 OK: Successfully retrieved scenario measurement report -
404 Not Found: Scenario report with the specified ID does not exist
The response is a JSON object with measurement 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 '{"scenario_id":"06C937FB-ED5A-4BE1-B6F9-57A8BA28FE4A"}'Example Response
Note this example has null measurements
{
"scenario": {
"motionworks_scenario_id": "06C937FB-ED5A-4BE1-B6F9-57A8BA28FE4A",
"periods": [
{
"end_time": "2024-01-02T23:45:00Z",
"start_time": "2024-01-02T00:00:00Z",
"period_name": "1/2/2024 12:00 AM - 1/2/2024 11:45 PM"
}
],
"scenario_published": "2025-04-14 08:28:46.697276+00",
"measured_places": 1,
"timezone": "",
"cohort": {
"home_geography_ids": [
"XX2020NATNUS"
],
"home_geography_names": [
"United States"
],
"motionworks_base_segment_id": "23b327e2-b9f2-4d23-9930-ac1f8621a75a",
"motionworks_base_segment_name": ""
},
"visits": 0,
"visits_ci": [
0,
0
],
"visits_total": 0,
"visits_unique": 0,
"visits_unique_total": 0,
"dropoffs": 0,
"dropoffs_ci": [
0,
0
],
"dropoffs_total": 0,
"passbys": 0,
"passbys_ci": [
0,
0
],
"passbys_total": 0,
"activities": 0,
"activities_ci": [
0,
0
],
"activities_total": 0,
"activities_unique": 0,
"activities_unique_total": 0,
"exposures": 0,
"exposures_ci": [
0,
0
],
"exposures_total": 0,
"exposures_unique": 0,
"exposures_unique_total": 0,
"exposures_visitors": 0,
"event_minutes_visitors": 0,
"percent": {
"dwell_bins": [],
"dwell_plus": [],
"event_time_plus": [],
"day": [],
"segment": {
"basic_demographics": null,
"consumer": null,
"customer": null,
"other": []
},
"home": {
"state_province": null,
"dma": null,
"metro_area": null,
"county": null,
"postal_code": null,
"census_neighborhood": null
}
},
"messages": {
"message": "",
"dropped_places": []
},
"debug_internal": {}
},
"places": []
}