Tutorials
Number of APIs: 9
To make it easy, we've created a Tutorials collection that allows you to follow our Data Model and Data Query tutorials in real time.
Refer to Alpine documentation for more details.
Getting started
Fork collection and environment into your workspace
To send requests or make changes to a collection from the Visier Alpine Platform workspace, you first need to fork the collection and environment into a personal or team workspace you belong to.
Note: Forking creates a copy of the collection in your Qodex workspace. The changes you make in a forked collection do not affect the original collection.
Configure forked environment
The Visier Alpine Platform environment includes variables that allow you to store and reuse values in Qodex.
After you've forked the environment, you can now update the current values before running your first request.
The following table defines each variable found in the environment.
| Name | Description |
|---|---|
username | Your Visier username. |
password | Your Visier password. |
baseUrl | The base URL is made up of the vanity name and domain name. https://{vanityname}.api.visier.io Replace {vanityname} with your Visier tenant name. |
apiKey | Your API key. |
vanityName | Your Visier tenant name. |
Here is an example of what your variables should look like:
| Variable | Type | Intitial Value | Current Value |
|---|---|---|---|
username | default | Your Visier username. | john@jupiter.com |
password | default | Your Visier password. | 12345678 |
baseUrl | default | https://{vanity_name}.api.visier.io | https://jupiter.api.visier.io |
asidToken | default | ||
apiKey | default | Your API key. | 093c2808ae49427bae8e64e727c42118 |
vanityName | default | Your Visier tenant name. | jupiter |
Running a tutorial
To run all requests in a tutorial at once, click the More actions button on the right side of the tutorial's name and select Run folder.
Result: Qodex displays each request and result in a console.
-
Get Aggregated Data Out of Visier-Steps - Request and retrieve metric objects GET {{baseUrl}}/v1/data/model/metrics
-
Get Aggregated Data Out of Visier-Steps - Request and retrieve employeeCount metric GET {{baseUrl}}/v1/data/model/metrics/employeeCount
-
Get Aggregated Data Out of Visier-Steps - Request and retrieve dimension objects GET {{baseUrl}}/v1/data/model/analytic-objects/Employee/dimensions
-
Get Aggregated Data Out of Visier-Steps - Request and retrieve selection concepts GET {{baseUrl}}/v1/data/model/analytic-objects/Employee/selection-concepts
-
Get Aggregated Data Out of Visier-Steps - Aggregate Query - CSV Response POST {{baseUrl}}/v1/data/query/aggregate
-
Get a List of Records Out of Visier-Authentication - Generate Security Token POST {{baseUrl}}/v1/admin/visierSecureToken
-
Get a List of Records Out of Visier-Steps - Request and retrieve employee properties GET {{baseUrl}}/v1/data/model/analytic-objects/Employee/properties
-
Get a List of Records Out of Visier-Steps - List Query - CSV Response POST {{baseUrl}}/v1/data/query/list
-
Get Aggregated Data Out of Visier-Authentication - Generate Security Token POST {{baseUrl}}/v1/admin/visierSecureToken