Metrics API
Manage the metrics in your analytic model.
Access requirements
To use the APIs, you must have a Visier account. 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.
Custom profile with these capabilities:
- For retrieve actions: Model (Read, API)
- For create, update, delete actions: Model (Write, API) and Direct Publish (if
ProjectIDheader is not used)
Reach out to your administrator for access.
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
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.