Error Rates API

The Error Rates API provides detailed insights into errors encountered during order processing. This includes error resolution times, associated ticket information, and discrepancies between POS and operational subtotals. The API is essential for monitoring operational accuracy, identifying recurring issues, and optimizing error management processes.

Example Response

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

[
    {
        "month": "2024-11",
        "week": "2024-11-04T00:00:00.000Z",
        "created_at": "2024-11-06T16:56:05.916Z",
        "recon_created_at": "2024-11-06T21:56:05.916Z",
        "order_number": "c9122d22-b386-4be0-8be0-ad9cf4cf5982",
        "location_id": 233138,
        "order_source": "Ordering Source Name",
        "ticket_id": 596078082,
        "order_id": null,
        "pos_subtotal": 11.6,
        "op_subtotal": 14.0,
        "is_resolved": null,
        "closed_at": "2024-11-06T16:56:10.544Z",
        "recon_closed_at": "2024-11-06T21:56:10.544Z",
        "last_activity_type": null,
        "last_activity_at": null,
        "notification_message": null,
        "agent_name": null,
        "assignee_id": null,
        "alt_order_number": "5e5ba332",
        "supports_menu_api": true,
        "error_category": null,
        "external_store_id": null
    }
  ]

Field Descriptions

Field Name	Description
`month`	Month associated with the error.
`week`	Week associated with the error.
`created_at`	Timestamp when the error record was created.
`recon_created_at`	Timestamp when the error reconciliation was created.
`order_number`	Unique identifier for the order associated with the error.
`location_id`	Identifier for the restaurant location where the error occurred.
`order_source`	Name of the platform or source where the order originated.
`ticket_id`	Identifier for the associated ticket (if applicable).
`order_id`	Unique identifier for the order (if applicable).
`pos_subtotal`	Subtotal amount from the POS system.
`op_subtotal`	Subtotal amount from the operational system.
`is_resolved`	Indicates whether the error has been resolved.
`closed_at`	Timestamp when the error was resolved.
`recon_closed_at`	Timestamp when the error reconciliation was completed.
`last_activity_type`	Type of the last activity related to the error (if applicable).
`last_activity_at`	Timestamp of the last activity related to the error.
`notification_message`	Message associated with the error notification (if any).
`agent_name`	Name of the agent handling the error resolution.
`assignee_id`	Identifier of the person assigned to resolve the error.
`alt_order_number`	Alternative order number, if available.
`supports_menu_api`	Indicates whether the menu API is supported (true or false).
`error_category`	Category of the error (if applicable).
`external_store_id`	Identifier for the external store, if applicable.

This API aids in comprehensive error tracking and management, enabling businesses to maintain high operational standards and enhance customer satisfaction.