Download OpenAPI specification:Download
You can use the Imply Polaris API to programmatically manage your tables, files, and ingestion tasks. See API overview for information and examples on how to get started.
Polaris API resources are either global or regional.
You can access a global resource irrespective of the cloud service provider or region in which Polaris hosts your project.
Global resources are relative to the base URL https://ORGANIZATION_NAME.api.imply.io
, where ORGANIZATION_NAME
is the custom domain through which you access Polaris.
The Polaris API supports the following global resources:
A regional resource is only accessible in the region where Polaris hosts your project. You must specify the project's region and cloud service provider to call a regional resource.
Regional resources are relative to the base URL https://ORGANIZATION_NAME.REGION.CLOUD_PROVIDER.api.imply.io/v1/projects/PROJECT_ID
.
Replace the following:
ORGANIZATION_NAME
: The custom domain through which you access Polaris.
REGION
: The cloud region of your Polaris project. Polaris supports the following regions:
us-east-1
us-west-2
ap-south-1
eu-central-1
eu-west-1
CLOUD_PROVIDER
: The cloud service provider for your Polaris infrastructure. Currently, Polaris only supports AWS.
PROJECT_ID
: The unique identifier for your Polaris project.
For example: https://example.us-east-1.aws.api.imply.io/v1/projects/12375ffx-f7x4-4f0x-a1a6-3b3424987ee0/files
.
The Polaris API supports the following regional resources:
For projects created after September 29, 2023, the Collections, Embedding, Events, Files, and Query APIs require the project ID in the base URL. We strongly recommend updating your regional API calls for existing projects to include the project ID prior to September 2024. See the API migration guide for more information.
The following Polaris API resources are deprecated. Instead, use the suggested replacements.
Deprecated resource | Replacement | Deprecation date | Removal date |
---|---|---|---|
Connections v2 | Connections v1 | September 2023 | September 2024 |
Embedding v1 | Embedding links v1 | February 2024 | September 2024 |
Jobs v2 | Jobs v1 | September 2023 | September 2024 |
Project v1 | Projects v1 | September 2023 | September 2024 |
Tables v2 | Tables v1 | September 2023 | September 2024 |
For more information, see Migration guide for deprecated APIs.
Imply uses conventional HTTP response codes to indicate success or failure of a Polaris API request. In general:
2xx
range indicate success.4xx
range indicate an error that failed due to the information supplied in the request—for example, a required parameter is missing.5xx
range indicate an error with the Imply servers.Some of the most commonly received status codes are as follows:
Code | Description |
---|---|
200 - OK |
Successful request. |
400 - Bad request |
The request was unacceptable, often due to missing a required parameter. The response usually contains information about the problem and how to resolve it. |
401 - Unauthorized |
Valid OAuth credentials not found. See Authenticate API requests for information on obtaining credentials for Polaris API requests. |
403 - Forbidden |
The supplied user credentials don't have permissions to perform the request. |
404 - Not found |
The requested resource doesn't exist. |
409 - Conflict |
The request can't complete—for example, due to a conflict with the current state of the target resource. |
429 - Too many requests |
Too many requests hit the API too quickly. For push streaming requests the response contains details on how many requests you can send in a defined period and how long to wait until retry. |
500 , 502 , 504 - Server errors |
Something went wrong at the Imply end. These are rare. Contact Polaris Support. |
503 - Service unavailable |
Polaris is temporarily unavailable, usually for scheduled maintenance. |
For more information see the official HTTP status code definitions.
Returns all existing connections.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project where the connections belong. |
{- "values": [
- {
- "modifiedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "modifiedOnTimestamp": "2019-08-24T14:15:22Z",
- "name": "example-connection",
- "submittedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "submittedOnTimestamp": "2019-08-24T14:15:22Z",
- "type": "azure",
- "description": "string"
}
]
}
Creates a new connection.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project where the connections belong. |
A connection to be created.
bootstrapServers required | string List of host and port pairs used for establishing the initial connection to the Kafka cluster. |
name required | string (ConnectionNamePayload) [ 1 .. 64 ] characters Name of the connection. A connection name can only contain ASCII letters, numbers, and the following characters: |
required | object (ConnectionSecretsRequiredPayload) Type of connection secrets. The following secrets types are supported:
|
topicName required | string (KafkaTopicNamePayload) The topic name or a regular expression that identifies the Kafka topics. |
type required | string (ConnectionTypePayload) Type of the connection. For reference on the information required for each connection type, see Create a connection. |
description | string (ConnectionDescriptionPayload) Optional description for the connection. |
topicNameIsPattern | boolean (KafkaTopicNameIsPatternPayload) Default: false Whether the topic name is a regex pattern. If false, Polaris looks for a single topic with the exact name in |
{- "name": "example-connection",
- "type": "confluent",
- "description": "string",
- "bootstrapServers": "pkc-xxxxx.us-east-1.aws.confluent.cloud:9092",
- "topicName": "example-topic",
- "topicNameIsPattern": false,
- "secrets": {
- "type": "aws_iam"
}
}
{- "modifiedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "modifiedOnTimestamp": "2019-08-24T14:15:22Z",
- "name": "example-connection",
- "submittedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "submittedOnTimestamp": "2019-08-24T14:15:22Z",
- "type": "confluent",
- "description": "string",
- "bootstrapServers": "pkc-xxxxx.us-east-1.aws.confluent.cloud:9092",
- "topicName": "example-topic",
- "topicNameIsPattern": false,
- "secrets": {
- "type": "aws_iam"
}
}
Returns information for a single connection.
name required | string (ConnectionNamePayload) [ 1 .. 64 ] characters Example: example-connection The name of the connection to get. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project where the connection belongs. |
{- "modifiedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "modifiedOnTimestamp": "2019-08-24T14:15:22Z",
- "name": "example-connection",
- "submittedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "submittedOnTimestamp": "2019-08-24T14:15:22Z",
- "type": "confluent",
- "description": "string",
- "bootstrapServers": "pkc-xxxxx.us-east-1.aws.confluent.cloud:9092",
- "topicName": "example-topic",
- "topicNameIsPattern": false,
- "secrets": {
- "type": "aws_iam"
}
}
Updates details for a specific connection.
name required | string The name of the connection to update. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project where the connection belongs. |
The updated connection spec.
type required | string (ConnectionTypePayload) Type of the connection. For reference on the information required for each connection type, see Create a connection. |
bootstrapServers | string List of host and port pairs used for establishing the initial connection to the Kafka cluster. |
description | string (ConnectionDescriptionPayload) Optional description for the connection. |
object (ConnectionSecretsOptionalPayload) Type for connection secrets. The following secrets types are supported:
| |
topicName | string (KafkaTopicNamePayload) The topic name or a regular expression that identifies the Kafka topics. |
topicNameIsPattern | boolean (KafkaTopicNameIsPatternPayload) Default: false Whether the topic name is a regex pattern. If false, Polaris looks for a single topic with the exact name in |
{- "type": "confluent",
- "description": "string",
- "bootstrapServers": "pkc-xxxxx.us-east-1.aws.confluent.cloud:9092",
- "topicName": "example-topic",
- "topicNameIsPattern": false,
- "secrets": {
- "type": "aws_iam"
}
}
{- "modifiedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "modifiedOnTimestamp": "2019-08-24T14:15:22Z",
- "name": "example-connection",
- "submittedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "submittedOnTimestamp": "2019-08-24T14:15:22Z",
- "type": "confluent",
- "description": "string",
- "bootstrapServers": "pkc-xxxxx.us-east-1.aws.confluent.cloud:9092",
- "topicName": "example-topic",
- "topicNameIsPattern": false,
- "secrets": {
- "type": "aws_iam"
}
}
Deletes an existing connection.
name required | string The name the connection to delete. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project where the connection belongs. |
{ }
Checks whether an existing connection is valid.
name required | string The name of the connection to test. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project where the connection belongs. |
{ }
Returns meta information related to connections.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project where the meta information related to connections belongs. |
{- "externalId": "123e4567-e89b-12d3-a456-426614174000",
- "implyArn": "arn:aws:iam::123456789012:role/imply-cluster-1234567"
}
Sends data from an application source to a Polaris connection.
connectionName required | string The name of the connection to push data to. Note that for legacy tables created via the v1 API, the connection name is named after the table ID. |
projectId required | string The project ID for the request. |
Data to push to the Polaris table.
See Supported data and file formats for the data formats that Polaris supports for streaming ingestion.
The event data must include a timestamp value. For more information on event payload requirements, see Push event data by API.
"{\"__time\":\"2022-04-16T00:46:58.771Z\",\"channel\":\"#en.wikipedia\",\"user\":\"GELongstreet\",\"added\":36,\"deleted\":0}\n{\"__time\":\"2022-04-17T04:07:28.781Z\",\"channel\":\"#de.wikipedia\",\"user\":\"Kolega2357\",\"added\":13,\"deleted\":16}"
List files.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project containing the files. |
paginationLimit | integer [ 1 .. 1000 ] Default: 1000 A result limit for pagination. |
paginationOffset | integer >= 0 Default: 0 A result offset for pagination. |
searchString | string Filter the results to only include files that have the provided string contained within one of their fields. |
sortColumn | string (FileSortColumn) Default: "uploaded_on_dt" Enum: "compression_format" "data_format" "digest_algo" "digest_hash" "name" "size_bytes" "uploaded_by_user_name" "uploaded_on_dt" The column to sort file results by. |
sortOrder | string (SortOrder) Default: "DESC" Enum: "ASC" "DESC" Example: sortOrder=ASC The order to sort file results by. |
{- "files": [
- {
- "compressionFormat": "gz",
- "dataFormat": "nd-json",
- "digest": {
- "algo": "md5",
- "hash": "098f6bcd4621d373cade4e832627b4f6"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "weather/20210603/01/hourly.json",
- "sizeBytes": 207394342360,
- "uploadedBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "uploadedOnDatetime": "2021-09-07T05:02:24Z"
}
], - "links": {
- "@nextLink": "string",
- "@prevLink": "string"
}, - "space": {
- "allocatedBytes": 1000000000000,
- "usedBytes": 39234249,
- "remainingBytes": 999960765751
}, - "totalCount": 0
}
Uploads a file to the Polaris staging area.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project containing the files. |
compressionFormat | string (CompressionFormat) Enum: "none" "bz2" "gz" "sz" "xz" "zstd" Example: compressionFormat=gz If specified, the compression used for the file. Otherwise, Polaris infers the compression from the filename or
the Supported compression formats:
|
dataFormat | string (DataFormat) Enum: "avro_ocf" "avro_stream" "csv" "kafka" "nd-json" "orc" "parquet" "protobuf" Example: dataFormat=nd-json If specified, the format of the data. Otherwise, Polaris infers the data format from the filename or
the For more information on supported data formats, see Supported data and file formats. |
A multipart/form-data request containing a single part with the file to be uploaded.
You should not set the Content-Type: multipart/form-data
header explicitly.
Allow your client to assign the header automatically because it will also
properly set the associated boundary directive.
The total size of the request including the file, HTTP headers, etc. must be less than 10 GB. This limit refers to the size of the file transmitted by the browser or HTTP client. You may upload a file that's larger than 10 GB on disk if your browser or client compresses the file in transit to below 10 GB.
File names must be unique. You cannot upload two files with the same name to Polaris.
file | string <binary> |
{- "compressionFormat": "gz",
- "dataFormat": "nd-json",
- "digest": {
- "algo": "md5",
- "hash": "098f6bcd4621d373cade4e832627b4f6"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "weather/20210603/01/hourly.json",
- "sizeBytes": 207394342360,
- "uploadedBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "uploadedOnDatetime": "2021-09-07T05:02:24Z"
}
Returns information for a single file.
name required | string Name of the file (may contain slashes) |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project where the file belongs. |
{- "compressionFormat": "gz",
- "dataFormat": "nd-json",
- "digest": {
- "algo": "md5",
- "hash": "098f6bcd4621d373cade4e832627b4f6"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "weather/20210603/01/hourly.json",
- "sizeBytes": 207394342360,
- "uploadedBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "uploadedOnDatetime": "2021-09-07T05:02:24Z"
}
Deletes a file.
name required | string Name of the file (may contain slashes) |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project where the file belongs. |
{ }
Returns all jobs.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The ID of the project where the tables belong. |
connectionName | Array of strings (ConnectionNamePayload) [ items [ 1 .. 64 ] characters ] Example: connectionName=example-connection The connection to filter jobs by. |
executionStatus | Array of strings (JobExecutionStatusV2) Items Enum: "pending" "running" "completed" "idle" "canceled" "failed" "unknown" Filters results with a certain execution status. For example, to list running jobs only, use the address |
healthStatus | Array of strings (JobHealthStatusV2) Items Enum: "ok" "warn" "error" Filters results with a certain health status. For example, to list jobs with warnings or errors, use the address |
paginationLimit | integer [ 1 .. 1000 ] Default: 100 A result limit for pagination. |
paginationOffset | integer >= 0 Default: 0 A result offset for pagination. |
searchString | string Filter results to those jobs where the given string is contained in one of the job's fields. |
sortColumn | string (JobSortSearchColumn) Default: "last_updated_date_time" Enum: "created_by_user_name" "created_date_time" "execution_status" "last_updated_date_time" "source_name" "source_type" "source_connection_name" "source_table_name" "target_table_name" "type" Sort results by one of the following fields:
|
sortOrder | string (SortOrder) Default: "DESC" Enum: "ASC" "DESC" Example: sortOrder=ASC The order to sort job results by. |
targetTableId | string <uuid> (TableId) Filters results for jobs associated with a particular target table id. |
targetTableName | string (TableName) [ 1 .. 255 ] characters Example: targetTableName=example-table Filters results for jobs associated with a particular target table name. |
type | Array of strings (JobTypeV2) Items Enum: "batch" "delete_data" "drop_table" "streaming" "sql" Example: type=batch Filters results with a certain job type. For example, to select batch and streaming jobs, use the address |
{- "values": [
- {
- "createdBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "createdTimestamp": "2021-06-06T00:00:00.000Z",
- "desiredExecutionStatus": "running",
- "executionStatus": "pending",
- "health": {
- "status": "ok"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "lastUpdatedTimestamp": "2021-06-06T00:00:00.000Z",
- "target": {
- "type": "table",
- "tableName": "example-table"
}, - "type": "batch",
- "completedTimestamp": "2021-06-06T00:00:00.000Z",
- "startedTimestamp": "2021-06-06T00:00:00.000Z"
}
], - "moreResultsAvailable": true
}
Creates a job.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The ID of the project where the tables belong. |
A job to be created.
required | object (JobSourceV2) Source input of the job. |
required | object (JobTargetV2) Target output of the job. |
type required | string (JobTypeV2) Default: "sql" Type of job:
For information about ingestion jobs, see Create an ingestion job and Ingest using SQL. |
object Context parameters used to specify various query configuration parameters. For more information, see SQL ingestion reference. | |
createTableIfNotExists | boolean Default: false Whether the job should create the table if it doesn't already exist. For more information, see Introduction to tables. |
desiredExecutionStatus | string (DesiredJobExecutionStatusV2) Default: "running" Enum: "running" "canceled" Desired execution status of the job. This field only applies to updating an ingestion job and is ignored when creating jobs. You cannot update a deletion job. The default desired execution status is |
filterExpression | string SQL expression to use for filtering the source data. |
ingestionMode | string (IngestionModeV2) Default: "append" Enum: "append" "replace" Mode of ingestion:
|
Array of objects (InputToTableSchemaMappingsV2) Relationship between the input fields and the output columns of a table's schema.
Define the Polaris column name in For batch ingestion jobs, you must include a mapping for each field. Polaris ignores
unmapped input fields. Streaming ingestion jobs may apply schema auto-discovery for
Polaris to discover input fields and map them directly to table dimensions.
Always specify a mapping for For more information, see Map and transform data with input expressions and Schema auto-discovery on ingestion jobs. | |
maxParseExceptions | integer Default: 2147483647 Configuration parameter that specifies the maximum number of parse exceptions that a task can tolerate before failing. |
{- "type": "batch",
- "desiredExecutionStatus": "running",
- "source": {
- "type": "uploaded",
- "fileList": [
- "example-file.json"
], - "formatSettings": {
- "format": "nd-json"
}, - "inputSchema": [
- {
- "dataType": "string",
- "name": "example-col1"
}, - {
- "dataType": "long",
- "name": "example-col2"
}
]
}, - "target": {
- "type": "table",
- "tableName": "example-table"
}, - "context": { },
- "createTableIfNotExists": false,
- "filterExpression": "\"dimension\" > 0",
- "ingestionMode": "append",
- "mappings": [
- {
- "columnName": "example-column",
- "expression": "\"inputField1\" + \"inputField2\"",
- "isAggregation": true
}
], - "maxParseExceptions": 2147483647
}
{- "createdBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "createdTimestamp": "2021-06-06T00:00:00.000Z",
- "desiredExecutionStatus": "running",
- "executionStatus": "pending",
- "health": {
- "status": "ok"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "lastUpdatedTimestamp": "2021-06-06T00:00:00.000Z",
- "spec": {
- "type": "batch",
- "desiredExecutionStatus": "running"
}, - "target": {
- "type": "table",
- "tableName": "example-table"
}, - "type": "batch",
- "completedTimestamp": "2021-06-06T00:00:00.000Z",
- "startedTimestamp": "2021-06-06T00:00:00.000Z",
- "source": {
- "type": "uploaded",
- "fileList": [
- "example-file.json"
], - "formatSettings": {
- "format": "nd-json"
}, - "inputSchema": [
- {
- "dataType": "string",
- "name": "example-col1"
}, - {
- "dataType": "long",
- "name": "example-col2"
}
]
}, - "context": { },
- "filterExpression": "\"dimension\" > 0",
- "ingestionMode": "append",
- "mappings": [
- {
- "columnName": "example-column",
- "expression": "\"inputField1\" + \"inputField2\"",
- "isAggregation": true
}
], - "maxParseExceptions": 2147483647,
- "query": "string"
}
Returns information for a single job.
jobId required | string <uuid> (JobIdPayload) The server-generated ID of the job for which to get the metadata. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The project ID where the tables belong. |
{- "createdBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "createdTimestamp": "2021-06-06T00:00:00.000Z",
- "desiredExecutionStatus": "running",
- "executionStatus": "pending",
- "health": {
- "status": "ok"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "lastUpdatedTimestamp": "2021-06-06T00:00:00.000Z",
- "spec": {
- "type": "batch",
- "desiredExecutionStatus": "running"
}, - "target": {
- "type": "table",
- "tableName": "example-table"
}, - "type": "batch",
- "completedTimestamp": "2021-06-06T00:00:00.000Z",
- "startedTimestamp": "2021-06-06T00:00:00.000Z",
- "source": {
- "type": "uploaded",
- "fileList": [
- "example-file.json"
], - "formatSettings": {
- "format": "nd-json"
}, - "inputSchema": [
- {
- "dataType": "string",
- "name": "example-col1"
}, - {
- "dataType": "long",
- "name": "example-col2"
}
]
}, - "context": { },
- "filterExpression": "\"dimension\" > 0",
- "ingestionMode": "append",
- "mappings": [
- {
- "columnName": "example-column",
- "expression": "\"inputField1\" + \"inputField2\"",
- "isAggregation": true
}
], - "maxParseExceptions": 2147483647,
- "query": "string"
}
Updates a job.
You can update an ingestion job to cancel its execution. Polaris does not support other updates to ingestion jobs. Deletion jobs cannot be updated.
jobId required | string <uuid> (JobIdPayload) The server-generated ID of the job for which to get the metadata. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The project ID where the tables belong. |
The job to be updated.
desiredExecutionStatus required | string (DesiredJobExecutionStatusV2) Default: "running" Enum: "running" "canceled" Desired execution status of the job. This field only applies to updating an ingestion job and is ignored when creating jobs. You cannot update a deletion job. The default desired execution status is |
{- "desiredExecutionStatus": "running"
}
{- "createdBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "createdTimestamp": "2021-06-06T00:00:00.000Z",
- "desiredExecutionStatus": "running",
- "executionStatus": "pending",
- "health": {
- "status": "ok"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "lastModifiedBy": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "lastUpdatedTimestamp": "2021-06-06T00:00:00.000Z",
- "spec": {
- "type": "batch",
- "desiredExecutionStatus": "running"
}, - "target": {
- "type": "table",
- "tableName": "example-table"
}, - "type": "batch",
- "completedTimestamp": "2021-06-06T00:00:00.000Z",
- "startedTimestamp": "2021-06-06T00:00:00.000Z",
- "source": {
- "type": "uploaded",
- "fileList": [
- "example-file.json"
], - "formatSettings": {
- "format": "nd-json"
}, - "inputSchema": [
- {
- "dataType": "string",
- "name": "example-col1"
}, - {
- "dataType": "long",
- "name": "example-col2"
}
]
}, - "context": { },
- "filterExpression": "\"dimension\" > 0",
- "ingestionMode": "append",
- "mappings": [
- {
- "columnName": "example-column",
- "expression": "\"inputField1\" + \"inputField2\"",
- "isAggregation": true
}
], - "maxParseExceptions": 2147483647,
- "query": "string"
}
Returns progress for a job.
jobId required | string <uuid> (JobIdPayload) The server-generated ID of the job for which to get the metadata. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The project ID where the tables belong. |
{- "overallProgress": 0
}
Returns logs for a job.
jobId required | string <uuid> (JobIdPayload) The server-generated ID of the job for which to get the metadata. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The project ID where the tables belong. |
{- "logs": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "healthStatus": "ok",
- "code": "string",
- "message": "string"
}
]
}
Returns detailed metrics about a job.
jobId required | string <uuid> (JobIdPayload) The server-generated ID of the job for which to get the metadata. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The project ID where the tables belong. |
{- "totals": {
- "numBytesProcessed": 0,
- "numRowsPersisted": 0,
- "numRowsProcessed": 0,
- "numRowsProcessedWithWarning": 0,
- "numRowsSkippedByError": 0,
- "numRowsSkippedByFilter": 0
}
}
Resets a streaming ingestion job.
This resets the point from which Polaris ingests streaming data to
readFromPoint
set in current streaming ingestion jobs. Only applies
when there was a previous streaming ingestion job that used the same
topic or stream name for the same target table. For more information,
see Reset streaming job offset.
jobId required | string <uuid> (JobIdPayload) The server-generated ID of the job |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The project ID where the tables belong. |
{ }
Returns all available tables for a project.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project containing the tables. |
{- "values": [
- {
- "availability": "available",
- "createdByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "createdOnTimestamp": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "modifiedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "modifiedOnTimestamp": "2021-06-06T00:00:00.000Z",
- "name": "example-table",
- "partitioningGranularity": "day",
- "schemaMode": "flexible",
- "storagePolicy": {
- "cached": {
- "type": "period"
}, - "retain": {
- "type": "period"
}
}, - "totalDataSizeBytes": 12345678,
- "totalRows": 1234,
- "type": "detail",
- "version": 0,
- "description": "Description of example-table"
}
]
}
Creates a table.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project containing the tables. |
A table to be created.
name required | string (TableName) [ 1 .. 255 ] characters The unique, immutable name of the table. |
type required | string (TableType) The type of table. Once set, you cannot change a table's type. The following table types are supported:
|
version required | integer <int64> (TableVersion) Default: 0 The version number of the table. Newly created tables are always initialized at version 0. Do not provide the version number when creating a table. When updating a table, provide the current table version number. If the version number in the request is not the current version, Polaris raises a |
clusteringColumns | Array of strings or null (TableClusteringColumns) Table columns to use for clustering. Polaris sorts table columns within the partition based on their order in this array. For aggregate tables, only dimensions (not measures) are supported for clustering.
If a nonexistent column is specified, Polaris raises a For more information, see Clustering. |
description | string or null (TableDescription) The table's description, limited to 1000 characters. |
partitioningGranularity | string (TablePartitioningGranularity) Default: "day" Enum: "second" "minute" "five_minute" "ten_minute" "fifteen_minute" "thirty_minute" "hour" "six_hour" "eight_hour" "day" "week" "month" "quarter" "year" "all" The time partitioning of the table. The |
object (GranularityPayload) The table's rollup granularity. Determines how to bucket data across the time dimension, such as aggregating data by hour.
When set, | |
Array of objects (AggregateTableColumn) The table's schema. The order of the elements determines the order of the columns in the Polaris UI and in | |
schemaMode | string (TableSchemaMode) Enum: "flexible" "strict" The table's schema enforcement mode. For more information, see Introduction to tables. |
object (TableStoragePolicy) Policy specifying the time range of data to retain or cache.
| |
timeResolution | string (TimeResolution) Default: "millisecond" Enum: "millisecond" "second" "minute" "fifteen_minute" "thirty_minute" "hour" "day" "week" "month" "quarter" "year" "all" The table's rollup granularity. See Introduction to data rollup for more details. You can specify a variable duration or a time zone and origin for a |
{- "name": "example-table",
- "type": "aggregate",
- "version": 0,
- "clusteringColumns": [
- "example-column"
], - "description": "Description of example-table",
- "partitioningGranularity": "day",
- "storagePolicy": {
- "cached": {
- "type": "period"
}, - "retain": {
- "type": "period"
}
}, - "schemaMode": "flexible",
- "queryGranularity": {
- "type": "simple"
}, - "schema": [
- {
- "type": "dimension",
- "name": "example-column",
- "dataType": "string"
}
], - "timeResolution": "millisecond"
}
{- "name": "example-table",
- "type": "aggregate",
- "version": 0,
- "availability": "available",
- "clusteringColumns": [
- "example-column"
], - "createdByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "createdOnTimestamp": "2019-08-24T14:15:22Z",
- "description": "Description of example-table",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "modifiedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "modifiedOnTimestamp": "2021-06-06T00:00:00.000Z",
- "partitioningGranularity": "day",
- "queryableSchema": [
- {
- "name": "example-column",
- "dataType": "string"
}
], - "storagePolicy": {
- "cached": {
- "type": "period"
}, - "retain": {
- "type": "period"
}
}, - "schemaMode": "flexible",
- "segmentCompactedBytes": 12345678,
- "segmentTotalBytes": 12345678,
- "totalDataSizeBytes": 12345678,
- "totalRows": 1234,
- "queryGranularity": {
- "type": "simple"
}, - "schema": [
- {
- "type": "dimension",
- "name": "example-column",
- "dataType": "string"
}
], - "timeResolution": "millisecond"
}
Returns information for a single table.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project containing the table. |
tableRef required | string (TableName) [ 1 .. 255 ] characters Example: example-table Name of the table for which to get information. |
{- "name": "example-table",
- "type": "aggregate",
- "version": 0,
- "availability": "available",
- "clusteringColumns": [
- "example-column"
], - "createdByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "createdOnTimestamp": "2019-08-24T14:15:22Z",
- "description": "Description of example-table",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "modifiedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "modifiedOnTimestamp": "2021-06-06T00:00:00.000Z",
- "partitioningGranularity": "day",
- "queryableSchema": [
- {
- "name": "example-column",
- "dataType": "string"
}
], - "storagePolicy": {
- "cached": {
- "type": "period"
}, - "retain": {
- "type": "period"
}
}, - "schemaMode": "flexible",
- "segmentCompactedBytes": 12345678,
- "segmentTotalBytes": 12345678,
- "totalDataSizeBytes": 12345678,
- "totalRows": 1234,
- "queryGranularity": {
- "type": "simple"
}, - "schema": [
- {
- "type": "dimension",
- "name": "example-column",
- "dataType": "string"
}
], - "timeResolution": "millisecond"
}
Updates a table.
You can add columns to a table's schema at any point. You can only update or remove columns from a table's schema when the table is empty and has no active ingestion jobs.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project containing the table. |
tableRef required | string (TableName) [ 1 .. 255 ] characters Example: example-table Name of the table for which to get information. |
The table to be updated.
name required | string (TableName) [ 1 .. 255 ] characters The unique, immutable name of the table. |
type required | string (TableType) The type of table. Once set, you cannot change a table's type. The following table types are supported:
|
version required | integer <int64> (TableVersion) Default: 0 The version number of the table. Newly created tables are always initialized at version 0. Do not provide the version number when creating a table. When updating a table, provide the current table version number. If the version number in the request is not the current version, Polaris raises a |
clusteringColumns | Array of strings or null (TableClusteringColumns) Table columns to use for clustering. Polaris sorts table columns within the partition based on their order in this array. For aggregate tables, only dimensions (not measures) are supported for clustering.
If a nonexistent column is specified, Polaris raises a For more information, see Clustering. |
description | string or null (TableDescription) The table's description, limited to 1000 characters. |
partitioningGranularity | string (TablePartitioningGranularity) Default: "day" Enum: "second" "minute" "five_minute" "ten_minute" "fifteen_minute" "thirty_minute" "hour" "six_hour" "eight_hour" "day" "week" "month" "quarter" "year" "all" The time partitioning of the table. The |
object (GranularityPayload) The table's rollup granularity. Determines how to bucket data across the time dimension, such as aggregating data by hour.
When set, | |
Array of objects (AggregateTableColumn) The table's schema. The order of the elements determines the order of the columns in the Polaris UI and in | |
schemaMode | string (TableSchemaMode) Enum: "flexible" "strict" The table's schema enforcement mode. For more information, see Introduction to tables. |
object (TableStoragePolicy) Policy specifying the time range of data to retain or cache.
| |
timeResolution | string (TimeResolution) Default: "millisecond" Enum: "millisecond" "second" "minute" "fifteen_minute" "thirty_minute" "hour" "day" "week" "month" "quarter" "year" "all" The table's rollup granularity. See Introduction to data rollup for more details. You can specify a variable duration or a time zone and origin for a |
{- "name": "example-table",
- "type": "aggregate",
- "version": 0,
- "clusteringColumns": [
- "example-column"
], - "description": "Description of example-table",
- "partitioningGranularity": "day",
- "storagePolicy": {
- "cached": {
- "type": "period"
}, - "retain": {
- "type": "period"
}
}, - "schemaMode": "flexible",
- "queryGranularity": {
- "type": "simple"
}, - "schema": [
- {
- "type": "dimension",
- "name": "example-column",
- "dataType": "string"
}
], - "timeResolution": "millisecond"
}
{- "name": "example-table",
- "type": "aggregate",
- "version": 0,
- "availability": "available",
- "clusteringColumns": [
- "example-column"
], - "createdByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "createdOnTimestamp": "2019-08-24T14:15:22Z",
- "description": "Description of example-table",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "modifiedByUser": {
- "username": "user@imply.io",
- "userId": "631db145-a6d9-492f-9c9e-99240345628a"
}, - "modifiedOnTimestamp": "2021-06-06T00:00:00.000Z",
- "partitioningGranularity": "day",
- "queryableSchema": [
- {
- "name": "example-column",
- "dataType": "string"
}
], - "storagePolicy": {
- "cached": {
- "type": "period"
}, - "retain": {
- "type": "period"
}
}, - "schemaMode": "flexible",
- "segmentCompactedBytes": 12345678,
- "segmentTotalBytes": 12345678,
- "totalDataSizeBytes": 12345678,
- "totalRows": 1234,
- "queryGranularity": {
- "type": "simple"
}, - "schema": [
- {
- "type": "dimension",
- "name": "example-column",
- "dataType": "string"
}
], - "timeResolution": "millisecond"
}
Create and manage alerts and the conditions that trigger them. See Set up alerts for information on managing alerts in the Polaris UI.
{- "values": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}
]
}
Creates an alert.
checkFrequency required | string <duration> How often Polaris evaluates alert criteria, expressed as an ISO 8601 duration. |
required | Array of objects (AlertCondition) Specify one or more conditions to trigger your alert.
If you specify more than one condition, you can set the |
dataCube required | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
owner required | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
timeFrame required | string <duration> Controls the amount of data Polaris considers when evaluating the alert criteria based upon a time interval, expressed as an ISO 8601 duration. |
title required | string Alert title to display in the Polaris UI, and in emails and webhooks. |
any (AccessList) Configure user access to the asset. | |
object (Compare) A comparison for Pivot Classic data cubes. | |
conditionOperation | string (ConditionOperation) Enum: "and" "or" Select whether one or all conditions must be true to trigger the alert. |
disabled | boolean Disables the alert. Polaris doesn't evaluate disabled alerts or trigger notifications. |
externalEmails | Array of strings <email> [ items <email > ] External email addresses to notify when the alert triggers. |
object (Filter) Filter to apply to a query. | |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
instance | string Optional instance ID to use for the alert configuration. |
LatestDataStrategy (string) or string (LatestDataStrategyOverride) | |
any (AccessList) Configure user access to the asset. | |
any (AccessList) Configure user access to the asset. | |
sendEmailToRecipients | boolean Send email notifications to the alert recipients when the alert triggers. |
severity | string (Severity) Default: "info" Enum: "info" "warning" "error" "ok" Severity determines the alert's color and icon in the Polaris UI. |
(SplitCombine (SplitCombine (string) or SplitCombineFull (object))) or (Array of SplitCombine (strings or SplitCombineFull (object))) (Splits) | |
type | string (AlertType) Enum: "overall" "within-split" Specify |
Array of objects (Webhook) Webhooks to call when the alert is triggered. | |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}
Returns details of a specified alert.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Alert ID. |
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}
Updates the details of an alert with a specified ID. You must provide all properties you want to retain in the alert, even if you don't want to update them. Polaris recreates the alert with the details you specify in the request.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Alert ID. |
Alert ID.
checkFrequency required | string <duration> How often Polaris evaluates alert criteria, expressed as an ISO 8601 duration. |
required | Array of objects (AlertCondition) Specify one or more conditions to trigger your alert.
If you specify more than one condition, you can set the |
dataCube required | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
owner required | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
timeFrame required | string <duration> Controls the amount of data Polaris considers when evaluating the alert criteria based upon a time interval, expressed as an ISO 8601 duration. |
title required | string Alert title to display in the Polaris UI, and in emails and webhooks. |
any (AccessList) Configure user access to the asset. | |
object (Compare) A comparison for Pivot Classic data cubes. | |
conditionOperation | string (ConditionOperation) Enum: "and" "or" Select whether one or all conditions must be true to trigger the alert. |
disabled | boolean Disables the alert. Polaris doesn't evaluate disabled alerts or trigger notifications. |
externalEmails | Array of strings <email> [ items <email > ] External email addresses to notify when the alert triggers. |
object (Filter) Filter to apply to a query. | |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
instance | string Optional instance ID to use for the alert configuration. |
LatestDataStrategy (string) or string (LatestDataStrategyOverride) | |
any (AccessList) Configure user access to the asset. | |
any (AccessList) Configure user access to the asset. | |
sendEmailToRecipients | boolean Send email notifications to the alert recipients when the alert triggers. |
severity | string (Severity) Default: "info" Enum: "info" "warning" "error" "ok" Severity determines the alert's color and icon in the Polaris UI. |
(SplitCombine (SplitCombine (string) or SplitCombineFull (object))) or (Array of SplitCombine (strings or SplitCombineFull (object))) (Splits) | |
type | string (AlertType) Enum: "overall" "within-split" Specify |
Array of objects (Webhook) Webhooks to call when the alert is triggered. | |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}
Updates the specified properties of an alert. Any properties omitted from the request retain their previous values. Polaris creates a new alert if the supplied alert ID doesn't exist.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Alert ID. |
Alert updates
any (AccessList) Configure user access to the asset. | |
checkFrequency | string <duration> How often Polaris evaluates alert criteria, expressed as an ISO 8601 duration. |
object (Compare) A comparison for Pivot Classic data cubes. | |
conditionOperation | string (ConditionOperation) Enum: "and" "or" Select whether one or all conditions must be true to trigger the alert. |
Array of objects (AlertCondition) Specify one or more conditions to trigger your alert.
If you specify more than one condition, you can set the | |
dataCube | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
disabled | boolean Disables the alert. Polaris doesn't evaluate disabled alerts or trigger notifications. |
externalEmails | Array of strings <email> [ items <email > ] External email addresses to notify when the alert triggers. |
object (Filter) Filter to apply to a query. | |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
instance | string Optional instance ID to use for the alert configuration. |
LatestDataStrategy (string) or string (LatestDataStrategyOverride) | |
owner | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
any (AccessList) Configure user access to the asset. | |
any (AccessList) Configure user access to the asset. | |
sendEmailToRecipients | boolean Send email notifications to the alert recipients when the alert triggers. |
severity | string (Severity) Default: "info" Enum: "info" "warning" "error" "ok" Severity determines the alert's color and icon in the Polaris UI. |
(SplitCombine (SplitCombine (string) or SplitCombineFull (object))) or (Array of SplitCombine (strings or SplitCombineFull (object))) (Splits) | |
timeFrame | string <duration> Controls the amount of data Polaris considers when evaluating the alert criteria based upon a time interval, expressed as an ISO 8601 duration. |
title | string Alert title to display in the Polaris UI, and in emails and webhooks. |
type | string (AlertType) Enum: "overall" "within-split" Specify |
Array of objects (Webhook) Webhooks to call when the alert is triggered. | |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}
Deletes an alert.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Alert ID. |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Returns all evaluations for an alert.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Alert ID. |
{- "values": [
- {
- "id": "wikipedia-1234",
- "alertId": "wikipedia-1234",
- "alert": {
- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}, - "triggerDate": "2019-08-24T14:15:22Z",
- "maxDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "summaries": [
- {
- "value": "string",
- "event": "string",
- "eventData": [
- {
- "summary": "string",
- "currentValue": "string",
- "previousValue": "string",
- "rawDelta": "string",
- "percentDelta": "string",
- "dimensionId": "wikipedia-1234",
- "dimensionValue": "string",
- "measureTitle": "string",
- "conditionTriggerValue": 0,
- "type": "value",
- "condition": "lessThan",
- "triggered": true
}
]
}
], - "errors": [
- {
- "type": "internal-error",
- "message": "string"
}
], - "queries": [
- "string"
]
}
]
}
Returns information for a single alert evaluation.
evaluationId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Evaluation ID. |
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Alert ID. |
{- "id": "wikipedia-1234",
- "alertId": "wikipedia-1234",
- "alert": {
- "id": "wikipedia-1234",
- "owner": "wikipedia-1234",
- "title": "My alert",
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "type": "overall",
- "checkFrequency": "PT5M",
- "timeFrame": "P1D",
- "compare": {
- "type": "absolute",
- "duration": "string",
- "interval": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "bounds": "[)"
}
}, - "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "splits": "string",
- "conditionOperation": "and",
- "conditions": [
- {
- "type": "value",
- "measure": "wikipedia-1234",
- "condition": "lessThan",
- "value": 0
}
], - "severity": "info",
- "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "admins": {
- "access": "all"
}, - "webhooks": [
- {
- "type": "slack",
- "authHeader": "Bearer 12345678-1234-1234-1234-123456789012",
- "payload": "{\n \"attachments\": [\n {\n \"fallback\": \"%title%\",\n \"color\": \"%color%\",\n \"title\": \"%title%\",\n \"title_link\": \"%link%\",\n \"text\": \"%summary%\",\n \"summaryData\": %summaryData%,\n \"ts\": %triggerDate%,\n \"footer\": \"%footer%\",\n \"footer_icon\": \"https://imply.io/favicon/apple-touch-icon.png\",\n \"checkFrequency\": \"%checkFrequency%\",\n \"timeFrame\": \"%timeFrame%\"\n }\n ]\n}\n"
}
], - "disabled": true,
- "sendEmailToRecipients": true,
- "latestDataStrategyOverride": "query",
- "externalEmails": [
- "user@example.com"
]
}, - "triggerDate": "2019-08-24T14:15:22Z",
- "maxDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "summaries": [
- {
- "value": "string",
- "event": "string",
- "eventData": [
- {
- "summary": "string",
- "currentValue": "string",
- "previousValue": "string",
- "rawDelta": "string",
- "percentDelta": "string",
- "dimensionId": "wikipedia-1234",
- "dimensionValue": "string",
- "measureTitle": "string",
- "conditionTriggerValue": 0,
- "type": "value",
- "condition": "lessThan",
- "triggered": true
}
]
}
], - "errors": [
- {
- "type": "internal-error",
- "message": "string"
}
], - "queries": [
- "string"
]
}
Create, edit, and delete Polaris collections. See Collections and favorites for information on managing collections in the Polaris UI.
Returns all collections in a specified project.
projectId required | string Project ID. |
{- "values": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "assets": [
- {
- "id": "string",
- "type": "dataCube"
}
], - "createdBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "createdAt": "2021-06-06T00:00:00.000Z",
- "updatedBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "updatedAt": "2021-06-06T00:00:00.000Z"
}
]
}
Creates a collection in a specified project.
projectId required | string Project ID. |
name required | string (CollectionName) Name of the collection. |
description | string (CollectionDescription) Description of the collection. |
{- "name": "string",
- "description": "string"
}
{- "id": 0,
- "name": "string",
- "description": "string",
- "assets": [
- {
- "id": "string",
- "type": "dataCube"
}
], - "createdBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "createdAt": "2021-06-06T00:00:00.000Z",
- "updatedBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "updatedAt": "2021-06-06T00:00:00.000Z"
}
Returns a single collection in a specified project.
id required | integer (CollectionId) Collection ID. |
projectId required | string Project ID. |
{- "id": 0,
- "name": "string",
- "description": "string",
- "assets": [
- {
- "id": "string",
- "type": "dataCube"
}
], - "createdBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "createdAt": "2021-06-06T00:00:00.000Z",
- "updatedBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "updatedAt": "2021-06-06T00:00:00.000Z"
}
Updates a collection name and/or description.
id required | integer (CollectionId) Collection ID. |
projectId required | string Project ID. |
The collection updates
description | string (CollectionDescription) Description of the collection. |
name | string (CollectionName) Name of the collection. |
{- "name": "string",
- "description": "string"
}
{- "id": 0,
- "name": "string",
- "description": "string",
- "assets": [
- {
- "id": "string",
- "type": "dataCube"
}
], - "createdBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "createdAt": "2021-06-06T00:00:00.000Z",
- "updatedBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "updatedAt": "2021-06-06T00:00:00.000Z"
}
Adds specified assets to a collection.
id required | integer (CollectionId) Collection ID. |
projectId required | string Project ID. |
Assets to add to the collection.
required | Array of objects (CollectionAsset) |
{- "values": [
- {
- "id": "string",
- "type": "dataCube"
}
]
}
{- "id": 0,
- "name": "string",
- "description": "string",
- "assets": [
- {
- "id": "string",
- "type": "dataCube"
}
], - "createdBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "createdAt": "2021-06-06T00:00:00.000Z",
- "updatedBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "updatedAt": "2021-06-06T00:00:00.000Z"
}
Returns all favorites for the authenticated user.
projectId required | string Project ID. |
{- "assets": [
- {
- "id": "string",
- "type": "dataCube"
}
], - "createdBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "createdAt": "2021-06-06T00:00:00.000Z",
- "updatedBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "updatedAt": "2021-06-06T00:00:00.000Z"
}
Adds specified assets to the authenticated user's favorites.
projectId required | string Project ID. |
Assets to add to favorites.
required | Array of objects (CollectionAsset) |
{- "values": [
- {
- "id": "string",
- "type": "dataCube"
}
]
}
{- "assets": [
- {
- "id": "string",
- "type": "dataCube"
}
], - "createdBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "createdAt": "2021-06-06T00:00:00.000Z",
- "updatedBy": {
- "username": "some.user@bigdatacompany.io",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "updatedAt": "2021-06-06T00:00:00.000Z"
}
Set and manage customized logos, colors, and visualization colors in the Imply Polaris UI for your organization. See Customize Polaris for information on managing customizations in the Polaris UI.
Returns the application name of the organization.
{- "appName": "Example Company",
- "lastModifiedBy": {
- "username": "user@examplecompany.com",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "lastUpdateTimestamp": "2023-03-10T15:35:59.000Z"
}
Updates the application name of the organization.
appName | string Application name. |
{- "appName": "Example Company"
}
{- "appName": "Example Company",
- "lastModifiedBy": {
- "username": "user@examplecompany.com",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "lastUpdateTimestamp": "2023-03-10T15:35:59.000Z"
}
Deletes the customized application name of the organization. The application name is reset to the default - Imply.
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
{- "full": {
- "lastUpdateTimestamp": "2023-03-10T15:35:59.000Z",
- "kind": "full",
- "fileType": "png",
}, - "favicon": {
- "lastUpdateTimestamp": "2023-03-10T15:35:59.000Z",
- "kind": "full",
- "fileType": "png",
}
}
Deletes all customized logos for the organization. Logos are reset to the Polaris defaults.
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
Updates a specified logo for the organization.
kind required | string (LogoKind) Enum: "full" "favicon" Logo type |
A multipart/form-data request containing a single part with the file to upload.
Do not set the Content-Type: multipart/form-data
header explicitly.
Allow your client to assign the header automatically - this also properly sets
the associated boundary directive.
file required | string <binary> |
{- "full": {
- "lastUpdateTimestamp": "2023-03-10T15:35:59.000Z",
- "kind": "full",
- "fileType": "png",
}, - "favicon": {
- "lastUpdateTimestamp": "2023-03-10T15:35:59.000Z",
- "kind": "full",
- "fileType": "png",
}
}
Deletes logos with a specified type for the organization. Logos are reset to the Polaris defaults.
kind required | string (LogoKind) Enum: "full" "favicon" Logo type. |
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
Returns the visual theme applied to the organization, including color palettes for the Polaris UI and visualizations.
{- "appPalette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "visPalette": {
- "primaryColor": "#EADDCA",
- "nullColor": "#FBCEB1",
- "otherColor": "#FFEA00",
- "categoricalPalette": [
- "#DFFF00",
- "#DFFF00"
], - "divergingPalette": {
- "baselineColor": "#73C2FB",
- "rangeStartColor": "#89CFEF",
- "rangeEndColor": "#0018F9"
}
}, - "lastModifiedBy": {
- "username": "user@examplecompany.com",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "lastUpdateTimestamp": "2023-03-10T15:35:59.000Z"
}
Updates the visual theme for the organization, including color palettes for the Polaris UI and visualizations. Any properties omitted from the request reset to the default values.
New theme details
object or null (AppColorPalette) Color palette for the Polaris UI. Use the 6-character hex format for all colors. | |
object or null (VisualizationColorPalette) Color palette for visualizations. Use the 6-character hex format for all colors. |
{- "appPalette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "visPalette": {
- "primaryColor": "#EADDCA",
- "nullColor": "#FBCEB1",
- "otherColor": "#FFEA00",
- "categoricalPalette": [
- "#DFFF00",
- "#DFFF00"
], - "divergingPalette": {
- "baselineColor": "#73C2FB",
- "rangeStartColor": "#89CFEF",
- "rangeEndColor": "#0018F9"
}
}
}
{- "appPalette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "visPalette": {
- "primaryColor": "#EADDCA",
- "nullColor": "#FBCEB1",
- "otherColor": "#FFEA00",
- "categoricalPalette": [
- "#DFFF00",
- "#DFFF00"
], - "divergingPalette": {
- "baselineColor": "#73C2FB",
- "rangeStartColor": "#89CFEF",
- "rangeEndColor": "#0018F9"
}
}, - "lastModifiedBy": {
- "username": "user@examplecompany.com",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "lastUpdateTimestamp": "2023-03-10T15:35:59.000Z"
}
Updates the visual theme for the organization, including color palettes for the Polaris UI and visualizations. Any properties omitted from the request retain their previous values.
Theme updates
object or null (AppColorPalette) Color palette for the Polaris UI. Use the 6-character hex format for all colors. | |
object or null (VisualizationColorPalette) Color palette for visualizations. Use the 6-character hex format for all colors. |
{- "appPalette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "visPalette": {
- "primaryColor": "#EADDCA",
- "nullColor": "#FBCEB1",
- "otherColor": "#FFEA00",
- "categoricalPalette": [
- "#DFFF00",
- "#DFFF00"
], - "divergingPalette": {
- "baselineColor": "#73C2FB",
- "rangeStartColor": "#89CFEF",
- "rangeEndColor": "#0018F9"
}
}
}
{- "appPalette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "visPalette": {
- "primaryColor": "#EADDCA",
- "nullColor": "#FBCEB1",
- "otherColor": "#FFEA00",
- "categoricalPalette": [
- "#DFFF00",
- "#DFFF00"
], - "divergingPalette": {
- "baselineColor": "#73C2FB",
- "rangeStartColor": "#89CFEF",
- "rangeEndColor": "#0018F9"
}
}, - "lastModifiedBy": {
- "username": "user@examplecompany.com",
- "userId": "12345678-1234-1234-1234-123456789012"
}, - "lastUpdateTimestamp": "2023-03-10T15:35:59.000Z"
}
Deletes the visual theme applied to the organization, including custom color palettes for the Polaris UI and visualizations. Colors are reset to the Polaris defaults.
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
Create and manage alerts and their pages and tiles. See Dashboards overview for information on managing dashboards in the Polaris UI.
{- "values": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "type": "classic",
- "title": "string",
- "description": "string",
- "summaries": [
- "string"
], - "pageCount": 0,
- "tileCount": 0,
- "defaultFilterCount": 0,
- "dataCubeIds": [
- "wikipedia-1234"
], - "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "readAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}
}
]
}
Creates a dashboard.
title required | string Dashboard title to display in the Polaris UI. |
object (DashboardCompare) Comparison that can be applied to a dashboard. | |
Array of objects (DashboardFilter) Default filters to apply to the dashboard. | |
defaultMeasures | Array of strings (Identifier) [ items [ 1 .. 255 ] characters ] IDs of default measures to apply to the dashboard. |
description | string Dashboard description. |
enforceTimeFilter | boolean Default: false Ensure that every query is filtered on the primary time dimension. |
filterQueryDefaultDuration | string <duration> Default: "P1D" Default time period used for filter queries, expressed as an ISO 8601 Duration. |
filterTile | string (ShowHide) Enum: "show" "hide" |
hasGlobalCompare | boolean Default: false Enable global comparisons. |
hasGlobalMeasures | boolean Default: false Enable global measures. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
any (AccessList) Configure user access to the asset. | |
Array of objects Array of dashboard pages. | |
pagesColorSummary | string (ShowHide) Enum: "show" "hide" |
pagesTile | string (ShowHide) Enum: "show" "hide" |
object or null (AppColorPalette) Color palette for the Polaris UI. Use the 6-character hex format for all colors. | |
any (AccessList) Configure user access to the asset. | |
type | string (DashboardType) Default: "dashboard2" Enum: "classic" "dashboard2" Dashboard type - always "dashboard2". |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "type": "classic",
- "title": "string",
- "description": "string",
- "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "readAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "pages": [
- {
- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": null,
- "elements": [ ]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": null,
- "action": null,
- "values": null,
- "search": null,
- "exclude": null,
- "mvFilterOnly": null
}
], - "measureFilters": [
- {
- "measure": null,
- "minOp": null,
- "minValue": null,
- "maxOp": null,
- "maxValue": null,
- "exclude": null
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
], - "defaultFilters": [
- {
- "id": "wikipedia-1234",
- "dimension": "wikipedia-1234",
- "isSeparate": true,
- "isMandatory": false,
- "hasDefaultValues": false,
- "defaultValues": {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
}
], - "enforceTimeFilter": false,
- "filterTile": "show",
- "pagesTile": "show",
- "pagesColorSummary": "show",
- "hasGlobalCompare": false,
- "defaultCompare": {
- "type": "relative",
- "duration": "PT5M"
}, - "hasGlobalMeasures": false,
- "defaultMeasures": [
- "wikipedia-1234"
], - "filterQueryDefaultDuration": "PT5M"
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "type": "classic",
- "title": "string",
- "description": "string",
- "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "readAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "pages": [
- {
- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": null,
- "elements": [ ]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": null,
- "action": null,
- "values": null,
- "search": null,
- "exclude": null,
- "mvFilterOnly": null
}
], - "measureFilters": [
- {
- "measure": null,
- "minOp": null,
- "minValue": null,
- "maxOp": null,
- "maxValue": null,
- "exclude": null
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
], - "defaultFilters": [
- {
- "id": "wikipedia-1234",
- "dimension": "wikipedia-1234",
- "isSeparate": true,
- "isMandatory": false,
- "hasDefaultValues": false,
- "defaultValues": {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
}
], - "enforceTimeFilter": false,
- "filterTile": "show",
- "pagesTile": "show",
- "pagesColorSummary": "show",
- "hasGlobalCompare": false,
- "defaultCompare": {
- "type": "relative",
- "duration": "PT5M"
}, - "hasGlobalMeasures": false,
- "defaultMeasures": [
- "wikipedia-1234"
], - "filterQueryDefaultDuration": "PT5M"
}
Returns details of a specified dashboard.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "type": "classic",
- "title": "string",
- "description": "string",
- "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "readAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "pages": [
- {
- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": null,
- "elements": [ ]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": null,
- "action": null,
- "values": null,
- "search": null,
- "exclude": null,
- "mvFilterOnly": null
}
], - "measureFilters": [
- {
- "measure": null,
- "minOp": null,
- "minValue": null,
- "maxOp": null,
- "maxValue": null,
- "exclude": null
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
], - "defaultFilters": [
- {
- "id": "wikipedia-1234",
- "dimension": "wikipedia-1234",
- "isSeparate": true,
- "isMandatory": false,
- "hasDefaultValues": false,
- "defaultValues": {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
}
], - "enforceTimeFilter": false,
- "filterTile": "show",
- "pagesTile": "show",
- "pagesColorSummary": "show",
- "hasGlobalCompare": false,
- "defaultCompare": {
- "type": "relative",
- "duration": "PT5M"
}, - "hasGlobalMeasures": false,
- "defaultMeasures": [
- "wikipedia-1234"
], - "filterQueryDefaultDuration": "PT5M"
}
Updates the details of a dashboard with a specified ID. You must provide all properties you want to retain in the dashboard, even if you don't want to update them. Polaris recreates the dashboard with the details you specify in the request.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
Dashboard to update.
title required | string Dashboard title to display in the Polaris UI. |
object (DashboardCompare) Comparison that can be applied to a dashboard. | |
Array of objects (DashboardFilter) Default filters to apply to the dashboard. | |
defaultMeasures | Array of strings (Identifier) [ items [ 1 .. 255 ] characters ] IDs of default measures to apply to the dashboard. |
description | string Dashboard description. |
enforceTimeFilter | boolean Default: false Ensure that every query is filtered on the primary time dimension. |
filterQueryDefaultDuration | string <duration> Default: "P1D" Default time period used for filter queries, expressed as an ISO 8601 Duration. |
filterTile | string (ShowHide) Enum: "show" "hide" |
hasGlobalCompare | boolean Default: false Enable global comparisons. |
hasGlobalMeasures | boolean Default: false Enable global measures. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
any (AccessList) Configure user access to the asset. | |
Array of objects Array of dashboard pages. | |
pagesColorSummary | string (ShowHide) Enum: "show" "hide" |
pagesTile | string (ShowHide) Enum: "show" "hide" |
object or null (AppColorPalette) Color palette for the Polaris UI. Use the 6-character hex format for all colors. | |
any (AccessList) Configure user access to the asset. | |
type | string (DashboardType) Default: "dashboard2" Enum: "classic" "dashboard2" Dashboard type - always "dashboard2". |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "type": "classic",
- "title": "string",
- "description": "string",
- "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "readAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "pages": [
- {
- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": null,
- "elements": [ ]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": null,
- "action": null,
- "values": null,
- "search": null,
- "exclude": null,
- "mvFilterOnly": null
}
], - "measureFilters": [
- {
- "measure": null,
- "minOp": null,
- "minValue": null,
- "maxOp": null,
- "maxValue": null,
- "exclude": null
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
], - "defaultFilters": [
- {
- "id": "wikipedia-1234",
- "dimension": "wikipedia-1234",
- "isSeparate": true,
- "isMandatory": false,
- "hasDefaultValues": false,
- "defaultValues": {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
}
], - "enforceTimeFilter": false,
- "filterTile": "show",
- "pagesTile": "show",
- "pagesColorSummary": "show",
- "hasGlobalCompare": false,
- "defaultCompare": {
- "type": "relative",
- "duration": "PT5M"
}, - "hasGlobalMeasures": false,
- "defaultMeasures": [
- "wikipedia-1234"
], - "filterQueryDefaultDuration": "PT5M"
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "type": "classic",
- "title": "string",
- "description": "string",
- "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "readAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "pages": [
- {
- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": null,
- "elements": [ ]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": null,
- "action": null,
- "values": null,
- "search": null,
- "exclude": null,
- "mvFilterOnly": null
}
], - "measureFilters": [
- {
- "measure": null,
- "minOp": null,
- "minValue": null,
- "maxOp": null,
- "maxValue": null,
- "exclude": null
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
], - "defaultFilters": [
- {
- "id": "wikipedia-1234",
- "dimension": "wikipedia-1234",
- "isSeparate": true,
- "isMandatory": false,
- "hasDefaultValues": false,
- "defaultValues": {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
}
], - "enforceTimeFilter": false,
- "filterTile": "show",
- "pagesTile": "show",
- "pagesColorSummary": "show",
- "hasGlobalCompare": false,
- "defaultCompare": {
- "type": "relative",
- "duration": "PT5M"
}, - "hasGlobalMeasures": false,
- "defaultMeasures": [
- "wikipedia-1234"
], - "filterQueryDefaultDuration": "PT5M"
}
Updates the specified properties of a dashboard. Any properties omitted from the request retain their previous values. Polaris creates a new dashboard if the supplied dashboard ID doesn't exist.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
Dashboard updates
object (DashboardCompare) Comparison that can be applied to a dashboard. | |
Array of objects (DashboardFilter) Default filters to apply to the dashboard. | |
defaultMeasures | Array of strings (Identifier) [ items [ 1 .. 255 ] characters ] IDs of default measures to apply to the dashboard. |
description | string Dashboard description. |
enforceTimeFilter | boolean Default: false Ensure that every query is filtered on the primary time dimension. |
filterQueryDefaultDuration | string <duration> Default: "P1D" Default time period used for filter queries, expressed as an ISO 8601 Duration. |
filterTile | string (ShowHide) Enum: "show" "hide" |
hasGlobalCompare | boolean Default: false Enable global comparisons. |
hasGlobalMeasures | boolean Default: false Enable global measures. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
any (AccessList) Configure user access to the asset. | |
Array of objects Array of dashboard pages. | |
pagesColorSummary | string (ShowHide) Enum: "show" "hide" |
pagesTile | string (ShowHide) Enum: "show" "hide" |
object or null (AppColorPalette) Color palette for the Polaris UI. Use the 6-character hex format for all colors. | |
any (AccessList) Configure user access to the asset. | |
title | string Dashboard title to display in the Polaris UI. |
type | string (DashboardType) Default: "dashboard2" Enum: "classic" "dashboard2" Dashboard type - always "dashboard2". |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "type": "classic",
- "title": "string",
- "description": "string",
- "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "readAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "pages": [
- {
- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": null,
- "elements": [ ]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": null,
- "action": null,
- "values": null,
- "search": null,
- "exclude": null,
- "mvFilterOnly": null
}
], - "measureFilters": [
- {
- "measure": null,
- "minOp": null,
- "minValue": null,
- "maxOp": null,
- "maxValue": null,
- "exclude": null
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
], - "defaultFilters": [
- {
- "id": "wikipedia-1234",
- "dimension": "wikipedia-1234",
- "isSeparate": true,
- "isMandatory": false,
- "hasDefaultValues": false,
- "defaultValues": {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
}
], - "enforceTimeFilter": false,
- "filterTile": "show",
- "pagesTile": "show",
- "pagesColorSummary": "show",
- "hasGlobalCompare": false,
- "defaultCompare": {
- "type": "relative",
- "duration": "PT5M"
}, - "hasGlobalMeasures": false,
- "defaultMeasures": [
- "wikipedia-1234"
], - "filterQueryDefaultDuration": "PT5M"
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "type": "classic",
- "title": "string",
- "description": "string",
- "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "readAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "pages": [
- {
- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": null,
- "elements": [ ]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": null,
- "action": null,
- "values": null,
- "search": null,
- "exclude": null,
- "mvFilterOnly": null
}
], - "measureFilters": [
- {
- "measure": null,
- "minOp": null,
- "minValue": null,
- "maxOp": null,
- "maxValue": null,
- "exclude": null
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
], - "defaultFilters": [
- {
- "id": "wikipedia-1234",
- "dimension": "wikipedia-1234",
- "isSeparate": true,
- "isMandatory": false,
- "hasDefaultValues": false,
- "defaultValues": {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
}
], - "enforceTimeFilter": false,
- "filterTile": "show",
- "pagesTile": "show",
- "pagesColorSummary": "show",
- "hasGlobalCompare": false,
- "defaultCompare": {
- "type": "relative",
- "duration": "PT5M"
}, - "hasGlobalMeasures": false,
- "defaultMeasures": [
- "wikipedia-1234"
], - "filterQueryDefaultDuration": "PT5M"
}
Deletes a dashboard.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Returns the data cubes associated with a dashboard via its tiles.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
{- "values": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "queryMode": "sql",
- "source": {
- "type": "direct",
- "value": "string",
- "connectionName": "string"
}, - "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "minAutoRefreshRate": "PT5M",
- "subsetFormula": "string",
- "filterToken": "string",
- "rollup": true,
- "options": {
- "fixedMaxTime": "2019-08-24T14:15:22Z",
- "timeoutOverride": 0,
- "exactResultsOnly": true,
- "customTransforms": { },
- "piiMask": {
- "aggregate": "string",
- "threshold": 0,
- "hideAggregates": true,
- "maskText": "string",
- "otherText": "string"
}, - "restrictedModeProperties": [
- "string"
], - "latestPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "currentPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "previousPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "splitLimits": [
- 0
], - "ignoreDimensionInExplain": [
- "string"
], - "rankExpression": "$main.count",
- "druidContext": { },
- "priority": 0,
- "maxDownloadLimit": 0,
- "largeDownloadInterval": "string",
- "suppressOverallByDefault": true,
- "boostPrefixRank": true,
- "boostSelectedMeasures": true,
- "grayOutTrivial": true,
- "alwaysShowCompareControl": true,
- "disablePreview": true,
- "showExplainBadge": true
}, - "readAccess": {
- "access": "all"
}, - "restrictedEditAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "downloadAccess": {
- "access": "all"
}, - "attributes": [
- {
- "name": "string",
- "type": "NULL",
- "nativeType": "string",
- "unsplitable": true,
- "maker": { },
- "cardinality": 0,
- "range": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "termsDelegate": "string"
}
], - "dimensions": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
], - "measures": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
], - "instances": {
- "dimensionFormula": "string",
- "values": [
- "string"
]
}, - "specialTimeDimension": "string",
- "enforceTimeFilter": true,
- "defaultFilter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "defaultTimezone": "string",
- "defaultDuration": "PT5M",
- "defaultSelectedMeasures": [
- "string"
], - "defaultPinnedDimensions": [
- "string"
], - "defaultRefreshRate": "string",
- "defaultVisualization": "string",
- "defaultHavingFilter": {
- "measure": "string",
- "op": "lessThan",
- "value": 0
}, - "latestDataStrategy": "query",
- "queryCaching": "allow",
- "formulaeVisibility": "show",
- "minAlertFrequency": "PT5M",
- "minAlertTimeFrame": "PT5M",
- "defaultParameters": "string",
- "defaultFacetSplits": [
- "string"
], - "defaultFacetCompare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "customFacetCompares": [
- {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}
], - "requireGroupFilters": true,
- "allowFilterCombine": true,
- "groupFilters": {
- "property1": {
- "name": "string",
- "formula": "string"
}, - "property2": {
- "name": "string",
- "formula": "string"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
]
}
Returns all pages for a dashboard.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
{- "values": [
- {
- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": null,
- "elements": [ ]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": null,
- "action": null,
- "values": null,
- "search": null,
- "exclude": null,
- "mvFilterOnly": null
}
], - "measureFilters": [
- {
- "measure": null,
- "minOp": null,
- "minValue": null,
- "maxOp": null,
- "maxValue": null,
- "exclude": null
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
]
}
Creates a dashboard page
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
label | string Page label to display in the Polaris UI. |
Array of objects Dashboard page tiles. |
{- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
{- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
Returns information for a single dashboard page.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
{- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
Updates the details of a dashboard page with a specified ID. You must provide all properties you want to retain in the page even if you don't want to update them. Polaris recreates the page with the details you specify in the request.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
Page to update.
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
label | string Page label to display in the Polaris UI. |
Array of objects Dashboard page tiles. |
{- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
{- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
Updates the specified properties of a page. Polaris creates a new page if the supplied page ID doesn't exist.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
Page updates
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
label | string Page label to display in the Polaris UI. |
Array of objects Dashboard page tiles. |
{- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
{- "id": "wikipedia-1234",
- "label": "string",
- "tiles": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
Deletes a page.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Returns all tiles for a dashboard page.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
{- "values": [
- {
- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
]
}
Creates a new tile for a dashboard page.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
type required | string (TileType) Enum: "blank" "visualization" "markdown" Tile type. |
canExpand | boolean Default: true Tile can be expanded into a full data cube view. |
content | string Markdown content to display in the tile. Only applicable if "type" is set to "markdown". Polaris renders markdown content using Markdown formatting. |
description | string Tile description to display in info popovers in the dashboard UI. |
object Visualization definition for data cubes. This is not applicable to Polaris. | |
object (ExploreEssence) State of a visualization in the Explore View | |
object (FacetEssence) State of a visualization in the Pivot 2 view | |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
infoHidden | boolean Default: false Hide the tile info popover. |
legendSide | string (LegendSide) Enum: "none" "right" "bottom" Side of the tile to display the legend. |
object (TilePosition) Position of a tile within a dashboard page. | |
title | string Tile title to display in the dashboard UI. If not set, defaults to an auto-generated title based on the displayed dimensions and measures. |
titleHidden | boolean Default: false Hide the tile title. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
{- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
Returns the definition for a single dashboard tile.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
tileId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Tile ID. |
{- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
Updates the details of a dashboard page tile with a specified ID. You must provide all properties you want to retain in the tile even if you don't want to update them. Polaris recreates the tile with the details you specify in the request.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
tileId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Tile ID. |
The tile to update.
type required | string (TileType) Enum: "blank" "visualization" "markdown" Tile type. |
canExpand | boolean Default: true Tile can be expanded into a full data cube view. |
content | string Markdown content to display in the tile. Only applicable if "type" is set to "markdown". Polaris renders markdown content using Markdown formatting. |
description | string Tile description to display in info popovers in the dashboard UI. |
object Visualization definition for data cubes. This is not applicable to Polaris. | |
object (ExploreEssence) State of a visualization in the Explore View | |
object (FacetEssence) State of a visualization in the Pivot 2 view | |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
infoHidden | boolean Default: false Hide the tile info popover. |
legendSide | string (LegendSide) Enum: "none" "right" "bottom" Side of the tile to display the legend. |
object (TilePosition) Position of a tile within a dashboard page. | |
title | string Tile title to display in the dashboard UI. If not set, defaults to an auto-generated title based on the displayed dimensions and measures. |
titleHidden | boolean Default: false Hide the tile title. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
{- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
Updates the specified properties of a dashboard page tile. Polaris creates a new tile if the supplied tile ID doesn't exist.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
tileId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Tile ID. |
Tile updates
canExpand | boolean Default: true Tile can be expanded into a full data cube view. |
content | string Markdown content to display in the tile. Only applicable if "type" is set to "markdown". Polaris renders markdown content using Markdown formatting. |
description | string Tile description to display in info popovers in the dashboard UI. |
object Visualization definition for data cubes. This is not applicable to Polaris. | |
object (ExploreEssence) State of a visualization in the Explore View | |
object (FacetEssence) State of a visualization in the Pivot 2 view | |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
infoHidden | boolean Default: false Hide the tile info popover. |
legendSide | string (LegendSide) Enum: "none" "right" "bottom" Side of the tile to display the legend. |
object (TilePosition) Position of a tile within a dashboard page. | |
title | string Tile title to display in the dashboard UI. If not set, defaults to an auto-generated title based on the displayed dimensions and measures. |
titleHidden | boolean Default: false Hide the tile title. |
type | string (TileType) Enum: "blank" "visualization" "markdown" Tile type. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
{- "id": "wikipedia-1234",
- "type": "blank",
- "title": "string",
- "description": "string",
- "position": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "titleHidden": false,
- "infoHidden": false,
- "canExpand": true,
- "content": "string",
- "legendSide": "none"
}
Deletes a dashboard page tile.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dashboard ID. |
pageId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Page ID. |
tileId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Tile ID. |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Create and manage data cubes and their dimensions and measures. See Manage data cubes for information on managing data cubes in the Polaris UI.
{- "values": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "queryMode": "sql",
- "source": "string",
- "sourceType": "direct",
- "sourceValue": "string",
- "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "rollup": true,
- "readAccess": {
- "access": "all"
}, - "restrictedEditAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "downloadAccess": {
- "access": "all"
}, - "dimensionCount": 0,
- "measureCount": 0,
- "latestDataStrategy": "query",
- "fixedMaxTime": "2019-08-24T14:15:22Z",
- "specialTimeDimension": "string",
- "defaultRefreshRate": "PT5M",
- "defaultTimezone": "string"
}
]
}
Creates a data cube.
queryMode required | string (QueryMode) Value: "sql" Data cube query mode. |
required | object (DataCubeSource) Data cube source. |
title required | string Data cube title. |
allowFilterCombine | boolean Determines the behaviour when a user is a member of two or more user groups with access filters applied.
If |
Array of objects (Attribute) Column metadata for the associated data source. | |
Array of objects (FacetCompare) Customized comparisons for the data cube. | |
defaultDuration | string <duration> Time period to display when a user first opens the data cube, expressed as an ISO 8601 duration. |
object (FacetCompare) Comparison for data cubes. | |
Array of strings or SplitCombineFull (object) (SplitCombine) Default dimensions to split on. | |
object (Filter) Filter to apply to a query. | |
object (HavingFilter) HAVING filter to apply to a measure. | |
defaultParameters | string The default parameters to populate an Explore visualization. |
defaultPinnedDimensions | Array of strings IDs of the dimensions to pin by default in visualizations. |
defaultRefreshRate | string <duration> The default refresh rate for the data cube, expressed as an ISO 8601 Duration. |
defaultSelectedMeasures | Array of strings IDs of the measures to show by default in visualizations. |
defaultTimezone | string Time zone to select when a user first opens the data cube, expressed as an Olsen Timezone. |
defaultVisualization | string Name of the default visualization to use when initially viewing the data cube. |
description | string Data cube description. |
Array of objects (DimensionPayload) The dimensions of the data cube. | |
any (AccessList) Configure user access to the asset. | |
enforceTimeFilter | boolean Ensures that every query is filtered on the primary time dimension. You can enable this setting if time unbounded queries are likely to be slow due to the volume of data. |
filterToken | string Only allow users with the given filter token to access this data cube. |
formulaeVisibility | string (Visibility) Enum: "show" "hide" Whether a field should be shown or hidden. |
object Maps the names of group filters to their filter definitions. | |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
object (DataCubeInstanceList) Data cube instances. | |
latestDataStrategy | string (LatestDataStrategy) Enum: "query" "query-floored-P1D" "predefined" Determines how Polaris calculates the latest data time for the data cube. By default, Polaris queries the data source for the latest time stamp on ingested data. You can set this property to always use the current time, which may be more appropriate for streaming data. |
Array of objects (MeasurePayload) Array of data cube measures. | |
minAlertFrequency | string <duration> Minimum allowable frequency for alerts associated with this data cube, expressed as an ISO 8601 Duration. |
minAlertTimeFrame | string <duration> Minimum allowable time frame for alerts associated with this data cube, expressed as an ISO 8601 Duration. |
minAutoRefreshRate | string <duration> Minimum auto refresh rate for the data cube, expressed as an ISO 8601 Duration. |
any (AccessList) Configure user access to the asset. | |
object (DataCubeOptions) Data cube options. | |
object or null (AppColorPalette) Color palette for the Polaris UI. Use the 6-character hex format for all colors. | |
queryCaching | string Enum: "allow" "disable" Allow caching on queries made to this data cube. Caching can greatly speed up exploration but can also cause results to be a little out of date especially in realtime rolled up datasets. |
any (AccessList) Configure user access to the asset. | |
requireGroupFilters | boolean Enable this property to use access filters. When enabled, users who aren't assigned an access filter can't perform queries. |
any (AccessList) Configure user access to the asset. | |
rollup | boolean Whether the associated table has rollup enabled. |
specialTimeDimension | string Time dimension Polaris uses for all time-related calculations for the data cube, including comparisons, filters, alerts, and reports. Polarise uses this to check the freshness of data and apply time filters. |
subsetFormula | string Row level filter to apply to the data cube. This filter is never shown in the cube view and effectively constrains the data cube to only the events that match this filter. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "queryMode": "sql",
- "source": {
- "type": "direct",
- "value": "string",
- "connectionName": "string"
}, - "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "minAutoRefreshRate": "PT5M",
- "subsetFormula": "string",
- "filterToken": "string",
- "rollup": true,
- "options": {
- "fixedMaxTime": "2019-08-24T14:15:22Z",
- "timeoutOverride": 0,
- "exactResultsOnly": true,
- "customTransforms": { },
- "piiMask": {
- "aggregate": "string",
- "threshold": 0,
- "hideAggregates": true,
- "maskText": "string",
- "otherText": "string"
}, - "restrictedModeProperties": [
- "string"
], - "latestPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "currentPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "previousPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "splitLimits": [
- 0
], - "ignoreDimensionInExplain": [
- "string"
], - "rankExpression": "$main.count",
- "druidContext": { },
- "priority": 0,
- "maxDownloadLimit": 0,
- "largeDownloadInterval": "string",
- "suppressOverallByDefault": true,
- "boostPrefixRank": true,
- "boostSelectedMeasures": true,
- "grayOutTrivial": true,
- "alwaysShowCompareControl": true,
- "disablePreview": true,
- "showExplainBadge": true
}, - "readAccess": {
- "access": "all"
}, - "restrictedEditAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "downloadAccess": {
- "access": "all"
}, - "attributes": [
- {
- "name": "string",
- "type": "NULL",
- "nativeType": "string",
- "unsplitable": true,
- "maker": { },
- "cardinality": 0,
- "range": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "termsDelegate": "string"
}
], - "dimensions": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
], - "measures": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
], - "instances": {
- "dimensionFormula": "string",
- "values": [
- "string"
]
}, - "specialTimeDimension": "string",
- "enforceTimeFilter": true,
- "defaultFilter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "defaultTimezone": "string",
- "defaultDuration": "PT5M",
- "defaultSelectedMeasures": [
- "string"
], - "defaultPinnedDimensions": [
- "string"
], - "defaultRefreshRate": "string",
- "defaultVisualization": "string",
- "defaultHavingFilter": {
- "measure": "string",
- "op": "lessThan",
- "value": 0
}, - "latestDataStrategy": "query",
- "queryCaching": "allow",
- "formulaeVisibility": "show",
- "minAlertFrequency": "PT5M",
- "minAlertTimeFrame": "PT5M",
- "defaultParameters": "string",
- "defaultFacetSplits": [
- "string"
], - "defaultFacetCompare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "customFacetCompares": [
- {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}
], - "requireGroupFilters": true,
- "allowFilterCombine": true,
- "groupFilters": {
- "property1": {
- "name": "string",
- "formula": "string"
}, - "property2": {
- "name": "string",
- "formula": "string"
}
}
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "queryMode": "sql",
- "source": {
- "type": "direct",
- "value": "string",
- "connectionName": "string"
}, - "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "minAutoRefreshRate": "PT5M",
- "subsetFormula": "string",
- "filterToken": "string",
- "rollup": true,
- "options": {
- "fixedMaxTime": "2019-08-24T14:15:22Z",
- "timeoutOverride": 0,
- "exactResultsOnly": true,
- "customTransforms": { },
- "piiMask": {
- "aggregate": "string",
- "threshold": 0,
- "hideAggregates": true,
- "maskText": "string",
- "otherText": "string"
}, - "restrictedModeProperties": [
- "string"
], - "latestPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "currentPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "previousPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "splitLimits": [
- 0
], - "ignoreDimensionInExplain": [
- "string"
], - "rankExpression": "$main.count",
- "druidContext": { },
- "priority": 0,
- "maxDownloadLimit": 0,
- "largeDownloadInterval": "string",
- "suppressOverallByDefault": true,
- "boostPrefixRank": true,
- "boostSelectedMeasures": true,
- "grayOutTrivial": true,
- "alwaysShowCompareControl": true,
- "disablePreview": true,
- "showExplainBadge": true
}, - "readAccess": {
- "access": "all"
}, - "restrictedEditAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "downloadAccess": {
- "access": "all"
}, - "attributes": [
- {
- "name": "string",
- "type": "NULL",
- "nativeType": "string",
- "unsplitable": true,
- "maker": { },
- "cardinality": 0,
- "range": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "termsDelegate": "string"
}
], - "dimensions": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
], - "measures": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
], - "instances": {
- "dimensionFormula": "string",
- "values": [
- "string"
]
}, - "specialTimeDimension": "string",
- "enforceTimeFilter": true,
- "defaultFilter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "defaultTimezone": "string",
- "defaultDuration": "PT5M",
- "defaultSelectedMeasures": [
- "string"
], - "defaultPinnedDimensions": [
- "string"
], - "defaultRefreshRate": "string",
- "defaultVisualization": "string",
- "defaultHavingFilter": {
- "measure": "string",
- "op": "lessThan",
- "value": 0
}, - "latestDataStrategy": "query",
- "queryCaching": "allow",
- "formulaeVisibility": "show",
- "minAlertFrequency": "PT5M",
- "minAlertTimeFrame": "PT5M",
- "defaultParameters": "string",
- "defaultFacetSplits": [
- "string"
], - "defaultFacetCompare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "customFacetCompares": [
- {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}
], - "requireGroupFilters": true,
- "allowFilterCombine": true,
- "groupFilters": {
- "property1": {
- "name": "string",
- "formula": "string"
}, - "property2": {
- "name": "string",
- "formula": "string"
}
}
}
Returns details of a specified data cube.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "queryMode": "sql",
- "source": {
- "type": "direct",
- "value": "string",
- "connectionName": "string"
}, - "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "minAutoRefreshRate": "PT5M",
- "subsetFormula": "string",
- "filterToken": "string",
- "rollup": true,
- "options": {
- "fixedMaxTime": "2019-08-24T14:15:22Z",
- "timeoutOverride": 0,
- "exactResultsOnly": true,
- "customTransforms": { },
- "piiMask": {
- "aggregate": "string",
- "threshold": 0,
- "hideAggregates": true,
- "maskText": "string",
- "otherText": "string"
}, - "restrictedModeProperties": [
- "string"
], - "latestPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "currentPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "previousPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "splitLimits": [
- 0
], - "ignoreDimensionInExplain": [
- "string"
], - "rankExpression": "$main.count",
- "druidContext": { },
- "priority": 0,
- "maxDownloadLimit": 0,
- "largeDownloadInterval": "string",
- "suppressOverallByDefault": true,
- "boostPrefixRank": true,
- "boostSelectedMeasures": true,
- "grayOutTrivial": true,
- "alwaysShowCompareControl": true,
- "disablePreview": true,
- "showExplainBadge": true
}, - "readAccess": {
- "access": "all"
}, - "restrictedEditAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "downloadAccess": {
- "access": "all"
}, - "attributes": [
- {
- "name": "string",
- "type": "NULL",
- "nativeType": "string",
- "unsplitable": true,
- "maker": { },
- "cardinality": 0,
- "range": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "termsDelegate": "string"
}
], - "dimensions": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
], - "measures": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
], - "instances": {
- "dimensionFormula": "string",
- "values": [
- "string"
]
}, - "specialTimeDimension": "string",
- "enforceTimeFilter": true,
- "defaultFilter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "defaultTimezone": "string",
- "defaultDuration": "PT5M",
- "defaultSelectedMeasures": [
- "string"
], - "defaultPinnedDimensions": [
- "string"
], - "defaultRefreshRate": "string",
- "defaultVisualization": "string",
- "defaultHavingFilter": {
- "measure": "string",
- "op": "lessThan",
- "value": 0
}, - "latestDataStrategy": "query",
- "queryCaching": "allow",
- "formulaeVisibility": "show",
- "minAlertFrequency": "PT5M",
- "minAlertTimeFrame": "PT5M",
- "defaultParameters": "string",
- "defaultFacetSplits": [
- "string"
], - "defaultFacetCompare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "customFacetCompares": [
- {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}
], - "requireGroupFilters": true,
- "allowFilterCombine": true,
- "groupFilters": {
- "property1": {
- "name": "string",
- "formula": "string"
}, - "property2": {
- "name": "string",
- "formula": "string"
}
}
}
Updates the details of a data cube with a specified ID. You must provide all properties you want to retain in the data cube, even if you don't want to update them. Polaris recreates the data cube with the details you specify in the request.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
The data cube to be updated
queryMode required | string (QueryMode) Value: "sql" Data cube query mode. |
required | object (DataCubeSource) Data cube source. |
title required | string Data cube title. |
allowFilterCombine | boolean Determines the behaviour when a user is a member of two or more user groups with access filters applied.
If |
Array of objects (Attribute) Column metadata for the associated data source. | |
Array of objects (FacetCompare) Customized comparisons for the data cube. | |
defaultDuration | string <duration> Time period to display when a user first opens the data cube, expressed as an ISO 8601 duration. |
object (FacetCompare) Comparison for data cubes. | |
Array of strings or SplitCombineFull (object) (SplitCombine) Default dimensions to split on. | |
object (Filter) Filter to apply to a query. | |
object (HavingFilter) HAVING filter to apply to a measure. | |
defaultParameters | string The default parameters to populate an Explore visualization. |
defaultPinnedDimensions | Array of strings IDs of the dimensions to pin by default in visualizations. |
defaultRefreshRate | string <duration> The default refresh rate for the data cube, expressed as an ISO 8601 Duration. |
defaultSelectedMeasures | Array of strings IDs of the measures to show by default in visualizations. |
defaultTimezone | string Time zone to select when a user first opens the data cube, expressed as an Olsen Timezone. |
defaultVisualization | string Name of the default visualization to use when initially viewing the data cube. |
description | string Data cube description. |
Array of objects (DimensionPayload) The dimensions of the data cube. | |
any (AccessList) Configure user access to the asset. | |
enforceTimeFilter | boolean Ensures that every query is filtered on the primary time dimension. You can enable this setting if time unbounded queries are likely to be slow due to the volume of data. |
filterToken | string Only allow users with the given filter token to access this data cube. |
formulaeVisibility | string (Visibility) Enum: "show" "hide" Whether a field should be shown or hidden. |
object Maps the names of group filters to their filter definitions. | |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
object (DataCubeInstanceList) Data cube instances. | |
latestDataStrategy | string (LatestDataStrategy) Enum: "query" "query-floored-P1D" "predefined" Determines how Polaris calculates the latest data time for the data cube. By default, Polaris queries the data source for the latest time stamp on ingested data. You can set this property to always use the current time, which may be more appropriate for streaming data. |
Array of objects (MeasurePayload) Array of data cube measures. | |
minAlertFrequency | string <duration> Minimum allowable frequency for alerts associated with this data cube, expressed as an ISO 8601 Duration. |
minAlertTimeFrame | string <duration> Minimum allowable time frame for alerts associated with this data cube, expressed as an ISO 8601 Duration. |
minAutoRefreshRate | string <duration> Minimum auto refresh rate for the data cube, expressed as an ISO 8601 Duration. |
any (AccessList) Configure user access to the asset. | |
object (DataCubeOptions) Data cube options. | |
object or null (AppColorPalette) Color palette for the Polaris UI. Use the 6-character hex format for all colors. | |
queryCaching | string Enum: "allow" "disable" Allow caching on queries made to this data cube. Caching can greatly speed up exploration but can also cause results to be a little out of date especially in realtime rolled up datasets. |
any (AccessList) Configure user access to the asset. | |
requireGroupFilters | boolean Enable this property to use access filters. When enabled, users who aren't assigned an access filter can't perform queries. |
any (AccessList) Configure user access to the asset. | |
rollup | boolean Whether the associated table has rollup enabled. |
specialTimeDimension | string Time dimension Polaris uses for all time-related calculations for the data cube, including comparisons, filters, alerts, and reports. Polarise uses this to check the freshness of data and apply time filters. |
subsetFormula | string Row level filter to apply to the data cube. This filter is never shown in the cube view and effectively constrains the data cube to only the events that match this filter. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "queryMode": "sql",
- "source": {
- "type": "direct",
- "value": "string",
- "connectionName": "string"
}, - "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "minAutoRefreshRate": "PT5M",
- "subsetFormula": "string",
- "filterToken": "string",
- "rollup": true,
- "options": {
- "fixedMaxTime": "2019-08-24T14:15:22Z",
- "timeoutOverride": 0,
- "exactResultsOnly": true,
- "customTransforms": { },
- "piiMask": {
- "aggregate": "string",
- "threshold": 0,
- "hideAggregates": true,
- "maskText": "string",
- "otherText": "string"
}, - "restrictedModeProperties": [
- "string"
], - "latestPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "currentPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "previousPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "splitLimits": [
- 0
], - "ignoreDimensionInExplain": [
- "string"
], - "rankExpression": "$main.count",
- "druidContext": { },
- "priority": 0,
- "maxDownloadLimit": 0,
- "largeDownloadInterval": "string",
- "suppressOverallByDefault": true,
- "boostPrefixRank": true,
- "boostSelectedMeasures": true,
- "grayOutTrivial": true,
- "alwaysShowCompareControl": true,
- "disablePreview": true,
- "showExplainBadge": true
}, - "readAccess": {
- "access": "all"
}, - "restrictedEditAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "downloadAccess": {
- "access": "all"
}, - "attributes": [
- {
- "name": "string",
- "type": "NULL",
- "nativeType": "string",
- "unsplitable": true,
- "maker": { },
- "cardinality": 0,
- "range": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "termsDelegate": "string"
}
], - "dimensions": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
], - "measures": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
], - "instances": {
- "dimensionFormula": "string",
- "values": [
- "string"
]
}, - "specialTimeDimension": "string",
- "enforceTimeFilter": true,
- "defaultFilter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "defaultTimezone": "string",
- "defaultDuration": "PT5M",
- "defaultSelectedMeasures": [
- "string"
], - "defaultPinnedDimensions": [
- "string"
], - "defaultRefreshRate": "string",
- "defaultVisualization": "string",
- "defaultHavingFilter": {
- "measure": "string",
- "op": "lessThan",
- "value": 0
}, - "latestDataStrategy": "query",
- "queryCaching": "allow",
- "formulaeVisibility": "show",
- "minAlertFrequency": "PT5M",
- "minAlertTimeFrame": "PT5M",
- "defaultParameters": "string",
- "defaultFacetSplits": [
- "string"
], - "defaultFacetCompare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "customFacetCompares": [
- {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}
], - "requireGroupFilters": true,
- "allowFilterCombine": true,
- "groupFilters": {
- "property1": {
- "name": "string",
- "formula": "string"
}, - "property2": {
- "name": "string",
- "formula": "string"
}
}
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "queryMode": "sql",
- "source": {
- "type": "direct",
- "value": "string",
- "connectionName": "string"
}, - "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "minAutoRefreshRate": "PT5M",
- "subsetFormula": "string",
- "filterToken": "string",
- "rollup": true,
- "options": {
- "fixedMaxTime": "2019-08-24T14:15:22Z",
- "timeoutOverride": 0,
- "exactResultsOnly": true,
- "customTransforms": { },
- "piiMask": {
- "aggregate": "string",
- "threshold": 0,
- "hideAggregates": true,
- "maskText": "string",
- "otherText": "string"
}, - "restrictedModeProperties": [
- "string"
], - "latestPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "currentPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "previousPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "splitLimits": [
- 0
], - "ignoreDimensionInExplain": [
- "string"
], - "rankExpression": "$main.count",
- "druidContext": { },
- "priority": 0,
- "maxDownloadLimit": 0,
- "largeDownloadInterval": "string",
- "suppressOverallByDefault": true,
- "boostPrefixRank": true,
- "boostSelectedMeasures": true,
- "grayOutTrivial": true,
- "alwaysShowCompareControl": true,
- "disablePreview": true,
- "showExplainBadge": true
}, - "readAccess": {
- "access": "all"
}, - "restrictedEditAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "downloadAccess": {
- "access": "all"
}, - "attributes": [
- {
- "name": "string",
- "type": "NULL",
- "nativeType": "string",
- "unsplitable": true,
- "maker": { },
- "cardinality": 0,
- "range": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "termsDelegate": "string"
}
], - "dimensions": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
], - "measures": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
], - "instances": {
- "dimensionFormula": "string",
- "values": [
- "string"
]
}, - "specialTimeDimension": "string",
- "enforceTimeFilter": true,
- "defaultFilter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "defaultTimezone": "string",
- "defaultDuration": "PT5M",
- "defaultSelectedMeasures": [
- "string"
], - "defaultPinnedDimensions": [
- "string"
], - "defaultRefreshRate": "string",
- "defaultVisualization": "string",
- "defaultHavingFilter": {
- "measure": "string",
- "op": "lessThan",
- "value": 0
}, - "latestDataStrategy": "query",
- "queryCaching": "allow",
- "formulaeVisibility": "show",
- "minAlertFrequency": "PT5M",
- "minAlertTimeFrame": "PT5M",
- "defaultParameters": "string",
- "defaultFacetSplits": [
- "string"
], - "defaultFacetCompare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "customFacetCompares": [
- {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}
], - "requireGroupFilters": true,
- "allowFilterCombine": true,
- "groupFilters": {
- "property1": {
- "name": "string",
- "formula": "string"
}, - "property2": {
- "name": "string",
- "formula": "string"
}
}
}
Updates the specified properties of a data cube. Any properties omitted from the request retain their previous values. Polaris creates a new data cube if the supplied data cube ID doesn't exist.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
Data cube updates
allowFilterCombine | boolean Determines the behaviour when a user is a member of two or more user groups with access filters applied.
If |
Array of objects (Attribute) Column metadata for the associated data source. | |
Array of objects (FacetCompare) Customized comparisons for the data cube. | |
defaultDuration | string <duration> Time period to display when a user first opens the data cube, expressed as an ISO 8601 duration. |
object (FacetCompare) Comparison for data cubes. | |
Array of strings or SplitCombineFull (object) (SplitCombine) Default dimensions to split on. | |
object (Filter) Filter to apply to a query. | |
object (HavingFilter) HAVING filter to apply to a measure. | |
defaultParameters | string The default parameters to populate an Explore visualization. |
defaultPinnedDimensions | Array of strings IDs of the dimensions to pin by default in visualizations. |
defaultRefreshRate | string <duration> The default refresh rate for the data cube, expressed as an ISO 8601 Duration. |
defaultSelectedMeasures | Array of strings IDs of the measures to show by default in visualizations. |
defaultTimezone | string Time zone to select when a user first opens the data cube, expressed as an Olsen Timezone. |
defaultVisualization | string Name of the default visualization to use when initially viewing the data cube. |
description | string Data cube description. |
Array of objects (DimensionPayload) The dimensions of the data cube. | |
any (AccessList) Configure user access to the asset. | |
enforceTimeFilter | boolean Ensures that every query is filtered on the primary time dimension. You can enable this setting if time unbounded queries are likely to be slow due to the volume of data. |
filterToken | string Only allow users with the given filter token to access this data cube. |
formulaeVisibility | string (Visibility) Enum: "show" "hide" Whether a field should be shown or hidden. |
object Maps the names of group filters to their filter definitions. | |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
object (DataCubeInstanceList) Data cube instances. | |
latestDataStrategy | string (LatestDataStrategy) Enum: "query" "query-floored-P1D" "predefined" Determines how Polaris calculates the latest data time for the data cube. By default, Polaris queries the data source for the latest time stamp on ingested data. You can set this property to always use the current time, which may be more appropriate for streaming data. |
Array of objects (MeasurePayload) Array of data cube measures. | |
minAlertFrequency | string <duration> Minimum allowable frequency for alerts associated with this data cube, expressed as an ISO 8601 Duration. |
minAlertTimeFrame | string <duration> Minimum allowable time frame for alerts associated with this data cube, expressed as an ISO 8601 Duration. |
minAutoRefreshRate | string <duration> Minimum auto refresh rate for the data cube, expressed as an ISO 8601 Duration. |
any (AccessList) Configure user access to the asset. | |
object (DataCubeOptions) Data cube options. | |
object or null (AppColorPalette) Color palette for the Polaris UI. Use the 6-character hex format for all colors. | |
queryCaching | string Enum: "allow" "disable" Allow caching on queries made to this data cube. Caching can greatly speed up exploration but can also cause results to be a little out of date especially in realtime rolled up datasets. |
queryMode | string (QueryMode) Value: "sql" Data cube query mode. |
any (AccessList) Configure user access to the asset. | |
requireGroupFilters | boolean Enable this property to use access filters. When enabled, users who aren't assigned an access filter can't perform queries. |
any (AccessList) Configure user access to the asset. | |
rollup | boolean Whether the associated table has rollup enabled. |
object (DataCubeSource) Data cube source. | |
specialTimeDimension | string Time dimension Polaris uses for all time-related calculations for the data cube, including comparisons, filters, alerts, and reports. Polarise uses this to check the freshness of data and apply time filters. |
subsetFormula | string Row level filter to apply to the data cube. This filter is never shown in the cube view and effectively constrains the data cube to only the events that match this filter. |
title | string Data cube title. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "queryMode": "sql",
- "source": {
- "type": "direct",
- "value": "string",
- "connectionName": "string"
}, - "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "minAutoRefreshRate": "PT5M",
- "subsetFormula": "string",
- "filterToken": "string",
- "rollup": true,
- "options": {
- "fixedMaxTime": "2019-08-24T14:15:22Z",
- "timeoutOverride": 0,
- "exactResultsOnly": true,
- "customTransforms": { },
- "piiMask": {
- "aggregate": "string",
- "threshold": 0,
- "hideAggregates": true,
- "maskText": "string",
- "otherText": "string"
}, - "restrictedModeProperties": [
- "string"
], - "latestPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "currentPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "previousPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "splitLimits": [
- 0
], - "ignoreDimensionInExplain": [
- "string"
], - "rankExpression": "$main.count",
- "druidContext": { },
- "priority": 0,
- "maxDownloadLimit": 0,
- "largeDownloadInterval": "string",
- "suppressOverallByDefault": true,
- "boostPrefixRank": true,
- "boostSelectedMeasures": true,
- "grayOutTrivial": true,
- "alwaysShowCompareControl": true,
- "disablePreview": true,
- "showExplainBadge": true
}, - "readAccess": {
- "access": "all"
}, - "restrictedEditAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "downloadAccess": {
- "access": "all"
}, - "attributes": [
- {
- "name": "string",
- "type": "NULL",
- "nativeType": "string",
- "unsplitable": true,
- "maker": { },
- "cardinality": 0,
- "range": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "termsDelegate": "string"
}
], - "dimensions": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
], - "measures": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
], - "instances": {
- "dimensionFormula": "string",
- "values": [
- "string"
]
}, - "specialTimeDimension": "string",
- "enforceTimeFilter": true,
- "defaultFilter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "defaultTimezone": "string",
- "defaultDuration": "PT5M",
- "defaultSelectedMeasures": [
- "string"
], - "defaultPinnedDimensions": [
- "string"
], - "defaultRefreshRate": "string",
- "defaultVisualization": "string",
- "defaultHavingFilter": {
- "measure": "string",
- "op": "lessThan",
- "value": 0
}, - "latestDataStrategy": "query",
- "queryCaching": "allow",
- "formulaeVisibility": "show",
- "minAlertFrequency": "PT5M",
- "minAlertTimeFrame": "PT5M",
- "defaultParameters": "string",
- "defaultFacetSplits": [
- "string"
], - "defaultFacetCompare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "customFacetCompares": [
- {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}
], - "requireGroupFilters": true,
- "allowFilterCombine": true,
- "groupFilters": {
- "property1": {
- "name": "string",
- "formula": "string"
}, - "property2": {
- "name": "string",
- "formula": "string"
}
}
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "queryMode": "sql",
- "source": {
- "type": "direct",
- "value": "string",
- "connectionName": "string"
}, - "palette": {
- "primary": "#C2B280",
- "compare": "#C2B280",
- "dimension": "#C2B280",
- "measure": "#C2B280"
}, - "minAutoRefreshRate": "PT5M",
- "subsetFormula": "string",
- "filterToken": "string",
- "rollup": true,
- "options": {
- "fixedMaxTime": "2019-08-24T14:15:22Z",
- "timeoutOverride": 0,
- "exactResultsOnly": true,
- "customTransforms": { },
- "piiMask": {
- "aggregate": "string",
- "threshold": 0,
- "hideAggregates": true,
- "maskText": "string",
- "otherText": "string"
}, - "restrictedModeProperties": [
- "string"
], - "latestPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "currentPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "previousPresets": [
- {
- "name": "string",
- "selection": "$m.timeRange('PT1M', -1)",
- "pillLabel": "string"
}
], - "splitLimits": [
- 0
], - "ignoreDimensionInExplain": [
- "string"
], - "rankExpression": "$main.count",
- "druidContext": { },
- "priority": 0,
- "maxDownloadLimit": 0,
- "largeDownloadInterval": "string",
- "suppressOverallByDefault": true,
- "boostPrefixRank": true,
- "boostSelectedMeasures": true,
- "grayOutTrivial": true,
- "alwaysShowCompareControl": true,
- "disablePreview": true,
- "showExplainBadge": true
}, - "readAccess": {
- "access": "all"
}, - "restrictedEditAccess": {
- "access": "all"
}, - "modifyAccess": {
- "access": "all"
}, - "downloadAccess": {
- "access": "all"
}, - "attributes": [
- {
- "name": "string",
- "type": "NULL",
- "nativeType": "string",
- "unsplitable": true,
- "maker": { },
- "cardinality": 0,
- "range": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "termsDelegate": "string"
}
], - "dimensions": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
], - "measures": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
], - "instances": {
- "dimensionFormula": "string",
- "values": [
- "string"
]
}, - "specialTimeDimension": "string",
- "enforceTimeFilter": true,
- "defaultFilter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "defaultTimezone": "string",
- "defaultDuration": "PT5M",
- "defaultSelectedMeasures": [
- "string"
], - "defaultPinnedDimensions": [
- "string"
], - "defaultRefreshRate": "string",
- "defaultVisualization": "string",
- "defaultHavingFilter": {
- "measure": "string",
- "op": "lessThan",
- "value": 0
}, - "latestDataStrategy": "query",
- "queryCaching": "allow",
- "formulaeVisibility": "show",
- "minAlertFrequency": "PT5M",
- "minAlertTimeFrame": "PT5M",
- "defaultParameters": "string",
- "defaultFacetSplits": [
- "string"
], - "defaultFacetCompare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "customFacetCompares": [
- {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}
], - "requireGroupFilters": true,
- "allowFilterCombine": true,
- "groupFilters": {
- "property1": {
- "name": "string",
- "formula": "string"
}, - "property2": {
- "name": "string",
- "formula": "string"
}
}
}
Deletes a data cube.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Returns all dimensions for a data cube.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
{- "values": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
]
}
Creates a dimension for a data cube.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
bucketingStrategy | string (BucketingStrategy) Enum: "defaultBucket" "defaultNoBucket" "neverBucket" "alwaysBucket" The bucketing strategy for a dimension. |
description | string Dimension description. |
format | string Date/time format to use for TIME dimensions. See MomentJS docs for more information. |
formula | string SQL expression for the dimension. Refer to the associated Polaris table by its alias "t". |
geo | boolean Indicates that this is a geographic dimension. You must also provide a valid |
geoEncoding | string (GeoEncodingType) Enum: "ISO 3166-1 Alpha-2" "ISO 3166-1 Alpha-3" "ISO 3166-2" "UN M49" "Geohash" "lng-coordinate" "lat-coordinate" The geo encoding type for a dimension. Geo dimensions require specific data types to be set
depending on the geo encoding type. For |
Array of strings or numbers or objects Preset bucketing granularities for time and numeric dimensions. | |
group | string Dimensions with the same value for this property are grouped together in the dimensions panel. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
ipPrefix | boolean Store the dimension as a complex data type representing an IP prefix. Requires the |
title | string Dimension title. |
type | string (DimensionType) Enum: "TIME" "STRING" "SET/STRING" "NUMBER" "BOOLEAN" "IP" Specific data type for a dimension. For IP Prefix dimensions, use the |
url | string URL transformation for string dimensions. Polaris interpolates the provided string and
replaces |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
Returns information for a single data cube dimension.
dimensionId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dimension identifier |
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
Updates the details of a dimension with a specified ID. You must provide all properties you want to retain in the dimension even if you don't want to update them. Polaris recreates the dimension with the details you specify in the request.
dimensionId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dimension identifier |
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
The dimension to be updated
bucketingStrategy | string (BucketingStrategy) Enum: "defaultBucket" "defaultNoBucket" "neverBucket" "alwaysBucket" The bucketing strategy for a dimension. |
description | string Dimension description. |
format | string Date/time format to use for TIME dimensions. See MomentJS docs for more information. |
formula | string SQL expression for the dimension. Refer to the associated Polaris table by its alias "t". |
geo | boolean Indicates that this is a geographic dimension. You must also provide a valid |
geoEncoding | string (GeoEncodingType) Enum: "ISO 3166-1 Alpha-2" "ISO 3166-1 Alpha-3" "ISO 3166-2" "UN M49" "Geohash" "lng-coordinate" "lat-coordinate" The geo encoding type for a dimension. Geo dimensions require specific data types to be set
depending on the geo encoding type. For |
Array of strings or numbers or objects Preset bucketing granularities for time and numeric dimensions. | |
group | string Dimensions with the same value for this property are grouped together in the dimensions panel. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
ipPrefix | boolean Store the dimension as a complex data type representing an IP prefix. Requires the |
title | string Dimension title. |
type | string (DimensionType) Enum: "TIME" "STRING" "SET/STRING" "NUMBER" "BOOLEAN" "IP" Specific data type for a dimension. For IP Prefix dimensions, use the |
url | string URL transformation for string dimensions. Polaris interpolates the provided string and
replaces |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
Updates the specified properties of a dimension. Any properties omitted from the request retain their previous values. Polaris creates a new dimension if the supplied dimension ID doesn't exist.
dimensionId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dimension identifier |
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
Dimension updates
bucketingStrategy | string (BucketingStrategy) Enum: "defaultBucket" "defaultNoBucket" "neverBucket" "alwaysBucket" The bucketing strategy for a dimension. |
description | string Dimension description. |
format | string Date/time format to use for TIME dimensions. See MomentJS docs for more information. |
formula | string SQL expression for the dimension. Refer to the associated Polaris table by its alias "t". |
geo | boolean Indicates that this is a geographic dimension. You must also provide a valid |
geoEncoding | string (GeoEncodingType) Enum: "ISO 3166-1 Alpha-2" "ISO 3166-1 Alpha-3" "ISO 3166-2" "UN M49" "Geohash" "lng-coordinate" "lat-coordinate" The geo encoding type for a dimension. Geo dimensions require specific data types to be set
depending on the geo encoding type. For |
Array of strings or numbers or objects Preset bucketing granularities for time and numeric dimensions. | |
group | string Dimensions with the same value for this property are grouped together in the dimensions panel. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
ipPrefix | boolean Store the dimension as a complex data type representing an IP prefix. Requires the |
title | string Dimension title. |
type | string (DimensionType) Enum: "TIME" "STRING" "SET/STRING" "NUMBER" "BOOLEAN" "IP" Specific data type for a dimension. For IP Prefix dimensions, use the |
url | string URL transformation for string dimensions. Polaris interpolates the provided string and
replaces |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "formula": "COALESCE(LOOKUP(t.\"Country\", 'store_sales_country_to_iso31661'), t.\"Country\")",
- "type": "TIME",
- "geo": true,
- "geoEncoding": "ISO 3166-1 Alpha-2",
- "ipPrefix": true,
- "format": "string",
- "granularities": [
- "string"
], - "bucketingStrategy": "defaultBucket"
}
Deletes a dimension.
dimensionId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dimension identifier |
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Returns all measures for a data cube.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
{- "values": [
- {
- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
]
}
Creates a measure for a data cube.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
object (ComparisonColors) Determines the display coloring for increased and decreased values. | |
description | string Measure description. |
formula | string SQL expression for the measure. Refer to tables with the alias "t". |
group | string Groups measures with the same group value together in the measures panel. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
missingValueFill | string (MissingValueFill) Enum: "zero" "none" "previous" "interpolate" Specifies how to fill empty values for a measure on continuous visualizations:
|
object (NumberStyle) Measure formatting. | |
scaleBehavior | string (ScaleBehavior) Enum: "pin-zero" "unpinned" Determines how the scale behaves in "continuous" visualizations (such as the line chart):
|
title | string Measure title. |
transform | string (MeasureTransform) Enum: "none" "percent-of-parent" "percent-of-root" You can transform a measure to be displayed as Percent of parent segment or as Percent of total instead of the default measure display. |
units | string Added as a suffix. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
Returns information for a single data cube measure.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
measureId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dimension identifier |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
Updates the details of a measure with a specified ID. You must provide all properties you want to retain in the measure, even if you don't want to update them. Polaris recreates the measure with the details you specify in the request.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
measureId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dimension identifier |
Measure to be update.
object (ComparisonColors) Determines the display coloring for increased and decreased values. | |
description | string Measure description. |
formula | string SQL expression for the measure. Refer to tables with the alias "t". |
group | string Groups measures with the same group value together in the measures panel. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
missingValueFill | string (MissingValueFill) Enum: "zero" "none" "previous" "interpolate" Specifies how to fill empty values for a measure on continuous visualizations:
|
object (NumberStyle) Measure formatting. | |
scaleBehavior | string (ScaleBehavior) Enum: "pin-zero" "unpinned" Determines how the scale behaves in "continuous" visualizations (such as the line chart):
|
title | string Measure title. |
transform | string (MeasureTransform) Enum: "none" "percent-of-parent" "percent-of-root" You can transform a measure to be displayed as Percent of parent segment or as Percent of total instead of the default measure display. |
units | string Added as a suffix. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
Updates the specified properties of a measure. Any properties omitted from the request retain their previous values. Polaris creates a new measure if the supplied measure ID doesn't exist.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
measureId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dimension identifier |
Measure updates
object (ComparisonColors) Determines the display coloring for increased and decreased values. | |
description | string Measure description. |
formula | string SQL expression for the measure. Refer to tables with the alias "t". |
group | string Groups measures with the same group value together in the measures panel. |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
missingValueFill | string (MissingValueFill) Enum: "zero" "none" "previous" "interpolate" Specifies how to fill empty values for a measure on continuous visualizations:
|
object (NumberStyle) Measure formatting. | |
scaleBehavior | string (ScaleBehavior) Enum: "pin-zero" "unpinned" Determines how the scale behaves in "continuous" visualizations (such as the line chart):
|
title | string Measure title. |
transform | string (MeasureTransform) Enum: "none" "percent-of-parent" "percent-of-root" You can transform a measure to be displayed as Percent of parent segment or as Percent of total instead of the default measure display. |
units | string Added as a suffix. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
{- "id": "wikipedia-1234",
- "title": "string",
- "description": "string",
- "group": "string",
- "units": "string",
- "formula": "SUM(t.\"revenue\") FILTER (WHERE t.\"country\" = 'United States')",
- "transform": "none",
- "numberStyle": {
- "type": "raw",
- "leading": 0,
- "minDecimals": 0,
- "maxDecimals": 0,
- "optionalDecimal": true,
- "negativeParentheses": true,
- "signed": true,
- "integer": true,
- "thousandsDelimiter": "string",
- "decimalDelimiter": "string",
- "forceAbbreviation": 0,
- "abbreviationSpace": true,
- "rawUnit": "string",
- "timeFormat": "string"
}, - "missingValueFill": "zero",
- "scaleBehavior": "pin-zero",
- "comparisonColors": {
- "label": "string",
- "increase": "#01ab51",
- "decrease": "#db3333"
}
}
Deletes a measure.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Data cube identifier |
measureId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Dimension identifier |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Create and manage links to embedded visualizations. See Embed visualizations for information on managing links to embedded visualizations in the Imply Polaris UI.
Returns all links to embedded visualizations.
{- "values": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "time",
- "dimension": "string",
- "value": {
- "timeType": "fixed",
- "value": "string",
- "start": "string",
- "end": "string"
}
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "timezone": "Etc/UTC"
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 50000,
- "id": "wikipedia-1234",
- "apiCreated": true,
- "embeddingSecret": "string"
}
]
}
Creates a link to an embedded visualization.
layout required | string Enum: "entire-view" "visualization-only" Show or hide the controls surrounding the visualization. |
name required | string Name of the embedding link. |
required | EmbeddingDataCubeDescription (object) or EmbeddingDashboardDescription (object) Object containing the properties of the embedded view. |
description | string Description of the embedding link. |
downloadLimit | number <= 50000 Set the maximum number of rows a user can download, and enable the download button on the embedded visualization. Set to 0 or leave undefined to disable downloads. The maximum download limit is 50000. |
nonFilterableDimensions | Array of strings Dimensions to exclude from the filter bar of the embedded visualization. |
nonShowableDimensions | Array of strings Dimensions to exclude from the show bar of the embedded visualization. |
requiredFilter | string SQL condition to apply to the underlying data. See Create an access filter for more information. |
restricted | boolean If set to true, a signature validated with the generated private key is required to access the link. |
ttl | number Period of time in milliseconds for which the link is valid, after a user first accesses it. Applies to restricted links only. Defaults to 1 hour. |
{- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "time",
- "dimension": "string",
- "value": {
- "timeType": "fixed",
- "value": "string",
- "start": "string",
- "end": "string"
}
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "timezone": "Etc/UTC"
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 50000
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "time",
- "dimension": "string",
- "value": {
- "timeType": "fixed",
- "value": "string",
- "start": "string",
- "end": "string"
}
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "timezone": "Etc/UTC"
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 50000,
- "id": "wikipedia-1234",
- "apiCreated": true,
- "embeddingSecret": "string"
}
Returns information for a single link to an embedded visualization.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Embedding link ID. |
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "time",
- "dimension": "string",
- "value": {
- "timeType": "fixed",
- "value": "string",
- "start": "string",
- "end": "string"
}
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "timezone": "Etc/UTC"
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 50000,
- "id": "wikipedia-1234",
- "apiCreated": true,
- "embeddingSecret": "string"
}
Updates a link to an embedded visualization.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Embedding link ID. |
Link to update
layout required | string Enum: "entire-view" "visualization-only" Show or hide the controls surrounding the visualization. |
name required | string Name of the embedding link. |
required | EmbeddingDataCubeDescription (object) or EmbeddingDashboardDescription (object) Object containing the properties of the embedded view. |
description | string Description of the embedding link. |
downloadLimit | number <= 50000 Set the maximum number of rows a user can download, and enable the download button on the embedded visualization. Set to 0 or leave undefined to disable downloads. The maximum download limit is 50000. |
nonFilterableDimensions | Array of strings Dimensions to exclude from the filter bar of the embedded visualization. |
nonShowableDimensions | Array of strings Dimensions to exclude from the show bar of the embedded visualization. |
requiredFilter | string SQL condition to apply to the underlying data. See Create an access filter for more information. |
restricted | boolean If set to true, a signature validated with the generated private key is required to access the link. |
ttl | number Period of time in milliseconds for which the link is valid, after a user first accesses it. Applies to restricted links only. Defaults to 1 hour. |
{- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "time",
- "dimension": "string",
- "value": {
- "timeType": "fixed",
- "value": "string",
- "start": "string",
- "end": "string"
}
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "timezone": "Etc/UTC"
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 50000
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "time",
- "dimension": "string",
- "value": {
- "timeType": "fixed",
- "value": "string",
- "start": "string",
- "end": "string"
}
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "timezone": "Etc/UTC"
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 50000,
- "id": "wikipedia-1234",
- "apiCreated": true,
- "embeddingSecret": "string"
}
Updates the specified properties of an embedding link. Any properties omitted from the request retain their previous values. Polaris creates a new embedding link if the supplied link ID doesn't exist.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Embedding link ID. |
Embedding link updates
layout required | string Enum: "entire-view" "visualization-only" Show or hide the controls surrounding the visualization. |
name required | string Name of the embedding link. |
required | EmbeddingDataCubeDescription (object) or EmbeddingDashboardDescription (object) Object containing the properties of the embedded view. |
description | string Description of the embedding link. |
downloadLimit | number <= 50000 Set the maximum number of rows a user can download, and enable the download button on the embedded visualization. Set to 0 or leave undefined to disable downloads. The maximum download limit is 50000. |
nonFilterableDimensions | Array of strings Dimensions to exclude from the filter bar of the embedded visualization. |
nonShowableDimensions | Array of strings Dimensions to exclude from the show bar of the embedded visualization. |
requiredFilter | string SQL condition to apply to the underlying data. See Create an access filter for more information. |
restricted | boolean If set to true, a signature validated with the generated private key is required to access the link. |
ttl | number Period of time in milliseconds for which the link is valid, after a user first accesses it. Applies to restricted links only. Defaults to 1 hour. |
{- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "time",
- "dimension": "string",
- "value": {
- "timeType": "fixed",
- "value": "string",
- "start": "string",
- "end": "string"
}
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "timezone": "Etc/UTC"
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 50000
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "time",
- "dimension": "string",
- "value": {
- "timeType": "fixed",
- "value": "string",
- "start": "string",
- "end": "string"
}
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "timezone": "Etc/UTC"
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 50000,
- "id": "wikipedia-1234",
- "apiCreated": true,
- "embeddingSecret": "string"
}
Deletes a link to an embedded visualization.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Embedding link ID. |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Creates an ECDSA private key that is required to access the embedding link.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Embedding link ID. |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Deletes the ECDSA public key associated with an embedding link. After deletion the link will function as a public link.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Embedding link ID. |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
The Embedding v1 API has been deprecated in favor of the Embedding links API. For information about how to adopt the new API, see Migration guide for deprecated APIs.
Returns all links to embedded visualizations.
projectId required | string Project ID. |
{- "embedLinks": [
- {
- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "__time",
- "dimension": "string",
- "operator": "gt",
- "value": "string"
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "compareType": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "string",
- "dimension": {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}, - "measure": {
- "name": "string",
- "transform": "none"
}, - "filter": [
- {
- "filterType": "__time",
- "dimension": "string",
- "operator": "gt",
- "value": "string"
}
]
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
]
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 0,
- "link": "string"
}
]
}
Creates a link to an embedded visualization.
projectId required | string Project ID. |
object (EmbedLinkDescription) Object containing the properties of the embedding link. |
{- "embedLinkDescription": {
- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "__time",
- "dimension": "string",
- "operator": "gt",
- "value": "string"
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "compareType": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "string",
- "dimension": {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}, - "measure": {
- "name": "string",
- "transform": "none"
}, - "filter": [
- {
- "filterType": "__time",
- "dimension": "string",
- "operator": "gt",
- "value": "string"
}
]
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
]
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 0
}
}
{- "status": "string",
- "link": "string",
- "embeddingSecret": "string"
}
Returns information for a single link to an embedded visualization.
linkId required | string Embedding link ID. |
projectId required | string Project ID. |
{- "embedLinkDescription": {
- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "__time",
- "dimension": "string",
- "operator": "gt",
- "value": "string"
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "compareType": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "string",
- "dimension": {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}, - "measure": {
- "name": "string",
- "transform": "none"
}, - "filter": [
- {
- "filterType": "__time",
- "dimension": "string",
- "operator": "gt",
- "value": "string"
}
]
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
]
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 0,
- "link": "string"
}
}
Updates a link to an embedded visualization.
linkId required | string Embedding link ID. |
projectId required | string Project ID. |
object (EmbedLinkDescription) Object containing the properties of the embedding link. |
{- "embedLinkDescription": {
- "name": "string",
- "description": "string",
- "viewDescription": {
- "type": "spot-matrix",
- "dataCube": "string",
- "filter": [
- {
- "filterType": "__time",
- "dimension": "string",
- "operator": "gt",
- "value": "string"
}
], - "measures": [
- {
- "name": "string",
- "transform": "none"
}
], - "comparison": {
- "compareType": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "string",
- "dimension": {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}, - "measure": {
- "name": "string",
- "transform": "none"
}, - "filter": [
- {
- "filterType": "__time",
- "dimension": "string",
- "operator": "gt",
- "value": "string"
}
]
}, - "rows": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
], - "columns": [
- {
- "name": "string",
- "sortByMeasure": "string",
- "sortAscending": true,
- "limit": 0,
- "overall": "auto",
- "others": "auto"
}
]
}, - "layout": "entire-view",
- "requiredFilter": "string",
- "restricted": true,
- "ttl": 0,
- "nonFilterableDimensions": [
- "string"
], - "nonShowableDimensions": [
- "string"
], - "downloadLimit": 0
}
}
{- "status": "string",
- "link": "string",
- "embeddingSecret": "string"
}
Deletes a link to an embedded visualization.
linkId required | string Embedding link ID. |
projectId required | string Project ID. |
{- "status": "string",
- "message": "string"
}
Creates an ECDSA private key that is required to access the embedding link.
linkId required | string Embedding link ID. |
projectId required | string Project ID. |
{- "status": "string",
- "embeddingSecret": "string"
}
Deletes the ECDSA public key associated with an embedding link. After deletion the link will function as a public link.
linkId required | string Embedding link ID. |
projectId required | string Project ID. |
{ }
Create and manage reports and their evaluations. See Set up reports for information on managing reports in the Polaris UI.
{- "values": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}
]
}
Creates a report.
creationDate required | string <date-time> Timestamp when the report was created. |
owner required | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
addTotalRowToFile | boolean Default: false Adds a line to the attachment that shows an overall total. You can't apply this option to JSON format attachments. |
any (AccessList) Configure user access to the asset. | |
object (Delivery) Delivery configuration for a report. | |
description | string Report description to display in the Polaris UI, and in emails and webhooks. |
disabled | boolean Disables the report. Polaris doesn't evaluate disabled reports or send notifications. |
number or string Default: 500 Maximum number of rows to include in the report attachment. Defaults to | |
enforceDecimalFormatting | boolean Default: false Formats numeric values in the report attachment as decimals. |
object Visualization definition for classic data cubes. This is not applicable to Polaris. | |
object (ExploreEssence) State of a visualization in the Explore View | |
externalEmails | Array of strings <email> [ items <email > ] External email addresses to receive report notications. |
object (FacetEssence) State of a visualization in the Pivot 2 view | |
fileFormat | string Default: "csv" Enum: "csv" "tsv" "xlsx" "json" Format of the report data attachment. Defaults to |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
preferredView | string Default: "pivot1" Enum: "pivot1" "pivot2" "explore" View to use when viewing the report in Polaris. Defaults to |
any (AccessList) Configure user access to the asset. | |
any (AccessList) Configure user access to the asset. | |
sendDataFile | boolean Default: true Sends the report data as an attachment. |
sendEmail | boolean Sends email notifications to the report recipients when the report is generated. |
object (TimeFrame) | |
timezone | string Default: "Etc/UTC" Timezone to use when evaluating report criteria. Defaults to |
title | string Report title to display in the Polaris UI, and in emails and webhooks. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}
Returns details of a specified report.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Report ID. |
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}
Updates the details of a report with a specified ID. You must provide all properties you want to retain in the report, even if you don't want to update them. Polaris recreates the report with the details you specify in the request.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Report ID. |
Report ID.
creationDate required | string <date-time> Timestamp when the report was created. |
owner required | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
addTotalRowToFile | boolean Default: false Adds a line to the attachment that shows an overall total. You can't apply this option to JSON format attachments. |
any (AccessList) Configure user access to the asset. | |
object (Delivery) Delivery configuration for a report. | |
description | string Report description to display in the Polaris UI, and in emails and webhooks. |
disabled | boolean Disables the report. Polaris doesn't evaluate disabled reports or send notifications. |
number or string Default: 500 Maximum number of rows to include in the report attachment. Defaults to | |
enforceDecimalFormatting | boolean Default: false Formats numeric values in the report attachment as decimals. |
object Visualization definition for classic data cubes. This is not applicable to Polaris. | |
object (ExploreEssence) State of a visualization in the Explore View | |
externalEmails | Array of strings <email> [ items <email > ] External email addresses to receive report notications. |
object (FacetEssence) State of a visualization in the Pivot 2 view | |
fileFormat | string Default: "csv" Enum: "csv" "tsv" "xlsx" "json" Format of the report data attachment. Defaults to |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
preferredView | string Default: "pivot1" Enum: "pivot1" "pivot2" "explore" View to use when viewing the report in Polaris. Defaults to |
any (AccessList) Configure user access to the asset. | |
any (AccessList) Configure user access to the asset. | |
sendDataFile | boolean Default: true Sends the report data as an attachment. |
sendEmail | boolean Sends email notifications to the report recipients when the report is generated. |
object (TimeFrame) | |
timezone | string Default: "Etc/UTC" Timezone to use when evaluating report criteria. Defaults to |
title | string Report title to display in the Polaris UI, and in emails and webhooks. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}
Updates the specified properties of a report. Any properties omitted from the request retain their previous values. Polaris creates a new report if the supplied report ID doesn't exist.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Report ID. |
Report updates
addTotalRowToFile | boolean Default: false Adds a line to the attachment that shows an overall total. You can't apply this option to JSON format attachments. |
any (AccessList) Configure user access to the asset. | |
creationDate | string <date-time> Timestamp when the report was created. |
object (Delivery) Delivery configuration for a report. | |
description | string Report description to display in the Polaris UI, and in emails and webhooks. |
disabled | boolean Disables the report. Polaris doesn't evaluate disabled reports or send notifications. |
number or string Default: 500 Maximum number of rows to include in the report attachment. Defaults to | |
enforceDecimalFormatting | boolean Default: false Formats numeric values in the report attachment as decimals. |
object Visualization definition for classic data cubes. This is not applicable to Polaris. | |
object (ExploreEssence) State of a visualization in the Explore View | |
externalEmails | Array of strings <email> [ items <email > ] External email addresses to receive report notications. |
object (FacetEssence) State of a visualization in the Pivot 2 view | |
fileFormat | string Default: "csv" Enum: "csv" "tsv" "xlsx" "json" Format of the report data attachment. Defaults to |
id | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
owner | string (Identifier) [ 1 .. 255 ] characters Asset ID. |
preferredView | string Default: "pivot1" Enum: "pivot1" "pivot2" "explore" View to use when viewing the report in Polaris. Defaults to |
any (AccessList) Configure user access to the asset. | |
any (AccessList) Configure user access to the asset. | |
sendDataFile | boolean Default: true Sends the report data as an attachment. |
sendEmail | boolean Sends email notifications to the report recipients when the report is generated. |
object (TimeFrame) | |
timezone | string Default: "Etc/UTC" Timezone to use when evaluating report criteria. Defaults to |
title | string Report title to display in the Polaris UI, and in emails and webhooks. |
property name* additional property | any |
{- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}
{- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}
Deletes a report.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Report ID. |
"{\n \"error\": {\n \"code\": \"ObjectNotFound\",\n \"message\": \"The project was not found.\"\n }\n}"
Returns all evaluations for a specified report.
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Report ID. |
{- "values": [
- {
- "id": "wikipedia-1234",
- "report": {
- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": null,
- "elements": [ ]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}, - "sendDate": "2019-08-24T14:15:22Z",
- "errors": [
- {
- "type": "internal-error",
- "message": "string"
}
]
}
]
}
Returns information for a single report evaluation.
evaluationId required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Evaluation ID. |
id required | string (Identifier) [ 1 .. 255 ] characters Example: wikipedia-1234 Report ID. |
{- "id": "wikipedia-1234",
- "report": {
- "id": "wikipedia-1234",
- "creationDate": "2019-08-24T14:15:22Z",
- "owner": "wikipedia-1234",
- "title": "My report",
- "description": "string",
- "disabled": true,
- "delivery": {
- "frequencyType": "fixed",
- "frequency": "string",
- "dayType": "of-month",
- "day": 1,
- "time": 23
}, - "preferredView": "pivot1",
- "timeFrame": {
- "interval": "previous_day",
- "startDay": 0,
- "startTime": 0
}, - "essence": { },
- "facetEssence": {
- "dataCube": "wikipedia-1234",
- "instance": "string",
- "timezone": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}, - "axesSplits": [
- "string"
], - "visualization": "table",
- "visualizationOptions": {
- "property1": "string",
- "property2": "string"
}, - "selectedMeasures": [
- {
- "measure": "wikipedia-1234",
- "transform": "none",
- "within": {
- "start": 0,
- "end": 0,
- "bounds": "[)"
}, - "id": "wikipedia-1234"
}
], - "multiMeasureMode": "row",
- "compare": {
- "type": "time-relative",
- "duration": "string",
- "absoluteStartingDate": "2019-08-24T14:15:22Z",
- "dimension": "string",
- "measure": "string",
- "filter": {
- "clauses": [
- {
- "dimension": "string",
- "action": "overlap",
- "values": {
- "setType": "NULL",
- "elements": [
- null
]
}, - "search": "string",
- "exclude": true,
- "mvFilterOnly": true
}
], - "measureFilters": [
- {
- "measure": "string",
- "minOp": "greaterThan",
- "minValue": 0,
- "maxOp": "lessThan",
- "maxValue": 0,
- "exclude": true
}
]
}
}, - "pinnedDimensions": [
- "wikipedia-1234"
]
}, - "exploreEssence": {
- "parameters": { },
- "transferGroups": {
- "property1": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}, - "property2": {
- "type": "string",
- "control": {
- "transferGroup": "string"
}
}
}, - "dataCube": "wikipedia-1234",
- "moduleName": "overall",
- "where": "string",
- "having": "string",
- "timezone": "string",
- "instance": "string"
}, - "admins": {
- "access": "all"
}, - "readAccess": {
- "access": "all"
}, - "recipients": {
- "access": "all"
}, - "externalEmails": [
- "user@example.com"
], - "timezone": "America/Los_Angeles",
- "sendDataFile": true,
- "addTotalRowToFile": false,
- "fileFormat": "csv",
- "downloadLimit": 500,
- "enforceDecimalFormatting": false,
- "sendEmail": true
}, - "sendDate": "2019-08-24T14:15:22Z",
- "errors": [
- {
- "type": "internal-error",
- "message": "string"
}
]
}
Returns a list of all the API keys in redacted form.
{- "items": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Visualization key",
- "description": "Visualization team API key",
- "apiKey": "string",
- "redactedApiKey": "pok_YxNxd...2xixwf",
- "permissions": [
- "ManageDashboards",
- "ManageDataCubes"
], - "createdBy": {
- "username": "string",
- "userId": "string"
}, - "lastModifiedBy": {
- "username": "string",
- "userId": "string"
}, - "createdOn": "2021-06-06T00:00:00.000Z",
- "lastModifiedOn": "2021-06-06T00:00:00.000Z"
}
]
}
Creates an API key.
An API key request.
description | string A human-readable description provided by the user. |
name | string A human-readable name provided by the user. |
Array of PermissionRepresentation (object) or strings The list of permissions for the API key. |
{- "name": "Visualization key",
- "description": "Visualization team API key",
- "permissions": [
- "ManageDashboards",
- "ManageDataCubes"
]
}
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Visualization key",
- "description": "Visualization team API key",
- "apiKey": "string",
- "redactedApiKey": "pok_YxNxd...2xixwf",
- "permissions": [
- "ManageDashboards",
- "ManageDataCubes"
], - "createdBy": {
- "username": "string",
- "userId": "string"
}, - "lastModifiedBy": {
- "username": "string",
- "userId": "string"
}, - "createdOn": "2021-06-06T00:00:00.000Z",
- "lastModifiedOn": "2021-06-06T00:00:00.000Z"
}
Returns information for a single API key.
id required | string The API key ID. |
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Visualization key",
- "description": "Visualization team API key",
- "apiKey": "string",
- "redactedApiKey": "pok_YxNxd...2xixwf",
- "permissions": [
- "ManageDashboards",
- "ManageDataCubes"
], - "createdBy": {
- "username": "string",
- "userId": "string"
}, - "lastModifiedBy": {
- "username": "string",
- "userId": "string"
}, - "createdOn": "2021-06-06T00:00:00.000Z",
- "lastModifiedOn": "2021-06-06T00:00:00.000Z"
}
Updates an API key.
id required | string The API key ID. |
description | string A human-readable description provided by the user. |
name | string A human-readable name provided by the user. |
Array of PermissionRepresentation (object) or strings The list of permissions for the API key. |
{- "name": "Visualization key",
- "description": "Visualization team API key",
- "permissions": [
- "ManageDashboards",
- "ManageDataCubes"
]
}
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Visualization key",
- "description": "Visualization team API key",
- "apiKey": "string",
- "redactedApiKey": "pok_YxNxd...2xixwf",
- "permissions": [
- "ManageDashboards",
- "ManageDataCubes"
], - "createdBy": {
- "username": "string",
- "userId": "string"
}, - "lastModifiedBy": {
- "username": "string",
- "userId": "string"
}, - "createdOn": "2021-06-06T00:00:00.000Z",
- "lastModifiedOn": "2021-06-06T00:00:00.000Z"
}
Deletes an API key.
id required | string The API key ID. |
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
Returns information for the API key used to authenticate to the Polaris API.
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "permissions": [
- "ManageDashboards",
- "ManageDataCubes"
]
}
{- "values": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
]
}
Returns all users.
search | string Filter users by a given string. Supported fields for search are |
skip | integer >= 0 Default: 0 The number of user records to skip before returning |
top | integer [ 1 .. 100 ] Default: 100 The maximum number of records to return. |
{- "values": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "username": "user@email.com",
- "email": "user@email.com",
- "firstName": "string",
- "lastName": "string",
- "enabled": true,
- "emailVerified": false,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "groups": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Data Manager",
- "readOnly": true,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
], - "identities": [
- {
- "providerId": "string"
}
], - "actions": [
- "VERIFY_EMAIL"
], - "createdOn": "2021-06-06T00:00:00.000Z"
}
], - "count": 0
}
Creates a user.
A user to be created.
actions | Array of any Items Enum: "VERIFY_EMAIL" "UPDATE_PASSWORD" The list of tasks a user must complete before being able to login. |
enabled | boolean Default: true Flag to indicate the user is enabled. |
firstName | string The user's first name. |
Array of objects (GroupRepresentation) The list of groups the user belongs to. | |
lastName | string The user's last name. |
Array of objects (PermissionRepresentation) The list of permissions individually assigned to the user. | |
username | string The username for the user. The username must be a valid email address. Once set, |
{- "username": "user@email.com",
- "firstName": "string",
- "lastName": "string",
- "enabled": true,
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "groups": [
- {
- "name": "Data Manager",
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
], - "actions": [
- "VERIFY_EMAIL"
]
}
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "username": "user@email.com",
- "email": "user@email.com",
- "firstName": "string",
- "lastName": "string",
- "enabled": true,
- "emailVerified": false,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "groups": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Data Manager",
- "readOnly": true,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
], - "identities": [
- {
- "providerId": "string"
}
], - "actions": [
- "VERIFY_EMAIL"
], - "createdOn": "2021-06-06T00:00:00.000Z"
}
Returns information for a specific user.
id required | string The user ID. |
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "username": "user@email.com",
- "email": "user@email.com",
- "firstName": "string",
- "lastName": "string",
- "enabled": true,
- "emailVerified": false,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "groups": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Data Manager",
- "readOnly": true,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
], - "identities": [
- {
- "providerId": "string"
}
], - "actions": [
- "VERIFY_EMAIL"
], - "createdOn": "2021-06-06T00:00:00.000Z"
}
Updates a user.
id required | string The user ID. |
actions | Array of any Items Enum: "VERIFY_EMAIL" "UPDATE_PASSWORD" The list of tasks a user must complete before being able to login. |
enabled | boolean Default: true Flag to indicate the user is enabled. |
firstName | string The user's first name. |
Array of objects (GroupRepresentation) The list of groups the user belongs to. | |
lastName | string The user's last name. |
Array of objects (PermissionRepresentation) The list of permissions individually assigned to the user. | |
username | string The username for the user. The username must be a valid email address. Once set, |
{- "username": "user@email.com",
- "firstName": "string",
- "lastName": "string",
- "enabled": true,
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "groups": [
- {
- "name": "Data Manager",
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
], - "actions": [
- "VERIFY_EMAIL"
]
}
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "username": "user@email.com",
- "email": "user@email.com",
- "firstName": "string",
- "lastName": "string",
- "enabled": true,
- "emailVerified": false,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "groups": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Data Manager",
- "readOnly": true,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
], - "identities": [
- {
- "providerId": "string"
}
], - "actions": [
- "VERIFY_EMAIL"
], - "createdOn": "2021-06-06T00:00:00.000Z"
}
Returns all permissions applied to a user through group membership. For more information, see Permissions reference.
id required | string The user ID. |
{- "values": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
]
}
{- "values": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Data Manager",
- "readOnly": true,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
]
}
Creates a group.
A group to be created.
name | string The group name. |
Array of objects (PermissionRepresentation) The list of permissions assigned to the group. | |
userCount | integer The number of users assigned to this group. |
{- "name": "Data Manager",
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Data Manager",
- "readOnly": true,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
Returns information for a specific group.
id required | string The group ID. |
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Data Manager",
- "readOnly": true,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
Updates a group.
id required | string The group ID. |
name | string The group name. |
Array of objects (PermissionRepresentation) The list of permissions assigned to the group. | |
userCount | integer The number of users assigned to this group. |
{- "name": "Data Manager",
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
{- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Data Manager",
- "readOnly": true,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
Returns all members for a given group.
id required | string The group ID. |
search | string Filter users by a given string. Supported fields for search are |
skip | integer >= 0 Default: 0 The number of user records to skip before returning |
top | integer [ 1 .. 100 ] Default: 100 The maximum number of records to return. |
{- "values": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "username": "user@email.com",
- "email": "user@email.com",
- "firstName": "string",
- "lastName": "string",
- "enabled": true,
- "emailVerified": false,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "groups": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "Data Manager",
- "readOnly": true,
- "permissions": [
- {
- "id": "5xb1d143-f6x6-455x-x091-fbxa85xbx7x0",
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
], - "identities": [
- {
- "providerId": "string"
}
], - "actions": [
- "VERIFY_EMAIL"
], - "createdOn": "2021-06-06T00:00:00.000Z"
}
], - "count": 0
}
Adds users to the specified group.
id required | string The group ID. |
Users to be added to the specified group.
actions | Array of any Items Enum: "VERIFY_EMAIL" "UPDATE_PASSWORD" The list of tasks a user must complete before being able to login. |
enabled | boolean Default: true Flag to indicate the user is enabled. |
firstName | string The user's first name. |
Array of objects (GroupRepresentation) The list of groups the user belongs to. | |
lastName | string The user's last name. |
Array of objects (PermissionRepresentation) The list of permissions individually assigned to the user. | |
username | string The username for the user. The username must be a valid email address. Once set, |
[- {
- "username": "user@email.com",
- "firstName": "string",
- "lastName": "string",
- "enabled": true,
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "groups": [
- {
- "name": "Data Manager",
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
], - "actions": [
- "VERIFY_EMAIL"
]
}
]
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
Removes specific users from the group.
id required | string The group ID. |
Users to be removed from the group.
actions | Array of any Items Enum: "VERIFY_EMAIL" "UPDATE_PASSWORD" The list of tasks a user must complete before being able to login. |
enabled | boolean Default: true Flag to indicate the user is enabled. |
firstName | string The user's first name. |
Array of objects (GroupRepresentation) The list of groups the user belongs to. | |
lastName | string The user's last name. |
Array of objects (PermissionRepresentation) The list of permissions individually assigned to the user. | |
username | string The username for the user. The username must be a valid email address. Once set, |
[- {
- "username": "user@email.com",
- "firstName": "string",
- "lastName": "string",
- "enabled": true,
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "groups": [
- {
- "name": "Data Manager",
- "permissions": [
- {
- "name": "AdministerDataCubes",
- "description": "Permission to create, update, and delete data cubes.",
- "resources": "[\"projects/*\", \"projects/5xb1d143-f6x6-455x-x091-fbxa85xbx7x0\"]"
}
], - "userCount": 0
}
], - "actions": [
- "VERIFY_EMAIL"
]
}
]
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
Returns all audit logs for the organization.
from | string <date-time> Filter audit logs that happened after the specified date. |
ip | string <ipv4> Filter audit logs by the IP address. |
to | string <date-time> Filter audit logs that happened before the specified date. |
AuthorizedAuditEventType (string) or AnonymousAuditEventType (string) (AuditEventType) Filter audit logs by type. | |
user | string Filter audit logs by the user ID. |
{- "values": [
- {
- "time": "2019-08-24T14:15:22Z",
- "accountId": "123456-abcdefg",
- "ip": "10.0.0.123",
- "region": "us-east-1",
- "type": "LOGIN",
- "category": "ALL",
- "resource": "v1/groups/045ca0cf-0240-44e7-9c26-0ce7d8149658",
- "actorType": "apikey",
- "context": {
- "reason": "user_not_found",
- "by": "joe.admin@imply.io",
- "representation": {
- "id": "045ca0cf-0240-44e7-9c26-0ce7d8149658",
- "name": "new-group-name"
}, - "oldRepresentation": {
- "id": "045ca0cf-0240-44e7-9c26-0ce7d8149658",
- "name": "original-group-name"
}
}, - "actorName": "support@example.net",
- "actorId": "90626xx-1234-5678-9101-f35911d6xx20"
}
]
}
Returns metrics for your Polaris organization. Configure your monitoring tools to scrape this endpoint to collect performance metrics.
includeLegacyMetrics | boolean Set to true to include all types of legacy metrics in the response. |
# HELP query_count The number of sql queries run against the datasource # TYPE query_count gauge query_count{table="[daily-spend]",region="us-east-1",} 2.0 1678302900000 query_count{table="[demo]",region="us-east-1",} 13.0 1678302900000 query_count{table="[flight-test]",region="us-east-1",} 1.0 1678302900000 query_count{table="[fresh-wiki-2]",region="us-east-1",} 1.0 1678302900000 query_count{table="[wikiticker]",region="us-east-1",} 1.0 1678302900000
Returns all projects.
To get all projects for the organization,
use the global base URL https://ORGANIZATION_NAME.api.imply.io
.
To get all projects in a specified region of the organization,
use the regional base URL
https://ORGANIZATION_NAME.REGION.CLOUD_PROVIDER.api.imply.io
.
[- {
- "metadata": {
- "uid": "e698dae6-fddc-40e0-b76f-xxxxxxxxxxxx",
- "name": "demo",
- "createdOnTimestamp": "2019-08-24T14:15:22Z"
}, - "spec": {
- "plan": "a.02",
- "desiredState": "running",
- "deletionProtection": false,
- "region": "us-east-1"
}, - "status": {
- "maxBytes": 200000000000,
- "currentBytes": 98201000,
- "state": "running",
- "version": "c47f5b18"
}
}
]
Creates a project in a specified region.
Configuration of the project to be created.
required | object (ObjectMeta) Metadata to identify the Polaris project. |
required | object (ProjectSpec) Information about the size and desired state of the project. |
{- "metadata": {
- "name": "demo"
}, - "spec": {
- "plan": "a.02",
- "desiredState": "running",
- "deletionProtection": false,
- "region": "us-east-1"
}
}
{- "metadata": {
- "uid": "e698dae6-fddc-40e0-b76f-xxxxxxxxxxxx",
- "name": "demo",
- "createdOnTimestamp": "2019-08-24T14:15:22Z"
}, - "spec": {
- "plan": "a.02",
- "desiredState": "running",
- "deletionProtection": false,
- "region": "us-east-1"
}, - "status": {
- "maxBytes": 200000000000,
- "currentBytes": 98201000,
- "state": "running",
- "version": "c47f5b18"
}
}
Returns information for a single project.
id required | string The ID of a Polaris project. |
{- "metadata": {
- "uid": "e698dae6-fddc-40e0-b76f-xxxxxxxxxxxx",
- "name": "demo",
- "createdOnTimestamp": "2019-08-24T14:15:22Z"
}, - "spec": {
- "plan": "a.02",
- "desiredState": "running",
- "deletionProtection": false,
- "region": "us-east-1"
}, - "status": {
- "maxBytes": 200000000000,
- "currentBytes": 98201000,
- "state": "running",
- "version": "c47f5b18"
}
}
Updates a project to a different size or state. See Update a project for more information.
id required | string The ID of a Polaris project. |
The project plan configuration to be updated to.
required | object (ObjectMeta) Metadata to identify the Polaris project. |
required | object (ProjectSpec) Information about the size and desired state of the project. |
{- "metadata": {
- "name": "demo"
}, - "spec": {
- "plan": "a.02",
- "desiredState": "running",
- "deletionProtection": false,
- "region": "us-east-1"
}
}
{- "metadata": {
- "uid": "e698dae6-fddc-40e0-b76f-xxxxxxxxxxxx",
- "name": "demo",
- "createdOnTimestamp": "2019-08-24T14:15:22Z"
}, - "spec": {
- "plan": "a.02",
- "desiredState": "running",
- "deletionProtection": false,
- "region": "us-east-1"
}, - "status": {
- "maxBytes": 200000000000,
- "currentBytes": 98201000,
- "state": "running",
- "version": "c47f5b18"
}
}
Deletes a project.
id required | string The ID of a Polaris project. |
"{\n \"error\": {\n \"code\": \"InvalidAuthentication\",\n \"message\": \"The provided authorization is invalid.\"\n }\n}"
The Project API has been deprecated in favor of the Projects API. For information about how to adopt the new API, see Migration guide for deprecated APIs.
View and manage your Polaris project plan.
Returns all supported Polaris project sizes for your organization. For more information about project sizes, see Billing structure.
[- {
- "name": "a.02",
- "maxBytes": 200000000000,
- "memory": "16GB",
- "cpu": 24
}
]
Returns information about the current project.
{- "metadata": {
- "uid": "e698dae6-fddc-40e0-b76f-xxxxxxxxxxxx",
- "name": "demo",
- "createdOnTimestamp": "2019-08-24T14:15:22Z"
}, - "spec": {
- "plan": "a.02",
- "desiredState": "running",
- "deletionProtection": false,
- "region": "us-east-1"
}, - "status": {
- "maxBytes": 200000000000,
- "currentBytes": 98201000,
- "state": "running",
- "version": "c47f5b18"
}
}
Updates a project to a different size or state. See Update a project for more information.
The project plan configuration to be updated to.
required | object (ObjectMeta) Metadata to identify the Polaris project. |
required | object (ProjectSpec) Information about the size and desired state of the project. |
{- "metadata": {
- "name": "demo"
}, - "spec": {
- "plan": "a.02",
- "desiredState": "running",
- "deletionProtection": false,
- "region": "us-east-1"
}
}
{- "metadata": {
- "uid": "e698dae6-fddc-40e0-b76f-xxxxxxxxxxxx",
- "name": "demo",
- "createdOnTimestamp": "2019-08-24T14:15:22Z"
}, - "spec": {
- "plan": "a.02",
- "desiredState": "running",
- "deletionProtection": false,
- "region": "us-east-1"
}, - "status": {
- "maxBytes": 200000000000,
- "currentBytes": 98201000,
- "state": "running",
- "version": "c47f5b18"
}
}