Get Started with Data Model API

Everything you need to know to get started with the Data Model 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 permission to access the data that you request through the Data Model API. For more information, see Data Security for a Permission.

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 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 make a request to retrieve all the metrics in your Visier solution using the /v1/data/model/metrics endpoint. For a complete list of available endpoints, see "Data Model" 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:

In Visier, in the global workspace, click Settings > Single Sign-On.
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.

Copy

cURL sample request: Retrieve a list of metrics

1
2
3
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/data/model/metrics' \
-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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "metrics": [
        {
            "id": "employeeCount",
            "displayName": "Headcount",
            "description": "The number of employees in the organization.",
            "dataStartDate": "1522627200000",
            "dataEndDate": "1604102400000",
            "analyticObject": "Employee",
            "parameters": []
        },
        {
            "id": "employeeTenureAverage",
            "displayName": "Tenure",
            "description": "The time in years that employees have worked for the organization.",
            "dataStartDate": "1522627200000",
            "dataEndDate": "1604102400000",
            "analyticObject": "Employee",
            "parameters": []
        }
    ]
}

Note: Each data model is unique to each Visier tenant, depending on purchased applications and any custom objects. The objects in the response are retrieved from the tenant specified by the tenant name in the request.

Next steps

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

To learn more, see "Data Model" in API Reference.