Get started with Traffic Analytics API
Get started
To get started, sign in to the Traffic Analytics website with your email address and password, then create a sample query.
API workflow
After you are familiar with the query concepts, build your app using the Traffic Analytics REST API.
When your app needs Traffic Analytics data, follow this general flow:
Step 1: Retrieve a security token
Use your API credentials to request a limited-lifetime security token. Include this token in all subsequent API calls.
Step 2: Submit a query
Send the query parameters that define the geographic area, time period, time of day, and requested output fields. The API returns a query ID.
Step 3: Poll the query status
Use the query ID to check whether processing is complete. When the query finishes, the API returns a download URL.
Step 4: Download the results
Retrieve the query results from the download URL.
Query submission guidelines
If you need to submit multiple queries, submit them one at a time. Wait for each query to complete before submitting the next one. Submitting several queries without waiting for completion can cause undefined results. The submitted queries may time out or fail.
As a general guideline:
- Don't submit more than a few queries per day.
- Check your product license for download limits, such as a maximum number of downloads per year.
- Review the service-level agreement (SLA) details in the following table.
| Administrative Area Tier | Example Coverage Area | Max Number of Requests Per Day | Historical Data Limit per Request | Average Size in GBs | SLA per request |
|---|---|---|---|---|---|
| Tier 1 Area | Potsdam (Germany), Eindhoven (Netherlands) | 5 | Up to 1 year | 1 | 6 hours |
| Tier 2 Area | Stuttgart (Germany), Lyon (France) | 4 | Up to 1 year | 1 | 6 hours |
| Tier 3 Area | Brandenburg (Germany), Normandy (France) | 3 | Up to 6 months | 1 | 8 hours |
| Tier 4 Area | Netherlands, Poland, Israel | 2 | Up to 1 month | 1 | 8 hours |
| Tier 5 Area | France, Germany, Italy | 1 | Up to 1 month | 1.5 | 8 hours |
| Tier 6 Area | EEU,WEU, MEA, APAC, CSA, USA | N/A | Professional Services | N/A | N/A |
| Tier 7 Area | Full Europe, Full North America | N/A | Professional Services | N/A | N/A |
| Tier 8 Area | Global | N/A | Professional Services | N/A | N/A |
Note:
Concurrent downloads, where multiple download requests are sent simultaneously, must be avoided.
Traffic Analytics data typically takes two days to compile, so the freshest available data is two days old.
The Traffic Analytics API supports a 95% service level. Make sure your app can handle error responses when the service is unavailable during maintenance or outage recovery.