How to enable the Export API feature in your tenant
To get access to Vena’s Export API, please reach out to your Vena Admin. If you previously participated in the Vena Export API beta program, you will continue to have access until your next Vena renewal date. Instructions are also provided in this 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.