Allstacks API Best Practices
- Brandon Godwin
- Shir Koretski
The Allstacks API can be used to automate operational tasks, like maintaining team rosters, or to export data for ingestion into an on-prem data warehouse.
API for Roster Maintenance
If you need to update your rosters on a regular basis due to changes in teams or structure, you can use the API to upload and export the roster CSV. For additional instructions, visit the “Team Management CSV Upload “page.
API for Data Ingestion
Allstacks has API endpoints to help you pull specific metrics from your account, and use them in your company’s data warehouse or other tools. You will be able to pull data on the org, project, user or tag level, but each metric will have to be set up individually.
To ensure system performance for all Allstacks users, there are a few guidelines that need to be followed when utilizing the API.
Polling Frequency
Allstacks ingests data from your source systems once a day during a nightly ETL pipeline. Polling any more frequently than every 24 hours won’t yield any updated data. The data ingestion pipeline begins at 9pm EST and runs throughout the night, downloading data and updating metrics within Allstacks throughout the pipeline.
We recommend polling for new data any time between 12pm and 8pm EST.
Rate Limits
Allstacks utilizes rate limits to ensure the health of API endpoints. If your API client exceeds the rate limit for an API, it will receive a HTTP 429 Too Many Requests response. If you receive this error, you should delay any retries for 1 minute. If you continue to run into rate limits, ensure that you are not running concurrent API clients.
If you wish to use our API endpoints, please reach out to your Customer Success Manager for additional details.