Skip to main content

Eggplant Monitoring Insights API Troubleshooting Guide

This guide is intended to be a quick reference to assist you in understanding and, if possible, resolving common issues that you might encounter when using the Eggplant Monitoring Insights API.

User Interface

The following table lists error messages you might see when using the Eggplant Monitoring Insights Query Builder, along with the message meaning and possible solutions.

IssueMeaningSolution
Authentication failure message displays at loginThe account you are using does not have access to the APIContact your account manager
You have exceeded the maximum number of allowed requests message displays at loginThe number of API queries made by your company has exceeded the contractual allowance, or the allowance has not been setContact support or your account manager
Query Builder AccountId filter does not show all the monitoring accounts you expectThe account you are using does not have access to all required monitoring accountsContact support or your account manager
Query Builder Id filter drop-down is emptyYou have not selected any accounts from the AccountId drop-down

OR

If this is the first time you are using the API user interface, an API query allowance might not be set for your company
Go back and select at least one AccountId

OR

Exit the API and try to log in again
Query Builder Return tree does not contain a branch that you expectNone of the tests covered by the test filters you have defined contain any data within this branch of the Return treeRedefine your test filters
Your query returns results for significantly fewer tests than you expectedThe LimitTestResults value may not have been defined, in which case only 20 test results will be returnedIncrease the LimitTestResults value as necessary
Query Builder becomes unresponsive when trying to select test filters or data filtersThe API key might have expiredRefresh the screen to see if a 401 authentication failure message displays. If so, the key has expired. Log in to the API again to generate a new one.

Specific Error Codes

This table lists error codes you might encounter when using the Eggplant Monitoring Insights Query Builder, along with possible solutions.

CodeMessageMeaningSolution
101 (HTTP)Service currently unavailableThe API is down or unreachableContact support
301 (response)Maximum number of items exceeded. Response was truncated.You have requested too much data for the API to provide in one queryNarrow your query, or divide it into several queries
401 (response)Authentication failureYour API key has expiredLog in again to generate a new key
402 (response)You have exceeded the maximum number of allowed requests.The number of API queries made by your company has exceeded the contractual allowance, or the allowance has not been setContact support or your account manager

Programmatic Calls

The following table lists error codes you might encounter when using Eggplant Monitoring Insights API calls programmatically,

CodeMessageMeaningSolution
101 (HTTP)Service currently unavailableThe API is down or unreachableContact support
301 (response)Maximum number of items exceeded. Response was truncated.You have requested too much data for the API to provide in one queryNarrow your query, or divide it into several queries
401 (response)Authentication failureThe API key has expired

OR

The application has provided an incorrect API key

OR

The account you are using does not have access to the API
Generate a new key and use it in your query

OR

Enter a different key in the query

OR

Contact your account manager
402 (response)You have exceeded the maximum number of allowed requests.The number of API queries made by your company has exceeded the contractual allowanceContact support or your account manager
402 (HTTP)Payment requiredThe number of API queries made by your company has exceeded the contractual allowanceContact support or your account manager
403 (HTTP)Not FoundThe API cannot resolve the supplied query URLMost likely the URL is constructed incorrectly, i.e., with an API key with a length other than 32 characters