Dimensions API

Manage the dimensions in your analytic model.

Alpha

Access requirements

To use APIs, you must have a Visier account and authenticate. For more information about authenticating, see API Authentication.

Custom profiles with one of the following capability sets:

  • Model (Read, API)
  • Model (Write, API) and Direct Publish (if ProjectID header is not used) required for creating, updating, and deleting

Reach out to your administrator for access.

Overview

A dimension in Visier is a design object that organizes unique values of an attribute into a list or a hierarchical structure for use as a filter or group by in your solution. Use Visier APIs to create, update, and delete dimensions or retrieve your existing dimensions. For more information about dimensions, see Dimensions.

The Dimensions API  improves on the existing dimension-related Data Model API endpoints with the ability to filter your GET requests to specific dimension types or analytic objects, and the option to create, update, delete dimensions.

Note: The Dimensions API is currently limited to leveled dimensions and parent-child dimensions.

You can use the Dimensions API to:

  • Retrieve a specific dimension or all dimensions
  • Create new dimensions
  • Update existing dimensions
  • Delete dimension

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.

Tip: If you submit API requests for changes that cause a project to publish to production, each request is individually published to production, resulting in hundreds or thousands of production versions. We recommend that you use the ProjectID request header to make changes in a project. For more information, see Projects API.

Get Started
Everything you need to know to get started with the Dimensions API.
Code Samples
Selection of code samples that demonstrate the use of the Dimensions 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.