Review API error alerts

When your account's API calls meet the 5% threshold for certain errors, the Developer Tools dashboard will display a new alert window with details about any endpoints returning a high rate of error.

You may receive an API error alert if:

• Your account makes over 1000 API calls per 24 hour period AND

  • The rate of errors exceeds 5%.

  • The calls are receiving 429, 400, or 403 errors.

Review an API error alert

Open the Developer Tools dashboard. If you have an active error alert, you will see a section titled Endpoints with high error rate. Review each column for additional details about the latest endpoint error rates or click View all to see a full list of endpoints returning errors above the threshold over the past 24 hours.

Method

The Method column lists the method used for the erroring API requests, such as GET and POST.

Request path

The Request path column provides the abbreviated endpoint URL being called.

Error code

The Error code column indicates which error code is returned.

• 400 (Bad Request)

  The request is missing a required parameter or has an invalid parameter.

• 403 (Forbidden)

  The request contains valid authentication information, but does not have permissions to perform the specified action.

  See API key scopes for more information.

• 429 (Rate Limit Exceeded)

  You hit the rate limit for this endpoint (different endpoints have different rate limits).

Error rate

The Error rate columns shows the percentage of calls returning an error.

Suggested actions

The Suggested actions column links out to recommended documentation which may be helpful in diagnosing and resolving erroring calls.

For more information about API calls made via one of your account's API keys, check out the API activity dashboard.