Trakwell API Overview
The Trakwell API allows developers to pass data between the Trakwell platform and external systems. This article provides a high-level overview of how the API works and links to the full interactive documentation.
In this article
Getting Started
To use the Trakwell API, youโll need an API key. If you are a company admin, you can find your API key by logging in to Trakwell, navigating to the Admin tab, then going to your Company page and opening its settings โ your API key will be listed near the top.
If you need help accessing your API key, reach out to our support team โ you can call or text us at 833-503-9934, email us at support@trakwell.ai, or submit a ticket directly from the knowledge base.
All requests are made over HTTPS, and your API key is required on every request.
๐ Base URL
All API requests are sent to the following base URL:
https://intg.trakwell.ai/ords/doorcounts/api/
๐ Available Endpoints
The Trakwell API covers several categories of data:
๐ถ Traffic / Foot Traffic Counts โ Pull summarized or detailed door count data by store and date range, including included and excluded counts. Multiple versions are available depending on the level of detail you need (summary, detail by record, or detail by user).
๐ Sales Statistics โ Retrieve sales performance data by employee or by location, including opportunities, conversion rates, average sale, revenue per opportunity, and more.
๐พ Sales Upload โ Push sale records into Trakwell from your POS or external system, including customer details, salesperson assignment, product categories, and advertising source.
๐ Scheduled Actions / CRM โ Download scheduled follow-up actions (be-backs, appointments, etc.) and push customer records into Trakwellโs CRM.
๐ Daily Sales โ Upload daily aggregate sales totals by store.
All GET endpoints accept dateFrom and dateThrough parameters in YYYYMMDD format. The store parameter is optional on most endpoints โ if omitted, data for all stores associated with your API key is returned.
๐๏ธ Response Formats
Most endpoints support three response formats: JSON, CSV, and XML. The format is specified in the endpoint URL (e.g., count.json, count.csv, count.xml).
๐ Full API Reference
For the complete list of endpoints, parameters, and example responses, refer to the Trakwell API reference:
๐ View the Trakwell API Reference
Still have questions? Call or text us at 833-503-9934, email us at support@trakwell.ai, or submit a ticket.