get https://app.itsacheckmate.com/reporting/v1/view_location_op_status?location_ids=1981,1933&from_timestamp=2023-03-03 00:00:00&to_timestamp=2023-03-04 00:00:00
Provides insights into the operational status of locations, including downtime and reasons for going offline.
Log in to see full request history
Location OP Status API
The Location OP Status API provides detailed insights into the operational status of specific restaurant locations. It tracks when locations go offline, the reasons for the downtime, and the duration of unavailability. This API is vital for monitoring operational disruptions and improving location-level performance.
Example Response
After a successful call, the API will return a response similar to the below structure.
[
{
"location_id": 235116,
"display_order_source": "Ubereats",
"offline_action_started_at": "2023-03-03T06:11:24.458Z",
"offline_by": "status-update-by-uber@itsacheckmate.com",
"offline_action_ended_at": "2023-03-03T12:29:07.111Z",
"offline_action_ended_by": "status-update-by-uber@itsacheckmate.com",
"reason": "PAUSED_BY_UBER",
"offline_hours": "6.3",
"times_went_offline": 1,
"external_store_id": null
}
]
Field Descriptions
| Field Name | Description |
|---|---|
location_id | Identifier for the restaurant location. |
display_order_source | Name of the platform or source (e.g., Uber Eats). |
offline_action_started_at | Timestamp when the location went offline. |
offline_by | Identifier of the user or system responsible for marking the location offline. |
offline_action_ended_at | Timestamp when the location came back online. |
offline_action_ended_by | Identifier of the user or system responsible for marking the location back online. |
reason | Reason for the location going offline (e.g., PAUSED_BY_UBER). |
offline_hours | Total duration (in hours) the location was offline. |
times_went_offline | Number of times the location went offline. |
external_store_id | Identifier for the external store, if applicable. |
This API is crucial for stakeholders needing to keep tabs on operational efficiencies and to address any disruptions promptly.
Responses