Get Started with Data Version Export API

Everything you need to know to get started with the Data Version Export API.

Prerequisites: Have a Visier tenant.

Get a Visier Account

To use the API, you must have a Visier account with a profile that has the following capabilities:

  • Data: Read (Access Level), API (View Level)
  • Manage Jobs
  • Legacy API Restricted

  • Access to All Data

    Note: If your API user has Super Admin Permission, you do not need Access to All Data. For more information, see Super Admin Permission.

If you don't have an account, contact your administrator. They will create an account for you with the above capabilities.

Generate your API key and security token

To make an API request, you will need an API key and a security token. For more information about how to get an API key and request a security token, see API Authentication.

Note: If using Postman to send requests, you can request a security token directly in the tool, see Use Postman to Call Visier APIs.

Choose your tool

To begin working with the Data Version Export API you will need to choose a tool to make your first request. This can be Postman or whichever method you usually use to make HTTP requests. For more information about using Postman for your first request, see Use Postman to Call Visier APIs.

Make your first request

To test that you have everything set up correctly, we'll make a request to the Retrieve a list of all data versions endpoint. For a complete list of available endpoints, see "Data Version Export" in API Reference.

The following sample request is used to retrieve a list of all data versions. Replace {vanity_name} with your tenant name. The API key is expected as a header, while the token ID is expected as a cookie.

Copy
cURL sample request: Retrieve a list of all data versions
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/data/data-version-exports/data-versions' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

If everything was set up correctly and the request was successful, you should see a similar response:

Copy
Sample response: 200 OK
{
    "dataVersions": [
        {
            "dataVersion": "9110004",
            "dataCategory": "",
            "created": "1624514036672"
        },
        {
            "dataVersion": "9110003",
            "dataCategory": "",
            "created": "1624508235073"
        },
        {
            "dataVersion": "9110002",
            "dataCategory": "",
            "created": "1624503809771"
        }
    ]
}

Next steps

Now that you've successfully authenticated and completed your first API request, you're ready to continue exporting data versions from Visier.

To learn more: