API Reference

Getting Started With Checkmate Reporting API

The Checkmate Reporting API provides structured and actionable data sourced from third-party ordering platforms. This API empowers you to monitor sales, track operational performance, and optimize item availability, enabling data-driven decisions to improve your business operations.

Key Benefits

The Checkmate Reporting API provides several critical advantages to enhance your business intelligence and operational strategies:

  • Access Key Metrics: Seamlessly retrieve comprehensive data on orders, customer behaviors, and inventory levels.
  • Consistent Reporting: Standardize and compare data across different locations to maintain clarity and facilitate actionable insights.
  • Easy Integration: Our API integrates smoothly with your existing BI tools and dashboards, simplifying data analysis.
  • Custom Reports: Tailor data retrieval by location, date range, and other criteria to focus on the metrics that matter most to your business.
  • Automated Data Feeds: Automate the transfer of data to your systems, reducing manual processing and ensuring real-time data flow.
  • Comprehensive Data Access: Gain insights into sales trends, promotional effectiveness, item availability, and overall store performance, with operational metrics updated every 48 hours to keep you informed.

How It Works

Initial Setup

Upon setting up your business with our API, our dedicated onboarding team will equip you with a secure, brand-specific API link. This setup ensures that you have access to data that is pertinent only to your designated locations, maintaining privacy and relevance.

Data Types

Internal Data

  • Update Frequency: Updates hourly to ensure you receive the most current information possible.
  • Content: Gain in-depth insights into items sold, stock levels, and availability at your stores.
  • Learn more about Checkmate-stored data here.

External Data

  • Update Frequency: Refreshed every 48 hours to reflect the most recent data from third-party platforms such as Uber Eats and DoorDash.
  • Content: Focuses on operational performance metrics including delivery times and customer feedback, crucial for refining customer service.
  • Learn more about external data sources here.

Data Normalization

Our API meticulously standardizes key data fields like order numbers, timestamps, and delivery statuses, ensuring uniformity across different platforms. This standardization aids in simplifying comparative analysis and enhancing data reliability.

Learn more about data normalization here.

Rate Limiting Policies

To ensure optimal performance and system stability, our API enforces rate limits:

  • 100 Locations per Request: Maximize efficiency by retrieving data for up to 100 locations in a single request.
  • 1 Day Per Request: For extensive data retrieval covering multiple days, separate requests are required for each day.

API Response Codes and Error Messages

  • 200 OK: The request was successful. The response body contains the expected data.
  • 401 Unauthorized: Your request lacks valid authentication credentials, or your API token has expired.
    • Error Message Example: {"error": "Unauthorized"}
    • Resolution: Verify your API credentials and ensure your token is active.
  • 404 Not Found: The specified location ID(s) could not be found in our system.
    • Error Message Example: {"error": "Invalid Locations"}
    • Resolution: Check the Location IDs for typos or incorrect formatting and ensure they match those registered in your account.
  • 422 Date Range Exceeded: Your date-time range exceeds the 24-hour limit.
    • Error Message Example: {"error": "Difference between start, end datetime should not exceed 24 hours."}
    • Resolution: Adjust the datetime parameters to ensure the range is within 24 hours.

Each error response includes a JSON object that provides detailed information about what went wrong, making it easier to diagnose and fix issues quickly.

Available Endpoints

  • Tickets API: Contains information on tickets/orders received.
  • Order Details API: Captures details of each order, including status and errors.
  • Order Promotions API: Logs promotional codes or discounts applied to orders.
  • Sold Items Details API: Summarizes items sold across orders, including quantities and totals.
  • Item Sold Out Events API: Logs sold-out events, including timestamps and restock information.
  • Sold Out Items Details API: Tracks items marked as sold out, with timestamps and restock times.
  • Error Rates API: Monitors and categorizes error events encountered during order processing.
  • Location Operational 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.