Analytic Objects API
Manage the analytic objects 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
An analytic object in Visier is a container that stores specific data and represents what you want to analyze or aggregate data for, like applicants, employees, pay change events, interviews, and even employee skills. Use Visier APIs to create, update, and delete analytic objects or retrieve your existing analytic objects. For more information about analytic objects, see Analytic Objects.
The Analytic Objects API improves on the existing analytic object-related Data Model API endpoints with the ability to filter your GET requests to specific object types and the option to create, update, delete analytic objects.
Note: The Analytic Objects API is currently limited to subjects and events.
You can use the Analytic Objects API to:
- Retrieve a list of all analytic objects
- Retrieve the details of a specific analytic object
- Create new analytic objects
- Update existing analytic objects
- Delete analytic objects
- Revert an analytic object to its Blueprint state
To specify a single tenant to manage analytic objects in, use TargetTenantID. To manage analytic objects 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.