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

A list of analytic tenants to dispatch extraction jobs for. One extraction job is dispatched per tenant. Only valid for requests from an administrating tenant.
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

A list of analytic tenants to dispatch extraction jobs for. One extraction job is dispatched per tenant. Only valid for requests from an administrating tenant.
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 tenant codes of the tenants to run processing jobs for. If omitted, runs a processing job for the tenant associated with the user who made the API request. Only valid for requests from an administrating tenant.
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 IDs of the tenants to exclude from the extraction job. Only valid if allTenants is "true". Only valid for requests from an administrating tenant.

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.
Note: This header is in limited availability. If you are interested in using it, please contact your Customer Success Manager (CSM).
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.