Operational Metrics API

The Operational Metrics API provides key insights into the performance of orders, including delivery times, cancellations, and overall efficiency. This API is crucial for evaluating operational effectiveness, understanding bottlenecks, and enhancing customer satisfaction.

Example Response

After a successful call, the API will return a response similar to the below structure.

[
    {
        "store_name": "IACM",
        "location_id": 233405,
        "ordering_source": "Ordering Source Name",
        "order_number": "EA207",
        "order_type": "completed",
        "courier_arrival_at": "2024-11-04T12:25:04.000Z",
        "courier_pickup_at": "2024-11-04T12:27:05.000Z",
        "order_delivered_at": "2024-11-04T12:33:29.000Z",
        "order_subtotal": 9.61,
        "total_delivery_time": 6.4,
        "cancelled_at": null,
        "cancellation_category": null,
        "cancellation_category_desc": null,
        "order_placed_at": "2024-11-04T12:21:41.000Z",
        "transaction_id": null,
        "transaction_amount": null,
        "transaction_status": null,
        "item_names": "Chili| Kids' Hamburger",
        "quantities": 2.0,
        "order_date": "2024-11-04",
        "error_datetime": null,
        "error_item_names": "",
        "error_item_quantities": 0.0,
        "error_refund_amount": 0.0,
        "error_category": "",
        "created_at": "2024-11-06T08:34:12.855Z",
        "external_store_id": null
    }
]

Field Descriptions

Field Name	Description
`store_name`	Name of the store handling the order.
`location_id`	Identifier for the restaurant location.
`ordering_source`	Name of the platform or source where the order originated.
`order_number`	Unique identifier for the order.
`order_type`	Type of order (e.g., completed, cancelled).
`courier_arrival_at`	Timestamp when the courier arrived at the location.
`courier_pickup_at`	Timestamp when the courier picked up the order.
`order_delivered_at`	Timestamp when the order was delivered to the customer.
`order_subtotal`	Subtotal amount of the order, excluding taxes and fees.
`total_delivery_time`	Total time taken for the delivery (in minutes).
`cancelled_at`	Timestamp when the order was canceled (if applicable).
`cancellation_category`	Category of the cancellation (if applicable).
`cancellation_category_desc`	Description of the cancellation category.
`order_placed_at`	Timestamp when the order was placed.
`transaction_id`	Unique identifier for the transaction (if applicable).
`transaction_amount`	Total transaction amount (if applicable).
`transaction_status`	Status of the transaction (e.g., completed, pending).
`rating_tags`	Tags related to customer ratings (if applicable).
`item_names`	List of item names included in the order.
`quantities`	Total quantities of items included in the order.
`order_date`	Date when the order was placed.
`error_datetime`	Timestamp when an error occurred (if applicable).
`error_item_names`	Names of items associated with errors (if any).
`error_item_quantities`	Quantities of items associated with errors (if any).
`error_refund_amount`	Total refund amount for errors in the order.
`error_category`	Description of the error category (if applicable).
`external_store_id`	Identifier for the external store, if applicable.

This API enables detailed analysis of order-related metrics, providing essential data for improving service delivery, optimizing efficiency, and boosting customer satisfaction.