Get Started with Vee API

Everything you need to know to get started with the Vee 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, any user who calls the Vee API needs a permission with the following capabilities:

  • Vee

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 create a request to retrieve a list of sample questions for Vee using the /v1alpha/vee/sample-questions endpoint. For a complete list of available endpoints, see "Vee" 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:

  1. In Visier, in the global workspace, click Settings > Single Sign-On.
  2. 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 sample questions
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1alpha/vee/sample-questions' \
-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
{
  "questions": [{
    "question": "What is the turnover rate?",
    "metadata": {
      "categories": ["metricQuestion"]
    }
  }, {
    "question": "How many employees do we have in the US?",
    "metadata": {
      "categories": ["metricQuestion"]
    }
  }, {
    "question": "What is the relationship of span of control and turnover rate for managers?",
    "metadata": {
      "categories": ["craftVisual"]
    }
  }, {
    "question": "Is the turnover rate consistent with industry trends?",
    "metadata": {
      "categories": ["comparison"]
    }
  }, {
    "question": "What is the tenure for employees who left?",
    "metadata": {
      "categories": ["employeeEvent"]
    }
  }, {
    "question": "How has this changed over time?",
    "metadata": {
      "categories": ["adjustAnswer"]
    }
  }..]
}

Next steps

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

To learn more: