Toast Analytics
Toast Analytics exposes Toast's restaurant analytics reporting API, providing pre-aggregated performance data such as sales, labor, menu, and payout metrics. With Weld, you can sync these analytics reports from Toast into your data warehouse for reporting and analysis.
This connector is separate from the standard Toast connector, which syncs raw restaurant configuration and operational data (orders, employees, menus, etc.). Use Toast Analytics if you want pre-aggregated restaurant performance reports instead.
Features
| Feature name | Supported | |
|---|---|---|
| Column Hashing | True | Column level |
| Blocking | True | Column level |
| Incremental | True | |
| Custom data | False | |
| History | False | |
| ReSync | True | Table level |
| Templates | False |
Data Schema
Setup Guide - ELT
Prerequisites
To connect Toast Analytics to Weld, you need API access credentials issued by the Toast integrations team. Contact your Toast representative to request partner API access to the Analytics API.
Step 1 - Gather your API credentials
Before setting up the connector in Weld, collect the following from Toast:
- Client ID — the standard API access client ID issued to you by the Toast integrations team.
- Client Secret — the standard API access client secret issued to you by the Toast integrations team.
- Domain - the domain where your Toast application is hosted. Do not include the protocol (https://) or any trailing slashes. For example, if your Toast application is hosted at
https://myrestaurant.toasttab.com, your domain would bemyrestaurant.toasttab.com.
Step 2 - Connect to Weld
- In the connector setup form, enter the destination schema name of your choice. This name will be used to identify the connection in future syncs.
- Enter your Client ID, Client Secret and Domain.
- Click Connect to validate the credentials and establish the connection.
Step 3 - Select restaurants
Select which restaurants you want to sync analytics data for. The list of restaurants is fetched live from your Toast partner account. If you don't select any restaurants, Weld will sync data for every restaurant your partner account can access.
Step 4 - Data To Sync
Select the tables you wish to include in the sync. Toast Analytics covers:
- Aggregated Sales and Check — sales and check-level performance
- Labor, Labor by Employee, and Labor by Job — labor cost and hours
- Menu, Menu by Menu, and Menu by Menu Item — menu performance
- Payout by Payments, Payout by Sales Date, and Payout by Settled Date — payout reconciliation
- Guest by Payment — guest engagement
- Restaurants Information — restaurant metadata
You can view the schema, remove columns or hash sensitive information.
Step 5 - Configure sync
- Select how often you would like the data to sync.
- Choose a start date to limit how far back the initial sync goes.
Due to the strict rate limits of the Toast Analytics API, we recommend a maximum lookback period of 2 years. The initial sync runs in chunks and can take a while to complete, so choosing the shortest lookback period possible is recommended. The initial sync runs from current date back to the start date, and subsequent syncs will only pull new data from the last successful sync.
- Provide a unique destination table name.
Weld will take over from here and commence syncing analytics data from your Toast account.