Vena API Troubleshooting Guide

Follow the steps in this troubleshooting guide to resolve errors with the Vena API. The steps provided in this guide apply to all endpoints in the Vena API. If you believe that your errors are particular to a specific endpoint, then please refer to the specific troubleshooting guides.

Initial Troubleshooting Steps

Check your authentication

If you are receiving a 401 Unauthorized error message, then the authentication user ID or key values you entered may be incorrect. Check that your authentication values are correct and try again.

Check your API parameters

If you are receiving a 404 Not Found error message, then you may be entering incorrect values for your API parameters. Visit the API reference page to find the values for your API parameters in Vena.

Check your data permissions

If you are receiving a 403 Forbidden error message, then you may not have the data permissions required to access the data you are requesting. For example, you may not have data permissions to access the model ID you are requesting. See this article for information on changing the data permissions applied to your authentication token.

Rate Limiting

If you are receiving a 429 Too Many Requests error, then you may have hit the rate limit that is applied to Vena’s API. The Export API has a rate limit applied for security and integrity reasons. If you are hitting the rate limit, you can consider increasing the pageSize query parameter.

Check your URL formatting

If you receive a 400 Bad Request error message, your URL request format may be incorrect. We recommend using the interactive request generator in the API Reference section to generate a URL in your programming language. This can help troubleshoot any formatting issues you may be experiencing.

Error Response Codes

Shown below are a few common error codes you may receive in the response when using the Vena API.

Error code	Name	Details
400	Bad Request	Something in your request is incorrect. Please check your request HTTP method, URL, and body.
401	Unauthorized	You do not have the authorization to make the request. Please make sure your Authorization is set correctly with your application token credentials, and that you have permission to the entity you are trying to access or update.
404	Not Found	The entity you are trying to access or update does not exist. Please make sure the entity you are seeing is in the collection (i.e. using list endpoints).
422	Invalid Entity	The entity you are trying to send is invalid. Please make sure your request body is formatted correctly. Note: For startWithData there is a 10,000 rows size limit.
500	Internal Server Error	Something went wrong processing your request. Make sure everything in your request is correct, and try again. If this problem persists, contact Vena Support.

Further Assistance

If you were unable to resolve your issue using the documentation and would like further assistance, please contact Vena Support