Get Started with Consolidated Analytics API

Everything you need to know to get started with the Consolidated Analytics (CA) API.

Get a Visier account

To use the APIs, you must have a Visier account with a profile that has the API capability. If you don't have an account, contact your administrator. They will create an account for you with permissions that allow you to view data.

In addition to an API profile, your API user must have a profile with the following capability:

  • Tenant Management: Write (access level), API (view level)

Generate your API key and authentication token

To make an API request, you will need an API key and an authentication token. For more information about how to get an API key and request an authentication 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 use Visier APIs, you 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 create a request to retrieve all the CA tenants in the administrating tenant using the /v1alpha/admin/consolidated-analytics/tenants endpoint. For a complete list of available endpoints, see "Consolidated Analytics" in API Reference.

Replace {vanity_name} with your tenant name. The API key is expected as a header, while the security token is expected as a cookie.

Tip:  

To find your vanity name:

  • Go to the global workspace in Studio, click Settings > Single Sign-On. Then, under Single Sign-On, find your service provider endpoint; for example, https://jupiter.visier.com/VServer/auth. In this example, jupiter is the vanity name.
  • As an administrating tenant, go to the global workspace in Studio, click Settings > Partner Single Sign-On. Then under Bypass Users (Optional), find your service provider endpoint; for example, https://jupiter.visier.com/VServer/auth. In this example, jupiter is the vanity name.
Copy
cURL sample request: Retrieve a list of all consolidated analytics tenants
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/admin/consolidated-analytics/tenants' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

Next steps

Now that you've successfully authenticated and completed your first API request, you can call more Visier APIs!

To learn more: