Ventrata

Access any data table available in the Backoffice using your dashboard API Token via these endpoints:

<code>POST /ventrata/dashboard/report</code>

<code>POST /ventrata/dashboard/export</code>

- <code>POST /ventrata/dashboard/report</code>
 
- <code>POST /ventrata/dashboard/export</code>

These endpoints allow you to generate the same <a href="https://support.ventrata.com/en/articles/9521969-working-with-charts-and-reports">reports</a> and exports available in the Ventrata Backoffice—programmatically. This provides a clean and flexible way to integrate reporting and data exports into your own systems.

___________________________________________________________

Add <code>ventrata/dashboard</code> to your list of capabilities.

- Create a dashboard mode connection.
- Add <code>ventrata/dashboard</code> to your list of capabilities.

If you are unsure how to create a dashboard mode connection, please contact your Ventrata Success Manager.

The <code>/report</code> endpoint returns custom reports as an array of JSON objects.

In your Ventrata dashboard, go to any data table (for example, <a href="https://support.ventrata.com/en/articles/9357364-how-to-use-the-bookings-table">Bookings</a>, <a href="https://support.ventrata.com/en/articles/9576381-how-to-use-the-transactions-table">Transactions</a>, etc.).

Press the Generate Report link in the action bar.

Press the Reporting API cURL link to download the request body.

- Replace the 'Authorization' header with your dashboard token.
 
 
 Dashboard Token - API Key
 
 
 .curl file - Authorization header
 
- (Optional) Modify the filters object to dynamically insert values.
 
 
 .curl file - Filters

Once submitted, the API will return the full report data in JSON format.

1. In your Ventrata dashboard, go to any data table (for example, <a href="https://support.ventrata.com/en/articles/9357364-how-to-use-the-bookings-table">Bookings</a>, <a href="https://support.ventrata.com/en/articles/9576381-how-to-use-the-transactions-table">Transactions</a>, etc.). 
2. Press the Generate Report link in the action bar.
 
 
 Generate Report
 
3. Press the Reporting API cURL link to download the request body.
 
 
 Reporting API cURL
 
4. Open the .curl file and:
 
 - Replace the 'Authorization' header with your dashboard token.
 
 
 Dashboard Token - API Key
 
 
 .curl file - Authorization header
 
 - (Optional) Modify the filters object to dynamically insert values.
 
 
 .curl file - Filters
 
5. Once submitted, the API will return the full report data in JSON format.

To include all the necessary filters, we recommend first generating the report manually from the dashboard. Then press the Reporting API cURL link below the generated report. This will automatically include all applied filters in the request body.

The <code>/export</code> endpoint lets you download raw data exports (for example, bookings, payments, tickets), also as an array of JSON objects.

In the Ventrata dashboard, go to any data table in the dashboard (for example, <a href="https://support.ventrata.com/en/articles/9357364-how-to-use-the-bookings-table">Bookings</a>, <a href="https://support.ventrata.com/en/articles/9576381-how-to-use-the-transactions-table">Transactions</a>, etc.).

Press the Export link in the action bar.

Press Download Export API cURL to download the request body.

- Replace the 'Authorization' header with your dashboard token
 
 
 Dashboard Token - API Key
 
 
 .curl file - Authorization header
 
- (Optional) Modify the filters object to fit your integration needs.
 
 
 .curl file - Filters

The API will return a JSON array with your requested export data.

1. In the Ventrata dashboard, go to any data table in the dashboard (for example, <a href="https://support.ventrata.com/en/articles/9357364-how-to-use-the-bookings-table">Bookings</a>, <a href="https://support.ventrata.com/en/articles/9576381-how-to-use-the-transactions-table">Transactions</a>, etc.). 
2. Press the Export link in the action bar.
3. Press Download Export API cURL to download the request body.
 
 
 Export
 
4. Open the .curl file and:
 
 - Replace the 'Authorization' header with your dashboard token
 
 
 Dashboard Token - API Key
 
 
 .curl file - Authorization header
 
 - (Optional) Modify the filters object to fit your integration needs.
 
 
 .curl file - Filters
 
5. The API will return a JSON array with your requested export data.

Every table and column available in the Backoffice is also available through these API endpoints, including but not limited to:

<a href="https://support.ventrata.com/en/articles/9357364-how-to-use-the-bookings-table">Bookings</a>

<a href="https://support.ventrata.com/en/articles/9490808-how-to-use-the-ledgers-table">Ledger entries</a>

<a href="https://support.ventrata.com/en/articles/9489717-how-to-use-the-customers-table">Customers</a>

<a href="https://support.ventrata.com/en/articles/9357390-how-to-use-the-tickets-table">Tickets</a>

<a href="https://support.ventrata.com/en/articles/9576381-how-to-use-the-transactions-table">Transactions</a>

- <a href="https://support.ventrata.com/en/articles/9357364-how-to-use-the-bookings-table">Bookings</a>
- <a href="https://support.ventrata.com/en/articles/9490808-how-to-use-the-ledgers-table">Ledger entries</a>
- <a href="https://support.ventrata.com/en/articles/9489717-how-to-use-the-customers-table">Customers</a>
- <a href="https://support.ventrata.com/en/articles/9357390-how-to-use-the-tickets-table">Tickets</a>
- <a href="https://support.ventrata.com/en/articles/9576381-how-to-use-the-transactions-table">Transactions</a>
- and more

Retrieve reporting and export data directly from Ventrata using dedicated endpoints.

How to Use Reporting and Export API Endpoints

Dashboard

Home

Status

About

Developer Docs

Careers

Release Notes

Resources

Company

Find answers and get help from Intercom Support and Community Experts

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Link, Press control-option-right-arrow to exit

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

How to Use Reporting and Export API Endpoints

Overview

Reporting API

Exporting API

Available Data