Beta Release Disclaimer
Vena’s Export API Beta is a beta feature release that provides a REST interface to export data from your data model. There is risk that it will not work as intended and that changes will be made to it during the beta period. Please review the information here before using the Export API Beta.
The feature has gone thorough internal testing and production-testing with customers. We will be making improvements to the API as necessary based on user feedback, including both feature enhancements and bug fixes. Any significant changes will be shared through Vena's biweekly release notes. Breaking changes are unlikely, and if needed, will be thoughtfully communicated and implemented.
Vena's Export API will remain free for the duration of the beta. That means that the feature can be activated and used free of charge, with no usage or data volume restrictions, outside of the rate limiting indicated below on this page. The beta period currently does not have a set end date.
How to enable the Export API feature in your tenant
To join the beta for the Export API, you must enable the feature in your Vena tenant. Instructions are provided in this article on how to enable the feature. You must be sign in with your Vena username and password to view the article.
Overview of Export API Capabilities
The Export API lets you integrate Vena with your data ecosystem to make financial and operational planning seamless and automatic between Vena and your other systems. A few examples of use cases that can be enabled with Vena’s Export API are data visualization in PowerBI, machine learning forecasting, and cross-functional reporting with your other systems.
The two Vena data types supported by the Export API are described below.
Export intersection values
The Intersections endpoint returns intersections of data that can be sent to your downstream systems.
Export your data model hierarchy
The Hierarchy endpoint returns the data model hierarchy that can be sent to your downstream systems.
Export Data Format
You can choose to export your data as JSON or CSV by specifying an Accept Header in the request.
Pagination
The Intersections endpoint follows a paginated design. The API synchronously fetches and returns one page of results, plus a link to the next page. You can then use the nextPage link in the response to make the next API request to return the next page, and continue the process until there are no pages left.
The Hierarchy endpoint does not offer pagination, because of the relatively small data size of a data model hierarchy.
Rate Limiting
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.