What is External Data?
The Reporting API provides internal and external data access, allowing you to track performance across your business. External data refers to metrics gathered from third-party platforms, such as Uber Eats and DoorDash, offering insights into:
- Order and Delivery Performance: Track delivery times, cancellations, and customer ratings to understand service quality.
- Customer Feedback: Monitor customer comments and ratings to improve service.
- Sales and Revenue Data: Access details on order values and quantities to analyze sales trends.
This data is updated every 48 hours, allowing you to make informed decisions based on the most current available information.
Overview of External Data APIs
The following APIs contain externally stored data to support your reporting needs:
| API Name | Description |
|---|---|
| Location OP Status API | Provides insights into the operational status of locations, including downtime and reasons for going offline. |
| Operational Metrics API | Tracks key metrics related to delivery times, cancellations, and errors. |
| Refund Source Data API | Tracks refunds issued for orders, including transaction details and payout amounts. |
| Item-Level Errors API | Identifies errors associated with individual items in orders. |
| Rating Tags API | Tracks customer feedback, including ratings and tags for quality assessment. |
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.
| 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. |
Operational Metrics API
The Operational Metrics API provides key insights into the performance of orders, including delivery times, cancellations, and overall efficiency. This API helps in evaluating operational effectiveness, understanding bottlenecks, and enhancing customer satisfaction.
| 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. |
Refund Source Data API
The Refund Source Data API provides detailed information about refunds issued for orders, including transaction details and payout amounts. This API is useful for tracking refunds, analyzing discrepancies, and improving financial reconciliation.
| Field Name | Description |
|---|---|
| location_id | Identifier for the location where the refund occurred. |
| product_id | Identifier for the product associated with the refund. |
| brand | Brand associated with the refund. |
| platform | Platform or ordering source where the refund was processed. |
| location_name | Name of the location where the refund occurred. |
| order_date | Date when the order was placed. |
| order_date_time | Timestamp when the order was placed. |
| transaction_type | Type of transaction (e.g., refund, order). |
| total_payout | Total amount paid out for the refund. |
| subtotal | Subtotal amount before taxes and fees. |
| store_type | Type of store where the refund was processed (if applicable). |
| external_store_id | Identifier for the external store, if applicable. |
Item-Level Errors API
The Item-Level Errors API identifies and provides details about errors associated with individual items in orders. This API is essential for monitoring and addressing product-level issues that may impact order fulfillment, customer satisfaction, or operational efficiency.
| Field Name | Description |
|---|---|
| location_id | Identifier for the location where the error occurred. |
| ordering_source | Name of the platform or source where the order was placed. |
| order_number | Unique identifier for the order containing the item. |
| item_name | Name of the item associated with the error. |
| quantity | Quantity of the item in the order. |
| subtotal | Total cost of the item, based on unit price and quantity. |
| item_order_date | Date when the item was ordered. |
| error_datetime | Timestamp when the error occurred (if applicable). |
| error_category | Description of the error category (if applicable). |
| created_at | Timestamp when the record was created. |
| external_store_id | Identifier for the external store associated with the item. |
Rating Tags API
The Ratings API provides insights into customer feedback by tracking ratings and related metrics for specific locations. This API is valuable for monitoring service quality, identifying areas of improvement, and evaluating customer satisfaction across platforms and locations.
| Field Name | Description |
| brand_name | The name of the brand associated with the location. |
| location_id | Unique identifier for the specific restaurant location. |
| country | The country where the restaurant location is situated. |
| external_store_id | Identifier for the store in external systems; null if not applicable. |
| order_date | The date on which the orders contributing to the ratings were placed. |
| ordering_source | The platform from which the order was received (e.g., DoorDash). |
| avg_rating | The average rating received from customer feedback. |
| rating_tags | Tags associated with the ratings, providing additional context; null if not applicable. |
| total_count | The total number of ratings contributing to the average; null if not applicable. |
Data Normalization for External Data
Since each platform may label and structure data differently, the API standardizes data to ensure consistent reporting. This process standardizes key metrics and terms, making comparing data across platforms like Uber Eats and DoorDash easier.
Data Normalization Between Uber Eats and DoorDash
To ensure accuracy in reporting, certain fields are normalized to maintain consistency between Uber Eats and DoorDash data. Here’s a sample of how fields are mapped for cross-platform analysis:
| New Field Name | DoorDash Field | Uber Eats Field | Formula/Mapping |
|---|---|---|---|
| store_name | store_name | store | Direct mapping |
| order_number | dd_order_number | order_id | Extract the last 8 characters from DoorDash order number |
| courier_arrival_at | dasher_arrival_time | courier_arrival_time | Direct mapping |
| order_placed_at | order_place_date, order_place_time | time_customer_ordered | Combined and converted timestamp |
| transaction_amount | subtotal | sales_excl_tax | Cast to float |
Comments
0 comments
Please sign in to leave a comment.