|
How do I get started with ClickMagick's API?
To get started with our API you’ll want to review the API Documentation and create an API Key.
API Rate Limiting
While some API requests generate almost no “work” on our end e.g. creating a new Smart Link, other API requests can generate quite a bit of work on our end e.g. generating Project stats for a time period containing lots of data.
Because of this, API Rate Limiting is dynamic and based on the amount of “work” your requests generate, as opposed to a simple number of requests per second.
Here’s what you need to know in order to avoid being rate limited, and what to do if you are …
1. When looking at how much “work” your requests generate, we look at your activity over the past 5 minutes. So you should take care to not submit too many requests that generate “a lot of work” in a short period of time.
2. Generally speaking, requests that generate “a lot of work” include retrieving raw click data, generating stats or resetting/deleting lots of data. Other requests generally won’t cause you to be rate limited.
3. If you’re rate limited you’ll receive a 429 response, with a
Retry-After header that indicates how long you’ve been rate limited in seconds e.g. 900s. You should not submit any more requests until the Retry-After period has passed.If you’re using ClickMagick, and our API, in a way it’s meant to be used you should rarely if ever be rate limited. If you have any questions don’t hesitate to reach out to our support team.
Tip: The most common cause of rate limiting is attempting to retrieve a large amount of click or conversion data in a short period of time.
This is a very “expensive” operation with more aggressive rate limiting.
So if you need to regularly retrieve click or conversion logs you’ll want to fetch small amounts of data on a regular basis e.g. every day or every hour.
If you attempt to retrieve weeks or months worth of data in a short period of time you will almost certainly be rate limited.
This is a very “expensive” operation with more aggressive rate limiting.
So if you need to regularly retrieve click or conversion logs you’ll want to fetch small amounts of data on a regular basis e.g. every day or every hour.
If you attempt to retrieve weeks or months worth of data in a short period of time you will almost certainly be rate limited.
Article 588 Last updated: 10/15/2025 1:09:29 PM
https://www.clickmagick.com/kb/?article=588