Toast Analytics

📘

Please read the Toast API Docs for more information.

Set up

Before you can begin using the connector make sure you have the following information available:

• Domain: If your application is hosted at https://toast-api.toasttab.com, the domain is toast-api.toasttab.com, excluding the "https://" portion.

• Client ID & Client Secret: Please retrieve your Client ID and Client Secret from the Toast API Access product, available under your Integrations section.

For more details on Client Credentials please see here in the Toast documentation. Be sure to keep a record of your Toast-Restaurant-External-ID or restaurantGuid, as these are required to generate restaurant-specific reports using this connector.

🚧

Analytics API access and credentials

Please note that access to the analytics API requires an active subscription to Toast Restaurant Management Suite Pro or higher.

Analytics API authentication credentials are different from other Toast API authentication credentials.

If your organization has access to other Toast APIs, you cannot use the authentication credentials for other Toast APIs to access the analytics API. You must use separate client authentication credentials for the analytics API.

If unsure how to get your Analytics API credentials, please reach out to your Toast representative

Features

Reports detail

Limitations

🚧

Strict Rate Limits Impacting Backfills

Toast enforces very strict rate limits on the Analytics API, and once these limits are reached, they can take several hours to reset.

As a result, long historical backfills on the Check Reporting Data report may fail or return errors. We recommend limiting automated backfills to one month.

If you need to backfill older data and longer backfills are consistently failing due to rate limits, use the Check Reporting Data (Custom Dates) report and run it in one-month intervals to complete the backfill in stages.

🚧

Incremental runs

Incremental runs may result in duplicates, please deduplicate in a transform layer.