API docs by Redocly

API Reference

Download OpenAPI specification:

License:Apache License, Version 2.0

Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.

Basic Authentication

Request an authentication token through basic authentication. With basic authentication, use your username and password to request a secure token. The response returns an ASID token that you can use in your API calls.

Request a Visier authentication token

Generate a secure ASID token.

Authorizations:
None
Request Body schema: application/x-www-form-urlencoded
required

Your username and password credentials to request an authentication token.

username
string

The unique identifier of the API user requesting a security token.
password
string

The password that corresponds to the user making the request.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Request an impersonation token

Generate an impersonation token for the given username. The requesting user must have the Impersonator profile. The impersonated user must have the Read Impersonated or Write Impersonated profile. Supports impersonating users within the same tenant or in an analytic tenant by specifying TargetTenantID. After receiving the token, use the Cookie:VisierImpersonationToken header to make API requests as the impersonated user.

Authorizations:
(ApiKeyAuthCookieAuth)
queryParameters
write
boolean

If true, the token grants read and write impersonation. The impersonated user must have the WriteImpersonated profile capability. Default is false and grants read only impersonation.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
TargetUsername
string

The username of the user to impersonate. If provided in both the header and the request body, the header value takes precedence.
Request Body schema: application/x-www-form-urlencoded
required

Request to generate an impersonation token.

TargetUsername
string

The username of the user to impersonate.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

OAuth 2.0

Request an authentication token through OAuth 2.0 with Open ID Connect (OIDC). With OAuth 2.0 with OIDC, use an OAuth 2.0 grant to request an authentication token. The response returns a JSON Web Token (JWT) that you can use in your API calls.

Retrieve user metadata

Retrieve user-specific metadata, such as user ID, username, and profile capabilities.

Authorizations:
BearerAuth
queryParameters
includeTenantDetails
boolean

If true, includes tenant details in the response. Default is false.

Responses

Response samples

Content type
application/json
{
  • "sub": "string",
  • "name": "string",
  • "email": "string",
  • "visier:user_id": "string",
  • "visier:capabilities": {
    },
  • "visier:subnets": {
    },
  • "visier:export_subnets": {
    },
  • "visier:tenant_details": {
    },
  • "visier:tenant_id": "string"
}

Request an authorization code

Request an authorization code for the authorization_code grant type. Not required in other OAuth 2.0 grant types.

Authorizations:
None
queryParameters
redirect_uri
string

The optional URI to redirect to after authorization.
response_type
required
string

The response type. Must be code.
client_id
required
string

The unique identifier of the pre-registered client application.
scope
string

The OAuth 2.0 scope of the authorization request. Default is read. If the scope includes visier:login:bypass_users, the redirect login URL ends in /auth/admin instead of /auth. This allows single sign-on (SSO) Bypass Users to sign in through Visier instead of being redirected to the SSO login page.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Request a JSON Web Token

Use an OAuth 2.0 grant type to request a JWT.

Authorizations:
None
Request Body schema: application/x-www-form-urlencoded
required
grant_type
string

The grant type. Supported values:

  • authorization_code: The authorization code grant type.
  • password: The password grant type.
  • urn:ietf:params:oauth:grant-type:saml2-bearer: The saml2-bearer grant type.
  • urn:visier:params:oauth:grant-type:asid-token: The ASID token grant type.
client_id
string

The unique identifier of the pre-registered client application.
client_secret
string

The secret of the pre-registered client application.
redirect_uri
string

The optional URI to redirect to after authorization.
code
string

The authorization code. Applicable only for authorization code grant type.
username
string

The username of the user to authenticate. Applicable only for password grant type.
password
string

The password of the user to authenticate. Applicable only for password grant type.
asid_token
string

The ASID token. Applicable only for ASID token grant type.
assertion
string

The SAML assertion. Applicable only for saml2-bearer grant type.
refresh_token
string

The refresh token. Applicable only for refresh_token grant type.

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "id_token": "string",
  • "token_type": "string",
  • "expires_in": 0
}

Direct Data Intake

Use the Direct Data Intake API to load data directly into Visier objects. These objects can be delivered as part of Visier Blueprint, locally modified objects, or even completely custom objects. Objects must be released to production to receive data through the DDI API. You can load data into:

  • Subjects
  • Events
  • Parent-child dimensions
  • Multi-value properties

Retrieve the direct data intake configuration

Retrieve the direct data intake configuration.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to load data into. Currently, the only supported value is prod to update the production version.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "job": {
    }
}

Update the direct data intake configuration

Configure the data intake settings, such as the direct data intake job type. Only provide values for settings that you want to change.

Settings that aren't present in the request body are ignored and remain unchanged.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to load data into. Currently, the only supported value is prod to update the production version.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
object

The direct data intake job configuration.

Responses

Request samples

Content type
application/json
{
  • "job": {
    }
}

Response samples

Content type
application/json
{
  • "job": {
    }
}

Retrieve an object's data load schema

Retrieve the data load schema for an object. The load schema defines the required structure for uploading data files to the object.

Your data file must include column headers that match the schema exactly. Column names are case sensitive. Only columns with isMandatory set to true require values.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to load data into. Currently, the only supported value is prod to update the production version.
objectName
required
string

The name of the object to return the load schema for.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "schema": [
    ]
}

Retrieve open transactions

Retrieve all open transactions. Doesn't return committed or rolled back transactions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to retrieve open transactions from. Currently, the only supported value is prod to retrieve open transactions for the production version.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Start a transaction

Start a transaction to contain your data files. You can then upload files to objects in Visier.

After starting a transaction and uploading files, commit the transaction to process the files. You can also roll back the transaction to discard the files.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to load data into. Currently, the only supported value is prod to update the production version.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "transactionId": "string"
}

Retrieve transaction status

Retrieve the job status for a committed transaction.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to load data into. Currently, the only supported value is prod to update the production version.
transactionId
required
string

The unique identifier of the transaction.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "transactionId": "string",
  • "jobId": "string",
  • "status": "string",
  • "message": "string"
}

Commit a transaction

Process a transaction and its uploaded data files. This starts a processing job to load the files into Visier.

After committing a transaction, you can't upload more files to it. Monitor the job status using GET /v1/data/directloads/{draftId}/transactions/{transactionId}.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to load data into. Currently, the only supported value is prod to update the production version.
transactionId
required
string

The unique identifier of the transaction.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "status": "string",
  • "message": "string"
}

Roll back a transaction

Roll back a transaction. This deletes the transaction and discards all uploaded files.

After rolling back a transaction, you can't use it to upload data files.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to load data into. Currently, the only supported value is prod to update the production version.
transactionId
required
string

The unique identifier of the transaction.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "status": "string",
  • "message": "string"
}

Load sample data

Load sample data in an open transaction. Visier doesn't process data until you commit the transaction. Sample data is available for employee, employee_exit, employment_start, and organization_hierarchy.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to load data into. Currently, the only supported value is prod to update the production version.
transactionId
required
string

The unique identifier of the transaction.
objectName
required
string

The object name of the analytic object to load sample data into.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
sampleName
string

The name of the target object to load sample data. Sample data is available for:

  • employee: The Employee subject.
  • employee_exit: The Employee Exit event.
  • employment_start: The Employment Start event.
  • organization_hierarchy: The Organization Hierarchy dimension.

Responses

Request samples

Content type
application/json
{
  • "sampleName": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "status": "string",
  • "message": "string"
}

Upload files

Send upload files to a previously-created transaction. Each upload file is associated with a target object in Visier. The files are not processed in Visier until you commit the transaction.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
draftId
required
string

The unique identifier of the project to load data into. Currently, the only supported value is prod to update the production version.
transactionId
required
string

The unique identifier of the transaction to load data files into.
objectName
required
string

The name of the object to upload the data to.

If uploading data to a multi-value property (MVP), specify the property in {object}--{property} format; for example, Employee--Employee_Budgeted_Compensation.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: multipart/form-data
file
string <binary>

The file to upload.

Responses

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "status": "string",
  • "message": "string"
}

Data Intake

Send raw or untransformed data to Visier. After we receive the data, Visier runs business rules to transform your data into the expected format for the existing mappings.

Note: This API is in limited availability. If you are interested in using it, please contact your Customer Success Manager (CSM).

Retrieve sources

Retrieve target sources before transferring data. Sources store data and map it to the Visier data model.

Contact Visier Customer Success to set up new sources. Query this endpoint to list available sources, schemas, and required fields.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ]
}

Start a transfer session

Start a transfer session. Transfer sessions contain one or more record batches sent as JSON or file payloads.

For optimal performance, include all record batches in one transfer session.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "transferSessionId": "string"
}

Transfer data to sources via JSON

Transfer record batches to Visier. Provide data as a comma-separated array with headers in the first row. Include header rows in all subsequent requests.

Each request transfers a batch to one source. Transfer sessions support multiple batches before completion.

Use sequence numbers to track and identify delivery issues across batches.

Batch limits:

  • Batch size: 10 MB
  • Record count: 300,000 rows
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transferSessionId
required
string

The unique identifier of the transfer session.
queryParameters
sourceId
string

The unique identifier of the source to transfer data to.
sequence
integer <uint32>

The unique sequence number of a batch of records.
tenantCode
string

The code of the tenant to transfer data to. For example, WFF_j1r or WFF_j1r~c7o.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "transferSessionId": "string",
  • "sequence": 0,
  • "status": "string",
  • "message": "string",
  • "tenants": [
    ]
}

Cancel a transfer session

Cancel an active transfer session. Cancelled sessions don't persist data in Visier.

Start a new session and resend all data if you cancel a transfer.

Cancel sessions when:

  • A batch request fails.
  • Data records are incomplete.
  • Infrastructure errors occur.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transferSessionId
required
string

The unique identifier of the transfer session to cancel.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "transferSessionId": "string",
  • "dataTransferResultDetails": [
    ],
  • "status": "string"
}

Complete a transfer session

Complete a transfer session and start a receiving job. The receiving job validates data and adds it to the Visier data store.

Optionally trigger a processing job immediately after completion to generate a data version.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
transferSessionId
string

The unique identifier of the transfer session.
processingData
boolean

If true, a processing job triggers after the receiving job successfully completes to generate a new data version. Default is false.

Responses

Request samples

Content type
application/json
{
  • "transferSessionId": "string",
  • "processingData": true
}

Response samples

Content type
application/json
{
  • "dataReceivingJobId": "string",
  • "message": "string",
  • "transferSessionId": "string",
  • "dataTransferResultDetails": [
    ],
  • "status": "string"
}

Transfer data to sources via file upload

Upload data to Visier as CSV or ZIP files. Each request transfers a single file. If the data intended for Visier is stored in multiple files, you may compress them into a single ZIP file or make multiple requests within the same transfer session.

File size limit: 3 GB

Each file is identified by a sequence number. Sequence numbers help identify any batches that were delivered incorrectly.

If you define a specific source in the request, all files within the request will target the declared source. If a source is not defined, the filenames are matched against the source regex to correctly assign each file to a source. To find out the source regex, please contact Visier Customer Success.

Note: If you include files that should target multiple sources in one ZIP file, do not define a source in the request.

Analytic tenants: For optimal transfer speed, provide one ZIP file per source. Administrating tenants: For optimal transfer speed, provide one ZIP file containing all the required data files for your analytic tenants. In the ZIP file, use one folder per analytic tenant. The ZIP file must adhere to the following file structure:

File1.zip

  • Folder1: WFF_tenantCode1
    • Filename1.csv
    • Filename2.csv
  • Folder2: WFF_tenantCode2
    • Filename3.csv
    • Filename4.csv
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transferSessionId
required
string

The transfer session ID returned after the data transfer session starts.
queryParameters
sourceId
string

The unique identifier associated with the source you want to transfer data to.
sequence
string

The unique sequence number associated with a batch of records.
tenantCode
string

The code of the tenant you want to transfer data to. For example, WFF_j1r or WFF_j1r~c7o.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: multipart/form-data
required
file
string <binary>

The file to upload in CSV or ZIP format.

Responses

Response samples

Content type
application/json
{
  • "transferSessionId": "string",
  • "sequence": 0,
  • "status": "string",
  • "message": "string",
  • "tenants": [
    ]
}

Data and Job Handling

Initiate and manage jobs, included or excluded data, and data connector credentials. Administrating tenant users can manage jobs and data for their analytic tenants.

Retrieve data connector credentials

Retrieve data connector credentials for a tenant. Connector credentials allow Visier to fetch data from source systems.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant code of a specific analytic tenant to retrieve for.
limit
integer <int32>

The maximum number of items to return. Default is 100.
start
integer <int32>

The starting index of the first result to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "connectorCredentials": [
    ],
  • "limit": 0,
  • "start": 0
}

Create a connector credential

Create credentials for a data connector. Connector credentials allow Visier to retrieve data from your source systems through an integration user in the source system.

Specify one provider in dataProviderAuthParams. Example UKG request body:

{
  model={"dataProviderAuthParams": {"provider": "UKG","ultimateAuthParams": {"hostDomainName": "exampleHostDomain","apiKey": "apiKey1234","username": "username1234","password": "password1234","userAccessKey": "accessKey1234"}},"dataProviderBasicInformation": {"displayName": "exampleDisplayName","description": "exampleDescription"}}}
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant code of a specific analytic tenant to create the credential for.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
object

The authentication information for the credential.
object

The display name and description for the credential.
object (designer.DataProviderBasicMetadataDTO)

Responses

Request samples

Content type
application/json
{
  • "dataProviderAuthParams": {
    },
  • "dataProviderBasicInformation": {
    },
  • "dataProviderMetadata": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "symbolName": "string",
  • "objectName": "string",
  • "missingConnectionProperties": [
    ]
}

Retrieve data connectors

Retrieve data connectors for a tenant. Data connectors connect and extract the raw data directly from your source systems, subsequently transforming and processing it within the Visier platform. Data connectors are an alternative to generating flat files and transferring them to Visier via SFTP.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant code of a specific analytic tenant to retrieve for.
limit
integer <int32>

The maximum number of items to return. Default is 100.
start
integer <int32>

The starting index of the first result to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "dataConnectors": [
    ],
  • "limit": 0,
  • "start": 0
}

Assign connector credentials

Assign a connector credential to a data connector.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (data_in.Connector)

The data connectors to be assigned with credentials.

Responses

Request samples

Content type
application/json
{
  • "connectors": [
    ]
}

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Retrieve data connector settings

Retrieve settings for all production data connectors in the tenant. The response returns a list of settings, if available, for each data connector in the tenant.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "connectors": [
    ]
}

Update data connector settings

Configure settings for data connectors. To retrieve the available settings, see GET /v1/op/data-connectors/connector-settings.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (admin.SetConnectorSettingRequestDTO)

The settings to define for each data connector and tenant.

Responses

Request samples

Content type
application/json
{
  • "connectors": [
    ]
}

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Retrieve the latest enabled data versions

Retrieve up to five of the latest enabled data versions for all analytic tenants or a single tenant. Use this endpoint to locate data versions that cause validation inconsistencies.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant code of a specific analytic tenant to retrieve data versions for. Use this if you're only interested in the results for one analytic tenant.
limit
integer <int32>

The maximum number of analytic tenants to return. Default is 100.
start
integer <int32>

The starting index of the first result to return. Default is 0.
numberOfVersions
integer <int32>

The number of latest enabled data versions to retrieve. Maximum is 5.
dataCategory
string

The object name of the data category. Default is the primary data category. For administrating tenants, the data category must exist in the requesting tenant; that is, the administrating tenant or the tenant specified in TargetTenantID.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "limit": 0,
  • "start": 0
}

Disable data versions

Disable the latest enabled data versions for specific analytic tenants or disable a specific data version per tenant.

Note: Disabling an older data version might not affect solution state.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
object

A form body key that contains a collection of key-value pairs.

Responses

Request samples

Content type
application/json
{
  • "model": {
    }
}

Response samples

Content type
application/json
{
  • "totalFailures": 0,
  • "totalSuccess": 0,
  • "results": [
    ]
}

Retrieve data categories

Retrieve all available data categories.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Trigger data connector extraction jobs

Start data connector extraction jobs for the administrating tenant or selected analytic tenants.

This endpoint creates a dispatching job that generates one extraction job per tenant. Use the returned dispatching job ID to track extraction job statuses using GET /v1/op/jobs/dispatching-jobs/{jobId}/extraction-jobs.

Extraction jobs generate receiving jobs to validate data and processing jobs to load data. Monitor job statuses using GET /v1/op/jobs/dispatching-jobs/{jobId}/receiving-jobs or GET /v1/op/jobs/dispatching-jobs/{jobId}/processing-jobs.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
tenants
Array of strings

The analytic tenants to dispatch extraction jobs for. Dispatches one extraction job per tenant. If omitted, the request uses the tenant of the requesting user.
allTenants
boolean

If true, one extraction job is dispatched for each accessible analytic tenant. Only valid for requests from an administrating tenant.
overrideLastExtractionTimestamp
string

An epoch timestamp in milliseconds from which to retrieve data. This overrides the last extraction date to retrieve more data.
publishDataLoadArtifacts
boolean

If true, the generated data load artifacts are published to production immediately.
runProcessingJob
boolean

If true, a processing job is spawned after a dispatched extraction job runs successfully.
dataCategoryId
string

The unique identifier of the data category on which to trigger the extraction job. Default is the tenant's primary data category.
disableArtifactGeneration
boolean

If true, the job does not generate data load artifacts. Default is false.
connectorIds
Array of strings

The unique identifiers of the connectors to run extraction jobs.
lastExtractionTimeOffsetWeeks
integer <int32>

The number of weeks in the past to retrieve data. This overrides the last extraction date to retrieve more data.
monthsToExtract
integer <int32>

The number of months to retrieve snapshot data.
extractToTimeOverride
string

An epoch timestamp in milliseconds for the end time up to which to retrieve data.
batchSizeOverride
integer <int32>

The maximum number of subjects the job can retrieve in each batch.
sqlBatchSize
integer <int32>

The maximum number of SQL table records the job can retrieve in each batch.
forceUpdateExistingArtifacts
boolean

If true and disableArtifactGeneration is false, updates extractor artifacts, which may overwrite the artifacts' manual overrides. Ignored if disableArtifactGeneration is true.
excludedTenants
Array of strings

The unique identifiers of the tenants to exclude from the extraction job. Only valid if allTenants is true. Only valid for requests from an administrating tenant.
spillDebugInfoPartitionsDTO
string <enum>
Enum: "spillNone" "spillStagesAndRecords" "spillAll"

The partitioning of debugging info to be generated, if any. Valid values:

  • spillNone: No debugging info is generated.
  • spillStagesAndRecords: Debugging info is generated for stages and records.
  • spillAll: Debugging info is generated for all partitions.
spillDebugInfoDetailLevelDTO
string <enum>
Enum: "fileAndLine" "mappingName"

The detail level of the debugging info to be generated. Valid values:

  • fileAndLine: Debugging info is generated for file and line.
  • mappingName: Debugging info is generated for mapping name.
lastExtractionTimeOffsetMonths
integer <int32>

The number of months to offset the last extraction time. This overrides the last extraction date backward to retrieve more data.
lastExtractionTimeOffsetMode
string

The mode used to offset the last extraction time. Valid values: "WEEK", "MONTH". Default is "MONTH".
offsetWeekOption
string

The week options used to offset the last extraction time. Valid values: "CURRENT_DAY_OF_WEEK", "FIRST_OF_WEEK", "LAST_OF_WEEK". Default is "CURRENT_DAY_OF_WEEK".
offsetMonthOption
string

The month options used to offset the last extraction time. Valid values: "CURRENT_DAY_OF_MONTH", "FIRST_OF_MONTH", "LAST_OF_MONTH". Default is "CURRENT_DAY_OF_MONTH".
credentialId
string

If running a job for the Databricks connector, specify the unique identifier of the connector credentials to use.
outputTarget
string

The output of the extraction. Default is Receiving. Valid values:

  • Receiving: A receiving job.
  • SQL: A SQL job for table sources.

Responses

Request samples

Content type
application/json
{
  • "tenants": [
    ],
  • "allTenants": true,
  • "overrideLastExtractionTimestamp": "string",
  • "publishDataLoadArtifacts": true,
  • "runProcessingJob": true,
  • "dataCategoryId": "string",
  • "disableArtifactGeneration": true,
  • "connectorIds": [
    ],
  • "lastExtractionTimeOffsetWeeks": 0,
  • "monthsToExtract": 0,
  • "extractToTimeOverride": "string",
  • "batchSizeOverride": 0,
  • "sqlBatchSize": 0,
  • "forceUpdateExistingArtifacts": true,
  • "excludedTenants": [
    ],
  • "spillDebugInfoPartitionsDTO": "spillNone",
  • "spillDebugInfoDetailLevelDTO": "fileAndLine",
  • "lastExtractionTimeOffsetMonths": 0,
  • "lastExtractionTimeOffsetMode": "string",
  • "offsetWeekOption": "string",
  • "offsetMonthOption": "string",
  • "credentialId": "string",
  • "outputTarget": "string"
}

Response samples

Content type
application/json
{
  • "JobId": "string"
}

Start the data load for analytic tenants

Start the data load process for analytic tenants included in uploaded SFTP files. Returns a receiving job ID.

Use the job ID to track the receiving job and spawned processing job statuses.

Prerequisite: Use a PGP public key to upload encrypted, compressed data files (.zip.gpg) to the Visier SFTP server.

Generate PGP keys using the PGP Keys API or in Visier under Settings > Manage PGP Keys.

Note:

  • View data load status details in the Jobs room in a project.
  • Limit uncompressed batch file sizes to 5 GB and 5000 tenants per batch.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
object

A form body key that contains a collection of key-value pairs.

Responses

Request samples

Content type
application/json
{
  • "model": {
    }
}

Response samples

Content type
application/json
{
  • "jobId": "string"
}

Retrieve data uploads

Retrieve data uploads and their inclusion status for managed tenants, a single tenant, or a receiving job.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
uploadJobId
string

The unique identifier of the upload job. Use this if you are interested in the data uploads for a specific upload job.
tenantCode
integer <int32>

The tenant code of a specific analytic tenant to retrieve the data uploads for.
limit
integer <int32>

The maximum number of analytic tenants to retrieve data uploads for. Not used if tenantCode is specified. Default is 1000.
start
integer <int32>

The starting index of the first result to return. Default is 0.
numberOfDataUploads
integer <int32>

The maximum number of latest enabled data uploads to retrieve for each analytic tenant. Default is 1. Maximum is 5.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "limit": 0,
  • "start": 0
}

Exclude data uploads

Exclude specified data uploads or all data uploads for analytic tenants.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (data_in.UploadToExclude)

The data uploads to exclude for a particular analytic tenant.

Responses

Request samples

Content type
application/json
{
  • "uploads": [
    ]
}

Response samples

Content type
application/json
{
  • "totalFailures": 0,
  • "totalSuccess": 0,
  • "uploads": [
    ]
}

Include data uploads

Include specified data uploads or all data uploads for analytic tenants.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (data_in.UploadToInclude)

The data uploads to include for a particular analytic tenant.

Responses

Request samples

Content type
application/json
{
  • "uploads": [
    ]
}

Response samples

Content type
application/json
{
  • "totalFailures": 0,
  • "totalSuccess": 0,
  • "uploads": [
    ]
}

Retrieve all job statuses

Retrieve the statuses for all jobs.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
startTime
string

The start time from which to retrieve job statuses.
endTime
string

The end time from which to retrieve job statuses.
status
string

The specific status to restrict the list of jobs to.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "queryStartTime": "string",
  • "queryEndTime": "string",
  • "jobStatus": [
    ]
}

Cancel jobs

Cancel processing, receiving, and extraction jobs.

Note: You can't cancel receiving jobs with Running status.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
jobIds
Array of strings

A list of jobs to cancel. Maximum is 500.

Responses

Request samples

Content type
application/json
{
  • "jobIds": [
    ]
}

Response samples

Content type
application/json
{
  • "jobCancellationResults": [
    ]
}

Retrieve a dispatching job's status

Retrieve a dispatching job's status, including the job ID and generated jobs count.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
jobId
required
string

The unique identifier of the job to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "jobId": "string",
  • "tenantCode": "string",
  • "status": "string",
  • "totalJobsDispatched": 0
}

Retrieve extraction job statuses by dispatching job ID

Retrieve extraction job statuses associated with a parent dispatching job.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
jobId
required
string

The unique identifier of the dispatching job to retrieve.
queryParameters
dispatchingJobId
string

The unique identifier of the dispatching job that generated the extraction jobs.
tenantCode
string

The tenant code of a specific analytic tenant to retrieve the extraction job status for. Use this if you're only interested in the results for one analytic tenant.
limit
integer <int32>

The maximum number of extraction job statuses to return. Default is 100.
start
integer <int32>

The starting index of the first result to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "parentJobId": "string",
  • "parentTenantCode": "string",
  • "limit": 0,
  • "start": 0,
  • "extractionJobs": [
    ]
}

Retrieve processing job statuses by dispatching job ID

Retrieve processing job statuses associated with a parent dispatching job.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
jobId
required
string

The unique identifier of the dispatching job to retrieve.
queryParameters
dispatchingJobId
string

The unique identifier of the dispatching job that generated the extraction jobs.
tenantCode
string

The tenant code of a specific analytic tenant to retrieve the extraction job status for. Use this if you're only interested in the results for one analytic tenant.
limit
integer <int32>

The maximum number of extraction job statuses to return. Default is 100.
start
integer <int32>

The starting index of the first result to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "parentJobId": "string",
  • "parentTenantCode": "string",
  • "limit": 0,
  • "start": 0,
  • "processingJobs": [
    ]
}

Retrieve receiving job statuses by dispatching job ID

Retrieve receiving job statuses associated with a parent dispatching job.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
jobId
required
string

The unique identifier of the dispatching job to retrieve.
queryParameters
dispatchingJobId
string

The unique identifier of the dispatching job that generated the extraction jobs.
tenantCode
string

The tenant code of a specific analytic tenant to retrieve the extraction job status for. Use this if you're only interested in the results for one analytic tenant.
limit
integer <int32>

The maximum number of extraction job statuses to return. Default is 100.
start
integer <int32>

The starting index of the first result to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "parentJobId": "string",
  • "parentTenantCode": "string",
  • "limit": 0,
  • "start": 0,
  • "receivingJobs": [
    ]
}

Retrieve processing job statuses by receiving job ID

Retrieve processing job statuses associated with a receiving job ID.

Processing jobs run data loads for individual analytic tenants. They are triggered manually or spawned from receiving jobs. When spawned from a receiving job, a parent ID associates the receiving job with the processing job.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
receivingJobId
required
string

The unique identifier of the receiving job.
queryParameters
tenantCode
string

The tenant code of the tenant to retrieve the processing jobs for. Use this if you're only interested in the results for one analytic tenant.
limit
integer <int32>

The maximum number of processing jobs to return per page. Default is 100.
start
integer <int32>

The starting index of the first result to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "parentJobId": "string",
  • "parentTenantCode": "string",
  • "limit": 0,
  • "start": 0,
  • "processingJobs": [
    ]
}

Retrieve a receiving job's status

Retrieve a receiving job's status after sending data to Visier. Receiving jobs validate and store transferred data. A successful response indicates that the receiving job was successful.

Set jobs to true to return status details for spawned processing jobs.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
receivingJobId
required
string

The job ID provided after sending data to Visier.
queryParameters
jobs
boolean

If true, returns the status of receiving jobs spawned by the receiving job specified by jobId.
tenantCode
string

The tenant code of the tenant to retrieve the receiving jobs for. Use this if you're only interested in the results for one analytic tenant.
start
integer <int32>

The starting index of the first result to return. Default is 0.
limit
integer <int32>

The maximum number of job statuses to return per page. Default is 100.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "jobId": "string",
  • "status": "string",
  • "parentJobId": "string",
  • "parentTenantCode": "string",
  • "receivingJobs": [
    ]
}

Retrieve a receiving job's files

Retrieve the files sent to Visier by a receiving job. You must know the ID of the receiving job to retrieve its files. To retrieve receiving job IDs, see GET /v1/op/job-status/jobs.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
jobId
required
string

The unique identifier of the receiving job.
queryParameters
fileNameRegex
string

The regular expression to match the file names of the files to retrieve. The regex must be URL-encoded; for example, the regular expression Employee[0-9]+\.csv becomes fileNameRegex=Employee%5B0-9%5D%2B%5C.csv.
limit
integer <int32>

The maximum number of files to return across tenants. Default is 500. Maximum is 1000.
start
integer <int32>

The starting index of the first file to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "receivingJobId": "string",
  • "tenants": [
    ]
}

Retrieve analytic tenant source files

Retrieve uploaded files for your tenants' sources. The default is to return files for all analytic tenants. Use TargetTenantID to retrieve files for one tenant. Optionally filter files using a filename regex. The response returns details of each source's files, including upload time, filename, and whether the file is included during data version generation.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
fileNameRegex
string

The regular expression to match the file names of the source files to retrieve. The regex must be URL-encoded; for example, the regular expression Employee[0-9]+\.csv becomes fileNameRegex=Employee%5B0-9%5D%2B%5C.csv.
limit
integer <int32>

