Data Model API

Discover the objects within your solution.

Who can use this feature?

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.

To retrieve plans, your API user must have:

If the plan is a managed plan, you must have access to the plan. For more information, see Set Managed Plan Security.

Not sure if you have this feature or capability? Reach out to your administrator.

Overview

Retrieve the objects that make up your analytic model in Visier and get detailed information about each object's schema. You can retrieve detailed information about objects in Visier by retrieving a list of all objects or retrieving information about an object by object ID.

Administrating tenants can perform actions on a single tenant using TargetTenantID or on multiple tenants in the same request using tenantCode.

  • The TargetTenantID request header defines the tenant that you're logged into. If defined, the API call executes from the specified tenant. If omitted, the default is the administrating tenant.
  • The tenantCode parameter defines the tenant to make changes to. In APIs that support many tenant codes, specify each tenantCode and omit TargetTenantID.

For more information about whether TargetTenantID or tenantCode is supported in an endpoint, see API Reference.

Use this API to retrieve:

  • Analytic objects
  • Properties
  • Dimensions
  • Selection concepts
  • Metrics
  • Plans
  • Predictions

For more information about these objects, see Understand Visier's Analytic Model.

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.

Get Started
Everything you need to know to get started with the Data Model API.
Code Samples
Selection of code samples that demonstrate the use of the Data Model API. Copy and edit these code samples to suit your needs.
API Authentication
Use OAuth 2.0 or basic authentication to access Visier's public APIs.
API Reference
Explore the full API reference documentation.
Postman Collections
Quickly dive into our APIs with our Postman collections that include a variety of pre-built examples and requests.