Visier Tenant Management API

Use this API to retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested. Mocked via Mockzilla.

Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. This API allows you to create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you.

Use this API to retrieve all details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant.

You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. You can use this API to update any field on an analytic tenant, except tenantCode.

Warning! Deprovisioning an analytic tenant is not reversible. Before deprovisioning, you must disable an analytic tenant. For more information, see /v1/admin/tenants/:tenantId/disable. This API removes an analytic tenant permanently from the Visier system. If you are unsure whether an analytic tenant may be re-enabled on any of the Visier modules at any time, you may instead want to disable the analytic tenant. If successful, the response returns the status "Deprovisioned". This indicates that the tenant is scheduled for deprovisioning, which may take several days to complete.

Use this API to disable an analytic tenant and remove access to Visier visualizations for the tenant's users. You must disable an analytic tenant before deprovisioning, or removing, it from the system. Available as a Mockzilla mock endpoint.

An analytic tenant is enabled when you provision or create the tenant. Use this API to enable a tenant that you have specifically disabled; for example, if you previously did not want that tenant to have access to Visier visualizations, but now do.

As you onboard more analytic tenants, you can validate the data visible to your users to ensure it matches the source systems from which it was exported and that it matches what your expectations are for this data. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the Home button. - Click Dashboard, and then click Edit Summary Metrics. - Select the metrics that you want to validate, and then close the Summary Metrics dialog. - Publish the project to production.

Use this API to retrieve the metric values for an individual analytic tenant. The metric values included in the response are the tenant's configured summary metrics. Administrators can configure summary metrics in a project: - Sign in to Visier as an administrator. - In a project, on the navigation bar, click the Home button. - Click Dashboard, and then click Edit Summary Metrics. - Select the metrics that you want to validate, and then close the Summary Metrics dialog. - Publish the project to production.

Use this API to retrieve the full list of analytic tenants managed by you with their current states and the content modules assigned to them, and all other relevant details for the tenants if requested.

Prior to processing and loading an analytic tenant's data files, you must provision, or create, that tenant. A provisioned analytic tenant is automatically enabled. If the tenant's data is loaded after provisioning, that data is immediately accessible by their users. This API allows you to create an analytic tenant and identify the applications assigned to the tenant. Visier organizes content under a set of modules. Contact Visier Support to determine the list of modules allocated to you. Note: API requests that contain homeAnalysisId, homeAnalysisByUserGroup, or clickThroughLink take longer to run because they require publishing a project to production. Mockzilla mock: no signup, no API key.

You may need to update analytic tenants as they grow and as your organization upgrades the content available to them. You may also encounter a scenario where an analytic tenant transitions across different industries. To make updates to your tenants, use this API. To ensure that the analytic tenant receives accurate benchmarks and predictive functionality, update their industry code in the Visier system. To programmatically assign the Home analysis that analytic tenants see at login, use this API to set the default Home analysis for a tenant and specific user groups of that tenant. You can use this API to update any field on an analytic tenant, except tenantCode. Note: API requests that contain homeAnalysisId, homeAnalysisByUserGroup, or clickThroughLink take longer to run because they require publishing a project to production.

Use this API to retrieve the details for a specified analytic tenant. Doing so allows you to see the current state of the tenant, the content modules assigned to it, and all other relevant details for the tenant.