The maximum number of source files to return. Default is 500. Maximum is 1000.
start
integer <int32>

The starting index of the first source file to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "sourceFiles": [
    ]
}

Run a consolidated analytics job

Run a job for a consolidated analytics tenant to retrieve source tenant data.

Set runProcessingJob to true in the request body to generate a data version for the consolidated analytics tenant.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
tenantCode
string

The tenant code of the consolidated analytics tenant; for example, WFF_j1r~CAa7s.
runProcessingJob
boolean

If true, runs a processing job after the consolidated analytics job completes. Default is false.

Responses

Request samples

Content type
application/json
{
  • "tenantCode": "string",
  • "runProcessingJob": true
}

Response samples

Content type
application/json
{
  • "jobId": "string"
}

Run a data connector extraction job

Run an extraction job using a Visier data connector to generate a new data version. Administrating tenants can run extraction jobs for all analytic tenants, selected tenants, or the administrating tenant.

Running extraction jobs for multiple tenants starts a dispatching job that generates one extraction job per tenant. Returns the extraction job ID or dispatching job ID.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
tenants
Array of strings

The analytic tenants to dispatch extraction jobs for. Dispatches one extraction job per tenant. If omitted, the request uses the tenant of the requesting user.
allTenants
boolean

If true, one extraction job is dispatched for each accessible analytic tenant. Only valid for requests from an administrating tenant.
overrideLastExtractionTimestamp
string

An epoch timestamp in milliseconds from which to retrieve data. This overrides the last extraction date to retrieve more data.
publishDataLoadArtifacts
boolean

If true, the generated data load artifacts are published to production immediately.
runProcessingJob
boolean

If true, a processing job is spawned after a dispatched extraction job runs successfully.
dataCategoryId
string

The unique identifier of the data category on which to trigger the extraction job. Default is the tenant's primary data category.
disableArtifactGeneration
boolean

If true, the job does not generate data load artifacts. Default is false.
connectorIds
Array of strings

The unique identifiers of the connectors to run extraction jobs.
lastExtractionTimeOffsetWeeks
integer <int32>

The number of weeks in the past to retrieve data. This overrides the last extraction date to retrieve more data.
monthsToExtract
integer <int32>

The number of months to retrieve snapshot data.
extractToTimeOverride
string

An epoch timestamp in milliseconds for the end time up to which to retrieve data.
batchSizeOverride
integer <int32>

The maximum number of subjects the job can retrieve in each batch.
sqlBatchSize
integer <int32>

The maximum number of SQL table records the job can retrieve in each batch.
forceUpdateExistingArtifacts
boolean

If true and disableArtifactGeneration is false, updates extractor artifacts, which may overwrite the artifacts' manual overrides. Ignored if disableArtifactGeneration is true.
excludedTenants
Array of strings

The unique identifiers of the tenants to exclude from the extraction job. Only valid if allTenants is true. Only valid for requests from an administrating tenant.
spillDebugInfoPartitionsDTO
string <enum>
Enum: "spillNone" "spillStagesAndRecords" "spillAll"

The partitioning of debugging info to be generated, if any. Valid values:

  • spillNone: No debugging info is generated.
  • spillStagesAndRecords: Debugging info is generated for stages and records.
  • spillAll: Debugging info is generated for all partitions.
spillDebugInfoDetailLevelDTO
string <enum>
Enum: "fileAndLine" "mappingName"

The detail level of the debugging info to be generated. Valid values:

  • fileAndLine: Debugging info is generated for file and line.
  • mappingName: Debugging info is generated for mapping name.
lastExtractionTimeOffsetMonths
integer <int32>

The number of months to offset the last extraction time. This overrides the last extraction date backward to retrieve more data.
lastExtractionTimeOffsetMode
string

The mode used to offset the last extraction time. Valid values: "WEEK", "MONTH". Default is "MONTH".
offsetWeekOption
string

The week options used to offset the last extraction time. Valid values: "CURRENT_DAY_OF_WEEK", "FIRST_OF_WEEK", "LAST_OF_WEEK". Default is "CURRENT_DAY_OF_WEEK".
offsetMonthOption
string

The month options used to offset the last extraction time. Valid values: "CURRENT_DAY_OF_MONTH", "FIRST_OF_MONTH", "LAST_OF_MONTH". Default is "CURRENT_DAY_OF_MONTH".
credentialId
string

If running a job for the Databricks connector, specify the unique identifier of the connector credentials to use.
outputTarget
string

The output of the extraction. Default is Receiving. Valid values:

  • Receiving: A receiving job.
  • SQL: A SQL job for table sources.

Responses

Request samples

Content type
application/json
{
  • "tenants": [
    ],
  • "allTenants": true,
  • "overrideLastExtractionTimestamp": "string",
  • "publishDataLoadArtifacts": true,
  • "runProcessingJob": true,
  • "dataCategoryId": "string",
  • "disableArtifactGeneration": true,
  • "connectorIds": [
    ],
  • "lastExtractionTimeOffsetWeeks": 0,
  • "monthsToExtract": 0,
  • "extractToTimeOverride": "string",
  • "batchSizeOverride": 0,
  • "sqlBatchSize": 0,
  • "forceUpdateExistingArtifacts": true,
  • "excludedTenants": [
    ],
  • "spillDebugInfoPartitionsDTO": "spillNone",
  • "spillDebugInfoDetailLevelDTO": "fileAndLine",
  • "lastExtractionTimeOffsetMonths": 0,
  • "lastExtractionTimeOffsetMode": "string",
  • "offsetWeekOption": "string",
  • "offsetMonthOption": "string",
  • "credentialId": "string",
  • "outputTarget": "string"
}

Response samples

Content type
application/json
{
  • "jobId": "string"
}

Run a processing job

Run a processing job to generate a new data version. Administrating tenants can run jobs for all analytic tenants, selected tenants, or the administrating tenant.

Running jobs for multiple tenants starts a dispatching job that generates one processing job per tenant. Returns the processing job ID or dispatching job ID.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
tenants
Array of strings

The analytic tenants to run processing jobs for. If omitted, the request uses the tenant of the requesting user.
allTenants
boolean

If true, runs processing jobs for all accessible analytic tenants. Default is false. Only valid for requests from an administrating tenant.
dataCategoryId
string

The unique identifier of the data category to run the job. If omitted, runs a job using the primary data category. To retrieve a list of all data categories, see GET /v1/op/data/categories.
publishToProduction
boolean

If true, publishes the generated data version to production. Default is false.
excludedTenants
Array of strings

The unique identifiers of the tenants to exclude from the extraction job. Only valid if allTenants is true.

Responses

Request samples

Content type
application/json
{
  • "tenants": [
    ],
  • "allTenants": true,
  • "dataCategoryId": "string",
  • "publishToProduction": true,
  • "excludedTenants": [
    ]
}

Response samples

Content type
application/json
{
  • "jobId": "string"
}

Delete a connector credential

Use this endpoint to delete connector credentials from your tenants. Credentials that are no longer valid should be deleted.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The credentialId of the credential you want to delete.
queryParameters
tenantCode
string

The tenant code of the analytic tenant in which the credential you're deleting.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
"string"

Retrieve a job's status

Use this endpoint to retrieve the list of statuses for a specific job with ID jobId.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
jobId
required
string

The unique identifier of the job to retrieve the status for.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PGP Keys

The Pretty Good Privacy (PGP) Keys API generates key pairs and provides a public key to encrypt data that you send to Visier. PGP encryption adds an additional layer of security against data disclosure.

After you generate a key pair and retrieve the public encryption key, you can encrypt your data files before sending them to Visier. When Visier receives files encrypted with the public key, we retrieve the associated private key to decrypt and process the file.

Retrieve PGP public keys

Retrieve all PGP public keys in your tenant.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Download a public encryption key

Generate a PGP key pair and retrieve the public encryption key.

Set key expiration in UTC using ISO 8601 format in the request body. Expiration must be between 2 and 10 years. Default is 2 years.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
expirationDate
string

The UTC expiration date of the key in ISO 8601 format. Must be between 2 and 10 years. Default is 2 years.

Responses

Request samples

Content type
application/json
{
  • "expirationDate": "string"
}

Response samples

Content type
application/json
{
  • "keyID": "string",
  • "dateGenerated": "string",
  • "expiryDate": "string",
  • "recipient": "string",
  • "publicKey": "string"
}

Retrieve a PGP public key

Retrieve a PGP public key using its key ID. You must know the ID of a key to retrieve its details. To retrieve key IDs, see GET /v1/api/pgp-keys.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
keyID
required
string

The unique identifier of the generated key pair in 16-letter hexadecimal format, including leading zeros.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "keyID": "string",
  • "dateGenerated": "string",
  • "expiryDate": "string",
  • "recipient": "string",
  • "publicKey": "string"
}

Delete a PGP key pair

Delete a PGP key pair using its key ID.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
keyID
required
string

The unique identifier of the generated key pair in 16-letter hexadecimal format, including leading zeros.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "keyID": "string"
}

Data Upload

Send data files to Visier. After we receive the data, Visier starts a receiving job and a processing job to process the data.

Upload a data file to Visier

Use this endpoint to upload data files to Visier. You can upload ZIP, CSV, XLS, and XLSX filetypes in plaintext or encrypted with Visier's PGP key.

Use of this endpoint requires client redirect. This endpoint redirects requests directly to Visier's upload infrastructure to support long-running uploads. To ensure efficient uploading, we recommend that you use an HTTP client that supports the 100 Continue status code.

The maximum file upload size is 500 MB. We recommend using SFTP for larger file sizes.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
filename
required
string

