What is the Reporting API?
The Reporting API gives you access to essential data, helping you monitor orders, track performance, and monitor store performance. With these insights, you can make data-driven decisions to improve business operations.
Key Benefits of the Reporting API
The Reporting API offers seamless access to data, enabling you to optimize performance with informed decisions. Key benefits include:
- Access Key Metrics: Get data on orders, customer trends, and sold-out events. (Note: Operational performance data is updated every 48 hours.)
- Consistent Reporting: Standardize data across multiple locations for clear comparisons.
- Easy Integration: Connect with BI tools and dashboards for streamlined reporting.
- Custom Reports: Filter data by location, date, or other criteria to generate specific insights.
- Automated Data Feeds: Reduce manual work by sending data directly to your reporting tools.
How It Works
Once your business is set up, our onboarding team will provide a secure, brand-specific API link from where you can access the data as required. This ensures access to relevant data for your locations only.
The Reporting API offers two types of data:
-
Internal Data:
- This data is collected from order payloads and integrations within the Checkmate system. It offers insights into order details, such as items sold and store availability.
- Internal data updates every hour to ensure timely and accurate reporting.
- Learn more about Checkmate-stored data here.
-
External Data:
- External data is retrieved from third-party platforms, including Uber Eats and DoorDash. It focuses on operational performance metrics, such as delivery times and customer feedback.
- Since these platforms refresh their reports every 24 hours, external data is updated every 48 hours.
- Learn more about external data sources here.
Data Normalization
The API standardizes fields like order numbers, timestamps, and delivery status to ensure consistency across sources. This makes comparing data from platforms like DoorDash and Uber Eats easier.
Learn more about data normalization here.
Rate Limiting
Rate limits ensure optimal performance and prevent overloading the system. They define how much data can be retrieved within a given period.
- 100 Locations per Request: Retrieve data for up to 100 locations at once.
- 1 Day Per Request: You can only fetch data for one day at a time. For example, retrieving data for three days requires three separate requests.
Error Handling
The API returns standard HTTP status codes with error messages to assist in resolving issues. Common errors include:
- 404 Invalid Location: The location ID provided is incorrect.
-
422 Invalid Datetime Format: The date format should be
YYYY-MM-DD HH:MM:SS
. - 422 Start/End Datetime Error: Ensure the start date is earlier than the end date.
- 422 Unauthorized: Verify that your API permissions are valid.
How to Get Started
This report is currently available to select users. If you would like access, please contact our customer support team at support@itsacheckmate.com.
Comments
0 comments
Please sign in to leave a comment.