Metrics API
Manage the metrics in your analytic model.
Note: Alpha This API is in alpha. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer/Partner Success Manager.
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 a profile with the following capability:
- To create, retrieve, update, and delete: Model: Write (access level), API (view level)
- To only retrieve: Model: Read (access level), API (view level)
- Direct Publish (if
ProjectIDheader is not used)
Not sure if you have this feature or capability? Reach out to your administrator.
Overview
A metric in Visier is a business concern that can be quantified as a number. Use Visier APIs to create, update, and delete metrics or retrieve your existing metrics. For more information about metrics, see Work With Metrics.
The Metrics API improves on the existing metric-related Data Model API endpoints with the ability to filter your GET requests to specific metric types or analytic objects, and the option to create, update, delete metrics.
You can use the Metrics API to:
- Retrieve a list of all metrics
- Retrieve all the metrics for a specific analytic object
- Create new metrics
- Update existing metrics
- Delete metrics
To specify a single tenant to manage metrics in, use TargetTenantID. To manage metrics for many tenants in the same request, use tenantCode.
- The
TargetTenantIDrequest 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
tenantCodeparameter defines the tenant to make changes to. In APIs that support many tenant codes, specify eachtenantCodeand omitTargetTenantID.
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.