The filename of the data file to upload, including the file extension such as .zip or .csv.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: */*
string <binary>

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Table Source

Use row-based management for your source data in Visier. The Table Source API supports direct SQL-based data modifications, eliminating concerns about file management or override behavior. Use the API to create, modify, and delete tables. Use SQL statements to query, insert, update, delete, and merge data into tables with transactions. You can reference the tables by mappings, just like other sources, to load data into an analytic object in a data version.

Note: 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.

Retrieve table sources

Retrieve table source configurations. Table sources are SQL-accessible tables that store data in Visier.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
limit
integer <int32>

The maximum number of table sources to return. Default is 100.
start
integer <int32>

The starting index of the first result to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "tables": [
    ]
}

Create a table source

Create a table source configuration to define table structure and metadata.

Assign a unique object name. Don't set a UUID because Visier generates UUIDs for new objects.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
uuid
string

The unique identifier for the table. This UUID is generated automatically when the table is created and cannot be changed. Do not provide a value when creating a new table.
objectName
string

The object name for the table. This determines the name of the table accessible from SQL.
object

Fields that identify and describe the table, such as its display name, description, and explanation.
Array of objects (servicing.sqlsource.SqlSourceColumnDTO)

The columns contained within the table.
canChildrenInherit
boolean

If true, analytic tenants inherit the table definition. To also inherit the table data, set canChildrenInheritData to true. Default is false.
canChildrenInheritData
boolean

If true, analytic tenants inherit the table data. Analytic tenants can read the data but cannot write to it. Default is false.
excludeFromAutoProcessing
boolean

If true, Visier ignores this source when checking which data categories require a processing job during a process action with no specified dataCategoryIds. Default is false.
snapshotRetentionDays
integer <int32>

The number of days to keep snapshots for this table before permanently deleting them. Must be between 1 and 180 days. Default is 7 days. You cannot reset the table to a timestamp older than the retention period because older snapshots are permanently deleted.
object

The configuration options for a materialized view. Omit or set enabled=false for non-materialized view tables.
filterInheritedDataByTenant
boolean

If true, analytic tenants only see data from inherited table data for rows where TENANT_ID or CUSTOMER_ID matches their own tenant code. Requires canChildrenInheritData=true.

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "objectName": "string",
  • "basicInformation": {
    },
  • "columns": [
    ],
  • "canChildrenInherit": true,
  • "canChildrenInheritData": true,
  • "excludeFromAutoProcessing": true,
  • "snapshotRetentionDays": 0,
  • "materializedView": {
    },
  • "filterInheritedDataByTenant": true
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "objectName": "string",
  • "basicInformation": {
    },
  • "columns": [
    ],
  • "canChildrenInherit": true,
  • "canChildrenInheritData": true,
  • "excludeFromAutoProcessing": true,
  • "snapshotRetentionDays": 0,
  • "materializedView": {
    },
  • "filterInheritedDataByTenant": true
}

Retrieve a table source

Retrieve a table source configuration by unique identifier. To retrieve table source UUIDs, see GET /v1alpha/data/table-sources/tables.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tableId
required
string

The unique identifier of the table source.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "objectName": "string",
  • "basicInformation": {
    },
  • "columns": [
    ],
  • "canChildrenInherit": true,
  • "canChildrenInheritData": true,
  • "excludeFromAutoProcessing": true,
  • "snapshotRetentionDays": 0,
  • "materializedView": {
    },
  • "filterInheritedDataByTenant": true
}

Update a table source

Update a table source configuration to modify its structure, columns, or metadata.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed from the table source.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tableId
required
string

The unique identifier of the table source to update.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
uuid
string

The unique identifier for the table. This UUID is generated automatically when the table is created and cannot be changed. Do not provide a value when creating a new table.
objectName
string

The object name for the table. This determines the name of the table accessible from SQL.
object

Fields that identify and describe the table, such as its display name, description, and explanation.
Array of objects (servicing.sqlsource.SqlSourceColumnDTO)

The columns contained within the table.
canChildrenInherit
boolean

If true, analytic tenants inherit the table definition. To also inherit the table data, set canChildrenInheritData to true. Default is false.
canChildrenInheritData
boolean

If true, analytic tenants inherit the table data. Analytic tenants can read the data but cannot write to it. Default is false.
excludeFromAutoProcessing
boolean

If true, Visier ignores this source when checking which data categories require a processing job during a process action with no specified dataCategoryIds. Default is false.
snapshotRetentionDays
integer <int32>

The number of days to keep snapshots for this table before permanently deleting them. Must be between 1 and 180 days. Default is 7 days. You cannot reset the table to a timestamp older than the retention period because older snapshots are permanently deleted.
object

The configuration options for a materialized view. Omit or set enabled=false for non-materialized view tables.
filterInheritedDataByTenant
boolean

If true, analytic tenants only see data from inherited table data for rows where TENANT_ID or CUSTOMER_ID matches their own tenant code. Requires canChildrenInheritData=true.

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "objectName": "string",
  • "basicInformation": {
    },
  • "columns": [
    ],
  • "canChildrenInherit": true,
  • "canChildrenInheritData": true,
  • "excludeFromAutoProcessing": true,
  • "snapshotRetentionDays": 0,
  • "materializedView": {
    },
  • "filterInheritedDataByTenant": true
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "objectName": "string",
  • "basicInformation": {
    },
  • "columns": [
    ],
  • "canChildrenInherit": true,
  • "canChildrenInheritData": true,
  • "excludeFromAutoProcessing": true,
  • "snapshotRetentionDays": 0,
  • "materializedView": {
    },
  • "filterInheritedDataByTenant": true
}

Delete a table source

Delete a table source configuration. This deletes table definitions but preserves stored data.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tableId
required
string

The unique identifier of the table source.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Retrieve table source metadata

Retrieve stored metadata for a table source, such as the key-value pairs to apply to the table if you commit the transaction. Store metadata using setMetadata in POST /v1alpha/data/table-sources/transactions/{transactionId}/jobs.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tableId
required
string

The unique identifier of the table source for which to retrieve metadata.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "tableId": "string",
  • "transactionId": "string",
  • "metadata": {
    },
  • "recordCount": "string",
  • "recordsUpdatedAt": "string",
  • "dataFilesSizeBytes": "string"
}

Regenerate a materialized view

Run a SQL job to manually refresh the dataset during troubleshooting, query updates, or when manual data fetching is required.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tableId
required
string

The unique identifier of the table source.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
tableId
string

The unique identifier of the table source.

Responses

Request samples

Content type
application/json
{
  • "tableId": "string"
}

Response samples

Content type
application/json
{
  • "jobId": "string",
  • "tableAccess": {
    },
  • "transactionId": "string"
}

Start a transaction

Start a transaction for SQL operations. Transactions isolate operations and support rollback capabilities.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
expireAfterSeconds
integer <int32>

The number of seconds that the transaction is open before rolling back and the number of seconds that query results are available.
tablesToModify
Array of strings

The tables to modify in the transaction. If unspecified, the transaction is read-only. You cannot add tables to modify after creating the transaction.

After a job starts running, the tables are locked for the duration of the transaction to prevent concurrent writes. Each tenant has independent locks; there is no cross-tenant locking.

Responses

Request samples

Content type
application/json
{
  • "expireAfterSeconds": 0,
  • "tablesToModify": [
    ]
}

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "status": "UNSPECIFIED",
  • "createdAt": "string",
  • "createdBy": "string",
  • "expireAt": "string",
  • "startedAt": "string",
  • "closedAt": "string",
  • "tablesToModify": [
    ],
  • "children": [
    ],
  • "summary": {
    }
}

Retrieve transaction status

Retrieve a transaction's status and details. Dispatched transactions return each analytic tenant's transaction status details in children.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transactionId
required
string

The unique identifier of the transaction.
queryParameters
summaryOnly
boolean

If true, the response omits the children array and returns only the summary counts. Use for polling. Default is false.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "status": "UNSPECIFIED",
  • "createdAt": "string",
  • "createdBy": "string",
  • "expireAt": "string",
  • "startedAt": "string",
  • "closedAt": "string",
  • "tablesToModify": [
    ],
  • "children": [
    ],
  • "summary": {
    }
}

Extend transaction expiry

Extend an open transaction's expiry time.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transactionId
required
string

The unique identifier of the transaction to extend.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
expireAfterSeconds
integer <int32>

The number of seconds that the transaction is open before rolling back and the number of seconds that query results are available.

Responses

Request samples

Content type
application/json
{
  • "expireAfterSeconds": 0
}

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "status": "UNSPECIFIED",
  • "createdAt": "string",
  • "createdBy": "string",
  • "expireAt": "string",
  • "startedAt": "string",
  • "closedAt": "string",
  • "tablesToModify": [
    ],
  • "children": [
    ],
  • "summary": {
    }
}

Upload an input file to a transaction

Upload input files to a transaction. SQL jobs query input files as temporary local views. For example, the input file can contain data to insert into your sources, IDs to match against to change or delete rows, or any other input for your SQL query.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transactionId
required
string

The unique identifier of the transaction.
filename
required
string

The name of the file to upload. The input will be accessible with this filename during job execution.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: multipart/form-data
file
string <binary>

The input file to upload. The file is accessible during SQL job execution as a temporary view using the provided filename.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Run a SQL job within a transaction

Execute a SQL job within a transaction. Jobs execute SQL operations including queries, inserts, updates, deletes, and merge operations.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transactionId
required
string

The unique identifier of the transaction.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (servicing.sqlsource.SqlSourceActionDTO)

The actions to execute within the job, in order.
tenants
Array of strings

The tenants to schedule the job for. If this field isn't specified and a distribution mode is set, the job dispatches to the tenants detected from the input data. If this field isn't specified and no distribution mode is set, the job runs for the current tenant only.
Array of objects (servicing.sqlsource.SqlSourceInputDTO)

The input files to make available to the job.
keepTransactionOpenOnError
boolean

If true, keep the transaction open if an error occurs while executing the job. The default is to rollback the transaction.
Array of objects (servicing.sqlsource.SqlSourceJobPreconditionDTO)

The precondition requirements to execute the job. If any precondition isn't met, the job fails with an error. To set metadata to use for preconditions, use the setMetadata action in POST /v1alpha/data/table-sources/transactions/{transactionId}/jobs.

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ],
  • "tenants": [
    ],
  • "inputs": [
    ],
  • "keepTransactionOpenOnError": true,
  • "preconditions": [
    ]
}

Response samples

Content type
application/json
{
  • "jobId": "string",
  • "tableAccess": {
    },
  • "transactionId": "string"
}

Retrieve a job's status

Retrieve the status for a SQL job and child jobs. Use the job ID returned by POST /v1alpha/data/table-sources/transactions/{transactionId}/jobs.

Dispatched jobs include status details and aggregated summary counts per tenant.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transactionId
required
string

The unique identifier of the transaction.
jobId
required
string

The unique identifier of the job.
queryParameters
summaryOnly
boolean

If true, the response includes the overall status and summary counts, and omits per-tenant job statuses. Useful for large multi-tenant jobs. Default is false.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "status": "UNKNOWN",
  • "summary": {
    },
  • "processingSummary": {
    },
  • "tenants": [
    ],
  • "jobId": "string"
}

Download a transaction's output file

Download an output file generated by a transaction SQL operation. Generate output files using the QUERY action and output parameter in POST /v1alpha/data/table-sources/transactions/{transactionId}/jobs.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transactionId
required
string

The unique identifier of the transaction.
filename
required
string

The name of the file to download. This should be the filename specified in an output of an action during job execution.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

List output file parts

List parts of a multi-part output file. SQL operations generate output files inside transactions. Each part is a complete file indexed from 0. For an output with numberOfParts: 3, the part numbers are 0, 1, and 2. Download large files by part to optimize performance.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transactionId
required
string

The unique identifier of the transaction.
filename
required
string

The name of the output file to list parts for.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "filename": "string",
  • "numberOfParts": 0
}

Download an output file part

Download a single part of a multi-part output file. Output parts are 0-indexed complete files generated by transaction SQL operations. For an output with numberOfParts: 3, the part numbers are 0, 1, and 2. Download large files by part to optimize performance.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
transactionId
required
string

The unique identifier of the transaction.
filename
required
string

The name of the output file to download a part of.
partIndex
required
integer <int32>

The zero-based index of the part to download.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Data Query

Query against your data in Visier to get aggregate and list data.

Query aggregate data

Retrieve aggregated values from your data in Visier. Aggregations retrieve values over time, such as multiple months. Group and filter data in an aggregation query to retrieve detailed information.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
object

The data to perform an aggregation on, such as a metric or formula. The query must include a time interval, and may optionally include filters and axes.
object

Additional instructions for your query, such as a calendar type or conversion information.

Responses

Request samples

Content type
application/json
{
  • "query": {
    },
  • "options": {
    }
}

Response samples

Content type
{
  • "cellSet": {
    },
  • "error": {
    }
}

Retrieve a data out connector's latest version

Retrieve the latest released version of a data out connector. Use this endpoint to automate checking connector release versions.

Authorizations:
None
queryParameters
connectorId
string <enum>
Enum: "powerbi" "tableau"

The name of the connector for which to retrieve the latest version. Valid values:

  • powerbi: Retrieve the latest version of Visier's Power BI connector.
  • tableau: Retrieve the latest version of Visier's Tableau connector.

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "id": "string"
}

Query a list of details

Retrieve unaggregated values for specific objects using a list query. A list query provides details for selected data points. In the Visier interface, a list query compares to Detailed View for a data point in a visualization.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
object

The source data to query.
Array of objects (dataservices.query.PropertyColumnDTO)

The columns to include in the result. This must contain at least one column.
Array of objects (dataservices.query.SortOptionDTO)

The index and direction to sort a column in the columns array.
Array of objects (dataservices.query.QueryFilterDTO)

The filters of this query. Omit filters if no filtering is required.
QueryTimeIntervalDTO with fromInstant (object) or QueryTimeIntervalDTO with fromDatetime (object) or QueryTimeIntervalDTO with dynamicDateFrom (object)

The time that the data is valid, such as a specific day or period of months.
Array of objects (dataservices.query.QueryParameterValueDTO)

The parameter values for either member or numeric parameters.
object

Additional instructions for your query, such as a calendar type or conversion information.

Responses

Request samples

Content type
application/json
{
  • "source": {
    },
  • "columns": [
    ],
  • "sortOptions": [
    ],
  • "filters": [
    ],
  • "timeInterval": {
    },
  • "parameterValues": [
    ],
  • "options": {
    }
}

Response samples

Content type
{
  • "header": {
    },
  • "rows": [
    ]
}

Query a series of detailed snapshots

Retrieve detailed time series snapshots taken at defined intervals. Each snapshot links to an effective date timestamp when data was valid.

Snapshot queries differ from list queries:

  • A snapshot query can include an effectiveDateProperty column to specify time. Add this object to the columns array:
    {"columnName": "Snapshot_Date","columnDefinition": {"effectiveDateProperty": {}}}
  • A snapshot query uses timeIntervals instead of timeInterval to specify generated snapshot counts. Use intervalCount in timeIntervals:
    {"timeIntervals": {"fromDateTime": "2022-01-01","intervalPeriodType": "MONTH","intervalPeriodCount": 6,"intervalCount": 4}
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
object

The source data to query.
Array of objects (dataservices.query.PropertyColumnDTO)

The columns to include in the result. This must contain at least one column.
Array of objects (dataservices.query.SortOptionDTO)

The index and direction to sort a column in the columns array.
Array of objects (dataservices.query.QueryFilterDTO)

The filters of this query. Omit filters if no filtering is required.
QueryTimeIntervalsDTO with fromInstant (object) or QueryTimeIntervalsDTO with fromDatetime (object) or QueryTimeIntervalsDTO with dynamicDateFrom (object)

The time intervals to query.
Array of objects (dataservices.query.QueryParameterValueDTO)

The parameter values for either member or numeric parameters.
object

Additional instructions for your query, such as a calendar type or conversion information.

Responses

Request samples

Content type
application/json
{
  • "source": {
    },
  • "columns": [
    ],
  • "sortOptions": [
    ],
  • "filters": [
    ],
  • "timeIntervals": {
    },
  • "parameterValues": [
    ],
  • "options": {
    }
}

Response samples

Content type
{
  • "header": {
    },
  • "rows": [
    ]
}

Query aggregate or list data using SQL-like syntax

Query aggregate or list data using SQL-like syntax. Responses match query types. Aggregate query results flatten into tabular formats when requested.

Queries containing metrics are aggregate queries and must specify time intervals divided into periods:

SELECT
  employeeCount() AS "Employee Count",level(Gender, "Gender") AS Gender
FROM
  Employee
WHERE
 Visier_Time IN periods(date("2023-01-01"), 4, period(3, Month));

Queries without metrics are list queries and define time intervals as simple ranges:

SELECT
  EmployeeID AS "Employee ID",level(Gender, "Gender") AS Gender
FROM
  Employee
WHERE
 Visier_Time BETWEEN date("2022-01-01") AND date("2023-01-01");
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
query
string

The SQL-like query string
object

Options to apply to a SQL-like aggregate query. The query is aggregate if it contains at least one metric. enableDescendingSpace is not supported in SQL-like aggregate queries.
object

Options to apply to a SQL-like list query. The query is list if it contains no metrics and has only properties. multipleTables is not supported in SQL-like list queries.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "aggregateQueryOptions": {
    },
  • "listQueryOptions": {
    }
}

Response samples

Content type
Example
{
  • "header": {
    },
  • "rows": [
    ]
}

Data Version Export

Export Visier data version information, such as tables, columns, and file information, in CSV format. Monitor export jobs using GET /v1alpha/data/data-version-exports/jobs/{jobUuid}. Use the returned exportUuid and fileId from GET /v1alpha/data/data-version-exports/exports/{exportUuid} to download CSV files.

Note: 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 Success Manager (CSM).

Retrieve data versions

Retrieve all data versions in the tenant.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "dataVersions": [
    ]
}

Retrieve data version exports

Retrieve the details of all available data version exports. Exports remain available for 14 days after job completion.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "dataVersionExports": [
    ]
}

Retrieve a data version export

Retrieve the details of a specific data version export. Exports remain available for 14 days after completion. You must know the ID of a data version export to retrieve its details. To retrieve data version export IDs, see GET/v1alpha/data/data-version-exports/exports.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
exportUuid
required
string

The unique identifier of the data version export.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "timestamp": "string",
  • "dataVersionNumber": "string",
  • "baseDataVersionNumber": "string",
  • "tables": [
    ],
  • "newTables": [
    ],
  • "deletedTables": [
    ]
}

Schedule a data version export job

Schedule a data version export job. The job schedules immediately and will begin when resources are available. The response returns a jobUuid to check export job status.

Note: Limit of 10 export jobs per tenant per day.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
dataVersionNumber
string

The data version number to generate an export for.
baseDataVersionNumber
string

Optional. The baseline data version number to use to generate a delta export. Delta exports contain the differences between baseDataVersionNumber and dataVersionNumber, such as anything updated, added, or removed in dataVersionNumber. If baseDataVersionNumber is not provided, a full export generates for dataVersionNumber.

Responses

Request samples

Content type
application/json
{
  • "dataVersionNumber": "string",
  • "baseDataVersionNumber": "string"
}

Response samples

Content type
application/json
{
  • "jobUuid": "string"
}

Retrieve a data version export job's status

Retrieve the status of a data version export job. Returns an exportUuid when completed to retrieve export details and files.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
jobUuid
required
string

The unique identifier of the data version export job.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "jobUuid": "string",
  • "completed": true,
  • "failed": true,
  • "exportUuid": "string"
}

Download a file from a data version export

This endpoint allows you to download a file from a data version export. Data version export files are in CSV format, compressed with gzip.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
exportUuid
required
string

The unique identifier of the data version export.
fileId
required
integer

The unique integer identifier of the file within the data version export.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "errorCode": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Vee V1

Ask questions, submit feedback, and retrieve sample questions using Vee. Vee provides answers based on the user's organization's people data and, if specified, the answer's numerical visualization data.

Submit Vee feedback

Submit feedback for a previous Vee answer.

Include in your feedback:

  • Conversation details from the /question response.
  • Answer rating. If isApproved is true, Vee answered correctly. If isApproved is false, the answer was incorrect or incomplete.
  • Description of expected answer improvements, such as Expected Headcount metric, but Vee returned Average Headcount.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
object

Details of the Vee conversation to provide feedback about.
isApproved
boolean

If true, Vee answered the question correctly. If false, Vee's answer was incorrect or lacked details.
description
string

A description of how Vee should have answered the question or how Vee can improve the answer; for example, "Expected Headcount metric, but Vee returned Average Headcount".

Responses

Request samples

Content type
application/json
{
  • "conversation": {
    },
  • "isApproved": true,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": "UNDEFINED",
  • "statusMsg": "string"
}

Ask Vee a question

Use plain language to ask Vee a people question. Use body parameters to specify how Vee should respond, such as returning a visualization, data, or rewording the question.

The response returns a conversationState object with a unique conversation ID. Include conversationState in your next /question request for follow-up questions. Include the response in /feedback calls to submit feedback.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
question
string

The question to ask Vee. If asking a follow-up question or continuing a conversation with Vee, specify the conversationState object from the question's response.
object

The unique identifier of the conversation with Vee. If empty, starts a new conversation with Vee. If asking a follow-up question or continuing a conversation with Vee, specify the conversationState object from the question's response. To submit feedback about Vee's answer, copy the entire response into your /feedback call.
object

Options to specify how Vee should respond to a question.
maxViewDetailsMembers
integer <uint32>

The maximum number of members to return in Detailed View. At maximum chart size (1600 by 900 pixels), a maximum of 16 members can be shown in the chart.

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "conversationState": {
    },
  • "options": {
    },
  • "maxViewDetailsMembers": 0
}

Response samples

Content type
application/json
{
  • "conversationState": {
    },
  • "statusCode": {
    },
  • "narrative": "string",
  • "chartUrl": "string",
  • "schema": {
    },
  • "corrections": [
    ],
  • "data": {
    },
  • "visual": {
    },
  • "rewordedQuestion": "string",
  • "relatedDocuments": {
    },
  • "suggestions": [
    ]
}

Retrieve Vee question categories

Retrieve Vee sample question categories displayed in the conversation interface.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Retrieve a Vee question category

Retrieve details of a Vee sample question category by questionCategoryId returned from GET /v1/vee/sample-question-categories.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
questionCategoryId
required
string
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "categoryId": "string",
  • "basicInformation": {
    },
  • "categoryIcon": {
    }
}

Retrieve sample questions to ask Vee

Retrieve sample questions to start using Vee. Returns questions like What is the turnover rate?.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "questions": [
    ]
}

Retrieve Vee's status

Check the current overall status of Vee.

Overall status values:

  • UP: Vee is operational.
  • DOWN: Vee isn't operational.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "overall": "string"
}

Vee V2

Ask questions, submit feedback, and retrieve sample questions using Vee. Vee provides answers based on the user's organization's people data and, if specified, the answer's numerical visualization data. Vee V2 improves upon Vee V1 by aligning response field names with the Vee UI.

Retrieve sample questions to ask Vee

Retrieve sample questions to start using Vee. Returns questions like What is the turnover rate?.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "questions": [
    ]
}

Search

Search for documents in Visier, such as analyses.

Note: 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 Success Manager (CSM).

Search document headers

Search Visier document headers, such as analysis titles. Simple search doesn't support keywords, Boolean expressions, or any other advanced search features. Example: GET /v1alpha/search/simple/document-headers?q=My+Query&limit=10 returns the first 10 document headers that best match My Query.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
q
string

The search query string. Search results include document headers matching the string. The search string is case insensitive and supports partial matches. Must be between 2 and 200 characters.
limit
integer <int32>

The maximum number of results to return. Default is 100.
offset
integer <int32>

The zero-based index to start retrieving results from. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "documentHeaders": [
    ]
}

Search Visier objects

Search Visier objects, such as metrics, dimensions, dimension members, concepts, analytic objects, and properties.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
query
Array of strings

The search string. You can provide multiple search strings. The results include Visier object headers that match each of the search strings. Search strings are case-insensitive and support partial matches. Search strings must be at least 2 characters up to a maximum of 200 characters.
objectType
string <enum>
Enum: "UNKNOWN" "METRIC" "DIMENSION" "DIMENSION_MEMBER" "CONCEPT" "ANALYTIC_OBJECT" "PROPERTY"

The type of Visier object to search. Valid values:

  • METRIC: Search for metrics that match the search strings.
  • DIMENSION: Search for dimensions that match the search strings.
  • DIMENSION_MEMBER: Search for dimension members that match the search strings.
  • CONCEPT: Search for concepts that match the search strings.
  • ANALYTIC_OBJECT: Search for analytic objects that match the search strings.
  • PROPERTY: Search for properties that match the search strings.
limit
integer <int32>

The maximum number of results to return. Default and maximum are 100.
offset
integer <int32>

The index to start retrieving results from, also known as offset. Default is 0.
mask
string

A comma-separated list of additional fields to include in the response. Valid values:

  • For all objects: Description, Explanation, Tags
  • For METRIC search: analyticObjectId, dataStartDate, dataEndDate
  • For ANALYTIC_OBJECT search: objectReferences, analyticObjectType, dataStartDate, dataEndDate, propertyIds
  • For DIMENSION_MEMBER search: path, level, dimensionId, matchedSynonyms
  • For PROPERTY search: dataType

Returns matchedSynonyms in the metadata response. Contains synonyms that match the dimension member search string, ordered by relevance. Returns an empty list if none match.

For example, to get descriptions and tags in the response, set mask="Description,Tags".
includeDocumentIdSearch
boolean

If true, the search includes document IDs. This is not valid for DIMENSION_MEMBER object type. Default is false. Note that document ID search queries are case-sensitive.
object

Additional context to refine a dimension search.
object

Additional context to refine a concept search.
object

Additional context to refine a dimension member search.
object

Additional context to refine a property search.

Responses

Request samples

Content type
application/json
{
  • "query": [
    ],
  • "objectType": "UNKNOWN",
  • "limit": 0,
  • "offset": 0,
  • "mask": "string",
  • "includeDocumentIdSearch": true,
  • "dimensionSearchContext": {
    },
  • "conceptSearchContext": {
    },
  • "dimensionMemberSearchContext": {
    },
  • "propertySearchContext": {
    }
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Source Files Download

Download a tenant's source files.

Note: 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 Success Manager (CSM).

Download source files

Download source files for a tenant. Download all included source files or specify sources by object name or unique identifier. Excluded source files aren't downloaded.

If minTimestamp and maxTimestamp are defined, downloads source files uploaded within the time range.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
downloadAll
boolean

If true, downloads all uploaded files for all sources. Default is false.
sources
Array of strings

A comma-separated list of strings representing the object name of each source to download.
sourceIds
Array of strings

A comma-separated list of strings representing the unique identifier of each source to download.
minTimestamp
string

The earliest upload time to download files from in ISO 8601 format, such as "2001-10-25T13:45:35.999". If omitted, downloads files from the earliest available time.
maxTimestamp
string

The latest upload time to download files up to in ISO 8601 format, such as "2001-10-25T13:45:35.999". If omitted, downloads files up to the latest available time.
minSnapshotTimestamp
string

The earliest snapshot time to download files from in ISO 8601 format, such as "2001-10-25T13:45:35.999". If omitted, downloads files from the earliest available time.
maxSnapshotTimestamp
string

The latest snapshot time to download files up to in ISO 8601 format, such as "2001-10-25T13:45:35.999". If omitted, downloads files up to the latest available time.
includeNonActiveFiles
boolean

If true, includes excluded files in download. Default is false.

Responses

Request samples

Content type
application/json
{
  • "downloadAll": true,
  • "sources": [
    ],
  • "sourceIds": [
    ],
  • "minTimestamp": "string",
  • "maxTimestamp": "string",
  • "minSnapshotTimestamp": "string",
  • "maxSnapshotTimestamp": "string",
  • "includeNonActiveFiles": true
}

Response samples

Content type
{
  • "status": "string",
  • "messages": "string"
}

Download a source file

Download a single source file in ZIP format using its unique identifier. To retrieve file identifiers, see GET /v1alpha/op/data/uploaded-files.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
identifier
required
string

The unique identifier of the source file.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "messages": "string"
}

Reporting

Create, retrieve, delete, copy, and download reports.

Note: 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 Success Manager (CSM).

Retrieve reports

Retrieve reports in the tenant. The response returns information such as the unique ID, title, description, owner, and the allowed actions you can take on the report.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
limit
integer <int32>

The maximum number of reports to return. Default is 100.
start
integer <int32>

The starting index of the first report to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Create a report

Create a new report with a title and description. To edit other contents of the report, such as columns and group bys, navigate to the Reports room in Visier.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
title
string

The localized title of the report.
description
string

The localized description of the report.

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "updatedTime": "string",
  • "isPublishedReport": true,
  • "owner": "string",
  • "isOwnedByUser": true,
  • "allowedActions": [
    ],
  • "link": "string"
}

Retrieve a report

Retrieve a specific report's details. You must know the ID of the report to retrieve its details. To retrieve report IDs, see GET /v1alpha/reporting/reports.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
reportId
required
string

The unique identifier of the report.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "updatedTime": "string",
  • "isPublishedReport": true,
  • "owner": "string",
  • "isOwnedByUser": true,
  • "allowedActions": [
    ],
  • "link": "string"
}

Duplicate a report

Make a copy of an existing report. You must know the ID of the report to copy it. To retrieve report IDs, see GET /v1alpha/reporting/reports.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
reportId
required
string

The unique identifier of the report.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "updatedTime": "string",
  • "isPublishedReport": true,
  • "owner": "string",
  • "isOwnedByUser": true,
  • "allowedActions": [
    ],
  • "link": "string"
}

Delete a report

Delete a specific report. You must know the ID of the report to delete it. To retrieve report IDs, see GET /v1alpha/reporting/reports.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
reportId
required
string

The unique identifier of the report.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Download a report

Download a report as a CSV file. The returned CSV file contains the data in the report. You must know the ID of the report to download it. To retrieve report IDs, see GET /v1alpha/reporting/reports.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
reportId
required
string

The unique identifier of the report you want to download.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Data Export Connectors

Manage data export connectors, credentials, and jobs. Data export connectors send Visier data to external systems, such as Databricks or Snowflake. Use these APIs to manage the credentials for authenticating with destinations, validate that credentials work, list available data export connectors, and dispatch connector jobs.

Note: 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 Success Manager (CSM).

Retrieve data export connectors

Retrieve data export connectors. Each connector defines its Data Exports and associated credentials.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)

Responses

Response samples

Content type
application/json
{
  • "connectors": [
    ]
}

Run a data export connector job

Dispatch a job for a data export connector using the production version. Returns an id to monitor job progress with GET /v1alpha/data/export-connectors/jobs/{jobId}.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
connectorId
required
string

The unique identifier of the data export connector.

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Retrieve data export connector credentials

Retrieve data export connector credentials. The response returns each credential's identifying fields and authentication parameters. Masked values hide sensitive fields, such as secrets and private keys.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)

Responses

Response samples

Content type
application/json
{
  • "credentials": [
    ]
}

Create a data export connector credential

Create a data export connector credential to authenticate with external systems, such as Databricks or Snowflake. Omit id when creating a credential. Visier generates the ID automatically.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
id
string

The unique identifier for the credential. This identifier is a UUID generated automatically when the credential is created and cannot be changed. Do not provide a value when creating a new credential. When updating a credential, this field is required and must match the id path parameter.
object

Fields that identify and describe the credential, such as its display name, description, and explanation.
DataExportConnectorCredentialParameters with Databricks (object) or DataExportConnectorCredentialParameters with Snowflake (object) or DataExportConnectorCredentialParameters with BigQueryServiceAccount (object)

The parameters for the credential. Sensitive fields are masked when retrieved.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "basicInformation": {
    },
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "basicInformation": {
    },
  • "parameters": {
    }
}

Validate a data export connector credential

Validate that a data export connector credential can connect to its destination. Validation runs asynchronously. Returns an id to poll for results with GET /v1alpha/data/export-connectors/credentials/validations/{id}.

Specify id to validate existing credentials or parameters to validate new values without saving.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
One of
id
required
string

The unique identifier of an existing credential to validate.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Retrieve a data export connector credential validation result

Retrieve validation results for a credential using the id from POST /v1alpha/data/export-connectors/credentials/validations.

Validation runs asynchronously. Continue polling this endpoint until results return:

  • While validation is in progress, the response is 200 OK with a null body.
  • When validation completes, the response is 200 OK with validation status and error details.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the credential validation request.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "errors": [
    ]
}

Retrieve a data export connector credential

Retrieve a specific data export connector credential. Masked values hide sensitive fields, such as secrets and private keys. You must know the ID of the data export credential to retrieve its details. To retrieve data export connector IDs, see GET /v1alpha/data/export-connectors/credentials.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the data export connector credential.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "basicInformation": {
    },
  • "parameters": {
    }
}

Update a data export connector credential

Update a data export connector credential. PUT requests replace existing definitions. Provide the complete object definition in the request body, including secrets and private keys in plain text.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the data export connector credential.
Request Body schema: application/json
required
id
string

The unique identifier for the credential. This identifier is a UUID generated automatically when the credential is created and cannot be changed. Do not provide a value when creating a new credential. When updating a credential, this field is required and must match the id path parameter.
object

Fields that identify and describe the credential, such as its display name, description, and explanation.
DataExportConnectorCredentialParameters with Databricks (object) or DataExportConnectorCredentialParameters with Snowflake (object) or DataExportConnectorCredentialParameters with BigQueryServiceAccount (object)

The parameters for the credential. Sensitive fields are masked when retrieved.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "basicInformation": {
    },
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "basicInformation": {
    },
  • "parameters": {
    }
}

Delete a data export connector credential

Delete a data export connector credential. You must know the ID of the data export credential to delete it. To retrieve data export connector IDs, see GET /v1alpha/data/export-connectors/credentials.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the data export connector credential.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Retrieve a data export connector job status

Retrieve the status of a data export connector job using the id from POST /v1alpha/data/export-connectors/connectors/{connectorId}/jobs. Returns job status, error messages, and spawned sync job statuses. A sync job sends the data from Visier to the target system, such as Databricks or Snowflake.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the data export connector job.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "errorMessage": "string",
  • "syncJobs": [
    ]
}

Projects

Create projects, publish projects, and retrieve project details.

Retrieve draft projects

Retrieve a list of draft projects accessible to the requesting user in the tenant.

A project is accessible if it is owned by the user or shared to the user.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
with
Array of strings

The types of draft projects to include in the request response.

  • If unspecified, returns all the Open draft projects.
  • If Open, returns all Open draft projects.
  • If Approval, returns all draft projects in the approval stage. Changes cannot be made in Approval projects.
  • If Rejected, returns all draft projects that have been rejected. Changes cannot be committed in Rejected projects.
  • If Archived, returns all draft projects that have been archived. Changes cannot be committed in Archived projects.
limit
integer <int32>

The maximum number of projects to return per type. Default is 100. Maximum is 1000.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "openProjects": [
    ],
  • "approvalProjects": [
    ],
  • "rejectedProjects": [
    ],
  • "archivedProjects": [
    ]
}

Create a new draft project

Create a new draft project in the tenant.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
id
string

The unique identifier of the project. Omit when creating a new project.
name
string

An identifiable project name to display in Visier.
description
string

A description of the project.
releaseVersion
string

The release version of the project.
ticketNumber
string

The change management ticket number of the project.
versionNumber
integer <int32>

The version number of the project.
capabilities
Array of strings <enum>[ items <enum> ]
ItemsEnum: "canRead" "canWrite" "canShare" "owner"

The current user's capabilities for the project. Users with canWrite, canShare, or owner capabilities can add and commit changes to the project. canRead: The project has been shared to the user with View access. canWrite: The project has been shared to the user with Edit access. canShare: The project has been shared to the user with Share access. owner: The user is the owner of the project. Omit when creating a new project.
projectType
string <enum>
Enum: "Standard" "Prototype" "UnknownType"

The type of the project. Omit when creating a new project.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "releaseVersion": "string",
  • "ticketNumber": "string",
  • "versionNumber": 0,
  • "capabilities": [
    ],
  • "projectType": "Standard"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "releaseVersion": "string",
  • "ticketNumber": "string",
  • "versionNumber": 0,
  • "capabilities": [
    ],
  • "projectType": "Standard"
}

Retrieve a draft project

Retrieve the details of an accessible draft project. You must know the ID of the project to retrieve its details. To retrieve draft project IDs, see GET /v1/admin/projects.

A project is accessible if it is owned by the user or shared to the user.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
projectId
required
string

The unique identifier of the draft project to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "releaseVersion": "string",
  • "ticketNumber": "string",
  • "versionNumber": 0,
  • "capabilities": [
    ],
  • "projectType": "Standard"
}

Perform an operation on a draft project

Perform operations on a draft project. Supported operations:

  • commitAndPublish: Commits project changes and publishes the project to production.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
projectId
required
string
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
operation
string <enum>
Enum: "unknown" "commitAndPublish"

The operation to perform on a draft project. Valid values:

  • commitAndPublish: Commits the requesting user's changes and publishes the draft project to production.

Responses

Request samples

Content type
application/json
{
  • "operation": "unknown"
}

Response samples

Content type
application/json
{
  • "commitAndPublish": {
    }
}

Delete a draft project

Delete a draft project in the tenant. The project is archived first if applicable.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
projectId
required
string

The unique identifier of the draft project to delete.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "releaseVersion": "string",
  • "ticketNumber": "string",
  • "versionNumber": 0,
  • "capabilities": [
    ],
  • "projectType": "Standard"
}

Retrieve all committed changes in a project

Retrieve the full list of all committed changes in a project.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
projectId
required
string

The unique identifier of the draft project to retrieve the committed changes for.
queryParameters
limit
integer <int32>

The maximum number of committed changes to return. Default is 400.
start
integer <int32>

The starting index of the first committed change to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "commits": [
    ]
}

Import committed changes into a project

Import a ZIP file that contains a list of committed changes into a draft project. The file must be an export from POST /v1/admin/production-versions. Use this endpoint after making changes in a development environment to copy the changes to a draft project in your production environment.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
projectId
required
string

The unique identifier of the draft project to import committed changes into.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/zip
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "commits": [
    ]
}

Production Versions

Use this API to retrieve information about data versions that were published to production. In Visier, production is the version of Visier available to your end users.

Retrieve production versions

Retrieve a list of all projects published to production, ordered from latest published to earliest published.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
limit
integer <int32>

The maximum number of production versions to return. Default is 400.
start
integer <int32>

The starting index of the first production version to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "publishedVersions": [
    ]
}

Perform an operation on production versions

Perform operations on production versions, such as exporting a production project's committed changes.

If exporting, specify Accept: application/zip, application/json in the header. The endpoint returns exported changes in ZIP format and error messages in JSON format. If your request returns an error and it doesn't accept application/json, you receive an HTTP 406 status code instead of the error response body.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
operation
string <enum>
Enum: "unknownProductionVersionsAPIOperation" "export"

The operation to perform. Valid values:

  • export: Export the project changes of the requested production versions and their related files, such as any Guidebook images. If successful, a ZIP file is returned containing any relevant image files and a JSON file with the production project changes.
object

The parameters for the export option, such as the production version to start exporting versions from. Required for export operations.

Responses

Request samples

Content type
application/json
{
  • "operation": "unknownProductionVersionsAPIOperation",
  • "exportParameters": {
    }
}

Response samples

Content type
application/json
{
  • "export": { }
}

Perform an operation on a production version

Perform operations on a specific production version. Supported operations:

  • rollBackTo: Create a project that rolls back the production version to the specified version. The project contains uncommitted changes that reverse the published versions after the target production version.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
productionVersionId
required
string

The production version to use as the target of the operation; for example, the production version to roll back to for the rollBackTo operation.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
operation
string <enum>
Enum: "unknownProductionVersionAPIOperation" "rollBackTo"

The operation to perform. Valid values:

  • rollBackTo: Create a project that rolls back the production version to the specified version. The project contains uncommitted changes that reverse the published versions after the target production version.

Responses

Request samples

Content type
application/json
{
  • "operation": "unknownProductionVersionAPIOperation"
}

Response samples

Content type
application/json
{
  • "rollBackTo": {
    }
}

Users V3

Manage users within an organization. Users V3 offers the ability to update or insert (upsert) a user.

Update or insert (upsert) a user

Update a user if the user exists, otherwise create a new user. Use the user's username to specify the user to update or create.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed from the user if the user exists.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
username
required
string

The username of the user to update if the user exists, otherwise creates a new user.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Prefer
string

When NonVersioned: true, use Prefer to optionally specify if API calls should be subject to locking. Locking prevents incremental changes in multiple API calls from overwriting each other. The Prefer header works alongside a tenant feature flag. When enabled, the default is nvLock=global. When disabled, the default is not to lock API calls. Contact Visier Technical Support to enable the tenant feature flag. Valid values for the Prefer header:

  • nvLock=global: Run API calls sequentially. Sequential API calls prevent calls from unintentionally overwriting each other.
  • nvLock=artifact: Allow API calls in parallel. Parallel API calls only work if the calls do not conflict with each other. If a change wasn't applied, the request fails and returns the HTTP 409 conflict error. Run the request again until successful.
  • nvLock=none: Disable the global lock if the tenant feature flag is enabled.
Request Body schema: application/json
required
username
string

The user's username. This is typically the user's email, such as john@jupiter.com. If a user's username changes, they must authenticate using the new username.
displayName
string

An identifiable name to display within Visier. For example, "John Smith".
employeeId
string

If applicable, and if available, the user employee ID in the data.
accountEnabled
string

If true, the user account is enabled.
email
string

The user's email address.
userGroupIds
Array of strings

The user groups to assign to the user.
permissionIds
Array of strings

The permissions to assign to the user.
Array of objects (servicing.ProfileAssignmentDTO)

The profiles to assign to the user.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "displayName": "string",
  • "employeeId": "string",
  • "accountEnabled": "string",
  • "email": "string",
  • "userGroupIds": [
    ],
  • "permissionIds": [
    ],
  • "profileAssignments": [
    ]
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "username": "string",
  • "displayName": "string",
  • "employeeId": "string",
  • "accountEnabled": "string",
  • "email": "string",
  • "userGroupIds": [
    ],
  • "profileIds": [
    ],
  • "permissionIds": [
    ]
}

Users V2

Manage users in bulk, such as creating, updating, and deleting many users.

Visier recommends that administrating tenant users focus primarily on managing users at the administrating tenant level. These users likely belong directly to your organization, such as customer support, customer value managers, account executives, and customer success. These users work with clients to manage their day-to-day solution needs.

Update users

Update an existing user's information, such as their display name or if the user is enabled in Visier.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to update a user in.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (servicing.UsersUpdateAPIUserDTO)

The users to update. Maximum is 100.

Responses

Request samples

Content type
application/json
{
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Add users

Create new users. Administrating tenant users can specify the tenant in which to add these users.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to create a user in.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (servicing.UserCreationAPIRequestDTO)

The users to create. Maximum is 100.

Responses

Request samples

Content type
application/json
{
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete users

Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to delete a user in.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
userIds
Array of strings

The users to delete. Maximum is 100.

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

User Groups V2

Manage user groups in Visier, such as creating, updating, and deleting user groups in bulk.

Retrieve user groups

Retrieve a collection of user groups. Use with to control the amount of detail returned in the response. with supports these values:

  • permissions: Include the user group's permissions.
  • users: Include the users in the user group.
  • details: Include all available information.

This endpoint can return a maximum of 1000 user groups. Default is 100.

To specify the project in which to return user groups, provide a project UUID in the ProjectID request header.

To specify the tenant in which to retrieve user groups, administrating tenants can provide an analytic tenant code in the TargetTenantID request header.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
with
string <enum>
Enum: "permissions" "users" "details"

Controls the amount of detail to return in the response. Omit to return basic information.

  • permissions: Include the user group's permissions.
  • users: Include the users in the user group.
  • details: Include all available information.
limit
integer <uint32>

The maximum number of user groups to return. Default is 100. Maximum is 1000.
start
integer <uint32>

The starting index of the first result to return. Default is 0.
displayNameFilter
string

The display name filter to narrow the set of user groups to return. This filter must be defined using glob syntax with the following wildcards and is case-sensitive. The value in parentheses is the equivalent hex code, which is used when URL-encoding the filter string:

  • '*' (%2A) matches any sequence of characters.
  • '?' (%3F) matches a single character.
  • ' ' (%20) matches a space character.

Example:

  • Sales* matches any user group that starts with "Sales".
  • * ?egional * Office is expressed as %2A%20%3Fegional%20%2A%20Office and can have many matches, such as "Western Regional Support Office".
correlationIds
string

If defined, correlationIds limits the response to the user groups associated with the specified correlation IDs. You can specify multiple correlation IDs in the correlationIds parameter separated by commas; for example, correlationIds=123,abc,456.

Note:

  • Correlation IDs must be between 3 and 64 characters long and may only contain alphanumeric characters, underscores and hyphens.
  • Correlation IDs have a lifetime of up to 7 days after creation. After a correlation ID expires, you can only retrieve specific user groups using the user group ID.
  • Correlation IDs are optional during user group creation and are only applicable to those objects created with a defined correlation ID.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Update user groups

Update existing user groups. To specify the tenant in which to update a user group, administrating tenants can provide an analytic tenant code in the TargetTenantID request header or tenantCode for each user group in the request body.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed from the user group. We recommend retrieving details before updating.

To specify the project in which to update user groups, provide a project UUID in the ProjectID request header or projectId for each user group in the request body.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
Array of objects (admin.UserGroupChangeDefinitionDTO)

The user groups and their definitions.

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create user groups

Create new user groups. To specify the tenant in which to add new user groups, administrating tenants can provide an analytic tenant code in the TargetTenantID request header.

To specify the project in which to create new user groups, provide a project UUID in the ProjectID request header or projectId for each user group in the request body.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
Array of objects (admin.UserGroupChangeDefinitionDTO)

The user groups and their definitions.

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete user groups

Delete user groups in bulk. To specify the tenant in which to delete user groups, administrating tenants can provide an analytic tenant code in the TargetTenantID request header.

To specify the project in which to delete user groups, provide a project UUID in the ProjectID request header or projectId for each user group in the request body.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
Array of objects (admin.UserGroupDeleteDTO)

The user groups to delete.

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Patch user groups

Make partial changes to user groups. To specify the tenant in which to patch a user group, administrating tenants can provide an analytic tenant code in the TargetTenantID request header or tenantCode for each user group in the request body.

Unlike PUT, which completely replaces the user group definition, use PATCH to change specific fields in the user group without affecting omitted fields.

To specify the project in which to patch user groups, provide a project UUID in the ProjectID request header or projectId for each user group in the request body.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Prefer
string

When NonVersioned: true, use Prefer to optionally specify if API calls should be subject to locking. Locking prevents incremental changes in multiple API calls from overwriting each other. The Prefer header works alongside a tenant feature flag. When enabled, the default is nvLock=global. When disabled, the default is not to lock API calls. Contact Visier Technical Support to enable the tenant feature flag. Valid values for the Prefer header:

  • nvLock=global: Run API calls sequentially. Sequential API calls prevent calls from unintentionally overwriting each other.
  • nvLock=artifact: Allow API calls in parallel. Parallel API calls only work if the calls do not conflict with each other. If a change wasn't applied, the request fails and returns the HTTP 409 conflict error. Run the request again until successful.
  • nvLock=none: Disable the global lock if the tenant feature flag is enabled.
Request Body schema: application/json
required
Array of objects (admin.UserGroupChangeDefinitionDTO)

The user groups and their definitions.

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Revert user groups

Revert a user group to its parent version.

Reverting behavior by object type:

  • Blueprint object: No changes. Objects are inherited from the parent.
  • Tenant override object: Reverts to the Blueprint version or administrating tenant version.
  • Tenant object: Request fails. Tenant-unique objects do not have Blueprint versions.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
Array of objects (admin.UserGroupRevertDTO)

The user groups to revert.

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve a user group

Retrieve all available information about a specific user group.

To specify the tenant in which to retrieve a user group, administrating tenants can provide an analytic tenant code in the TargetTenantID request header.

To specify the project in which to return a user group, provide a project UUID in the ProjectID request header.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
userGroupId
required
string

The unique identifier of the user group.
queryParameters
with
string <enum>
Enum: "permissions" "users" "details"

Controls the amount of detail to return in the response. Omit to return detailed information.

  • permissions: Include the user group's permissions.
  • users: Include the users in the user group.
  • details: Include all available information.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "userGroupId": "string",
  • "displayName": "string",
  • "description": "string",
  • "permissionIds": {
    },
  • "users": {
    },
  • "tenantCode": "string",
  • "projectId": "string",
  • "visibleForSelection": {
    },
  • "correlationId": "string"
}

Delete a user group

Delete a specific user group. To specify the tenant in which to delete a user group, administrating tenants can provide an analytic tenant code in the TargetTenantID request header.

To specify the project in which to delete a user group, provide a project UUID in the ProjectID request header.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
userGroupId
required
string

The unique identifier of user group to delete.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "success": {
    },
  • "failure": {
    }
}

Users V1

Manage users within an organization, such as assigning permissions to users and retrieving user permission assignments and application logs.

Visier recommends that administrating tenant users focus primarily on managing users at the administrating tenant level. These users likely belong directly to your organization, such as customer support, customer value managers, account executives, and customer success. These users work with clients to manage their day-to-day solution needs

Assign permissions to users

Assign a permission to specific users. Administrating tenant users can assign permissions to users in the administrating tenant and in the analytic tenants those users belong to. Administrating tenants can assign permissions to users in analytic tenants by providing a tenant code and project ID in the request body.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
SessionBasedPermissions
boolean

If true, the API call assigns user permissions that are only valid for the specified SessionRepoId without creating a new production version. When a user signs in to your application with the SessionRepoId, their session-based permissions are valid until the user session ends. Cannot be true if NonVersioned is true. Default is false.
SessionRepoId
string

Optionally, specify a session repository ID to overwrite the user's permissions that are associated with the SessionRepoId. Only valid with SessionBasedPermissions. If omitted and SessionBasedPermissions is true, the API creates a new SessionRepoId.
Request Body schema: application/json
required
Array of objects (servicing.AssignRevokePermissionRequestDTO)

The permissions to assign to or remove from users.
object

Administrating tenants can specify the tenants and projects in which to assign permissions to users or remove permissions from users. Specify one projectId per tenantCode. If omitted, the request is immediately published to production or applied to the ProjectID in the request header, if available, for the administrating tenant or TargetTenantID, if available.

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ],
  • "targetProjectForTenantsList": {
    }
}

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "sessionRepoId": "string"
}

Remove permissions from users

Remove a permission from specific users. Administrating tenant users can remove permissions from users in the administrating tenant and in the analytic tenants those users belong to. Administrating tenants can remove permissions from users in analytic tenants by providing a tenant code and project ID in the request body.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.AssignRevokePermissionRequestDTO)

The permissions to assign to or remove from users.
object

Administrating tenants can specify the tenants and projects in which to assign permissions to users or remove permissions from users. Specify one projectId per tenantCode. If omitted, the request is immediately published to production or applied to the ProjectID in the request header, if available, for the administrating tenant or TargetTenantID, if available.

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ],
  • "targetProjectForTenantsList": {
    }
}

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "sessionRepoId": "string"
}

Retrieve users that are assigned a specific permission

Retrieve all users assigned to a specified permission. You must know the ID of the permission you want to retrieve users for.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
permissionId
required
string

The unique identifier of the permission to retrieve users for.
queryParameters
includeUserGroups
boolean

If true, returns a list of all users that are assigned the permission, including users that are assigned the permission through a user group. If false, returns a list of the users that are directly assigned the permission.
tenantFilter
string

The tenant to retrieve the list of users from.
limit
integer <int32>

The maximum number of results to return. Maximum is 100.
start
integer <int32>

The starting index of the first result to return. Default is 0.
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "limit": 0,
  • "start": 0
}

Retrieve user groups

Retrieve the full list of user groups in a tenant.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to retrieve the list of user groups from.
limit
integer <uint32>

The maximum number of users to return. Maximum is 1000.
start
integer <uint32>

The starting index of the first result to return. Default is 0.
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "userGroups": [
    ],
  • "limit": 0,
  • "start": 0
}

Assign permissions to user groups

Assign a permission to specific user groups. This assigns the permission to all users in the user group.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (admin.PermissionsToUserGroupRequestDTO)

The user groups and permissions to assign or remove.

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "status": "string",
  • "message": "string",
  • "userGroups": [
    ]
}

Remove permissions from user groups

Remove a permission from specific user groups.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (admin.PermissionsToUserGroupRequestDTO)

The user groups and permissions to assign or remove.

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "status": "string",
  • "message": "string",
  • "userGroups": [
    ]
}

Assign users to user groups

Assign users to specific user groups. Administrating tenants can assign users to user groups in multiple analytic tenants by providing a tenant code and project ID in the request body.

We recommend that administrating tenants set the analytic tenant in which to execute the API call using the TargetTenantID request header.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Prefer
string

When NonVersioned: true, use Prefer to optionally specify if API calls should be subject to locking. Locking prevents incremental changes in multiple API calls from overwriting each other. The Prefer header works alongside a tenant feature flag. When enabled, the default is nvLock=global. When disabled, the default is not to lock API calls. Contact Visier Technical Support to enable the tenant feature flag. Valid values for the Prefer header:

  • nvLock=global: Run API calls sequentially. Sequential API calls prevent calls from unintentionally overwriting each other.
  • nvLock=artifact: Allow API calls in parallel. Parallel API calls only work if the calls do not conflict with each other. If a change wasn't applied, the request fails and returns the HTTP 409 conflict error. Run the request again until successful.
  • nvLock=none: Disable the global lock if the tenant feature flag is enabled.
Request Body schema: application/json
required
Array of objects (admin.UsersToUserGroupRequestDTO)

The user groups and users to assign or remove.
object

Administrating tenants can specify the tenants and projects in which to assign users to user groups or remove users from user groups. Specify one projectId per tenantCode. If omitted, the request is immediately published to production or applied to the ProjectID in the request header, if available, for the administrating tenant or TargetTenantID, if available.

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ],
  • "targetProjectForTenantsList": {
    }
}

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Remove users from user groups

Remove users from specific user groups. Administrating tenants can remove users to user groups in multiple analytic tenants by providing a tenant code and project ID in the request body.

We recommend that administrating tenants set the analytic tenant in which to execute the API call using the TargetTenantID request header.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Prefer
string

When NonVersioned: true, use Prefer to optionally specify if API calls should be subject to locking. Locking prevents incremental changes in multiple API calls from overwriting each other. The Prefer header works alongside a tenant feature flag. When enabled, the default is nvLock=global. When disabled, the default is not to lock API calls. Contact Visier Technical Support to enable the tenant feature flag. Valid values for the Prefer header:

  • nvLock=global: Run API calls sequentially. Sequential API calls prevent calls from unintentionally overwriting each other.
  • nvLock=artifact: Allow API calls in parallel. Parallel API calls only work if the calls do not conflict with each other. If a change wasn't applied, the request fails and returns the HTTP 409 conflict error. Run the request again until successful.
  • nvLock=none: Disable the global lock if the tenant feature flag is enabled.
Request Body schema: application/json
required
Array of objects (admin.UsersToUserGroupRequestDTO)

The user groups and users to assign or remove.
object

Administrating tenants can specify the tenants and projects in which to assign users to user groups or remove users from user groups. Specify one projectId per tenantCode. If omitted, the request is immediately published to production or applied to the ProjectID in the request header, if available, for the administrating tenant or TargetTenantID, if available.

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ],
  • "targetProjectForTenantsList": {
    }
}

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Retrieve user group users

Retrieve the list of users explicitly assigned to a user group. Doesn't return users implicitly included in the user group through dynamic filters.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
userGroupId
required
string

The unique identifier of user group.
queryParameters
tenantFilter
string

Specifies the tenant to retrieve the list of users from.
limit
integer <uint32>

The maximum number of tenants to return. The maximum number of tenants to retrieve is 100.
start
integer <uint32>

The starting index of the first result to return. Default is 0.
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "limit": 0,
  • "start": 0
}

Retrieve users

Retrieve the full list of users and their current states.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to retrieve a list of users from.
assignedProfiles
boolean

If true, returns a list of the user's assigned profiles.
assignedPermissions
boolean

If true, returns the user's assigned permissions.
assignedUserGroups
boolean

If true, returns the user's assigned user groups.
limit
integer <uint32>

The maximum number of users to return. Maximum is 1000.
start
integer <uint32>

The starting index of the first result to return. Default is 0.
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "limit": 0,
  • "start": 0
}

Add a user

Create a new user. Administrating tenant users can specify the tenant in which to add a user.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

Specify the tenant to create a user in.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
username
string

The user's username. This is typically the user's email, such as john@visier.com.
displayName
string

An identifiable name to display within Visier. For example, "John Smith".
employeeId
string

If applicable, and if available, the user employee ID in the data.
accountEnabled
string

If false, the user account is disabled.
email
string

The user's email. This is used if the user's email is different from their username. For example, "john.doe@visier.com".

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "displayName": "string",
  • "employeeId": "string",
  • "accountEnabled": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "username": "string",
  • "displayName": "string",
  • "employeeId": "string",
  • "accountEnabled": "string",
  • "email": "string"
}

Retrieve a user

Retrieve all details for a specified user.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
userId
required
string

The unique identifier of the user to retrieve.
queryParameters
tenantCode
string

The tenant to retrieve a user from.
assignedProfiles
boolean

If true, returns a list of the user's assigned profiles.
assignedPermissions
boolean

If true, returns the user's assigned permissions.
assignedUserGroups
boolean

If true, returns the user's assigned user groups.
headerParameters
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "userId": "string",
  • "username": "string",
  • "displayName": "string",
  • "employeeId": "string",
  • "accountEnabled": true,
  • "profiles": {
    },
  • "permissions": {
    },
  • "userGroups": {
    },
  • "lastLogin": {
    },
  • "email": "string"
}

Update a user

Update an existing user's information, such as their display name or if the user is enabled in Visier.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
userId
required
string

The unique identifier of the user to update.
queryParameters
tenantCode
string

The tenant to update a user in.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
displayName
string

An identifiable name to display within Visier. For example, "John Smith".
employeeId
string

If applicable, and if available, the user employee ID in the data.
accountEnabled
string

If true, the user account is enabled.
email
string

The user's email address.
username
string

The user's username. This is typically the user's email, such as john@jupiter.com. If a user's username changes, they must authenticate using the new username.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "employeeId": "string",
  • "accountEnabled": "string",
  • "email": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "employeeId": "string",
  • "accountEnabled": "string",
  • "email": "string",
  • "username": "string"
}

Delete a user

Delete an existing user. Administrating tenant users can specify the tenant from which to delete a user.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
userId
required
string

The unique identifier of the user to delete.
queryParameters
tenantCode
string

The tenant to delete a user in.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{ }

Retrieve the Application Logs

Export Application Logs for a tenant. Application Logs track user activity and help you identify potential security issues.

Application Logs are retained for 180 days.

Administrating tenant users can export logs for their tenant and its assigned analytic tenants.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
startTime
string
Examples:
  • startTime=1738368000000 -The start time 2025-02-01:00:00:00 GTM in milliseconds.

An inclusive date-time in milliseconds to start retrieving Application Logs from.
endTime
string
Examples:
  • endTime=1740787200000 -The end time 2025-03-01:00:00:00 GTM in milliseconds.

An exclusive date-time in milliseconds to stop retrieving Application Logs from.
tenantCode
string

The tenant to retrieve Application Logs from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Retrieve the Data Security Report

Export the Data Security Report for a user. This report shows which populations and properties a user can access.

Administrating tenant users can export reports for users in their tenant and its assigned analytic tenants.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
userId
required
string

The unique identifier of the user to retrieve the Data Security Report for.
queryParameters
tenantCode
string

The tenant to retrieve the Data Security Report from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Retrieve user profile assignments in XLSX format

Export profiles assigned to each user and their validity periods.

Administrating tenant users can export profile assignments for their tenant and its assigned analytic tenants.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to retrieve profile assignments from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Retrieve user permissions in XLSX format

Export user permission assignments for a tenant. This report summarizes assigned permissions, their usage across users, and users without assigned permissions.

Administrating tenant users can export permission assignments for their tenant and its assigned analytic tenants.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to retrieve the permission assignments report from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Retrieve permissions in XLSX format

Export the list of permissions in a tenant. This report includes the name, description, and ID for each permission.

Administrating tenant users can export permission lists for their tenant and its assigned analytic tenants.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to retrieve permissions from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Retrieve the Vee Logs

This API allows you to download the Vee Logs for a tenant. The Vee Logs track information about Vee queries executed by your users, including query content, execution status, processing time, and user feedback. Performing regular audits will help you understand how users are interacting with Vee and identify potential issues.

Administrating tenant users can export Vee Logs for the administrating tenant and the analytic tenants those users belong to.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
startTime
required
string
Examples:
  • startTime=1738368000000 -The start time `2025-02-01:00:00:00 UTC` in milliseconds.

An inclusive date-time to start retrieving Vee Logs from in milliseconds since the Unix epoch.
endTime
required
string
Examples:
  • endTime=1740787200000 -The end time `2025-03-01:00:00:00 UTC` in milliseconds.

An exclusive date-time to stop retrieving Vee Logs from in milliseconds since the Unix epoch.
tenantCode
string

Specify the tenant to retrieve Vee Logs from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Profiles

Manage the profiles assigned to users, such as assigning or removing a profile from a list of users and retrieving profile details. Administrating tenant users can manage profiles at the administrating tenant level and analytic tenant level.

Retrieve profiles

Retrieve all available profiles. For administrating tenants, this retrieves all administrating tenant profiles.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "profiles": [
    ]
}

Retrieve analytic tenant profiles

Retrieve a list of profiles available for analytic tenants.

Note: Administrating tenants only.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)

Responses

Response samples

Content type
application/json
{
  • "profiles": [
    ]
}

Retrieve an analytic tenant profile

Retrieve the details of an analytic tenant profile.

Note: Administrating tenants only.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
profileId
required
string

The unique identifier of the profile to retrieve details for.

Responses

Response samples

Content type
application/json
{
  • "profileId": "string",
  • "displayName": "string",
  • "capabilities": [
    ],
  • "additionalCapabilities": [
    ]
}

Assign an analytic tenant profile to administrating tenant users

Assign an analytic tenant profile to a list of administrating tenant users for a list of analytic tenants.

Note:

  • Administrating tenants only.
  • Revoke a profile by setting validityEndTime to a past time.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
profileId
required
string

The unique identifier of the profile to assign.
Request Body schema: application/json
required
targetUserIds
Array of strings

The users to assign this profile.
Array of objects (servicing.TargetTenantCodeDTO)

The analytic tenants for profiles assigned to the users.
validityStartTime
string

An inclusive date-time when this profile is active.
validityEndTime
string

An exclusive date-time when this profile is no longer active.

Responses

Request samples

Content type
application/json
{
  • "targetUserIds": [
    ],
  • "targetTenantCodes": [
    ],
  • "validityStartTime": "string",
  • "validityEndTime": "string"
}

Response samples

Content type
application/json
{
  • "errors": true,
  • "badTenantCodes": [
    ],
  • "badUserIds": [
    ],
  • "failedAssignments": [
    ],
  • "successfulAssignments": [
    ]
}

Remove an analytic tenant profile from administrating tenant users

Remove an analytic tenant profile from a list of administrating tenant users for a list of analytic tenants.

Note: Administrating tenants only.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
profileId
required
string

The unique identifier of the profile to remove.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
targetUserIds
Array of strings

The users to remove this profile from.
Array of objects (servicing.TargetTenantCodeDTO)

The analytic tenants for removing profiles from each target user ID.

Responses

Request samples

Content type
application/json
{
  • "targetUserIds": [
    ],
  • "targetTenantCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "badTenantCodes": [
    ],
  • "badUserIds": [
    ],
  • "unaffectedUsers": [
    ],
  • "succeeded": [
    ]
}

Retrieve a profile

Retrieve the details of a specific profile. For administrating tenants, this retrieves the details of administrating tenant profiles.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
profileId
required
string

The unique identifier of the profile to retrieve details for.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "profileId": "string",
  • "displayName": "string",
  • "capabilities": [
    ],
  • "additionalCapabilities": [
    ]
}

Assign a profile to users

Assign a profile to a list of users. For administrating tenants, this assigns an administrating tenant profile to a list of users.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
profileId
required
string

The unique identifier of the profile to assign to a list of users.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
targetUserIds
Array of strings

The users to assign this profile.
validityStartTime
string

An inclusive date-time when this profile is active.
validityEndTime
string

An exclusive date-time when this profile is no longer active.

Responses

Request samples

Content type
application/json
{
  • "targetUserIds": [
    ],
  • "validityStartTime": "string",
  • "validityEndTime": "string"
}

Response samples

Content type
application/json
{
  • "errors": true,
  • "badUserIds": [
    ],
  • "failedAssignments": [
    ],
  • "successfulAssignments": [
    ]
}

Remove a profile from users

Remove a profile from a list of users. For administrating tenants, this removes an administrating tenant profile from a list of users.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
profileId
required
string

The unique identifier of the profile to remove to a list of users.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
targetUserIds
Array of strings

The users to remove this profile from.

Responses

Request samples

Content type
application/json
{
  • "targetUserIds": [
    ]
}

Response samples

Content type
application/json
{
  • "failed": [
    ],
  • "succeeded": [
    ]
}

Retrieve an administrating tenant user's analytic tenant profiles

Retrieve a specified user's assigned profiles for analytic tenants.

Note: Administrating tenants only.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
userId
required
string

The unique identifier of the user to retrieve.

Responses

Response samples

Content type
application/json
{
  • "assignedProfilesForAccessibleTenant": [
    ]
}

Retrieve a user's profiles

Retrieve a specified user's assigned profiles. For administrating tenants, this retrieves a user's administrating tenant profiles.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
userId
required
string

The unique identifier of the user to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "assignedProfiles": [
    ]
}

Permissions

Manage permissions in Visier, such as retrieving the details of a permission, content package, or data access set, creating new permissions and data access sets, and updating or deleting permissions. To assign permissions to users, see Users V1.

Retrieve permission capabilities

Retrieve all permission capabilities in your tenant. Assign returned capabilities to permissions when creating or updating permissions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to retrieve capabilities from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "capabilities": [
    ]
}

Retrieve a permission capability

Retrieve the details of a specific capability.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
capabilityId
required
string

The unique identifier of the capability to retrieve.
queryParameters
tenantCode
string

The tenant to retrieve a capability from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "displayName": "string",
  • "description": "string"
}

Retrieve content packages

Retrieve the list of available content packages. Add returned content packages to permissions when creating or updating permissions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to retrieve content packages from.
searchString
string

Optional search string to return only content packages whose display name or description contains that search string. If searchString is empty or not provided, returns a list of all content packages.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "contentPackages": [
    ]
}

Retrieve a content package

Retrieve the details of a specific content package.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
contentPackageId
required
string

The unique identifier of the content package to retrieve.
queryParameters
tenantCode
string

The tenant to retrieve a content package from.
with
Array of strings

Controls the amount of detail to return in the response. Omit to return basic information.

  • details: Include the content package's artifacts, grouped by artifact type.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "contentPackageId": "string",
  • "displayName": "string",
  • "description": "string",
  • "artifactsByType": [
    ]
}

Retrieve data access sets

Retrieve a list of all shareable data access sets. Data access sets define user access levels for properties and property values of analytic objects in a permission. Data access sets also grant access to properties of subjects referenced by the object. Assign data access sets when creating or updating permissions.

Note: If valid data access sets exceed the default limit of 100, the response status code is 206. Set limit higher to retrieve more.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
analyticObjectId
string

Specify the analytic object ID to retrieve the shareable data access sets for. Default is all analytic objects.
with
Array of strings

The information about the data access set to include in the request response.

  • If unspecified, returns basic information for the data access set, including its unique ID, display name, description, and analytic object ID.
  • If details, returns basic information and property data access information (propertyAccessConfigs).
limit
integer <int32>

The maximum number of data access sets to return. Default is 100. Maximum is 1000.
correlationIds
string

If defined, correlationIds limits the response to the data access sets associated with the specified correlation IDs. You can specify multiple correlation IDs in the correlationIds parameter separated by commas; for example, correlationIds=123,abc,456.

Note:

  • Correlation IDs must be between 3 and 64 characters long and may only contain alphanumeric characters, underscores and hyphens.
  • Correlation IDs have a lifetime of up to 7 days after creation. After a correlation ID expires, you can only retrieve specific data access sets using the data access set ID.
  • Correlation IDs are optional during data access set creation and are only applicable to those objects created with a defined correlation ID.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "dataAccessSets": [
    ]
}

Update shareable data access sets

Update shareable data access sets. Shareable data access sets let you reuse common data access configurations across multiple permissions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.DataAccessSetDTO)

The data access sets to create or update.

Responses

Request samples

Content type
application/json
{
  • "shareablePropertyAccessConfigs": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create shareable data access sets

Create shareable data access sets. Shareable data access sets let you reuse common data access configurations across multiple permissions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.DataAccessSetDTO)

The data access sets to create or update.

Responses

Request samples

Content type
application/json
{
  • "shareablePropertyAccessConfigs": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete shareable data access sets

Delete shareable data access sets.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.DataAccessSetIdDTO)

The data access sets to delete.

Responses

Request samples

Content type
application/json
{
  • "shareablePropertyAccessConfigs": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Revert data access sets

Revert a shareable data access set to its parent version.

Reverting behavior by object type:

  • Blueprint object: No changes. Objects are inherited from the parent.
  • Tenant override object: Reverts to the Blueprint version or administrating tenant version.
  • Tenant object: Request fails. Tenant-unique objects do not have Blueprint versions.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.DataAccessSetIdDTO)

The data access sets to revert.

Responses

Request samples

Content type
application/json
{
  • "shareablePropertyAccessConfigs": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve a data access set

Retrieve details for a specific shareable data access set. You must know the ID to retrieve its details. To retrieve IDs, see GET /v1/admin/data-access-sets.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
dataAccessSetId
required
string

The unique identifier of the data access set to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string",
  • "analyticObjectId": "string",
  • "propertyAccessConfigs": [
    ],
  • "correlationId": "string"
}

Retrieve data security objects

Retrieve the list of available data security objects. Data security objects are analytic objects and their related objects available to define permission security profiles.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
id
Array of strings

The unique identifiers of the data security objects (analytic objects) to retrieve. Default is all data security objects.
includeDetails
boolean

If true, the response includes the analytic objects (display name, ID, and object type), related objects, securable properties, and securable dimensions. If false, the response only includes analytic objects (display name, ID, and object type). Default is false.
tenantCode
string

The tenant to retrieve data security objects from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "analyticObjects": [
    ]
}

Retrieve permissions

Retrieve the full list of user permissions in your tenant.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to retrieve permissions from.
includeDetails
boolean

If true, returns the permission's details. If false, only returns the permission's ID, display name, and description. Default is false.
includeDetailsWithStatus
boolean

If true, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If false, doesn't return validity status information. Default is false.
correlationIds
string

If defined, correlationIds limits the response to the permissions associated with the specified correlation IDs. You can specify multiple correlation IDs in the correlationIds parameter separated by commas; for example, correlationIds=123,abc,456.

Note:

  • Correlation IDs must be between 3 and 64 characters long and may only contain alphanumeric characters, underscores and hyphens.
  • Correlation IDs have a lifetime of up to 7 days after creation. After a correlation ID expires, you can only retrieve specific permissions using the permission ID.
  • Correlation IDs are optional during permission creation and are only applicable to those objects created with a defined correlation ID.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ]
}

Update permissions

Update existing permissions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to update permissions in.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
FastMode
boolean

If true, the API skips loading the tenant's data environment. Use FastMode to reduce latency when you don't need to perform dynamic permission checks, such as checking for the Super Admin permission assignment. Without the environment, permission checks that depend on dynamic, data-driven security, such as group assignments using dynamic populations, fall back to checks resolvable from the requesting user's static user group or direct assignments. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.PermissionDTO)

The permissions to create or update.

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create permissions

Create new permissions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to create permissions in.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
FastMode
boolean

If true, the API skips loading the tenant's data environment. Use FastMode to reduce latency when you don't need to perform dynamic permission checks, such as checking for the Super Admin permission assignment. Without the environment, permission checks that depend on dynamic, data-driven security, such as group assignments using dynamic populations, fall back to checks resolvable from the requesting user's static user group or direct assignments. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.PermissionDTO)

The permissions to create or update.

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete permissions

Delete existing permissions.

To specify the project in which to delete permissions, provide a project UUID in the ProjectID request header.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
tenantCode
string

The tenant to delete permissions from.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
permissionIds
Array of strings

The identifiers of the permissions to delete.

Responses

Request samples

Content type
application/json
{
  • "permissionIds": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Revert permissions

Revert a permission to its parent version.

Reverting behavior by object type:

  • Blueprint object: No changes. Objects are inherited from the parent.
  • Tenant override object: Reverts to the Blueprint version or administrating tenant version.
  • Tenant object: Request fails. Tenant-unique objects do not have Blueprint versions.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
Request Body schema: application/json
required
permissionIds
Array of strings

The identifiers of the permissions to revert.

Responses

Request samples

Content type
application/json
{
  • "permissionIds": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve a permission

Retrieve details for a specified permission.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
permissionId
required
string

The unique identifier of the permission to retrieve.
queryParameters
tenantCode
string

The tenant to retrieve a permission from.
includeDetailsWithStatus
string

If true, returns the validity statuses for the permission's properties in data access sets and the permission's dimensions, dimension members, and hierarchy properties in member filters. If false, doesn't return validity status information. Default is false.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "permissionId": "string",
  • "displayName": "string",
  • "description": "string",
  • "dataSecurityProfiles": [
    ],
  • "adminCapabilityConfig": {
    },
  • "roleModulesConfig": {
    },
  • "sourceSecurityConfig": {
    },
  • "targetSecurityConfig": {
    },
  • "correlationId": "string"
}

Synchronize versioned security artifacts

Copy permissions, data access sets, user groups, and direct user assignments from the versioned environment to the non-versioned environment. This operation immediately applies security configurations, independent of data versioning.

The versioned environment uses projects and data versions, while the non-versioned environment applies changes directly.

This endpoint always synchronizes permissions and data access sets. You can optionally synchronize user group assignments and direct permissions assignments to users.

Use this operation to apply security configurations immediately without waiting for data version changes. This is particularly useful for administrating tenants syncing security artifacts to analytic tenants.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
syncTypes
Array of strings <enum>[ items <enum> ]
ItemsEnum: "UserGroups" "UserDirectAssignments"

Optional types to synchronize. Specify which artifact types to include in the sync operation. Valid values:

  • UserGroups: Synchronizes user group assignments.
  • UserDirectAssignments: Synchronizes direct permission assignments to users.

Data access sets and permissions are always synchronized regardless of this setting.

Responses

Request samples

Content type
application/json
{
  • "syncTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "Unknown",
  • "errors": [
    ]
}

Retrieve security filters

Retrieve all shareable security filters. Security filters define member populations users can access for analytic objects in permissions. Assign security filters when creating or updating permissions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
analyticObjectId
string

The unique identifier of the analytic object to retrieve shareable security filters for. Default is all analytic objects.
with
Array of strings

The security filter information to include in the response.

  • If unspecified, returns basic information for the security filter, including its unique identifier, display name, description, and analytic object ID.
  • If details, returns basic information and dimension filters that define the population in dimensionFilters.
limit
integer <int32>

The maximum number of security filters to return. Default is 100. Maximum is 1000.
correlationIds
string

Filter the security filters to return by correlation ID. Specify multiple correlation IDs as a comma-separated list. For example, correlationIds=123,abc,456.

Note:

  • Correlation IDs must be between 3 and 64 characters long and contain only alphanumeric characters, underscores, and hyphens.
  • Correlation IDs expire 7 days after creation. After expiration, retrieve specific security filters using the security filter ID.
  • Correlation IDs are optional during security filter creation. They apply only to objects created with a defined correlation ID.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "securityFilters": [
    ]
}

Update shareable security filters

Update shareable security filters. Shareable data access sets let you reuse common populations across multiple permissions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
FastMode
boolean

If true, the API skips loading the tenant's data environment. Use FastMode to reduce latency when you don't need to perform dynamic permission checks, such as checking for the Super Admin permission assignment. Without the environment, permission checks that depend on dynamic, data-driven security, such as group assignments using dynamic populations, fall back to checks resolvable from the requesting user's static user group or direct assignments. If your access to all data comes only from a dynamic assignment, the request fails with HTTP 403. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.SecurityFilterDTO)

The security filters to create or update.

Responses

Request samples

Content type
application/json
{
  • "securityFilters": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create shareable security filters

Create shareable security filters. Shareable data access sets let you reuse common populations across multiple permissions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
FastMode
boolean

If true, the API skips loading the tenant's data environment. Use FastMode to reduce latency when you don't need to perform dynamic permission checks, such as checking for the Super Admin permission assignment. Without the environment, permission checks that depend on dynamic, data-driven security, such as group assignments using dynamic populations, fall back to checks resolvable from the requesting user's static user group or direct assignments. If your access to all data comes only from a dynamic assignment, the request fails with HTTP 403. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.SecurityFilterDTO)

The security filters to create or update.

Responses

Request samples

Content type
application/json
{
  • "securityFilters": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete shareable security filters

Delete shareable security filters.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
FastMode
boolean

If true, the API skips loading the tenant's data environment. Use FastMode to reduce latency when you don't need to perform dynamic permission checks, such as checking for the Super Admin permission assignment. Without the environment, permission checks that depend on dynamic, data-driven security, such as group assignments using dynamic populations, fall back to checks resolvable from the requesting user's static user group or direct assignments. If your access to all data comes only from a dynamic assignment, the request fails with HTTP 403. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.SecurityFilterIdDTO)

The security filters to delete.

Responses

Request samples

Content type
application/json
{
  • "securityFilters": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Revert security filters

Revert a shareable security filter to its parent version.

Reverting behavior by object type:

  • Blueprint object: No changes. Objects are inherited from the parent.
  • Tenant override object: Reverts to the Blueprint version or administrating tenant version.
  • Tenant object: Request fails. Tenant-unique objects do not have Blueprint versions.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.
FastMode
boolean

If true, the API skips loading the tenant's data environment. Use FastMode to reduce latency when you don't need to perform dynamic permission checks, such as checking for the Super Admin permission assignment. Without the environment, permission checks that depend on dynamic, data-driven security, such as group assignments using dynamic populations, fall back to checks resolvable from the requesting user's static user group or direct assignments. If your access to all data comes only from a dynamic assignment, the request fails with HTTP 403. Default is false.
Request Body schema: application/json
required
Array of objects (servicing.SecurityFilterIdDTO)

The security filters to revert.

Responses

Request samples

Content type
application/json
{
  • "securityFilters": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve a security filter

Retrieve a specific shareable security filter. You must know the ID of the security filter to retrieve its details. To retrieve security filter IDs, see GET /v1/admin/security-filters.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
securityFilterId
required
string

The unique identifier of the security filter to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
NonVersioned
boolean

If true, the API call executes on non-versioned artifacts and create/update actions take effect without a new production version. If false, the API call executes on versioned artifacts and create/update actions release a new production version. Default is false.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string",
  • "analyticObjectId": "string",
  • "dimensionFilters": [
    ],
  • "correlationId": "string"
}

Tenants V2

Create analytic tenants, deprovision tenants, retrieve tenant information, and update tenant information. Tenants V2 improves upon Tenants V1 in the following ways:

  • Programmatically assign a Home analysis to your analytic tenants.
  • Specify whether to merge or replace values when updating the details of an analytic tenant.
  • Specify the property fields to include in the response for GET requests.

Retrieve analytic tenants

Retrieve the full list of managed analytic tenants, including current states, assigned content modules, and other requested details.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
limit
integer <int32>

The limit of analytic tenants to return. The limit is 1000 if the following fields are not included in the mask.

  • homeAnalysisId
  • homeAnalysisByUserGroup
  • clickThroughLink
  • defaultCurrency

The limit is 400 if any of the above fields are included in the mask or if mask is not specified.
start
integer <int32>

The starting index of the first tenant to return. Default is 0.
mask
string

A list of fields to include in the response, separated by commas. If not specified, includes all fields in the response. Valid values:

  • tenantCode
  • tenantDisplayName
  • currentDataVersion
  • traits
  • dataVersionDate
  • provisionDate
  • vanityUrlName
  • status
  • canAdministerOtherTenants
  • industryCode
  • industryInfo
  • purchasedModules
  • manuallyAddedModules
  • embeddableDomains
  • allowedOAuthIdpUrlDomains
  • customProperties
  • ssoInstanceIssuers
  • homeAnalysisId
  • homeAnalysisByUserGroup
  • clickThroughLink
  • clickThroughLinkEnabled
  • defaultCurrency
  • primaryBusinessLocation
  • effectiveIndustryCode
  • companySize

If mask is specified in both request body and on the query string, the effective mask is the set union of both inputs.
dataProfile
string

Returns tenants with the specified data profile. Valid values: Regular, Integration, Demo, Cat, Test, ProductIntelligence. If omitted, returns all tenants.
tenantCodes
string

A comma-separated string of the tenants to retrieve details for. Specify tenant codes in one of the following formats:

  • Full tenant code. Example: WFF_j1r~c1o.
  • Short tenant code. Example: c1o.

Use the same format for all tenants. Do not use both formats in one request.

Examples:

  • Full: tenantCodes=WFF_j1r~c1o,WFF_j1r~e1a,WFF_j1r~i1o
  • Short: tenantCodes=c1o,e1a,i1o

The limit of analytic tenants to return is 1000 if the following fields are not included in the mask argument.

  • homeAnalysisId
  • homeAnalysisByUserGroup
  • clickThroughLink
  • defaultCurrency

The limit is 400 if any of the above fields are included in the mask or if mask is not specified.

Note: It is recommended to use the request body for long lists of tenant codes. The specified tenant codes are combined (set union) with the tenantCodes query parameter if values for both are provided.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
tenantCodes
Array of strings

The tenants to retrieve details for. Specify tenant codes in one of the following formats:

  • Full tenant code. Example: WFF_j1r~c7o.
  • Short tenant code. Example: c1o.

Use the same format for all tenants. Do not use both formats in one request. The limit of analytic tenants to return is 1000 if the following fields are not included in the mask argument.

  • homeAnalysisId
  • homeAnalysisByUserGroup
  • clickThroughLink
  • defaultCurrency

The limit is 400 if any of the above fields are included in the mask or if mask is not specified.
mask
string

A list of fields to include in the response, separated by commas. If not specified, includes all fields in the response. Valid values:

  • tenantCode
  • tenantDisplayName
  • currentDataVersion
  • traits
  • dataVersionDate
  • provisionDate
  • vanityUrlName
  • status
  • canAdministerOtherTenants
  • industryCode
  • industryInfo
  • purchasedModules
  • manuallyAddedModules
  • embeddableDomains
  • allowedOAuthIdpUrlDomains
  • customProperties
  • ssoInstanceIssuers
  • homeAnalysisId
  • homeAnalysisByUserGroup
  • clickThroughLink
  • clickThroughLinkEnabled
  • defaultCurrency
  • primaryBusinessLocation
  • effectiveIndustryCode
  • companySize

If mask is specified in both request body and on the query string, the effective mask is the set union of both inputs.

Responses

Request samples

Content type
application/json
{
  • "tenantCodes": [
    ],
  • "mask": "string"
}

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "limit": 0,
  • "start": 0
}

Add an analytic tenant

Provision, or create, an analytic tenant before processing and loading its data files. A provisioned analytic tenant is automatically enabled. Loaded data is immediately accessible to users.

Create an analytic tenant and identify the assigned applications. Visier organizes content under modules.

Contact Visier Support to determine your allocated modules.

Note: API requests that contain homeAnalysisId, homeAnalysisByUserGroup, clickThroughLink, or defaultCurrency take longer to run because they publish a project to production.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
tenantCode
string [ 1 .. 50 ] characters^[a-zA-Z][a-zA-Z0-9]+$

An alphanumeric string that represents a unique identifier for the analytic tenant. Required if creating new tenants. Example: If the full tenant code is WFF_j1r~c7o, specify c7o in this field. The maximum is 50 characters for the full tenant code, including the automatically prefixed administrating tenant code (WFF_j1r~ in the example).
tenantDisplayName
string non-empty

A new display name to assign to the analytic tenant. Required if creating new tenants.
tenantShortName
string
Deprecated

This will no longer be available as of Spring 2028. A new short name to assign to the tenant.
vanityUrlName
string

A new vanity name to assign to the tenant. Omit for new Embedded analytic tenants.
industryCode
integer <uint32> non-empty

The North American Industry Classification System (NAICS) code for the industry in which the business operates. Provide a value of 0 to use the business unit industry codes in the data or if the industry code is unknown. We highly recommend that you provide an industry code here or with the business units in the data to take advantage of all of Visier’s features.

Required if creating new tenants.
object

The primary location of operations or where business is performed. This field is optional.
purchasedModules
Array of strings

A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant. Required if creating new tenants.

To get module object names, contact your Partner Success Manager.
embeddableDomains
Array of strings

A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant. This is optional.
Array of objects (admin.CustomPropertyDTO)

A list of objects that represent different customizable properties for the analytic tenant. This is optional.
ssoInstanceIssuers
Array of strings

A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant. This is optional.
homeAnalysisId
string

The unique identifier of the analysis to display for this tenant when a user logs in. This is optional. Causes the API request to take longer because it must publish a project to production.

Retrieve the ID by opening an analysis in the production version of a tenant and copying the string after the last forward slash (/) in the URL. For example: https://jupiter.visier.com/hr/prod/appcontainer?previewId=-eZPm8xvo3SUMpD4Q5pdE-6mCj9CQ9K699XgqRGwtOxagH5x2IzDFawlWn3hYqFEfU7nP0YK9ASEzmrNfAihGg..&previewType=Production#/analytics/myanalyses/8a4c1d4f-eb61-4da0-9e5b-55bef757c30e.

The homeAnalysisID is 8a4c1d4f-eb61-4da0-9e5b-55bef757c30e. Alternatively, retrieve the ID by copying the Analysis ID or contentId found by following the Embed a Visualization documentation.
Array of objects (admin.HomeAnalysisByUserGroupDTO)

The analysis to display to specific user groups when users sign in. This is optional. Causes the API request to take longer because it must publish a project to production.
updateAction
string <enum>
Enum: "MERGE" "REPLACE"

Specifies the way you want to update values. Default is MERGE. Valid values:

  • MERGE: Combine the existing values with the new values.
  • REPLACE: Remove existing values and let the new values take their place.
enabled
boolean

If true, the tenant is enabled. Enabled tenants have access to Visier visualizations.
clickThroughLink
string

A custom URL to redirect users into your portal to see the relevant content. This URL is used for links that are shared by and with your users through the sharing capability, embedded visualizations, or email content. This is optional. Causes the API request to take longer because it must publish a project to production.
defaultCurrency
string

The default currency to show in the application for the tenant.
allowedOAuthIdpUrlDomains
Array of strings

A comma-separated list of strings that represent the URLs, or domains, that are allowed in the idp_url OAuth parameter. This is optional.
object

The tenant's traits, including aggregation rights, tenant type, and data profile type. To set an analytic tenant's traits, contact Visier Technical Support.
forceLoginsWithSessionBasedPermissions
boolean

If true, user sign in must also provide a SessionRepoId. Default is false.
object

The tenant's industry information, including the industry code and classification type. Valid classification systems are NAICS and NACE.

Responses

Request samples

Content type
application/json
{
  • "tenantCode": "string",
  • "tenantDisplayName": "string",
  • "tenantShortName": "string",
  • "vanityUrlName": "string",
  • "industryCode": 0,
  • "primaryBusinessLocation": {
    },
  • "purchasedModules": [
    ],
  • "embeddableDomains": [
    ],
  • "customProperties": [
    ],
  • "ssoInstanceIssuers": [
    ],
  • "homeAnalysisId": "string",
  • "homeAnalysisByUserGroup": [
    ],
  • "updateAction": "MERGE",
  • "enabled": true,
  • "clickThroughLink": "string",
  • "defaultCurrency": "string",
  • "allowedOAuthIdpUrlDomains": [
    ],
  • "traits": {
    },
  • "forceLoginsWithSessionBasedPermissions": true,
  • "industryInfo": {
    }
}

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "tenantDisplayName": "string",
  • "industryCode": 0,
  • "primaryBusinessLocation": {
    },
  • "purchasedModules": [
    ],
  • "embeddableDomains": [
    ],
  • "customProperties": [
    ],
  • "ssoInstanceIssuers": [
    ],
  • "homeAnalysisId": "string",
  • "homeAnalysisByUserGroup": [
    ],
  • "status": "string",
  • "clickThroughLink": "string",
  • "vanityUrlName": "string",
  • "defaultCurrency": "string",
  • "allowedOAuthIdpUrlDomains": [
    ],
  • "forceLoginsWithSessionBasedPermissions": true
}

Retrieve an analytic tenant

Retrieve details for a specified analytic tenant, including current state, assigned content modules, and other relevant details.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant to retrieve.
queryParameters
mask
string

A list of fields to include in the response, separated by commas. If not specified, includes all fields in the response. Valid values:

  • tenantCode
  • tenantDisplayName
  • currentDataVersion
  • traits
  • dataVersionDate
  • provisionDate
  • vanityUrlName
  • status
  • canAdministerOtherTenants
  • industryCode
  • industryInfo
  • purchasedModules
  • manuallyAddedModules
  • embeddableDomains
  • allowedOAuthIdpUrlDomains
  • customProperties
  • ssoInstanceIssuers
  • homeAnalysisId
  • homeAnalysisByUserGroup
  • clickThroughLink
  • clickThroughLinkEnabled
  • defaultCurrency
  • primaryBusinessLocation
  • effectiveIndustryCode
  • companySize

If mask is specified in both request body and on the query string, the effective mask is the set union of both inputs.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
mask
string

A list of fields to include in the response, separated by commas. If not specified, includes all fields in the response. Valid values:

  • tenantCode
  • tenantDisplayName
  • currentDataVersion
  • traits
  • dataVersionDate
  • provisionDate
  • vanityUrlName
  • status
  • canAdministerOtherTenants
  • industryCode
  • industryInfo
  • purchasedModules
  • manuallyAddedModules
  • embeddableDomains
  • allowedOAuthIdpUrlDomains
  • customProperties
  • ssoInstanceIssuers
  • homeAnalysisId
  • homeAnalysisByUserGroup
  • clickThroughLink
  • clickThroughLinkEnabled
  • defaultCurrency
  • primaryBusinessLocation
  • effectiveIndustryCode
  • companySize

If mask is specified in both request body and on the query string, the effective mask is the set union of both inputs.

Responses

Request samples

Content type
application/json
{
  • "mask": "string"
}

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "tenantDisplayName": "string",
  • "status": "string",
  • "provisionDate": "string",
  • "currentDataVersion": "string",
  • "dataVersionDate": "string",
  • "purchasedModules": [
    ],
  • "industryCode": 0,
  • "primaryBusinessLocation": {
    },
  • "canAdministerOtherTenants": true,
  • "embeddableDomains": [
    ],
  • "customProperties": [
    ],
  • "ssoInstanceIssuers": [
    ],
  • "vanityUrlName": "string",
  • "homeAnalysisId": "string",
  • "homeAnalysisByUserGroup": [
    ],
  • "clickThroughLink": "string",
  • "clickThroughLinkEnabled": "string",
  • "defaultCurrency": "string",
  • "allowedOAuthIdpUrlDomains": [
    ],
  • "effectiveIndustryCode": 0,
  • "companySize": 0,
  • "traits": {
    },
  • "industryInfo": {
    },
  • "manuallyAddedModules": [
    ]
}

Update an analytic tenant

Update analytic tenants as they grow or when upgrading available content, or if an analytic tenant transitions across industries.

  • Update tenant industry codes in the Visier system to ensure accurate benchmarks and predictive functionality.
  • Programmatically assign the default Home analysis that analytic tenants see at login for the tenant and specific user groups.

You can update any field on an analytic tenant except tenantCode.

Note: API requests that contain homeAnalysisId, homeAnalysisByUserGroup, clickThroughLink, or defaultCurrency take longer to run because they publish a project to production.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant to update.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
tenantCode
string [ 1 .. 50 ] characters^[a-zA-Z][a-zA-Z0-9]+$

An alphanumeric string that represents a unique identifier for the analytic tenant. Required if creating new tenants. Example: If the full tenant code is WFF_j1r~c7o, specify c7o in this field. The maximum is 50 characters for the full tenant code, including the automatically prefixed administrating tenant code (WFF_j1r~ in the example).
tenantDisplayName
string non-empty

A new display name to assign to the analytic tenant. Required if creating new tenants.
tenantShortName
string
Deprecated

This will no longer be available as of Spring 2028. A new short name to assign to the tenant.
vanityUrlName
string

A new vanity name to assign to the tenant. Omit for new Embedded analytic tenants.
industryCode
integer <uint32> non-empty

The North American Industry Classification System (NAICS) code for the industry in which the business operates. Provide a value of 0 to use the business unit industry codes in the data or if the industry code is unknown. We highly recommend that you provide an industry code here or with the business units in the data to take advantage of all of Visier’s features.

Required if creating new tenants.
object

The primary location of operations or where business is performed. This field is optional.
purchasedModules
Array of strings

A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant. Required if creating new tenants.

To get module object names, contact your Partner Success Manager.
embeddableDomains
Array of strings

A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant. This is optional.
Array of objects (admin.CustomPropertyDTO)

A list of objects that represent different customizable properties for the analytic tenant. This is optional.
ssoInstanceIssuers
Array of strings

A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant. This is optional.
homeAnalysisId
string

The unique identifier of the analysis to display for this tenant when a user logs in. This is optional. Causes the API request to take longer because it must publish a project to production.

Retrieve the ID by opening an analysis in the production version of a tenant and copying the string after the last forward slash (/) in the URL. For example: https://jupiter.visier.com/hr/prod/appcontainer?previewId=-eZPm8xvo3SUMpD4Q5pdE-6mCj9CQ9K699XgqRGwtOxagH5x2IzDFawlWn3hYqFEfU7nP0YK9ASEzmrNfAihGg..&previewType=Production#/analytics/myanalyses/8a4c1d4f-eb61-4da0-9e5b-55bef757c30e.

The homeAnalysisID is 8a4c1d4f-eb61-4da0-9e5b-55bef757c30e. Alternatively, retrieve the ID by copying the Analysis ID or contentId found by following the Embed a Visualization documentation.
Array of objects (admin.HomeAnalysisByUserGroupDTO)

The analysis to display to specific user groups when users sign in. This is optional. Causes the API request to take longer because it must publish a project to production.
updateAction
string <enum>
Enum: "MERGE" "REPLACE"

Specifies the way you want to update values. Default is MERGE. Valid values:

  • MERGE: Combine the existing values with the new values.
  • REPLACE: Remove existing values and let the new values take their place.
enabled
boolean

If true, the tenant is enabled. Enabled tenants have access to Visier visualizations.
clickThroughLink
string

A custom URL to redirect users into your portal to see the relevant content. This URL is used for links that are shared by and with your users through the sharing capability, embedded visualizations, or email content. This is optional. Causes the API request to take longer because it must publish a project to production.
defaultCurrency
string

The default currency to show in the application for the tenant.
allowedOAuthIdpUrlDomains
Array of strings

A comma-separated list of strings that represent the URLs, or domains, that are allowed in the idp_url OAuth parameter. This is optional.
object

The tenant's traits, including aggregation rights, tenant type, and data profile type. To set an analytic tenant's traits, contact Visier Technical Support.
forceLoginsWithSessionBasedPermissions
boolean

If true, user sign in must also provide a SessionRepoId. Default is false.
object

The tenant's industry information, including the industry code and classification type. Valid classification systems are NAICS and NACE.

Responses

Request samples

Content type
application/json
{
  • "tenantCode": "string",
  • "tenantDisplayName": "string",
  • "tenantShortName": "string",
  • "vanityUrlName": "string",
  • "industryCode": 0,
  • "primaryBusinessLocation": {
    },
  • "purchasedModules": [
    ],
  • "embeddableDomains": [
    ],
  • "customProperties": [
    ],
  • "ssoInstanceIssuers": [
    ],
  • "homeAnalysisId": "string",
  • "homeAnalysisByUserGroup": [
    ],
  • "updateAction": "MERGE",
  • "enabled": true,
  • "clickThroughLink": "string",
  • "defaultCurrency": "string",
  • "allowedOAuthIdpUrlDomains": [
    ],
  • "traits": {
    },
  • "forceLoginsWithSessionBasedPermissions": true,
  • "industryInfo": {
    }
}

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "tenantDisplayName": "string",
  • "industryCode": 0,
  • "primaryBusinessLocation": {
    },
  • "purchasedModules": [
    ],
  • "embeddableDomains": [
    ],
  • "customProperties": [
    ],
  • "ssoInstanceIssuers": [
    ],
  • "homeAnalysisId": "string",
  • "homeAnalysisByUserGroup": [
    ],
  • "status": "string",
  • "clickThroughLink": "string",
  • "vanityUrlName": "string",
  • "defaultCurrency": "string",
  • "allowedOAuthIdpUrlDomains": [
    ],
  • "forceLoginsWithSessionBasedPermissions": true
}

Deprovision an analytic tenant

Warning! Deprovisioning an analytic tenant is not reversible. Disable an analytic tenant before deprovisioning it. For more information, see PUT /v1/admin/tenants/{tenantId}/disable.

This endpoint permanently removes an analytic tenant from the Visier system. Disable the tenant instead if it may be re-enabled on any Visier module later.

A successful response returns the Deprovisioned status. This indicates that the tenant is scheduled for deprovisioning, which may take several days.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "status": "string",
  • "tenantDisplayName": "string",
  • "canAdministerOtherTenants": true
}

Tenants V1

Create analytic tenants, retrieve tenant information, and validate metric values.

Retrieve analytic tenants

Retrieve the full list of managed analytic tenants, including current states, assigned content modules, and other requested details.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
limit
integer <int32>

The maximum number of tenants to return. Default is 0.
start
integer <int32>

The starting index of the first tenant to return. Default is 0.
details
boolean

If true, returns information about the data version and modules.

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "limit": 0,
  • "start": 0
}

Add an analytic tenant

Provision, or create, an analytic tenant before processing and loading its data files. A provisioned tenant is automatically enabled. Loaded data is immediately accessible to users.

Create an analytic tenant and identify assigned applications. Visier organizes content under modules.

Contact Visier Support to determine your allocated modules.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
tenantCode
required
string [ 1 .. 50 ] characters^[a-zA-Z][a-zA-Z0-9]+$

An alphanumeric string that represents the unique identifier of the analytic tenant. Example: If the full tenant code is WFF_j1r~c7o, specify c7o in this field. The maximum is 50 characters for the full tenant code, including the automatically prefixed administrating tenant code (WFF_j1r~ in the example).
tenantDisplayName
required
string non-empty

The display name that is assigned to the analytic tenant.
purchasedModules
Array of strings

A comma-separated list of strings that represent the Visier modules assigned to the analytic tenant.
industryCode
integer <uint32>

The North American Industry Classification System (NAICS) code for the industry in which the business operates. Provide a value of 0 to use the business unit industry codes in the data or if the industry code is unknown. We highly recommend that you provide an industry code here or with the business units in the data to take advantage of all of Visier’s features.
embeddableDomains
Array of strings

A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant.
Array of objects (admin.CustomTenantPropertyDTO)

A set of key-value pairs that represent different customizable properties for the analytic tenant.
ssoInstanceIssuers
Array of strings

A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant.
allowedOAuthIdpUrlDomains
Array of strings

A comma-separated list of strings that represent the URLs, or domains, which can be used as values for the idp_url OAuth parameter.

Responses

Request samples

Content type
application/json
{
  • "tenantCode": "string",
  • "tenantDisplayName": "string",
  • "purchasedModules": [
    ],
  • "industryCode": 0,
  • "embeddableDomains": [
    ],
  • "customProperties": [
    ],
  • "ssoInstanceIssuers": [
    ],
  • "allowedOAuthIdpUrlDomains": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "tenantDisplayName": "string",
  • "purchasedModules": [
    ],
  • "industryCode": 0,
  • "embeddableDomains": [
    ],
  • "customProperties": [
    ],
  • "ssoInstanceIssuers": [
    ],
  • "allowedOAuthIdpUrlDomains": [
    ]
}

Add analytic tenants

Provision, or create, analytic tenants before processing and loading data files. Provisioned tenants are automatically enabled. Loaded data is immediately accessible to users.

Create up to 200 analytic tenants in one request and identify assigned applications.

Contact Visier Support to determine your allocated modules.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
Array of objects (admin.TenantProvisionAPIDTO)

An array of tenants to create. The maximum number of tenants to create in one request is 200.

Responses

Request samples

Content type
application/json
{
  • "tenants": [
    ]
}

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Retrieve an analytic tenant

Retrieve details for a specified analytic tenant, including current state, assigned content modules, and other relevant details.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.

Responses

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "tenantDisplayName": "string",
  • "status": "string",
  • "provisionDate": "string",
  • "currentDataVersion": "string",
  • "dataVersionDate": "string",
  • "modules": [
    ],
  • "industryCode": 0,
  • "canAdministerOtherTenants": true,
  • "embeddableDomains": [
    ],
  • "customProperties": [
    ],
  • "ssoInstanceIssuers": [
    ],
  • "vanityUrlName": "string",
  • "allowedOAuthIdpUrlDomains": [
    ],
  • "manuallyAddedModules": [
    ]
}

Update an analytic tenant

Update analytic tenants as they grow, upgrade content, or transition across industries.

Update industry codes in the Visier system to ensure accurate benchmarks and predictive functionality.

You can update any field on an analytic tenant except tenantCode.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant to update.
Request Body schema: application/json
required
tenantDisplayName
string

A display name that is assigned to the new analytic tenant.
industryCode
integer <int32>

The 6-digit NAICS code for the industry to which the analytic tenant belongs. If the code is unknown, type 0.

For 2-digit codes, add trailing zeros at the end to reach 6 digits, such as 620000.
purchasedModules
Array of strings

A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant.
embeddableDomains
Array of strings

A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant.
object

A set of key-value pairs that represent different customizable properties for the analytic tenant.
ssoInstanceIssuers
Array of strings

A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant.

Responses

Request samples

Content type
application/json
{
  • "tenantDisplayName": "string",
  • "industryCode": 0,
  • "purchasedModules": [
    ],
  • "embeddableDomains": [
    ],
  • "customProperties": {
    },
  • "ssoInstanceIssuers": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "tenantDisplayName": "string",
  • "purchasedModules": [
    ],
  • "industryCode": 0,
  • "embeddableDomains": [
    ],
  • "customProperties": [
    ],
  • "ssoInstanceIssuers": [
    ],
  • "allowedOAuthIdpUrlDomains": [
    ]
}

Deprovision an analytic tenant

Warning! Deprovisioning an analytic tenant is not reversible. Disable an analytic tenant before deprovisioning it. For more information, see PUT /v1/admin/tenants/{tenantId}/disable.

This endpoint permanently removes an analytic tenant from the Visier system. Disable the tenant instead if it may be re-enabled on any Visier module later.

A successful response returns the Deprovisioned status. This indicates that the tenant is scheduled for deprovisioning, which may take several days.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.

Responses

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "status": "string",
  • "tenantDisplayName": "string",
  • "canAdministerOtherTenants": true
}

Disable an analytic tenant

Disable an analytic tenant and remove visualization access for its users. Disable an analytic tenant before deprovisioning it from the system.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.

Responses

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "status": "string",
  • "tenantDisplayName": "string",
  • "canAdministerOtherTenants": true
}

Enable an analytic tenant

An analytic tenant is enabled after provisioning or creation. Use this endpoint to enable a previously-disabled tenant to restore user access to Visier visualizations.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.

Responses

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "status": "string",
  • "tenantDisplayName": "string",
  • "canAdministerOtherTenants": true
}

Validate metric values for all analytic tenants

Validate user-visible data against exported source systems as you onboard analytic tenants.

The metric values in the response are configured summary metrics. Administrators 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.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
limit
integer <int32>

The limit of analytic tenant details to retrieve.
start
integer <int32>

The starting index of the first result to return. Default is 0.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ],
  • "limit": 0,
  • "start": 0
}

Validate an analytic tenant's metric values

Retrieve metric values for an individual analytic tenant. Metric values in the response are configured summary metrics. Administrators 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.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~{YYY} where {XXX} is the administrating tenant code and {YYY} is the analytic tenant code.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "tenantCode": "string",
  • "dataVersion": "string",
  • "dataVersionDate": "string",
  • "metrics": [
    ]
}

Consolidated Analytics

Manage your consolidated analytics (CA) tenants in Visier, such as retrieving the details of CA tenants, creating CA tenants, adding or deleting source tenants from CA tenants, and excluding sources from CA tenants.

Note: 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 Success Manager (CSM).

Retrieve consolidated analytics tenants

Retrieve the full list of consolidated analytics tenants in your administrating tenant.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
limit
integer <int32>

The maximum number of tenants to return. Default is 400. Maximum is 1000.
start
integer <int32>

The starting index of the first tenant to return. Default is 0.

Responses

Response samples

Content type
application/json
{
  • "tenantCodes": [
    ]
}

Create a consolidated analytics tenant

Create a consolidated analytics tenant.

A new CA tenant has no source tenants and no excluded sources.

Note: CA tenant codes must have a prefix of CA. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
tenantCode
string

The unique identifier of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.

Responses

Request samples

Content type
application/json
{
  • "tenantCode": "string"
}

Response samples

Content type
application/json
{
  • "tenantCode": "string"
}

Retrieve the details of all consolidated analytics tenants

Retrieve the full list of consolidated analytics tenants and their details in your administrating tenant.

Note: If your consolidated analytics tenants have thousands of source tenants, use GET /v1alpha/admin/consolidated-analytics/tenants to get all CA tenants, then use GET /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants and GET /v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources to retrieve details for specific CA tenants.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
limit
integer <int32>

The maximum number of tenants to return. Default is 400. Maximum is 1000.
start
integer <int32>

The starting index of the first tenant to return. Default is 0.

Responses

Response samples

Content type
application/json
{
  • "tenants": [
    ]
}

Retrieve a consolidated analytics tenant's excluded sources

Retrieve a CA tenant's excluded sources.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.

Responses

Response samples

Content type
application/json
{
  • "excludedSources": [
    ]
}

Set a consolidated analytics tenant's excluded sources

Define the excluded sources for a consolidated analytics tenant.

After creating a CA tenant, define excluded sources to exclude their data from the CA tenant. You can also use this endpoint to replace excluded sources for an existing CA tenant.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
Request Body schema: application/json
required
excludedSources
Array of strings

A list of a CA tenant's excluded sources.

Responses

Request samples

Content type
application/json
{
  • "excludedSources": [
    ]
}

Response samples

Content type
application/json
{
  • "excludedSources": [
    ]
}

Remove excluded sources from a consolidated analytics tenants

Remove excluded sources from the list of excluded sources for a consolidated analytics tenant.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
Request Body schema: application/json
required
excludedSources
Array of strings

A list of a CA tenant's excluded sources.

Responses

Request samples

Content type
application/json
{
  • "excludedSources": [
    ]
}

Response samples

Content type
application/json
{
  • "excludedSources": [
    ]
}

Add excluded sources to a consolidated analytics tenant

Add excluded sources to the list of excluded sources for a consolidated analytics tenant.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
Request Body schema: application/json
required
excludedSources
Array of strings

A list of a CA tenant's excluded sources.

Responses

Request samples

Content type
application/json
{
  • "excludedSources": [
    ]
}

Response samples

Content type
application/json
{
  • "excludedSources": [
    ]
}

Retrieve a consolidated analytics tenant's source tenants

Retrieve a CA tenant's source tenants.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
queryParameters
limit
integer <int32>

The maximum number of source tenants to return. Default is 400. Maximum is 1000.
start
integer <int32>

The starting index of the first source tenant to return. Default is 0.

Responses

Response samples

Content type
application/json
{
  • "tenantCodes": [
    ]
}

Set a consolidated analytics tenant's source tenants

Define the source tenants for a consolidated analytics tenant.

After creating a CA tenant, define its source tenants. Source tenants provide data that aggregates into the CA tenant. You can also use this endpoint to replace source tenants for an existing CA tenant.

If successful, returns an updated list of source tenants.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
queryParameters
limit
integer <int32>

The maximum number of source tenants to return. Default is 400. Maximum is 1000.
Request Body schema: application/json
required
tenantCodes
Array of strings

A list of a CA tenant's source tenants codes. The maximum length is 1000.

Responses

Request samples

Content type
application/json
{
  • "tenantCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantCodes": [
    ]
}

Remove source tenants from a consolidated analytics tenants

Remove source tenants from the list of source tenants for a consolidated analytics tenant.

If successful, returns an updated list of source tenants.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
queryParameters
limit
integer <int32>

The maximum number of source tenants to return. Default is 400. Maximum is 1000.
Request Body schema: application/json
required
tenantCodes
Array of strings

A list of a CA tenant's source tenants codes. The maximum length is 1000.

Responses

Request samples

Content type
application/json
{
  • "tenantCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantCodes": [
    ]
}

Add source tenants to a consolidated analytics tenant

Add source tenants to the list of source tenants for a consolidated analytics tenant.

If successful, returns an updated list of source tenants.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
tenantId
required
string

The unique identifier of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY} is the consolidated analytic tenant code.
queryParameters
limit
integer <int32>

The maximum number of source tenants to return. Default is 400. Maximum is 1000.
Request Body schema: application/json
required
tenantCodes
Array of strings

A list of a CA tenant's source tenants codes. The maximum length is 1000.

Responses

Request samples

Content type
application/json
{
  • "tenantCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantCodes": [
    ]
}

Sources

Export and import sources in Visier.

Note: This API is in beta. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).

Perform an operation on all sources

Perform operations on all sources. Supported operations:

  • exportSources: Export a ZIP file containing a list of all sources in the application.
  • cloneFilesIntoSource: Clone source files into a different source.


Note: This API is in beta. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
operation
string <enum>
Enum: "unknownSourcesAPIOperation" "exportSources" "cloneFilesIntoSource"

The operation to perform. Valid values:

  • exportSources: Export sources from the tenant. If successful, returns a ZIP file containing a compressed JSON file with the sources.
  • cloneFilesIntoSource: Clone a source's files into a different source. If successful, returns a receiving job ID. Use the job ID to monitor the cloning results.
object

The parameters for the exportSources option. If neither parameter is specified, exports all sources. If both parameters are specified, exports the sources that match values from both parameters.
object

The parameters for the cloneFilesIntoSource option, such as the source to clone files from, the source to clone files into, and the date range of the files to clone.

Responses

Request samples

Content type
application/json
{
  • "operation": "unknownSourcesAPIOperation",
  • "exportSourcesParameters": {
    },
  • "cloneFilesIntoSourceParameters": {
    }
}

Response samples

Content type
application/json
{ }

Import a list of sources

Import a list of sources in ZIP format. The file must be an export from POST /v1beta/admin/sources. Use this endpoint after making changes in a development environment to copy the changes to your production environment.

Note: This API is in beta. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your Customer Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
replaceAllExistingSources
boolean

If false, adds the sources from the ZIP to the sources in the target tenant. If true, removes all sources in the target tenant and adds the sources from the ZIP. Default is false.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/zip
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "summary": {
    }
}

System Status

Check the health and status of Visier's platform and services.

Retrieve Visier's system status

Check the current overall status of Visier's systems.

Overall status values:

  • UP : All systems are operational.
  • DOWN: At least one system is not fully operational.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "overall": "string"
}

Retrieve Visier's system status

Check the current overall status of Visier's systems.

Overall status values:

  • UP : All systems are operational.
  • DOWN: At least one system is not fully operational.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "overall": "string"
}

Email Domains

Manage the list of user email address domains that are allowed in your tenant.

Note: 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 Success Manager (CSM).

Retrieve allowed email domains

Retrieve the full list of allowed email domains.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

Add domains to the list of allowed domains

Add email address domains to the allowed domains list. The response returns an updated list of allowed email domains.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
domains
Array of strings

The list of allowed email address domains.

Responses

Request samples

Content type
application/json
{
  • "domains": [
    ]
}

Response samples

Content type
application/json
{
  • "domains": [
    ]
}

Remove domains from the list of allowed domains

Delete email address domains from the allowed domains list. The response returns an updated list of allowed email domains.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
domains
Array of strings

The list of allowed email address domains.
confirmNotAllowedDomain
boolean

If true, allows deletion of the requester's own domain when using credential-based sign in. If false, prevents deletion of the requester's own domain when using credential-based sign in. This setting only applies to credential-based sign in, not to single sign-on (SSO) unless used in API calls.

Responses

Request samples

Content type
application/json
{
  • "domains": [
    ],
  • "confirmNotAllowedDomain": true
}

Response samples

Content type
application/json
{
  • "domains": [
    ],
  • "confirmNotAllowedDomain": true
}

Encryption Keys

Manage the encryption keys in your Visier tenant. For PGP keys, see /v1/api/pgp-keys.

Note: 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 Success Manager (CSM).

Retrieve encryption keys

Retrieve a list of all encryption keys, including key name, algorithm, creator, creation date, and expiration date.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)

Responses

Response samples

Content type
application/json
{
  • "keyDetails": [
    ]
}

Generate an encryption key

Create an encryption key using a specific algorithm. The algorithm must be one of HmacSHA224, HmacSHA256, HmacSHA384, or HmacSHA512.

In the request body, set the algorithm, provide a display name, and optionally set the UTC expiration date in ISO 8601 format. Must be between 2 and 10 years. Default is 2 years.

Each tenant supports up to 5 encryption keys.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
keyName
string

The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 6 and 36 characters long.
expiryDate
string

The UTC expiration date of the key in ISO 8601 format. Must be between 2 and 10 years. Default is 2 years.
algorithm
string

The hash-based message authentication code and cryptographic hash function associated with the encryption key. Must be one of HmacSHA224, HmacSHA256, HmacSHA384, or HmacSHA512.

Responses

Request samples

Content type
application/json
{
  • "keyName": "string",
  • "expiryDate": "string",
  • "algorithm": "string"
}

Response samples

Content type
application/json
{
  • "detail": {
    },
  • "key": "string"
}

Delete an encryption key

Delete a specific encryption key.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
keyName
required
string

The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 3 and 36 characters long.

Responses

Response samples

Content type
application/json
{
  • "keyName": "string"
}

Network Subnets

Manage the IP addresses that can call Visier APIs.

Note: 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 Success Manager (CSM).

Retrieve API network subnets

Retrieve a list of all IP addresses that can call Visier APIs.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "networkSubnetsForApi": [
    ]
}

Update API network subnets

Overwrite the allowed network subnets list with a new list. Use Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted IP addresses are removed from the allowlist. Retrieve the current list before updating.

Note: Updating allowed network subnets may remove your current IP address and lock you out from making API calls. Visier doesn't allow lockouts unless confirmLockout is true. Default is false.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
networkSubnetsForApi
Array of strings

The IP addresses in the request.
confirmLockout
boolean

If true, you acknowledge that the API call removes your IP address from the list of allowed network subnets and you will not be able to call Visier APIs from your current IP address. Default is false. To avoid this, add your current IP address to the allowed network subnets list.

Responses

Request samples

Content type
application/json
{
  • "networkSubnetsForApi": [
    ],
  • "confirmLockout": true
}

Response samples

Content type
application/json
{
  • "networkSubnetsForApi": [
    ]
}

Add API network subnets

Add IP addresses to the allowed network subnets list that can call Visier APIs. Use Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
networkSubnetsForApi
Array of strings

The IP addresses in the request.
confirmLockout
boolean

If true, you acknowledge that the API call removes your IP address from the list of allowed network subnets and you will not be able to call Visier APIs from your current IP address. Default is false. To avoid this, add your current IP address to the allowed network subnets list.

Responses

Request samples

Content type
application/json
{
  • "networkSubnetsForApi": [
    ],
  • "confirmLockout": true
}

Response samples

Content type
application/json
{
  • "networkSubnetsForApi": [
    ]
}

Delete API network subnets

Remove IP addresses from the allowed network subnets list that can call Visier APIs. Use Classless Inter-Domain Routing (CIDR) format: xxx.xxx.xxx.xxx/xx.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted IP addresses are removed from the allowlist. Retrieve the current list before updating.

Note: Deleting allowed network subnets may remove your current IP address and lock you out from making API calls. Visier doesn't allow lockouts unless confirmLockout is true. Default is false.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
networkSubnetsForApi
Array of strings

The IP addresses in the request.
confirmLockout
boolean

If true, you acknowledge that the API call removes your IP address from the list of allowed network subnets and you will not be able to call Visier APIs from your current IP address. Default is false. To avoid this, add your current IP address to the allowed network subnets list.

Responses

Request samples

Content type
application/json
{
  • "networkSubnetsForApi": [
    ],
  • "confirmLockout": true
}

Response samples

Content type
application/json
{
  • "networkSubnetsForApi": [
    ]
}

Sidecar Solutions

Manage your sidecar solution's configuration. A sidecar solution is a unique solution built using the Visier platform, such as Smart Compensation. Use this API to retrieve the current settings, update the settings to new values, or delete existing settings.

Note: 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 Success Manager (CSM).

Retrieve a sidecar solution's settings

Retrieve settings for a specific sidecar solution. Contact Visier Technical Support to get your solution ID.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
applicationId
required
string

The unique identifier of the solution to configure.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "configs": [
    ],
  • "applicationId": "string"
}

Update a sidecar solution's settings

Update sidecar solution settings. The response returns updated settings. Retrieve existing settings with GET before updating.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted values are removed.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
applicationId
required
string

The unique identifier of the solution to configure.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (servicing.SettingsDTO)

The available configuration settings.
applicationId
string

The unique identifier of the solution to configure.

Responses

Request samples

Content type
application/json
{
  • "configs": [
    ],
  • "applicationId": "string"
}

Response samples

Content type
application/json
{
  • "configs": [
    ],
  • "applicationId": "string"
}

Delete a sidecar solution's settings

Delete the settings for a sidecar solution. This deletes all the settings for the solution.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
applicationId
required
string

The unique identifier of the solution to configure.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
applicationId
string

The unique identifier of the solution to configure.

Responses

Request samples

Content type
application/json
{
  • "applicationId": "string"
}

Release Versions

Manage the Visier product release versions for your tenants.

Note: This API is available for Embedded Partners.
Note: 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 Success Manager (CSM).

Retrieve available product releases

Retrieve a list of release versions available for each product. The response returns information such as the unique ID of the product, the latest release version, and when the latest release version of the product will automatically be activated. Sometimes, the previous and latest versions are the same.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)

Responses

Response samples

Content type
application/json
{
  • "releases": [
    ]
}

Retrieve active product release versions

Retrieve the currently active product release versions for a tenant.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ]
}

Activate product release versions

Set the product release version to activate it on selected tenants. Analytic tenants automatically inherit the release version from the administrating tenant. You cannot roll back to a previous version.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
Array of objects (admin.ProductVersionDTO)

A list of products and their current release versions for a tenant.

Responses

Request samples

Content type
application/json
{
  • "versions": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Data Version Snapshots

Create and manage data version snapshots. Creating a snapshot retains a specific data version so that it remains available and is not removed by routine cleanup.

Note: 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 Success Manager (CSM).

Retrieve data version snapshots

Retrieve all data version snapshots in the tenant.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "dataVersionSnapshots": [
    ]
}

Create a data version snapshot

Create a data version snapshot. If omitted, the snapshot defaults to the latest data and production versions.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
name
string

The display name of the snapshot.
description
string

An optional description of the snapshot.
dataVersionId
string

The data version to capture. Default is the latest production version.
productionVersionId
string

The production version to associate with the snapshot. Default is the latest production version.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "dataVersionId": "string",
  • "productionVersionId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "dataVersionId": "string",
  • "productionVersionId": "string",
  • "createdAt": "string",
  • "creatorId": "string"
}

Retrieve a data version snapshot

Retrieve the details of a data version snapshot. You must know the ID of the snapshot to retrieve its details. To retrieve snapshot IDs, see GET /v1alpha/admin/data-version-snapshots.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the data version snapshot to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "dataVersionId": "string",
  • "productionVersionId": "string",
  • "createdAt": "string",
  • "creatorId": "string"
}

Delete a data version snapshot

Delete a data version snapshot. Deleting the last snapshot for a data version allows routine cleanup to remove that data version.

Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the data version snapshot to delete.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Data Model

Discover objects in your Visier solution and view schema details. Retrieve objects by listing all objects or by object ID. Object types available in data model APIs:

  • Analytic objects
  • Properties
  • Dimensions
  • Selection concepts
  • Metrics
  • Predictions
  • Vee sample questions and categories

Retrieve analytic objects

Retrieve all analytic objects in your Visier solution.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
id
Array of strings

The unique identifiers of the analytic objects to retrieve. Default is all analytic objects.
objectType
string

The object type to filter the returned analytic objects by.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "analyticObjects": [
    ]
}

Retrieve an analytic object

Retrieve a specific analytic object. You must know the ID of an analytic object to retrieve its details. To retrieve analytic object IDs, see GET /v1/data/model/analytic-objects.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the analytic object to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string",
  • "type": "SUBJECT",
  • "dataStartDate": "string",
  • "dataEndDate": "string",
  • "propertyIds": [
    ],
  • "dimensionIds": [
    ],
  • "selectionConceptIds": [
    ],
  • "objectReferences": [
    ],
  • "populationConfiguration": {
    },
  • "defaultSelectionConcept": {
    }
}

Retrieve metrics for an analytic object

Retrieve metrics for a specific analytic object. You must know the ID of an analytic object to retrieve its metrics. To retrieve analytic object IDs, see GET /v1/data/model/analytic-objects.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the analytic object to retrieve metrics for.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "metrics": [
    ]
}

Retrieve dimensions by analytic object

Retrieve dimensions for a specific analytic object. You must know the ID of an analytic object to retrieve its dimensions. To retrieve analytic object IDs, see GET /v1/data/model/analytic-objects.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectId
required
string

The unique identifier of the analytic object to retrieve.
queryParameters
id
Array of strings

The unique identifiers of the dimensions to retrieve. Default is all dimensions.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "dimensions": [
    ]
}

Validate a member map's unmapped dimension members

Validate a dimension in a member map. Returns the member map ID, requested dimension ID, unmapped members, and error details.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectId
required
string

The unique identifier of the analytic object.
dimensionId
required
string

The unique identifier of a dimension of the member map.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
memberMapId
string

The unique identifier of the member map to validate.
analyticObject
string

The analytic object associated with the member map.

Responses

Request samples

Content type
application/json
{
  • "memberMapId": "string",
  • "analyticObject": "string"
}

Response samples

Content type
application/json
{
  • "dimensionMapId": "string",
  • "dimensionId": "string",
  • "unmappedMembers": [
    ],
  • "failures": [
    ]
}

Retrieve dimension members by analytic object

Retrieve dimension members for an analytic object. Dimension members exist in fixed or non-uniform hierarchies. Leveled dimensions have fixed hierarchies, while parent-child dimensions have non-uniform levels. Returns the dimension level and path. Example for Vancouver in a Location dimension:

  • All > Canada > British Columbia > Vancouver

Parent-child hierarchies are non-uniform and include dynamic traits, such as time dependence and data attributes. The response includes elements expressing validity ranges for retrieved members.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectId
required
string

The unique identifier of the analytic object.
dimensionId
required
string

The unique identifier of the dimension.
queryParameters
id
Array of strings

The unique identifiers of the members to retrieve. Default is all members.
maxLevel
integer <int32>

The maximum level in the hierarchy to retrieve. The top level of the hierarchy is 0. Default is all levels.
filter
string

A regular expression that members must match to be retrieved. Default is all members.
field
string

Indicates the aspect of the member to apply the filter to. Default is id. Valid values:

  • id: Match the filter to the member ID.
  • display: Match the filter to the member's display name.
  • either: Match the filter to the member ID or display name.
includeDataMembers
boolean

If true, data members are included in the response. Parent-child dimensions only. Default is false.
offset
integer <int32>

For paginated member requests against high-cardinality dimensions, the offset of the first member to retrieve. Default is 0. If offset is a non-default value, all other non-pagination parameters are ignored.
limit
integer <int32>

For paginated member requests against high-cardinality dimensions, the maximum number of members to retrieve. Default is -1 to return up to 15,000 members. If limit is a non-default value, all other non-pagination parameters are ignored. If pagination occurs, the response status code is 206.
sortType
string

The order of the members in the response. Default is natural. Valid values:

  • configured: Sorts members according to their configuration. For parent-child dimensions, sorts members by name in ascending order. For other dimensions, sorts members by their configured order in Studio.
  • natural: Doesn't sort the members.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "members": [
    ]
}

Retrieve a dimension member by analytic object

Retrieve a specific dimension member for an analytic object and dimension.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectId
required
string

The unique identifier of the analytic object.
dimensionId
required
string

The unique identifier of the dimension.
id
required
string
queryParameters
Id
string

The unique identifier of the member to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "members": [
    ]
}

Retrieve a dimension by analytic object

Retrieve a specific dimension for an analytic object. You must know the IDs of the analytic object and dimension to retrieve the dimension details. To retrieve the IDs, see GET /v1/data/model/analytic-objects and GET /v1/data/model/analytic-objects/{objectId}/dimensions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectId
required
string

The unique identifier of the analytic object to retrieve.
id
required
string

The unique identifier of the dimension to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string",
  • "levels": [
    ],
  • "unknownMember": [
    ],
  • "memberCount": 0,
  • "visibleInApp": true,
  • "tags": [
    ],
  • "explanation": "string"
}

Retrieve properties

Retrieve properties for a specific analytic object. You must know the ID of an analytic object to retrieve its properties. To retrieve analytic object IDs, see GET /v1/data/model/analytic-objects.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectId
required
string

The unique identifier of the analytic object to retrieve.
queryParameters
id
Array of strings

The unique identifiers of the properties to retrieve. Default is all properties.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "properties": [
    ]
}

Retrieve a property

Retrieve a specific property for an analytic object. You must know the IDs of the analytic object and property to retrieve the property details. To retrieve the IDs, see GET /v1/data/model/analytic-objects and GET /v1/data/model/analytic-objects/{objectId}/properties.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectId
required
string

The unique identifier of the analytic object to retrieve.
id
required
Array of strings

The unique identifier of the property to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string",
  • "dataType": "string",
  • "primitiveDataType": "string",
  • "parameters": [
    ],
  • "tags": [
    ],
  • "explanation": "string"
}

Retrieve selection concepts by analytic object

Retrieve selection concepts for a specific analytic object. You must know the ID of an analytic object to retrieve its selection concepts. To retrieve analytic object IDs, see GET /v1/data/model/analytic-objects.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectId
required
string

The unique identifier of the analytic object to retrieve.
queryParameters
id
Array of strings

The unique identifiers of the selection concepts to retrieve. Default is all selection concepts.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "selectionConcepts": [
    ]
}

Retrieve a selection concept by analytic object

Retrieve a specific selection concept by ID for an analytic object. You must know the IDs of the analytic object and selection concept to retrieve the concept details. To retrieve the IDs, see GET /v1/data/model/analytic-objects and GET /v1/data/model/analytic-objects/{objectId}/selection-concepts.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectId
required
string

The unique identifier of the analytic object to retrieve.
id
required
string

The unique identifier of the selection concept to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string",
  • "visibleInApp": true,
  • "tags": [
    ],
  • "explanation": "string"
}

Retrieve currencies

Retrieve available currencies in your Visier solution.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "currencies": [
    ],
  • "tenantReportingCurrencyCode": "string",
  • "userPreferredCurrencyCode": "string"
}

Retrieve a currency

Retrieve a specific currency by currency code.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The currency code in ISO 4217 format.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "currencyCode": "string",
  • "displayName": "string",
  • "symbol": "string",
  • "shortSymbol": "string"
}

Retrieve a currency's exchange rates

Retrieve exchange rates for a specific currency. Optionally specify query parameter options for the returned rates, such as rounding precision for returned rates.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The currency to get rates for in ISO 4217 format.
queryParameters
startTime
string

The earliest time instant to retrieve exchange rates from. Default is 0 milliseconds.
endTime
string

The latest time instant to retrieve exchange rates from. Default is the time of this request in milliseconds.
decimals
string

The number of decimals to round exchange rates to. Default is 2 decimal places.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "currencyRates": [
    ]
}

Retrieve exchange rates between currencies

Retrieve exchange rates from one currency to another. Optionally specify query parameter options for the returned rates, such as rounding precision for returned rates.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The currency to convert from in ISO 4217 format.
toId
required
string

The currency to convert to in ISO 4217 format.
queryParameters
startTime
string

The earliest time instant to retrieve exchange rates from. Default is 0 milliseconds.
endTime
string

The latest time instant to retrieve exchange rates from. Default is the time of this request in milliseconds.
decimals
string

The number of decimals to round exchange rates to. Default is 2 decimal places.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "currencyRates": [
    ]
}

Update dimensions

Update display names, short display names, and descriptions for dimensions. Supports leveled dimensions. Update up to 10 dimensions per tenant across up to 500 tenants per request.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.objectconfiguration.DimensionChangeDefinitionsByTenantDTO)

The dimension updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "dimensionsByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve metrics

Retrieve all metrics in your Visier solution.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
id
Array of strings

The unique identifiers of the metrics to retrieve. Default is all metrics.
category
string

The category to filter the returned metrics by.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "metrics": [
    ]
}

Retrieve a metric

Retrieve a specific metric. You must know the ID of a metric to retrieve its details. To retrieve metric IDs, see GET /v1/data/model/metrics.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the metric to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string",
  • "dataStartDate": "string",
  • "dataEndDate": "string",
  • "analyticObjectId": "string",
  • "parameters": [
    ],
  • "category": "REGULAR",
  • "visibleInApp": true,
  • "dataType": "string"
}

Retrieve metric dimensions

Retrieve dimensions for a specific metric. You must know the ID of a metric to retrieve its dimensions. To retrieve metric IDs, see GET /v1/data/model/metrics.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
metricId
required
string

The unique identifier of the metric to retrieve.
queryParameters
id
Array of strings

The unique identifiers of the dimensions to retrieve. Default is all dimensions.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "dimensions": [
    ]
}

Retrieve metric selection concepts

Retrieve selection concepts for a specific metric. You must know the ID of a metric to retrieve its selection concepts. To retrieve metric IDs, see GET /v1/data/model/metrics.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
metricId
required
string

The unique identifier of the metric to retrieve.
queryParameters
id
Array of strings

The unique identifiers of the selection concepts to retrieve. Default is all selection concepts.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "selectionConcepts": [
    ]
}

Retrieve planning models

Retrieve accessible planning models.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
id
Array of strings

The unique identifiers of the planning models to retrieve. Default is all models.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "models": [
    ]
}

Retrieve a planning model

Retrieve a specific planning model. You must know the ID of the planning model to retrieve its details. To retrieve planning model IDs, see GET /v1/data/model/plan-models.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the planning model to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string"
}

Retrieve planning model metrics

Retrieve metrics for a planning model. You must know the ID of the planning model to retrieve its metrics. To retrieve planning model IDs, see GET /v1/data/model/plan-models.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the planning model to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "metrics": [
    ]
}

Retrieve planning model plans

Retrieve plans for a planning model by ID. You must know the ID of the planning model to retrieve its plans. To retrieve planning model IDs, see GET /v1/data/model/plan-models.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
modelId
required
string

The unique identifier of the planning model to retrieve.
queryParameters
id
Array of strings

The unique identifiers of the plans to retrieve. Default is all plans.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "plans": [
    ]
}

Retrieve a plan by planning model ID and plan ID

Retrieve a specific plan in a planning model by planning model ID and plan ID.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
modelId
required
string

The unique identifier of the planning model to retrieve.
id
required
string

The unique identifier of the plan to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "subjectId": "string",
  • "defaultContexts": [
    ],
  • "planDimensionIds": [
    ],
  • "scenarios": [
    ],
  • "snapshots": [
    ]
}

Retrieve predictions

Retrieve all predictions in your Visier solution.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
id
Array of strings

The unique identifiers of the predictions to retrieve. Default is all predictions.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "predictions": [
    ]
}

Retrieve a prediction

Retrieve a specific prediction. You must know the ID of a prediction to retrieve its details. To retrieve prediction IDs, see GET /v1/data/model/predictions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the prediction to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string",
  • "subject": "string",
  • "subjectKey": "string",
  • "subjectParentKey": "string",
  • "subjectFilter": "string",
  • "event": "string",
  • "eventFilter": "string",
  • "labelProperty": "string",
  • "factorProperties": [
    ],
  • "factorDimensions": [
    ],
  • "factorConcepts": [
    ],
  • "dataStartDate": "string",
  • "dataEndDate": "string",
  • "scoreName": "string",
  • "factorsName": "string",
  • "minimumTrainingMonths": "string",
  • "isMultiTenant": true
}

Replace properties

Replace existing property definitions. Update up to 10 properties per tenant across up to 500 tenants per request.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed from the property.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.objectconfiguration.PropertyChangeDefinitionsByTenantDTO)

The property updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "propertiesByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create properties

Create new properties.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.objectconfiguration.PropertyChangeDefinitionsByTenantDTO)

The property updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "propertiesByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete properties

Delete existing properties. Delete up to 10 properties per tenant across up to 500 tenants per request.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
deleteDerivedProperties
boolean

If true, deletes derived properties along with the properties to delete. Default is false.
ignorePropertyReferences
boolean

If true, ignores properties that reference the properties to delete. Default is false.
Array of objects (servicing.objectconfiguration.PropertyDeleteDefinitionsByTenantDTO)

The properties to delete for each tenant.

Responses

Request samples

Content type
application/json
{
  • "deleteDerivedProperties": true,
  • "ignorePropertyReferences": true,
  • "propertiesByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Update properties

Update display names, short display names, and descriptions for properties. Update up to 10 properties per tenant across up to 500 tenants per request.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.objectconfiguration.PropertyChangeDefinitionsByTenantDTO)

The property updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "propertiesByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve Vee question categories

Retrieve all Vee sample question categories.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Update Vee question categories

Replace existing Vee sample question category definitions, such as the display name or icon.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed from the question category.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.VeeQuestionCategoryChangeDefinitionsByTenantDTO)

The Vee question category updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "categoriesByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create Vee question categories

Create Vee sample question categories.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.VeeQuestionCategoryChangeDefinitionsByTenantDTO)

The Vee question category updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "categoriesByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete Vee question categories

Delete existing Vee sample question categories.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.VeeQuestionCategoryDeleteDefinitionsByTenantDTO)

The question categories to delete for each tenant.

Responses

Request samples

Content type
application/json
{
  • "categoriesByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Partially update Vee question categories

Partially update Vee sample question categories. Use PATCH to update specific category fields without changing omitted fields.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.VeeQuestionCategoryChangeDefinitionsByTenantDTO)

The Vee question category updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "categoriesByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve a Vee question category

Retrieve details for a specific Vee sample question category by categoryID returned from GET /v1/data/model/vee/sample-question-categories.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
questionCategoryId
required
string

The unique identifier of the Vee sample question category to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "categoryId": "string",
  • "basicInformation": {
    },
  • "categoryIcon": {
    },
  • "versionInformation": {
    }
}

Retrieve Vee sample questions

Retrieve all Vee sample questions for a tenant, including questions unavailable to end users.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "questions": [
    ]
}

Update Vee sample questions

Replace existing sample question definitions.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed from the sample question.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.VeeQuestionChangeDefinitionsByTenantDTO)

The Vee sample question updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "questionsByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Add Vee sample questions

Create sample questions for users to ask Vee.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.VeeQuestionChangeDefinitionsByTenantDTO)

The Vee sample question updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "questionsByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete Vee sample questions

Delete existing sample questions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.VeeQuestionDeleteDefinitionsByTenantDTO)

The sample questions to delete for each tenant.

Responses

Request samples

Content type
application/json
{
  • "questionsByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Patch Vee sample questions

Partially update Vee sample questions. Use PATCH to update specific question fields without changing omitted fields.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.VeeQuestionChangeDefinitionsByTenantDTO)

The Vee sample question updates to make in each tenant.

Responses

Request samples

Content type
application/json
{
  • "questionsByTenant": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve a Vee sample question

Retrieve a specific Vee sample question by questionID returned from GET /v1/data/model/vee/sample-questions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
questionId
required
string

The unique identifier of the Vee sample question to retrieve.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "question": "string",
  • "questionId": "string",
  • "visibleInVee": true,
  • "categoryId": "string",
  • "userGroupAssignment": {
    },
  • "versionInformation": {
    }
}

Retrieve plans

Retrieve accessible plans. Returns plan information to use with the Plan Data Load API and Plan Administration API.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
displayName
string

Returns plans that match the specified display name. Ignores text case and includes partial matches. For example, displayName=WFP Plan returns plans named WFP Plan 2024, WFP plan v1, and WFP plan - Product.
model
string

Returns plans that belong to the specified planning model ID.
planStatus
string

Returns plans with the specified plan status. Any other value returns an error. Valid values:

  • ASSIGNED: The plan was created but work on it has not started. A primary plan always has this status.
  • IN_PROGRESS: The subplanner has opened the subplan.
  • AWAITS_USER_ACTION: The subplan is open but is blocked and cannot be worked on until its subplanner resolves what is blocking it. One case is a subplan whose promoted rows must be reconciled after its primary plan was rebaselined. Other blocking conditions may use this status in future, so don't assume a specific cause.
  • SUBMITTED: The subplan has been submitted for review.
  • SENT_BACK: The subplan was rejected and returned to the subplanner for editing.
  • CONSOLIDATED: The subplan is closed. This includes subplans combined into the primary plan, and subplans closed when the collaboration ended without ever being combined.
createdStart
string

Returns plans created on or after this date in YYYY-MM-DD format.
createdEnd
string

Return plans created on or before this date in YYYY-MM-DD format.
editedStart
string

Returns plans edited on or after this date in YYYY-MM-DD format.
editedEnd
string

Returns plans edited on or before this date in YYYY-MM-DD format.
orderBy
string

Orders plan results by the specified value. Default is LAST_EDITED_DATE. Valid values:

  • LAST_EDITED_DATE: Orders plans by the last edited date.
  • CREATED_DATE: Orders plans by the creation date.
  • PLAN_MODEL: Orders plans alphabetically by planning model.
sortOrder
string

Sorts plan results by the specified value. Default is DESCENDING. Valid values: ASCENDING or DESCENDING.
excludeSubplans
boolean

If true, the response doesn't return subplans. Default is true.
maxResults
string

Sets the maximum number of results to return per page. Default is 50.
page
string

Sets the results page to return. If unspecified, returns the first 50 results. To get the next 50 results, specify page=2.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "plans": [
    ],
  • "page": 0
}

Retrieve a plan

Retrieve the details of a specific plan. Returns plan information to use with the Plan Data Load API.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
id
required
string

The unique identifier of the plan.
queryParameters
withSchema
boolean

If true, returns the plan's schema. Default is false.
segmentIdFilter
string

If specified, returns segment levels and members for the specified segment.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "plan": {
    },
  • "schema": {
    },
  • "errors": [
    ]
}

Object Configuration

Manage objects in your analytic model.

Retrieve calculation concepts

Retrieve calculation concepts available in production.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "concepts": [
    ]
}

Retrieve a calculation concept

Retrieve configuration details for a calculation concept in production.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
conceptId
required
string

The unique identifier of the concept to retrieve the configuration for.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "configuration": {
    }
}

Map dimension members to nodes in a calculation concept

Map dimension members to nodes in a calculation concept. Changes publish to production in a new project.

The request body acts as the source of truth for mapped members. Nodes without mapped members remove existing member mappings.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
conceptId
required
string

The unique identifier of the concept to configure.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (designer.api.PerspectiveConfigurationDTO)

The perspectives in the calculation concept.

Responses

Request samples

Content type
application/json
{
  • "perspectivesToMap": [
    ]
}

Response samples

Content type
application/json
{
  • "conceptId": "string",
  • "projectId": "string",
  • "message": "string"
}

Retrieve selection concepts

Retrieve selection concepts available in production.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "concepts": [
    ]
}

Retrieve a selection concept

Retrieve configuration details for a selection concept in production.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
conceptId
required
string

The unique identifier of the concept to retrieve the configuration for.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "configuration": {
    }
}

Map dimension members to a selection concept

Map dimension members to a selection concept. Changes publish to production in a new project.

The request body acts as the source of truth for mapped members. Nodes without mapped members remove existing member mappings.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
conceptId
required
string

The unique identifier of the concept to configure.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: application/json
required
Array of objects (designer.api.AnalyticObjectFilterDTO)

A list of analytic object filters indicating the analytic object and dimension members used for the selection concept.

If this array is empty, all filters will be removed for the concept.

Responses

Request samples

Content type
application/json
{
  • "analyticObjectFiltersToMap": [
    ]
}

Response samples

Content type
application/json
{
  • "conceptId": "string",
  • "projectId": "string",
  • "message": "string"
}

Concepts V2

Create, retrieve, update, and delete concepts in your analytic model. You can create, update, and delete one or more concepts in an API call.

Retrieve concepts by analytic object

Retrieve concepts for an analytic object. Returns concept details, including object names, concept types, and descriptions.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
analyticObjectName
required
string

The object name of the analytic object from which to retrieve concepts.
queryParameters
type
Array of strings <enum>[ items <enum> ]
ItemsEnum: "process" "selection"

The type of the concept to retrieve. Omit to retrieve all supported concept types. Valid values:

  • process: Retrieves all process concepts.
  • selection: Retrieves all member selection concepts and calculated selection concepts.
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the concept. Default is basic. Valid values:

  • basic: Retrieves the concept's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as visibleInAnalytics.
  • version: Retrieves the object's version information, such as version type and last edited details.
objectName
Array of strings

The concept object names to return in the response. When combined with uuid, the results return objects that match either the objectName or uuid.
uuid
Array of strings

The concept UUIDs to return in the response. When combined with objectName, the results return objects that match either the objectName or uuid.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "concepts": [
    ]
}

Retrieve concepts

Retrieve concepts in your Visier tenant.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
type
Array of strings <enum>[ items <enum> ]
ItemsEnum: "process" "selection"

The type of the concept to retrieve. Omit to retrieve all supported concept types. Valid values:

  • process: Retrieves all process concepts.
  • selection: Retrieves all member selection concepts and calculated selection concepts.
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the concept. Default is basic. Valid values:

  • basic: Retrieves the concept's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as visibleInAnalytics.
  • version: Retrieves the object's version information, such as version type and last edited details.
objectName
Array of strings

The concept object names to return in the response. When combined with uuid, the results return objects that match either the objectName or uuid.
uuid
Array of strings

The concept UUIDs to return in the response. When combined with objectName, the results return objects that match either the objectName or uuid.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "concepts": [
    ]
}

Update concepts

Update existing concepts. Returns update results for each concept. Retrieve concept definitions using GET before updating. Use the GET response in PUT requests.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed. To partially update concepts, see PATCH /v2/data/model/concepts.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.ConceptWithContextDTO)

The concepts in the request.

Responses

Request samples

Content type
application/json
{
  • "concepts": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create concepts

Create concepts. Returns creation results for each concept. Assign a unique object name when creating objects. Do not set a UUID; Visier generates UUIDs for new objects.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.ConceptWithContextDTO)

The concepts in the request.

Responses

Request samples

Content type
application/json
{
  • "concepts": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete concepts

Delete existing concepts. Returns deletion results for each concept.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.ConceptDeleteWithContextDTO)

The concepts in the request.

Responses

Request samples

Content type
application/json
{
  • "concepts": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Partially update concepts

Partially update existing concepts. Returns update results for each concept. Retrieve concept definitions using GET before patching. Use the GET response in PATCH requests.

Use PATCH to update specific fields without changing omitted fields. To replace full definitions, see PUT /v2/data/model/concepts.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.ConceptWithContextDTO)

The concepts in the request.

Responses

Request samples

Content type
application/json
{
  • "concepts": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve a concept

Retrieve a specific concept details, including concept type and description.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
conceptId
required
string

The object name or UUID of the concept to retrieve.
queryParameters
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the concept. Default is details. Valid values:

  • basic: Retrieves the concept's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as visibleInAnalytics.
  • version: Retrieves the object's version information, such as version type and last edited details.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "concepts": [
    ]
}

Dimensions V2

Create, retrieve, update, and delete dimensions in your analytic model. You can create, update, and delete one or more dimensions in an API call.

Note: 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 Success Manager (CSM).

Retrieve dimensions by analytic object

Retrieve dimensions for an analytic object. Returns dimension details, including object names, dimension types, and descriptions.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
analyticObjectId
required
string

The object name or UUID of the analytic object from which to retrieve dimensions.
queryParameters
type
Array of strings <enum>[ items <enum> ]
ItemsEnum: "leveled" "parentChild"

The type of the dimension to retrieve. Valid values:

  • leveled: Retrieves leveled dimensions.
  • parentChild: Retrieves parent-child dimensions.
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the dimension. Default is basic. Valid values:

  • basic: Retrieves the dimension's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as levels and settings.
  • version: Retrieves the object's version information, such as version type and last edited details.
objectName
Array of strings

The dimension object names to return in the response. When combined with uuid, the results return objects that match either the objectName or uuid.
uuid
Array of strings

The dimension UUIDs to return in the response. When combined with objectName, the results return objects that match either the objectName or uuid.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "dimensions": [
    ]
}

Retrieve dimensions

Retrieve dimensions in your Visier tenant. Optionally filter dimensions by dimension type or analytic object.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
type
Array of strings <enum>[ items <enum> ]
ItemsEnum: "leveled" "parentChild"

The type of the dimension to retrieve. If unspecified, retrieves all dimension types. Valid values:

  • leveled: Retrieves leveled dimensions.
  • parentChild: Retrieves parent-child dimensions.
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the dimension. Default is basic. Valid values:

  • basic: Retrieves the dimension's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as levels and settings.
  • version: Retrieves the object's version information, such as version type and last edited details.
analyticObjectName
Array of strings

The object names of the analytic objects from which to retrieve dimensions. Default is all analytic objects.
analyticObjectUuid
Array of strings

The UUIDs of the analytic objects from which to retrieve dimensions. Default is all analytic objects.
objectName
Array of strings

The dimension object names to return in the response. When combined with uuid, the results return objects that match either the objectName or uuid.
uuid
Array of strings

The dimension UUIDs to return in the response. When combined with objectName, the results return objects that match either the objectName or uuid.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "dimensions": [
    ]
}

Update dimensions

Update existing dimensions. Returns update results for each dimension. Retrieve dimension definitions using GET before updating. Use the GET response in PUT requests.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed. To partially update dimensions, see PATCH /v2alpha/data/model/dimensions.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.DimensionWithContextDTO)

The dimensions in the request.

Responses

Request samples

Content type
application/json
{
  • "dimensions": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create dimensions

Create new dimensions. Returns creation results for each dimension. Assign a unique object name when creating objects. Do not set a UUID; Visier generates UUIDs for new objects.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.DimensionWithContextDTO)

The dimensions in the request.

Responses

Request samples

Content type
application/json
{
  • "dimensions": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete dimensions

Delete existing dimensions. Returns deletion results for each dimension.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.DimensionDeleteWithContextDTO)

The dimensions in the request.

Responses

Request samples

Content type
application/json
{
  • "dimensions": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Partially update dimensions

Partially update existing dimensions. Returns update results for each dimension. Retrieve dimension definitions using GET before patching. Use the GET response in PATCH requests.

Use PATCH to update specific fields without changing omitted fields. To replace full definitions, see PUT /v2alpha/data/model/dimensions.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.DimensionWithContextDTO)

The dimensions in the request.

Responses

Request samples

Content type
application/json
{
  • "dimensions": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve a dimension

Retrieve dimension details, including dimension type and description.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
dimensionId
required
string

The object name or UUID of the dimension to retrieve.
queryParameters
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the dimension. Default is details. Valid values:

  • basic: Retrieves the dimension's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as levels and settings.
  • version: Retrieves the object's version information, such as version type and last edited details.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "executionContext": {
    },
  • "dimension": {
    }
}

Analytic Objects V2

Create, retrieve, update, and delete analytic objects in your analytic model. You can create, update, and delete one or more analytic objects in an API call. Supported analytic objects include subjects (entities evolving over time) and events (occurrences for subjects at specific times).

Note: 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 Success Manager (CSM).

Retrieve analytic objects

Retrieve analytic objects in your Visier tenant.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
type
Array of strings <enum>[ items <enum> ]
ItemsEnum: "subject" "event"

The type of the analytic object to retrieve. If unspecified, retrieves all analytic object types. Valid values:

  • subject: Retrieves subject analytic objects.
  • event: Retrieves event analytic objects.
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the analytic object. Default is basic. Valid values:

  • basic: Retrieves the analytic object's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as properties, dimensions, and references.
  • version: Retrieves the object's version information, such as version type and last edited details.
objectName
Array of strings

The analytic object names to return in the response. When combined with uuid, the results return objects that match either the objectName or uuid.
uuid
Array of strings

The analytic object UUIDs to return in the response. When combined with objectName, the results return objects that match either the objectName or uuid.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "analyticObjects": [
    ]
}

Update analytic objects

Replace existing analytic objects. Returns update results for each analytic object. Retrieve object definitions using GET before updating. Use the GET response in PUT requests.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed. To partially update an analytic object, see PATCH /v2alpha/data/model/analytic-objects.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO)

The analytic objects in the request.

Responses

Request samples

Content type
application/json
{
  • "analyticObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create analytic objects

Create new analytic objects. Returns creation results for each analytic object. Assign a unique object name when creating objects. Do not set a UUID; Visier generates UUIDs for new objects.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO)

The analytic objects in the request.

Responses

Request samples

Content type
application/json
{
  • "analyticObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete analytic objects

Delete existing analytic objects. Returns deletion results for each analytic object.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.AnalyticObjectDeleteWithContextDTO)

The analytic objects to delete.

Responses

Request samples

Content type
application/json
{
  • "analyticObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Partially update analytic objects

Partially update existing analytic objects. Returns update results for each analytic object. Retrieve object definitions using GET before patching. Use the GET response in PATCH requests.

Use PATCH to update specific fields without changing omitted fields. To replace full definitions, see PUT /v2alpha/data/model/analytic-objects.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.AnalyticObjectWithContextDTO)

The analytic objects in the request.

Responses

Request samples

Content type
application/json
{
  • "analyticObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Revert analytic objects to Blueprint

Revert tenant override objects to Blueprint. Returns reversion results for each analytic object.

Reverting behavior by object type:

  • Blueprint object: No changes. Objects are inherited from the parent.
  • Tenant override object: Reverts to the Blueprint version or administrating tenant version.
  • Tenant object: Request fails. Tenant-unique objects do not have Blueprint versions.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.AnalyticObjectRevertWithContextDTO)

The analytic objects to revert.

Responses

Request samples

Content type
application/json
{
  • "analyticObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve an analytic object

Retrieve analytic object details, including properties, dimensions, and references.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
objectNameOrUuid
required
string

The object name or UUID of the analytic object to retrieve.
queryParameters
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the analytic object. Default is details. Valid values:

  • basic: Retrieves the analytic object's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as properties, dimensions, and references.
  • version: Retrieves the object's version information, such as version type and last edited details.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "executionContext": {
    },
  • "analyticObject": {
    }
}

Metrics V2

Create, retrieve, update, and delete simple and derived metrics in your analytic model. Simple metrics are based on analytic objects. Derived metrics are based on simple metrics. You can create, update, and delete one or more metrics in an API call.

Note: 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 Success Manager (CSM).

Retrieve metrics by analytic object

Retrieve simple or derived metrics for an analytic object. Returns basic metric definitions by default.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
analyticObjectName
required
string

The object name of the analytic object from which to retrieve metrics.
queryParameters
type
Array of strings <enum>[ items <enum> ]
ItemsEnum: "simple" "derived"

The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values:

  • simple: Retrieves all simple metrics. A simple metric is a metric based on one or more analytic objects.
  • derived: Retrieves all derived metrics. A derived metric is a metric based on a simple metric.
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the metric. Default is basic. Valid values:

  • basic: Retrieves the metric's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as visibleInAnalytics.
  • version: Retrieves the object's version information, such as version type and last edited details.
objectName
Array of strings

The metric object names to return in the response. When combined with uuid, the results return objects that match either the objectName or uuid.
uuid
Array of strings

The metric UUIDs to return in the response. When combined with objectName, the results return objects that match either the objectName or uuid.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "metrics": [
    ]
}

Retrieve metrics

Retrieve simple or derived metrics in your Visier tenant. Returns basic metric definitions by default.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
type
Array of strings <enum>[ items <enum> ]
ItemsEnum: "simple" "derived"

The type of the metric to retrieve. Omit to retrieve all supported metric types. Valid values:

  • simple: Retrieves all simple metrics. A simple metric is a metric based on one or more analytic objects.
  • derived: Retrieves all derived metrics. A derived metric is a metric based on a simple metric.
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the metric. Default is basic. Valid values:

  • basic: Retrieves the metric's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as visibleInAnalytics.
  • version: Retrieves the object's version information, such as version type and last edited details.
objectName
Array of strings

The metric object names to return in the response. When combined with uuid, the results return objects that match either the objectName or uuid.
uuid
Array of strings

The metric UUIDs to return in the response. When combined with objectName, the results return objects that match either the objectName or uuid.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "metrics": [
    ]
}

Update metrics

Update simple or derived metrics. Returns update results for each metric. Retrieve metric definitions using GET before updating. Use the GET response in PUT requests.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted fields are removed. To partially update metrics, see PATCH /v2alpha/data/model/metrics.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.MetricWithContextDTO)

The metrics in the request.

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Create metrics

Create new simple or derived metrics. Returns creation results for each metric. Assign a unique object name when creating objects. Do not set a UUID; Visier generates UUIDs for new objects.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.MetricWithContextDTO)

The metrics in the request.

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Delete metrics

Delete existing simple or derived metrics. Returns deletion results for each metric. Deleting a simple metric deletes dependent derived metrics.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.MetricDeleteWithContextDTO)

The metrics in the request.

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Partially update metrics

Partially update existing simple or derived metrics. Returns update results for each metric. Retrieve metric definitions using GET before patching. Use the GET response in PATCH requests.

Use PATCH to update specific fields without changing omitted fields. To replace full definitions, see PUT /v2alpha/data/model/metrics.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.
Request Body schema: application/json
required
Array of objects (servicing.v2.objectconfiguration.MetricWithContextDTO)

The metrics in the request.

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve a metric

Retrieve details for a specific simple or derived metric, including metric type and description. Returns detailed metric definitions by default.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
metricId
required
string

The object name or UUID of the metric to retrieve.
queryParameters
with
Array of strings <enum>[ items <enum> ]
ItemsEnum: "basic" "details" "version"

The level of information to retrieve for the metric. Default is details. Valid values:

  • basic: Retrieves the metric's UUID, object name, and basic information.
  • details: Retrieves the basic details and additional configurations, such as visibleInAnalytics.
  • version: Retrieves the object's version information, such as version type and last edited details.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
ProjectID
string <uuid>

Optionally, specify a project in which to make the request. If omitted, the request uses the production version.

Responses

Response samples

Content type
application/json
{
  • "metrics": [
    ]
}

Personalized Alerts

Manage your personalized alerts in Visier. Alerts notify you if a metric exceeds your defined threshold.

Note: 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 Success Manager (CSM).

Retrieve personalized alerts

Retrieve accessible personalized alerts. Returns alert IDs, creators, and status.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)

Responses

Response samples

Content type
application/json
{
  • "ownedAlerts": [
    ],
  • "sharedAlerts": [
    ]
}

Create a personalized alert

Create a new personalized alert. Define display names and trigger criteria in the request body, including metrics, filters, time periods, and threshold values.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
object

The conditions on which to trigger the personalized alert.
displayName
string

The display name of the alert.
description
string

The user-provided description of the alert.

Responses

Request samples

Content type
application/json
{
  • "triggerCriteria": {
    },
  • "displayName": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "alertId": "string",
  • "triggerCriteria": {
    },
  • "displayName": "string",
  • "isEnabledForUser": true,
  • "description": "string",
  • "content": {
    }
}

Retrieve a personalized alert

Retrieve the details of a specific personalized alert. You must know the ID of the alert to retrieve its details. To retrieve all alert IDs, see GET /v1alpha/alerts.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
alertId
required
string

Responses

Response samples

Content type
application/json
{
  • "alertId": "string",
  • "triggerCriteria": {
    },
  • "displayName": "string",
  • "isEnabledForUser": true,
  • "description": "string",
  • "content": {
    }
}

Update a personalized alert

Update personalized alerts created by the requesting user. You must know the ID of the alert to update it. To retrieve all alert IDs, see GET /v1alpha/alerts.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
alertId
required
string

The unique identifier of the alert.
Request Body schema: application/json
required
alertId
string

The unique identifier of the alert.
object

The conditions on which to trigger the personalized alert.
displayName
string

The display name of the alert.
isEnabledForUser
boolean

If true, the personalized alert is enabled for the user.
description
string

The description of the alert.
object

Content related to the alert, such as analyses.

Responses

Request samples

Content type
application/json
{
  • "alertId": "string",
  • "triggerCriteria": {
    },
  • "displayName": "string",
  • "isEnabledForUser": true,
  • "description": "string",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "alertId": "string",
  • "triggerCriteria": {
    },
  • "displayName": "string",
  • "isEnabledForUser": true,
  • "description": "string",
  • "content": {
    }
}

Delete a personalized alert

Delete personalized alerts created by the requesting user. To disable alerts without deleting them, see PUT /v1alpha/alerts/{alertId}/recipient-status. You must know the ID of the alert to delete it. To retrieve all alert IDs, see GET /v1alpha/alerts.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
alertId
required
string

The unique identifier of the alert.

Responses

Response samples

Content type
application/json
{
  • "alertId": "string"
}

Enable or disable a personalized alert

Enable or disable personalized alerts. Disabling an alert removes notifications from the Home room and email digests. Re-enable alerts at any time.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
alertId
required
string

The unique identifier of the alert.
Request Body schema: application/json
required
status
string <enum>
Enum: "UNSUPPORTED_EVENT_ALERT_STATUS" "SUBSCRIBED" "PAUSED"

Whether the alert is enabled for the user. Valid values:

  • SUBSCRIBED: The alert is enabled and the user will receive notifications for the alert.
  • PAUSED: The alert is disabled and the user will not receive notifications for the alert.

Responses

Request samples

Content type
application/json
{
  • "status": "UNSUPPORTED_EVENT_ALERT_STATUS"
}

Response samples

Content type
application/json
{
  • "status": "UNSUPPORTED_EVENT_ALERT_STATUS"
}

Retrieve personalized alert notifications

Retrieve active personalized alert notifications from the last 30 days. Returns trigger dates and criteria for active alerts.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)

Responses

Response samples

Content type
application/json
{
  • "notifications": [
    ]
}

Labels

Create, manage, and retrieve labels for analyses and reports. Labels are personalized tags visible only to you. They help organize and categorize your Visier content. For example, create labels like "Compensation" and assign them to content. You can create up to 100 labels and 250 total label assignments.

Retrieve all labels and assignments

Retrieve all labels and assignments for the current user. The response returns each label ID, display name, color, and assigned content items.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "assignments": [
    ]
}

Update a label

Update an existing label display name or color. Provide the entire definition in the request. If you omit values, the request fails. Display name maximum is 150 characters. Color must be a hex value.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
labelId
string

The unique identifier of the label.
displayName
string

The display name of the label. Maximum is 150 characters.
color
string

The color of the label as a hex value. Example: #FF5733.

Responses

Request samples

Content type
application/json
{
  • "labelId": "string",
  • "displayName": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "labelId": "string",
  • "displayName": "string",
  • "color": "string"
}

Create a label

Create a new label. You must specify the display name and color as a hex value. Maximum is 150 characters for the display name. Optionally, provide a content ID to automatically assign the label. If auto-assignment fails, the label is still created. You can create up to 100 labels.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
displayName
string

The display name of the label. Maximum is 150 characters.
color
string

The color of the label as a hex value. Example: #FF5733.
contentId
string

Optional. The unique identifier of an analysis or report to automatically assign the label to upon creation.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "color": "string",
  • "contentId": "string"
}

Response samples

Content type
application/json
{
  • "createdLabel": {
    },
  • "hasNoAutoAssignment": true,
  • "labelAssignment": {
    },
  • "labelAssignmentError": "string"
}

Delete a label

Delete a specific label. You must provide the unique identifier of the label. To retrieve label IDs, see GET /v1/analysis-labels/labels. Deleting a label removes all assignments of that label to analyses and reports.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
labelId
required
string

The unique identifier of the label.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Assign a label

Create a label assignment to associate a label with an analysis or report. Specify the label ID and content ID. Content items can have multiple assigned labels. To retrieve label IDs, see GET /v1/analysis-labels/labels. Maximum is 250 label assignments across all content.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
labelId
required
string

The unique identifier of the label.
contentId
required
string

The unique identifier of the content item to assign to the label.

Responses

Response samples

Content type
application/json
{
  • "labelId": "string",
  • "contentId": "string"
}

Unassign a label

Delete a label assignment to remove the association between a label and content item. Specify the label ID and content ID. To retrieve IDs, see GET /v1/analysis-labels/labels.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
labelId
required
string

The unique identifier of the label.
contentId
required
string

The unique identifier of the content item to unassign from the label.

Responses

Response samples

Content type
application/json
{
  • "localizedMessage": "string",
  • "code": "string",
  • "message": "string",
  • "rci": "string",
  • "userError": true
}

Webhooks

Create, manage, and retrieve webhook definitions. Use webhooks to register your HTTPS endpoints with Visier and listen for specific events. When these events occur, Visier sends an API request to your registered endpoint. For example, create a webhook to monitor job status events. Visier sends success or failure notifications to your endpoint after the job completes.

Retrieve webhooks

Retrieve all webhooks. Returns each webhook definition, such as endpoint URL, active status, and event types.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
event
string

Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.

The possible event types to listen for. Valid values:

  • jobResultSuccess: A job completed successfully.
  • jobResultFailure: A job failed to complete.
  • jobReschedule: A job was rescheduled.
  • dvPublish: A data version published to production.
  • alertNotification: A personalized alert notification was triggered.
  • smartCompNotification: A Smart Compensation event notification was triggered. This is available for Embedded Partners.
  • dataUploadNotification: A data file was uploaded.
  • systemAlertNotification: A system event alert notification was triggered.
  • planRowPromotionNotification: A row in a plan was promoted.
  • auditEvent: An audit event was triggered.
isActive
boolean

If true, retrieve active webhooks only. If false, retrieve active and inactive webhooks. Default is false.

Responses

Response samples

Content type
application/json
{
  • "webhooks": [
    ]
}

Create a webhook

Create a webhook with Visier. Specify the webhook endpoint URL, active status, event types to listen for, and authentication credentials.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
Request Body schema: application/json
required
object

The webhook's details, such as its URL, active status, and event types to listen for.
object

The webhook's credentials, such as a username and password or access token.

Responses

Request samples

Content type
application/json
{
  • "details": {
    },
  • "credentials": {
    }
}

Response samples

Content type
application/json
{
  • "webhookId": "string",
  • "details": {
    },
  • "credentialReference": "string"
}

Retrieve webhook statuses

Retrieve webhook statuses, such as active status and event types.API users can call this endpoint without any special capabilities.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
event
string

Retrieve all webhooks listening for the specified event type. Default is to retrieve all webhooks.

The possible event types to listen for. Valid values:

  • jobResultSuccess: A job completed successfully.
  • jobResultFailure: A job failed to complete.
  • jobReschedule: A job was rescheduled.
  • dvPublish: A data version published to production.
  • alertNotification: A personalized alert notification was triggered.
  • smartCompNotification: A Smart Compensation event notification was triggered. This is available for Embedded Partners.
  • dataUploadNotification: A data file was uploaded.
  • systemAlertNotification: A system event alert notification was triggered.
  • planRowPromotionNotification: A row in a plan was promoted.
  • auditEvent: An audit event was triggered.
isActive
boolean

If true, retrieve active webhooks only. If false, retrieve active and inactive webhooks. Default is false.

Responses

Response samples

Content type
application/json
{
  • "webhooks": [
    ]
}

Retrieve a webhook

Retrieve a specific webhook. You must know the ID of the webhook to retrieve its details. To retrieve webhook IDs, see GET /v1/op/webhooks.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
webhookId
required
string

The unique identifier of the webhook.

Responses

Response samples

Content type
application/json
{
  • "webhookId": "string",
  • "details": {
    },
  • "credentialReference": "string"
}

Update a webhook

Update an existing webhook. You must know the ID of the webhook to update it. To retrieve webhook IDs, see GET /v1/op/webhooks. To update a webhook's credentials, see PUT /v1/op/webhooks/{webhookId}/credentials.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted values are removed from the webhook.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
webhookId
required
string

The unique identifier of the webhook.
Request Body schema: application/json
required
webhookId
string

The unique identifier of the webhook.
object

The webhook's details, such as its URL, active status, and event types to listen for.
credentialReference
string

The unique identifier of the configured webhook credentials.

Responses

Request samples

Content type
application/json
{
  • "webhookId": "string",
  • "details": {
    },
  • "credentialReference": "string"
}

Response samples

Content type
application/json
{
  • "webhookId": "string",
  • "details": {
    },
  • "credentialReference": "string"
}

Delete a webhook

Delete a specific webhook. You must know the ID of the webhook to delete it. To retrieve webhook IDs, see GET /v1/op/webhooks.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
webhookId
required
string

The unique identifier of the webhook.

Responses

Response samples

Content type
application/json
{
  • "webhookId": "string",
  • "details": {
    },
  • "credentialReference": "string"
}

Update webhook credentials

Update a webhook's credentials. You must know the ID of the webhook to update it. To retrieve webhook IDs, see GET /v1/op/webhooks. To update webhook details, see PUT /v1/op/webhooks/{webhookId}.

PUT requests replace existing definitions. Provide the complete object definition in the request body. Omitted values are removed from the webhook.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
webhookId
required
string

The unique identifier of the webhook.
Request Body schema: application/json
required
object

Authentication using a username and password.
accessToken
string

Authentication using an access token.

Responses

Request samples

Content type
application/json
{
  • "basicAuth": {
    },
  • "accessToken": "string"
}

Response samples

Content type
application/json
{
  • "webhookId": "string",
  • "details": {
    },
  • "credentialReference": "string"
}

Delete webhook credentials

Delete a webhook's credentials. You must know the ID of the webhook to delete its credentials. To retrieve webhook IDs, see GET /v1/op/webhooks.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
webhookId
required
string

The unique identifier of the webhook.

Responses

Response samples

Content type
application/json
{
  • "webhookId": "string",
  • "details": {
    },
  • "credentialReference": "string"
}

Test a webhook

Send a test event to validate a webhook. Specify the webhook ID and event type in the request.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
webhookId
required
string

The unique identifier of the webhook.
Request Body schema: application/json
required
eventType
string

The possible event types to listen for. Valid values:

  • jobResultSuccess: A job completed successfully.
  • jobResultFailure: A job failed to complete.
  • jobReschedule: A job was rescheduled.
  • dvPublish: A data version published to production.
  • alertNotification: A personalized alert notification was triggered.
  • smartCompNotification: A Smart Compensation event notification was triggered. This is available for Embedded Partners.
  • dataUploadNotification: A data file was uploaded.
  • systemAlertNotification: A system event alert notification was triggered.
  • planRowPromotionNotification: A row in a plan was promoted.
  • auditEvent: An audit event was triggered.

Responses

Request samples

Content type
application/json
{
  • "eventType": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "messageId": "string",
  • "eventId": "string"
}

Plan Administration

Manage collaboration projects in your plans, including actions such as consolidating and reopening subplans.

Partially update a plan

Make partial changes to existing plans. Returns plan update results.

Retrieve the object definition using GET before patching. Use the GET response in your PATCH request. To retrieve main plan or subplan IDs, see GET /v1/planning/model/plans. Plans containing parentPlanUuid are subplans.

Use PATCH to update specific plan fields without changing omitted fields.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
planId
required
string

The unique identifier of the plan.
Request Body schema: application/json
required
object

The details of sharing a plan.

Responses

Request samples

Content type
application/json
{
  • "shareActionPayload": {
    }
}

Response samples

Content type
application/json
{
  • "actionResults": [
    ]
}

Partially update a plan scenario

Make partial changes to a scenario in an existing plan. Returns scenario update results.

Retrieve the object definition using GET before patching. Use the GET response in your PATCH request. To retrieve plan IDs and scenario IDs, see GET /v1/planning/model/plans. Plans containing parentPlanUuid are subplans.

Use PATCH to update specific scenario fields without changing omitted fields.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
planId
required
string

The unique identifier of the main plan or subplan. Use the main plan ID for consolidating, starting collaboration, or ending collaboration. Otherwise, use the subplan ID.
scenarioId
required
string

The unique identifier of the plan scenario.
Request Body schema: application/json
required
actionType
required
string

The action to perform on the main plan or the subplan, in a specific scenario. Valid values:

  • Consolidate: Combine the submitted subplan values into the main plan.
  • Submit: Send your completed subplan to the plan coordinator for review.
  • Reopen: Reopen consolidated subplans so subplanners can change the values.
  • StartCollaboration: Enter collaboration mode, so you can assign subplans to subplanners.
  • EndCollaboration: Regain control of the plan, so you can finalize it and put it into operation.
  • AssignSubplan: Create a new subplan anchored at a specific row in the parent plan.
required
object (planning.ConsolidateActionPayload)

The details of consolidating a subplan.

Responses

Request samples

Content type
application/json
Example
{
  • "actionType": "Consolidate",
  • "consolidateActionPayload": {
    }
}

Response samples

Content type
application/json
{
  • "actionResults": [
    ]
}

Plan Data Load

Send data directly to your plan's scenario and optionally add or remove rows from your plan.

Upload plan data

Send a CSV file to Visier to modify plan data. The file must match the plan schema. To retrieve the plan schema, see GET /v1/planning/model/plans/{id}?withSchema=true. The data file must contain the following columns:

  • periodId: Use the date values in the timePeriods array from the GET response as values in this column.
  • A column for each id value in the planSegmentLevels object, where the row value is the id of the members in the planSegmentLevelMembers object.
  • A column for each id value in the planItems object that you want to modify data for, where the row value is the data value.
Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
planId
required
string

The unique identifier of the plan.
scenarioId
required
string

The unique identifier of the plan scenario to load data into.
queryParameters
calculation
string

Sets the plan values to rollup, distribute, or neither. Default is NONE. Valid values:

  • ROLLUP: Roll up loaded data values to parent and ancestor rows. If the data provides a parent value and its child value, this method prioritizes the loaded value for the child and overwrites the parent.
  • DISTRIBUTE: Distribute loaded data values to their children and descendent rows. If the data provides a parent value and its child value, this method prioritizes the parent values and overrides the loaded child value.
  • NONE: Loaded values aren't rolled up or distributed.
currency
string

The 3-digit ISO 4217 currency code of the data. If unspecified, default is the plan's consolidation currency. If the currency differs from the plan's consolidation currency, values convert to the consolidation currency using conversion rates loaded for the plan's baseline period.
method
string

Sets how to validate the data being loaded into Visier. Default is STRICT_UPLOAD. Valid values:

  • VALIDATE: Runs a test load through all validation steps without putting data into the plan. Use VALIDATE to find errors before using STRICT_UPLOAD to load data.
  • SKIP_ERRORS: Loads all data without errors into the plan. Rows with errors are excluded from the plan update.
  • STRICT_UPLOAD: Loads data into the plan only if every row passes validation. If any row fails, the load fails with a 422 response and the plan is unchanged. method applies to row-level validation errors only. A request that can't be accepted at all, such as one with an invalid ID or an unusable file, fails with a 400 response whichever method you use, and no rows are inspected.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: multipart/form-data
file
string <binary>

The CSV file to load into the plan.

Responses

Response samples

Content type
application/json
{
  • "updatedCellsCount": 0,
  • "potentialUpdatedCellsCount": 0,
  • "errors": [
    ],
  • "changelists": [
    ]
}

Add or remove plan rows

Send a CSV file to Visier to modify plan rows. The file must contain the following columns:

  • Add/Remove: Use Add to add a row to the plan or Remove to remove a row from the plan.
  • A column for each plan segment level using the IDs from planSegmentLevels.
    • To add a row, use the corresponding segment member ID from planSegmentLevelMembers. If the member doesn't exist in the schema, provide a display name. The response returns its assigned segment member ID.
    • To remove a row, use the corresponding segmentId as the column name and the segment member ID from planSegmentLevelMembers as the row value.


Note: 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 Success Manager (CSM).

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
planId
required
string

The unique identifier of the plan.
queryParameters
method
string

Sets how to validate the data being loaded into Visier. Default is STRICT_UPLOAD. Valid values:

  • VALIDATE: Runs a test load through all validation steps without putting data into the plan. Use VALIDATE to find errors before using STRICT_UPLOAD to load data.
  • SKIP_ERRORS: Loads all data without errors into the plan. Rows with errors are excluded from the plan update.
  • STRICT_UPLOAD: Loads data into the plan only if every row passes validation. If any row fails, the load fails with a 422 response and the plan is unchanged. method applies to row-level validation errors only. A request that can't be accepted at all, such as one with an invalid ID or an unusable file, fails with a 400 response whichever method you use, and no rows are inspected.
headerParameters
TargetTenantID
string

Optionally, specify the tenant that you want to execute the API call on. This defines the tenant that you're logged into. If omitted, the request uses the administrating tenant as the login tenant.
Request Body schema: multipart/form-data
file
string <binary>

The CSV file to load into the plan.

Responses

Response samples

Content type
application/json
{
  • "addedRowsCount": 0,
  • "removedRowsCount": 0,
  • "potentialAddedRowsCount": 0,
  • "potentialRemovedRowsCount": 0,
  • "errors": [
    ],
  • "customMembers": [
    ]
}

Plan Events

Retrieve details about planning events, such as member promotions and row changes.

Retrieve planning events

Retrieve planning events in bulk. Specify one of:

  • planId: Retrieve events for one plan.
  • mainPlanId: Retrieve events for a main plan and its subplans.

If both are specified, planId takes precedence. If neither are specified, returns events for accessible plans. Results sort oldest first for forward pagination.

To retrieve single event details, including promoted member paths, see GET /v1/planning/data/events/{eventId}.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
queryParameters
planId
string

Optionally, specify the unique identifier of the plan to retrieve events for. Specify one of planId or mainPlanId. If both are provided, planId takes precedence and mainPlanId is ignored. If both are omitted, the response includes events for all plans you have access to.
mainPlanId
string

Optionally, specify the unique identifier of the main plan. When provided, the response includes events for the main plan and all its subplans. Specify one of planId or mainPlanId. If both are provided, planId takes precedence and mainPlanId is ignored. If both are omitted, the response includes events for all plans you have access to.
fromDate
string

Optionally, specify a start date to filter by and return only the events created after it. The format is the number of milliseconds since midnight 01 January 1970 UTC as a string.
toDate
string

Optionally, specify an end date to filter by and return only the events created before it. The format is the number of milliseconds since midnight 01 January 1970 UTC as a string.
eventTypes
Array of strings

Optionally, specify one or more event types to filter by. If omitted, the response includes all event types.
userFilter
string

Optionally, specify the username of the user who triggered the events. If omitted, the response includes events triggered by all users.
limit
integer <int32>

The maximum number of events to return. Default is 50. Maximum is 50.
start
integer <int32>

The starting index of the first event to return. Default is 0.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "limit": 0,
  • "start": 0
}

Retrieve a planning event

Retrieve a planning event by ID. Returns event metadata and full member paths for promoted rows per plan segment. To retrieve event IDs, create a webhook for planRowPromotionNotification. The webhook payload returns eventID. To create webhooks, see POST /v1/op/webhooks.

Authorizations:
(ApiKeyAuthBearerAuth) (ApiKeyAuthCookieAuth) (ApiKeyAuthOAuth2Auth)
pathParameters
eventId
required
string

The unique identifier of the event.

Responses

Response samples

Content type
application/json
{
  • "eventId": "string",
  • "planId": "string",
  • "scenarioId": "string",
  • "mainPlanId": "string",
  • "eventType": "unknownPlanEventType",
  • "createdDate": "string",
  • "user": "string",
  • "promotionData": {
    },
  • "bulkPromotionDemotionData": {
    }
}

Benchmarks

Get benchmark values.

Get base salary benchmark value

Retrieve the base salary benchmark value.

Authorizations:
api_key
queryParameters
job
required
string

The job member ID.
industry
string

The industry member ID. If the ID is not provided, the response returns the benchmark value across all industries.
naicsCode
string

The North American Industry Classification System (NAICS) code.

If the NAICS code is not provided, the response returns the benchmark value across all industries. If both naicsCode and industry are provided, the response returns the benchmark value for the industry parameter. The entered naicsCode will not be applied.
location
string

The location member ID. If the ID is not provided, the response returns the benchmark value across all locations.
companySize
string

The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes.
careerLevel
string

The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels.
matchDate
string

The date on which the career level was matched in yyyy-MM-dd format. A matchDate allows precise migration of career levels according to job architecture changes released since the match was made. If matchDate is not available, the migration assumes the most recent possible match date for the provided career level.

Responses

Response samples

Content type
application/json
{
  • "percentile10": 0,
  • "percentile25": 0,
  • "percentile50": 0,
  • "percentile75": 0,
  • "percentile90": 0,
  • "alignedRangeMin": 0,
  • "alignedRangeMax": 0,
  • "referenceDate": "string",
  • "releaseDate": "string",
  • "industryId": "string",
  • "careerLevelId": "string"
}

Submit feedback to improve salary benchmark values

Give feedback for a salary benchmark value returned by GET /v1/compensation-benchmarks/base-salary or /base-salaries. To submit feedback, include the benchmark value's:

  • ID values you defined in GET /v1/compensation-benchmarks/base-salary or /base-salaries.
  • referenceDate and releaseDate returned by GET /v1/compensation-benchmarks/base-salary or /base-salaries.
  • Optional additionalComments up to 750 characters.
Authorizations:
api_key
Request Body schema: application/json
required

The feedback to submit.

job
required
string

The job member ID for the salary benchmark.
location
required
string

The location member ID for the salary benchmark.
careerLevel
required
string

The career level member ID for the salary benchmark.
industry
required
string

The industry member ID for the salary benchmark.
companySize
required
string

The company size member ID for the salary benchmark.
referenceDate
required
string

The date that benchmark values are calculated for. The format is YYYY-MM-DD.
releaseDate
required
string

The date that benchmark values are released. The format is YYYY-MM-DD.
naicsCode
string

If provided, the naicsCode in GET /v1/compensation-benchmarks/base-salary or /base-salaries.
additionalComments
string

Optional written feedback about the salary benchmark values. The maximum is 750 characters.

Responses

Request samples

Content type
application/json
{
  • "job": "string",
  • "location": "string",
  • "careerLevel": "string",
  • "industry": "string",
  • "companySize": "string",
  • "referenceDate": "string",
  • "releaseDate": "string",
  • "naicsCode": "string",
  • "additionalComments": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "message": "string",
  • "rci": "string"
}

Get salary benchmark values in bulk

Retrieve multiple base salary benchmark values in a single request.

Authorizations:
api_key
Request Body schema: application/json
required

A batch request takes a JSON object consisting of an array of your requests. You can batch up to 1000 individual requests in one API call.

Array
uuid
required
string

A unique identifier of the individual requests.
job
required
string

The job member ID.
industry
string

The industry member ID. If the ID is not provided, the response returns the benchmark value across all industries.
naicsCode
string

The North American Industry Classification System (NAICS) code.

If the NAICS code is not provided, the response returns the benchmark value across all industries. If both naicsCode and industry are provided, the response returns the benchmark value for the industry parameter. The entered naicsCode will not be applied.
location
string

The location member ID. If the ID is not provided, the response returns the benchmark value across all locations.
companySize
string

The company size member ID. If the ID is not provided, the response returns the benchmark value across all company sizes.
careerLevel
string

The career level member ID. If the ID is not provided, the response returns the benchmark value across all career levels.
matchDate
string

The date on which the career level was matched in yyyy-MM-dd format. A matchDate allows precise migration of career levels according to job architecture changes released since the match was made. If matchDate is not available, the migration assumes the most recent possible match date for the provided career level.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Get benchmark metadata

Retrieve metadata that summarizes the benchmark dataset and API such as the release date.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Dimensions

Discover dimensions and members.

A dimension organizes unique values of an attribute into a list or a hierarchical structure of members. The structure can be navigated to discover the members, and the members can be used to look up benchmark values.

Get jobs V1

Retrieve a list of all the jobs in Visier's ontology. A new version of this endpoint is now available. For more information, see GET /v2/compensation-benchmarks/jobs.

Authorizations:
api_key
queryParameters
hierarchy
string

The ID of the job hierarchy to navigate.

If not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings.
parent
string

The ID of the parent member.

If the ID is provided, the response returns the immediate children of the parent member.

To get the top-level members, use the value root.

Member availability and the parent-child relationship depends on the selected hierarchy. Please refer to the hierarchy parameter.
term
string

The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results.

The minimum length is 2 characters and the maximum length is 100 characters.

The search term must be URL encoded.
naicsCode
string

The North American Industry Classification System (NAICS) code.

If naicsCode is provided, term is required. The most relevant job members associated with the naicsCode are returned first.
hasBenchmarkValue
boolean

Filter members based on the availability of benchmark values. If true, members with benchmark values are returned. If false, members without benchmark values are returned. If no value is specified, all members are returned.
semanticOnly
boolean

If true, only semantic search will be used to find matches. Ensure the parameter lexicalOnly is set to false. Default is false. By default, both semantic and lexical search are used to find matches.
lexicalOnly
boolean

If true, only lexical search will be used to find matches. Ensure the parameter semanticOnly is set to false. Default is false. By default, both semantic and lexical search are used to find matches.
typicalTitlesSearch
boolean

If true, similar job titles for a job member are included in the lexical search for matches. Default is false.
showHierarchy
boolean

If true, returns members in a tree structure based on the occupation hierarchy. Default is false.
includeArchived
boolean

If true, both active and archived members are returned. Default is false. Members are archived when taxonomy changes are made.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get jobs V2

Retrieve a list of all the jobs in Visier's ontology. Jobs V2 improves upon Jobs V1 in the following ways:

  • Supports pagination through the page and limit parameters.
  • Returns both the short and long versions of job descriptions and job typical titles.
Authorizations:
api_key
queryParameters
hierarchy
string

The ID of the job hierarchy to navigate.

If not provided, Visier's default job hierarchy is used. In the default hierarchy, jobs are organized into three levels with domain and subdomain groupings.
parent
string

The ID of the parent member.

If the ID is provided, the response returns the immediate children of the parent member.

To get the top-level members, use the value root.

Member availability and the parent-child relationship depends on the selected hierarchy. Please refer to the hierarchy parameter.
term
string

The input search term. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results.

The minimum length is 2 characters and the maximum length is 100 characters.

The search term must be URL encoded.
naicsCode
string

The North American Industry Classification System (NAICS) code.

If naicsCode is provided, term is required. The most relevant job members associated with the naicsCode are returned first.
hasBenchmarkValue
boolean

Filter members based on the availability of benchmark values. If true, members with benchmark values are returned. If false, members without benchmark values are returned. If no value is specified, all members are returned.
semanticOnly
boolean

If true, only semantic search will be used to find matches. Ensure the parameter lexicalOnly is set to false. Default is false. By default, both semantic and lexical search are used to find matches.
lexicalOnly
boolean

If true, only lexical search will be used to find matches. Ensure the parameter semanticOnly is set to false. Default is false. By default, both semantic and lexical search are used to find matches.
typicalTitlesSearch
boolean

If true, similar job titles for a job member are included in the lexical search for matches. Default is false.
showHierarchy
boolean

If true, returns members in a tree structure based on the occupation hierarchy. Default is false.
includeArchived
boolean

If true, both active and archived members are returned. Default is false. Members are archived when taxonomy changes are made.
page
integer

The subset of the overall result set to return. The number of rows per page is equal to limit, except the last page which may contain fewer rows. Page is an index that begins at 0. The index to start retrieving results is calculated by multiplying page by limit. Default is to return results for page 0.
limit
integer

The maximum number of entries to return. Default and maximum are 1000 entries.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Standardize custom job titles in bulk

Find the top standardized job matches for any custom job title and optional NAICS code in bulk.

Authorizations:
api_key
Request Body schema: application/json
required

The custom job titles that you want to retrieve standardized jobs for, the optional NAICS code to retrieve industry specific jobs, and the optional number of top matches to retrieve.

By default, both semantic and lexical search are used to find matches. If you want to use a specific search method, set one of the parameters semanticOnly or lexicalOnly to true. Default for semanticOnly and lexicalOnly are false.

The minimum custom job title length is 2 characters and the maximum length is 100 characters. You can submit up to 30 custom job titles per request.

The default number of top matches returned is 5.

terms
required
Array of strings

A list of input search terms. The job members that are the most semantically similar to the search term are returned with the most relevant job members displayed first. Your search term may not be included in the results as semantic search goes beyond keyword matching and attempts to interpret the meaning behind the query to provide search results.

The maximum number of search terms is 30.

For the individual search term, the minimum length is 2 characters and the maximum length is 100 characters.
naicsCode
string

The North American Industry Classification System (NAICS) code.

If naicsCode is provided, the most relevant job titles associated with the naicsCode are returned first.
numMatches
integer
Default: 5

The number of top matches to retrieve.
semanticOnly
boolean
Default: false

If true, only semantic search will be used to find matches. Ensure the parameter lexicalOnly is set to false. Default is false. By default, both semantic and lexical search are used to find matches.
lexicalOnly
boolean
Default: false

If true, only lexical search will be used to find matches. Ensure the parameter semanticOnly is set to false. Default is false. By default, both semantic and lexical search are used to find matches.
typicalTitlesSearch
boolean
Default: false

If true, similar job titles for a job member are included in the lexical search for matches. Default is false.
includeArchived
boolean
Default: false

If true, both active and archived members are returned. Default is false. Members are archived when taxonomy changes are made.

Responses

Request samples

Content type
application/json
{
  • "terms": [
    ],
  • "naicsCode": "string",
  • "numMatches": 5,
  • "semanticOnly": false,
  • "lexicalOnly": false,
  • "typicalTitlesSearch": false,
  • "includeArchived": false
}

Response samples

Content type
application/json
[
  • {
    }
]

Get job hierarchies

Retrieve a list of all hierarchies used to organize jobs.

Authorizations:
api_key
queryParameters
naicsCode
string

The North American Industry Classification System (NAICS) code.

If provided, the response returns the hierarchies associated with the code.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search jobs by IDs

Retrieve a matching job for each specified job ID.

Authorizations:
api_key
Request Body schema: application/json
required

The job IDs that you want to retrieve a job match.

Include the mandatory jobIDs field.

jobIDs
required
Array of strings

A list of job IDs to search jobs. The maximum number of job IDs is 1000.

Responses

Request samples

Content type
application/json
{
  • "jobIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Send feedback to help improve the quality of the job match results

This API allows you to submit feedback on the quality of the job match results returned by the Get jobs endpoint.

You must include the search term (job title you entered) in the request body. You can include the optional naicsCode if it was used as part of the search in the Get jobs endpoint.

You can also submit additional comments by providing values for additionalComments, along with term and naicsCode.

Note:

For term, the minimum is 2 characters and the maximum is 100 characters.

For additionalComments, the maximum is 750 characters.

Authorizations:
api_key
Request Body schema: application/json
required

The feedback you want to submit for.

Ensure to include the mandatory fields: search term (term).

term
required
string

The search term (job title) you entered when using the Get jobs endpoint. You're providing feedback on the quality of the search results for this term. This field is required. The minimum is 2 characters and the maximum is 100 characters.
naicsCode
string

If provided, the naicsCode entered when using the Get jobs endpoint. You're providing feedback on the quality of the results for the search term and code.
additionalComments
string

Additional written feedback about the job match results returned by the Get jobs endpoint. The maximum is 750 characters.

Responses

Request samples

Content type
application/json
{
  • "term": "string",
  • "naicsCode": "string",
  • "additionalComments": "string"
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "message": "string",
  • "rci": "string"
}

Get industries

Retrieve a list of all available industries.

Authorizations:
api_key
queryParameters
parent
string

The ID of the parent member.

If the ID is provided, the response returns the immediate children of the parent member.

To get the top-level members, use the value root.
naicsCode
string

The North American Industry Classification System (NAICS) code.

If provided, the response returns the best matching member associated with the code.
showHierarchy
boolean

If true, returns members in a tree structure based on the industry hierarchy. Default is false.
hasBenchmarkValue
boolean

Filter members based on the availability of benchmark values. If true, members with benchmark values are returned. If false, members without benchmark values are returned. If no value is specified, all members are returned.
includeArchived
boolean

If true, both active and archived members are returned. Default is false. Members are archived when taxonomy changes are made.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get locations

Retrieve a list of all available locations.

Authorizations:
api_key
queryParameters
parent
string

The ID of the parent member.

If the ID is provided, the response returns the immediate children of the parent member.

To get the top-level member, use the value root.
countryCode
string

The ISO 3166-1 country code to look up. Returns location members that match the country code.

Currently, the only supported country code is US.
postalCode
string

Postal code to look up. If postalCode is provided, countryCode is required. Returns location members that match both the country code and postal code.
showHierarchy
boolean

If true, returns members in a tree structure based on the location hierarchy. Default is false.
hasBenchmarkValue
boolean

Filter members based on the availability of benchmark values. If true, members with benchmark values are returned. If false, members without benchmark values are returned. If no value is specified, all members are returned.
includeArchived
boolean

If true, both active and archived members are returned. Default is false. Members are archived when taxonomy changes are made.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get location members in bulk

Retrieve location members in bulk by country code and postal code.

Authorizations:
api_key
Request Body schema: application/json
required

A list of requests that contain a combination of country and postal codes to look up. Returns location members that match both codes.

required
Array of objects (LocationSearchInput)
hasBenchmarkValue
boolean

Filter members based on the availability of benchmark values. If true, members with benchmark values are returned. If false, members without benchmark values are returned. If no value is specified, all members are returned.

Responses

Request samples

Content type
application/json
{
  • "searchInputs": [
    ],
  • "hasBenchmarkValue": true
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Get company sizes

Retrieve a list of all available company sizes.

Authorizations:
api_key
queryParameters
headcount
integer

The number of employees.

If provided, the response returns the members with the same headcount.
hasBenchmarkValue
boolean

Filter members based on the availability of benchmark values. If true, members with benchmark values are returned. If false, members without benchmark values are returned. If no value is specified, all members are returned.
includeArchived
boolean

If true, both active and archived members are returned. Default is false. Members are archived when taxonomy changes are made.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get career levels

Retrieve a list of all available career levels.

Authorizations:
api_key
queryParameters
job
string

The job member ID.

If provided, the response returns the members for the job.
hasBenchmarkValue
boolean

Filter members based on the availability of benchmark values. If true, members with benchmark values are returned. If false, members without benchmark values are returned. If no value is specified, all members are returned.
includeArchived
boolean

If true, both active and archived members are returned. Default is false. Members are archived when taxonomy changes are made.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get career level members in bulk

Retrieve career level members in bulk by job IDs.

Authorizations:
api_key
Request Body schema: application/json
required

A list of requests that contain job IDs to look up. Returns career levels that match.

Include the mandatory jobIDs field.

jobIDs
required
Array of strings

A list of job IDs to retrieve career levels for. The maximum number of job IDs is 500.
hasBenchmarkValue
boolean

Filter members based on the availability of benchmark values. If no value is specified, all members are returned. If true, members with benchmark values are returned. If false, members without benchmark values are returned.

Responses

Request samples

Content type
application/json
{
  • "jobIDs": [
    ],
  • "hasBenchmarkValue": true
}

Response samples

Content type
application/json
{
  • "successes": [
    ],
  • "failures": [
    ]
}

Retrieve taxonomy changes

Retrieve a list of taxonomy changes in CSV format, including updates to jobs, locations, industries, career levels, and company size up to the latest release.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "message": "string",
  • "rci": "string"
}