Visier APIs

Visier's suite of public APIs allows developers to programmatically use the platform's built-in features and access data and datasets to build or enrich their application at scale.

With these APIs, you can:

  • Have greater control over users working with or accessing data in Visier.
  • Retrieve data stored in Visier.
  • Load data directly into Visier objects with ease.
  • ...and more!

Note:

  • Visier APIs make requests and return data based on your production environment in Visier unless otherwise specified.
  • Visier reserves the right to, without notice and at its sole discretion, add new elements to API responses. Authorized users who call Visier's APIs must set their JSON parsers to not fail on unknown properties or risk being unable to interpret such API's result set.

Visier releases APIs in the following release statuses:

  • General availability: The API is available to use in your production environment. If there are backwards-incompatible or breaking changes, Visier releases a new API version. The API route contains the version number; for example, /v1/data/model/metrics. For more information about versions, see Version Control and Deprecation.
  • Limited availability: The API is available to use in your production environment after contacting Visier. The API documentation states that the API is limited availability. The API route contains the version number; for example, /v1/data/model/metrics.
  • Beta: The API interface is stable but its implementation may change. If there are backwards-incompatible changes, Visier communicates a deprecation notice to users. The API route contains beta; for example, /v1beta/data/model/metrics. To use a beta API in your production environment, contact Visier.
  • Alpha: The API may change in a breaking way without notice. The API route contains alpha; for example, /v1alpha/data/model/metrics. To use an alpha API in your production environment, contact Visier.
Get Started
Learn about authentication, rate limiting, status and error codes, and more.

Data In APIs

Send data to Visier with ease.

Data Upload API
Send data files to Visier.
Direct Data Intake API
Send prepared data files to Visier to quickly and easily load data directly into objects.
Data Intake API (Limited Availability)
Send your raw data files to Visier and let us take care of the rest.
PGP Key API
Generate a key pair that you can use to encrypt your data to send to Visier.

Tip: What data in API should I use?

Visier has multiple data intake APIs that allow you to send data to Visier based on the format of your data files, as described next.

  • If your data is already in an acceptable format to load into Visier objects, use the Direct Data Intake API. For more information, see Direct Data Intake API.
  • If your data needs some work after being sent to Visier, use the Data Upload API. For more information, see Data Upload API. Alternatively, the Data Intake API is also available, but we recommend the Data Upload API because it's simpler and stabler.

The following diagram describes the decisions to make before deciding which data API to use.

Data Out APIs

Retrieve your data from Visier.

Data Query API
Perform aggregation and list queries to retrieve data from Visier.
Data Version Export API (Alpha)
Export data version information, such as tables, columns, and file information, in CSV format.
Data Exports
Leverage Visier metrics and data outside of the solution with Data Exports.
Write SQL-Like Queries
Learn how to author queries using Visier's SQL-like language.
Visier Python Connector
Use Python to query against Visier's platform in Visier's SQL-like syntax and export data to your tool of choice.
Data Out Connectors

Take your data out of Visier into a different application.
Vee API (Alpha)
Use Vee through Visier APIs, such as asking questions, submitting feedback, and getting sample questions.

Administration APIs

Manage your Visier tenant with APIs.

Projects API (Alpha)
Manage project changes using Visier APIs.
Users API
Manage the users within your organization.
Permissions API (Limited Availability)
Manage the user permissions that secure your data in Visier.
Profiles API
Manage the profiles assigned to users in your Visier solution.
System Status API
Check the health and status of Visier's platform and services.

Analytic Model APIs

Retrieve and configure your analytic model in Visier with APIs.

Data Model API
Retrieve objects in your Visier solution.

Resources

Helpful resources to make your development process easy and efficient.

Postman Collections
Quickly dive into our APIs with our Postman collections that include a variety of pre-built examples and requests.
Visier Python Connector
Use Python to query against Visier's platform in Visier's SQL-like syntax.
Visier SQL-Like Shell
Use a SQL-like shell to issue queries against Visier's platform in Visier's SQL-like syntax.