What is Internal Data?
The Reporting API leverages a set of internal tables that store and track essential data points related to orders, operations, and quality indicators. These tables provide a structured foundation for retrieving order details, operational metrics, and error logs, enabling efficient monitoring and analysis of restaurant operations and customer interactions.
Overview of Internal Data Tables
The following internal tables contain key data to support your reporting needs:
- TICKETS: Contains information on tickets/orders received.
- ORDER_DETAILS: Captures details of each order, including status and errors.
- LOG_ITEM_SOLD_OUT_EVENT: Logs sold-out events, including timestamps and restock information.
- ORDER_ITEMS: Records individual items within orders, including quantities and selected modifiers.
- ERROR_RATE: Monitors and categorizes error events encountered during order processing.
- LOCATION_OP_STATUS: Provides operational status of locations.
- ORDER_PROMOS: Logs promotional codes or discounts applied to orders.
- SOLD_ITEMS_DETAILS: Summarizes items sold across orders, including quantities and total amounts.
- SOLD_OUT_ITEMS_DETAILS: Tracks items marked as sold out, with timestamps and restock times.
DIM_TICKETS
This table contains information about individual tickets and orders received. The following columns are included in this table:
Column Name | Description |
---|---|
TICKET_ID | Unique identifier for each ticket. |
LOCATION_ID | Identifier for the restaurant location. |
ORDER_NUMBER | Unique order number assigned by the platform. |
ORDER_SOURCE | Source from which the order was received. |
CUSTOMER_NAME | Name of the customer placing the order. |
QUANTITY | Total quantity of items in the order. |
DISCOUNT | Discount applied to the order, if any. |
TAX | Tax amount applied to the order. |
SUBTOTAL | Subtotal amount before discounts and taxes. |
CREATED_AT | Timestamp when the order was created. |
UPDATED_AT | Timestamp of the latest update. |
MAT_BATCH_ID | Batch ID for tracking processing batches. |
DIM_OPERATIONAL_ORDER_INDICATORS
Contains operational indicators related to order handling, delivery, and errors. The following columns are included in this table:
Column Name | Description |
---|---|
STORE_NAME | Name of the store handling the order. |
ORDER_NUMBER | Unique order number assigned by the platform. |
COURIER_ARRIVAL_AT | Timestamp when the courier arrived at the restaurant. |
TOTAL_DELIVERY_TIME | Total time taken for the delivery. |
ORDER_PLACED_AT | Time when the order was placed. |
CANCELLATION_CATEGORY | Category assigned for order cancellation. |
ERROR_DATETIME | Timestamp of any errors in the order process. |
ERROR_ITEM_NAMES | List of item names associated with the error. |
DIM_ORDER_DETAILS
Stores detailed information about orders, including status and errors. The following columns are included in this table:
Column Name | Description |
---|---|
ORDER_ID | Unique identifier for each order. |
STATUS | Current status of the order (e.g., completed, failed). |
IS_ERR | Flag indicating if the order has an error. |
RESOLVED_BY | User ID of the person who resolved any issues. |
EVENT_TIME | Timestamp when the event occurred. |
MAT_BATCH_ID | Batch ID for tracking processing batches. |
DIM_LOCATIONS
Information about each restaurant location, including operational status. The following columns are included in this table:
Column Name | Description |
---|---|
LOCATION_NAME | Name of the location. |
FRANCHISEE_NAME | Name of the franchisee owning the location. |
TIME_ZONE | Time zone of the location. |
IS_DIRECT_SYNC | Flag indicating if the location uses direct sync. |
OFFLINE_REASON | Reason if the location is offline. |
MAT_BATCH_ID | Batch ID for tracking processing batches. |
DIM_LOG_ITEM_SOLD_OUT_EVENT
Logs events when items are marked as sold out, including user and timestamp data. The following columns are included in this table:
Column Name | Description |
---|---|
REASON | Reason why the item was marked as sold out. |
ITEM_ID | Identifier for the item. |
SUSPENDED_UNTIL | Timestamp until the item is expected to be restocked. |
CREATED_AT | Time when the sold-out status was recorded. |
DIM_OPERATIONAL_QUALITY_INDICATORS
Quality metrics, including ratings and uptime for each location. The following columns are included in this table:
Column Name | Description |
---|---|
TOTAL_NUMBER_OF_RATINGS | Count of customer ratings received. |
TOTAL_1_STAR_RATINGS | Count of 1-star ratings received. |
DOWNTIME_PERCENT | Percentage of time the location was offline. |
DIM_ORDER_ITEMS
Detailed breakdown of each item in orders. The following columns are included in this table:
Column Name | Description |
---|---|
MENU_ITEM_COUNT | Total count of items in the menu. |
MENU_ITEM_LIST | List of menu items ordered. |
TICKET_ID | Ticket ID associated with the order items. |
VIEW_ERROR_RATE
Contains records related to errors in order processing. The following columns are included in this table:
Column Name | Description |
---|---|
MONTH | Month when the error occurred. |
ORDER_NUMBER | Unique order number. |
ERROR_CATEGORY | Category assigned to the error. |
Comments
0 comments
Please sign in to leave a comment.