API usage
See how many requests each API key and connected app made per day, with errors and rate limits, and whether the two independent counts agree.
The API usage report shows the requests made to the IconEngage API with each of your API keys and connected apps, day by day. Every day is counted twice, by two independent records, so you can see that the numbers agree.
Note: Only Owners, Admins and Developers can see this report.
Go to Analytics › API usage. To change the days, set From and To, then click Apply.
API usage days are always UTC days. Your organisation's day boundary doesn't apply here, so leave Day boundary on UTC. Requests can take until the next day to appear.
How fresh the numbers are
The page shows two "Counted up to …" lines, one for each record. The usage record is written in batches, so recent requests may not be in it yet. The page says so: "Usage recorded since then is not in these numbers yet."
Agreement
The two counts are compared for each credential and day:
| Badge | What it means |
|---|---|
| Agrees | Both records counted the same requests. |
| Differs | The records disagree on a day that has finished. One of them missed requests. A warning at the top of the page tells you when any row differs. |
| Not yet decidable | The day hadn't finished when the records were last measured. This isn't a disagreement. |
API usage per credential per day
| Column | What it means |
|---|---|
| Credential | The API key or connected app's name, and which kind it is (API key or Connected app). |
| Day | The UTC day. |
| Ledger | Requests counted by the usage record. Not recorded means the usage record has no entry for that day, which isn't the same as zero. |
| Events | Requests counted by the independent request log. |
| 4xx | Requests refused because of a problem with the request, such as invalid input or missing permission. |
| 5xx | Requests that failed because of a server error. |
| Rate limited | Requests refused because the credential was sending too many. |
| Agrees | The agreement badge described above. |
Not counted: requests refused before they named a credential, such as a missing or malformed key, or a rate limit applied before the key was checked. They belong to no credential, so they're in neither count and in no row.
If no requests were made in the range, the page says No API calls in this range.
Related
Still need help?
Write to us at [email protected] and tell us what you were trying to do. Already a customer? Sign in to IconEngage — the same articles are under Help in the app.