05
Reference
When to use the API
Choose between file uploads, one-click connectors and the API, and what each API endpoint is for.
| You want to | Use |
|---|---|
| Load history, or run a one-off analysis | A file upload |
| Connect Intercom | The one-click Intercom connector |
| Bring in another tool (each has a guide; most mean running a small script on your side) | The integration guides |
| Send messages from your own systems or any vendor’s API | The universal API |
| Send bot intents, or events such as clicks and purchases | Intents and events |
| Run a guide’s code on a schedule | Scheduled sync |
| Pull your Dimensions out into your own systems | The Export API |
Business data (accounts, orders, renewals) comes in by file upload only today, under Data Sources > Structured data. An API for it is on the roadmap. See Join business data.
Your API keys
Section titled “Your API keys”- Tracker key. Each source in Data Sources has its own key, shown in the source’s integration instructions. For the universal API, add the source with the Universal API tile. See Your API key.
- Export API key. In Settings. See Export API.
Stuck? Email [email protected] with the source name and a sample payload.