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 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 cloud and region where Polaris hosts your project. You must specify the project's cloud provider and region to call a regional resource. For more information, see Cloud providers and regions.
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
: Custom domain through which you access Polaris.REGION
: Cloud region of your Polaris project.CLOUD_PROVIDER
: Cloud provider for your Polaris project.PROJECT_ID
: 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.
container required | string Name of the container in the specified storage account in Azure Blob Storage. |
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:
|
storageAccount required | string Name of the storage account in Azure Blob Storage. |
type required | string (ConnectionTypePayload) Connection type. For reference on the information required for each connection type, see Create a connection. |
description | string (ConnectionDescriptionPayload) Optional description for the connection. |
prefix | string Prefix to restrict the connection to specific blobs. |
{- "name": "example-connection",
- "type": "azure",
- "description": "string",
- "storageAccount": "my-account",
- "container": "demo-container",
- "prefix": "project/files/",
- "secrets": {
- "type": "access_key"
}
}
{- "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",
- "storageAccount": "my-account",
- "container": "demo-container",
- "prefix": "project/files/",
- "secrets": {
- "type": "access_key"
}
}
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": "azure",
- "description": "string",
- "storageAccount": "my-account",
- "container": "demo-container",
- "prefix": "project/files/",
- "secrets": {
- "type": "access_key"
}
}
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) Connection type. For reference on the information required for each connection type, see Create a connection. |
container | string Name of the container in the specified storage account in Azure Blob Storage. |
description | string (ConnectionDescriptionPayload) Optional description for the connection. |
prefix | string Prefix to restrict the connection to specific blobs. |
object (ConnectionSecretsOptionalPayload) Type of connection secrets. The following secrets types are supported:
| |
storageAccount | string Name of the storage account in Azure Blob Storage. |
{- "type": "azure",
- "description": "string",
- "storageAccount": "my-account",
- "container": "demo-container",
- "prefix": "project/files/",
- "secrets": {
- "type": "access_key"
}
}
{- "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",
- "storageAccount": "my-account",
- "container": "demo-container",
- "prefix": "project/files/",
- "secrets": {
- "type": "access_key"
}
}
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. |
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
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. |
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
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" "kinesis" "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. |
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
Create and manage lookups for Imply Polaris. See Lookups for more details about lookups and how to manage lookups in the Polaris UI.
Returns all lookups in a specified project.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Project ID. |
{- "values": [
- {
- "name": "my-lookup-name",
- "source": {
- "type": "table",
- "tableName": "my-lookup-table"
}
}
]
}
Creates a lookup in a specified project.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Project ID. |
A lookup to be created.
name required | string Unique name of the lookup. |
required | object (LookupSourcePayload) The source of a lookup. The following lookup type is supported:
|
{- "name": "my-lookup-name",
- "source": {
- "type": "table",
- "tableName": "my-lookup-table"
}
}
{- "name": "my-lookup-name",
- "source": {
- "type": "table",
- "tableName": "my-lookup-table"
}
}
Returns details for a specified lookup.
lookupName required | string The name of a lookup. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Project ID. |
{- "name": "my-lookup-name",
- "source": {
- "type": "table",
- "tableName": "my-lookup-table"
}
}
Updates the details of a specified lookup.
lookupName required | string The name of a lookup. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Project ID. |
The updated lookup request.
required | object (LookupSourcePayload) The source of a lookup. The following lookup type is supported:
|
{- "source": {
- "type": "table",
- "tableName": "another-lookup-table"
}
}
{- "name": "my-lookup-name",
- "source": {
- "type": "table",
- "tableName": "my-lookup-table"
}
}
Deletes a lookup in a specified project.
lookupName required | string The name of a lookup. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Project ID. |
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
Returns all aliases for a specified lookup.
lookupName required | string The name of a lookup. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Project ID. |
{- "values": [
- {
- "key": "vid",
- "name": "vehicles",
- "value": "make"
}
]
}
Create or update the aliases for a specified lookup. You must provide the details of all aliases you want to retain for the lookup, even if you don't want to update them. Polaris recreates the lookup's aliases with the details you specify in the request. Polaris creates a new alias if the supplied alias name doesn't exist.
lookupName required | string The name of a lookup. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Project ID. |
A lookup alias to be created or updated.
required | Array of objects (LookupAliasPayload) |
{- "values": [
- {
- "key": "vid",
- "name": "vehicles",
- "value": "make"
}
]
}
{- "values": [
- {
- "key": "vid",
- "name": "vehicles",
- "value": "make"
}
]
}
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" "suspended" "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" "restore_data" "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:
You can't drop a table that's used as a lookup source. For information about ingestion jobs, see Create an ingestion job and Ingest using SQL. |
clusteringColumns | Array of strings (ClusteringColumns) Optional columns to use for clustering. If specified, will take precedence over clustering columns defined on a table. Polaris sorts columns within a partition based on their order in this array. For jobs targeting aggregate tables, only dimensions (not measures) are supported for clustering. For more information, see Clustering. |
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. |
filterExpression | string SQL expression to use for filtering the source data. For more information, see Filter data to ingest. |
ingestionMode | string (IngestionModeV2) Default: "append" Enum: "append" "replace" Mode of ingestion:
|
Array of objects (InputToTableSchemaMappingsV2) Default: [] 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. |
partitionedBy | string (PartitioningGranularity) Enum: "second" "minute" "five_minute" "ten_minute" "fifteen_minute" "thirty_minute" "hour" "six_hour" "eight_hour" "day" "month" "quarter" "year" "all" Optional time partitioning. If specified, takes precedence over the time partitioning defined on the target table. If unspecified, defaults to the time partitioning of the table. When ingesting into a lookup table, you can only set |
replaceAll | boolean Default: false Replace all data with this job. Don't set this to true when the job's ingestion mode is |
{- "type": "batch",
- "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": { },
- "clusteringColumns": [
- "example-column"
], - "createTableIfNotExists": false,
- "filterExpression": "\"dimension\" > 0",
- "ingestionMode": "append",
- "mappings": [
- {
- "columnName": "__time",
- "expression": "TIME_PARSE(CONCAT(\"date\", 'T', \"time\"))"
}, - {
- "columnName": "Restaurant",
- "expression": "\"restaurant\""
}, - {
- "columnName": "Rating",
- "expression": "MAX(\"rating\")",
- "isAggregation": true
}
], - "maxParseExceptions": 2147483647,
- "partitionedBy": "day",
- "replaceAll": false
}
{- "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"
}, - "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": "__time",
- "expression": "TIME_PARSE(CONCAT(\"date\", 'T', \"time\"))"
}, - {
- "columnName": "Restaurant",
- "expression": "\"restaurant\""
}, - {
- "columnName": "Rating",
- "expression": "MAX(\"rating\")",
- "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"
}, - "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": "__time",
- "expression": "TIME_PARSE(CONCAT(\"date\", 'T', \"time\"))"
}, - {
- "columnName": "Restaurant",
- "expression": "\"restaurant\""
}, - {
- "columnName": "Rating",
- "expression": "MAX(\"rating\")",
- "isAggregation": true
}
], - "maxParseExceptions": 2147483647,
- "query": "string"
}
Updates the execution status of a job.
Although you can continue to use this PUT request to update a job's status, it's recommended to use the POST request to the job status endpoint.
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" "suspended" 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"
}, - "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": "__time",
- "expression": "TIME_PARSE(CONCAT(\"date\", 'T', \"time\"))"
}, - {
- "columnName": "Restaurant",
- "expression": "\"restaurant\""
}, - {
- "columnName": "Rating",
- "expression": "MAX(\"rating\")",
- "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.1
}
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. |
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}
Returns the execution status for a job.
jobId required | string <uuid> (JobIdPayload) Server-generated job ID. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The project ID where the tables belong. |
{- "executionStatus": "pending"
}
Updates the execution status of a job.
Use this request to cancel any ingestion job in progress or to suspend and resume a streaming ingestion job.
You can't update data deletion jobs.
Prefer this method over Updating a job.
jobId required | string <uuid> (JobIdPayload) Server-generated job ID. |
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The project ID where the tables belong. |
A request to update the job's execution status.
desiredExecutionStatus required | string (DesiredJobExecutionStatusV2) Default: "running" Enum: "running" "canceled" "suspended" 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"
}
{- "executionStatus": "pending"
}
Submit and manage queries.
The Query API has resources to perform synchronous or asynchronous queries. Synchronous (sync) queries are short running (highly concurrent) and low latency. Asynchronous (async) queries are long running, high latency, and high throughput.
Sync queries target precached data including real-time streaming data.
Async queries target all data, including any data only in deep storage.
Data only in deep storage is offloaded from precache due to one or more cached
storage policies.
To add or update a storage policy on a table, see storagePolicy
in
Update a table.
You can query data that's already ingested into Imply Polaris. You can't use the Query API for ingesting data. To ingest data, see Create a job.
For a guide on querying data, see Query data by API.
Polaris projects created after July 1, 2024 have the async query feature enabled by default. If your project was created before July 1, 2024, contact your Polaris support representative to enable the feature.
Submits a SQL query against precached data including real-time streaming data. Returns a JSON object with the query results.
This request does not query data that’s offloaded from precache and only in deep storage. Polaris directly returns query results in the HTTP response body.
projectId required | string (ProjectId1) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project of the table being queried. |
The SQL query and additional properties to control query execution and result format.
query required | string The SQL query. |
object JSON object containing optional SQL query context parameters, such as to set the query ID, time zone, and whether to use an approximation algorithm for distinct count. For supported parameters, see Druid SQL query context. | |
header | boolean Default: false Boolean value that determines whether to return information on column names. When set to |
parameters | Array of objects List of Druid SQL query parameters for parameterized queries. Each parameter in the array should be a JSON object containing the parameter's SQL data type and parameter value. For example, the following query
returns results with timestamps later than
|
resultFormat | string (ResultFormat) Default: "object" Enum: "object" "array" "objectLines" "arrayLines" "csv" String that indicates the format to return query results. Select one of the following formats:
|
sqlTypesHeader | boolean Default: false Adds SQL type information in the header. Requires
|
typesHeader | boolean Default: false Adds runtime type information in the header. Requires |
{- "query": "SELECT \"__time\", \"val\" FROM \"polaris_table\" WHERE \"foo\" = 'bar'",
- "resultFormat": "array",
- "header": false,
- "typesHeader": false,
- "sqlTypesHeader": false,
- "context": {
- "sqlTimeZone": "America/Los_Angeles"
}, - "parameters": [
- {
- "type": "TIMESTAMP",
- "value": "2019-08-21 00:00:00"
}
]
}
[- [
- {
- "__time": "2023-11-16T18:00:38.624Z",
- "val": "abc"
}
]
]
Submits a SQL query against real-time data as well as data in deep storage.
Queries precached data as well as data offloaded from precache. The response body doesn't return query results. To get query results, see Get results for an async query.
projectId required | string (ProjectId1) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project of the table being queried. |
The SQL query and additional properties to control query execution and result format.
query required | string The SQL query. |
object JSON object containing optional SQL query context parameters, such as to set the query ID, time zone, and whether to use an approximation algorithm for distinct count. For supported parameters, see Druid SQL query context. | |
header | boolean Default: false Boolean value that determines whether to return information on column names. When set to |
parameters | Array of objects List of Druid SQL query parameters for parameterized queries. Each parameter in the array should be a JSON object containing the parameter's SQL data type and parameter value. For example, the following query
returns results with timestamps later than
|
resultFormat | string (ResultFormat) Default: "object" Enum: "object" "array" "objectLines" "arrayLines" "csv" String that indicates the format to return query results. Select one of the following formats:
|
sqlTypesHeader | boolean Default: false Adds SQL type information in the header. Requires
|
typesHeader | boolean Default: false Adds runtime type information in the header. Requires |
{- "query": "SELECT \"__time\", \"val\" FROM \"polaris_table\" WHERE \"foo\" = 'bar'",
- "resultFormat": "array",
- "header": false,
- "typesHeader": false,
- "sqlTypesHeader": false,
- "context": {
- "sqlTimeZone": "America/Los_Angeles"
}, - "parameters": [
- {
- "type": "TIMESTAMP",
- "value": "2019-08-21 00:00:00"
}
]
}
{- "queryId": "string",
- "state": "ACCEPTED",
- "createdAt": "2021-06-06T00:00:00.000Z",
- "schema": [
- {
- "name": "continent",
- "type": "VARCHAR",
- "nativeType": "STRING"
}, - {
- "name": "country_count",
- "type": "BIGINT",
- "nativeType": "LONG"
}
], - "durationMs": 36000,
- "result": {
- "numTotalRows": 7,
- "totalSizeInBytes": 279,
- "dataSource": "__query_select",
- "sampleRecords": [ ],
- "pages": [
- {
- "id": 0,
- "numRows": 7,
- "sizeInBytes": 279
}
]
}, - "stages": { },
- "counters": { },
- "warnings": { }
}
Retrieves results for a completed query.
This request doesn’t return results when the async query performs an ingestion job, that is, a query starting with INSERT or REPLACE. To get the status of the ingestion job, see Get job execution status.
Results are separated into pages, so you can use the optional page
parameter to refine the results you get.
Polaris returns information about the composition of each page and its page number (id
).
For information about pages, see Get status of an async query. If you don't specify a page number, the API returns all results sequentially in the same response.
projectId required | string (ProjectId1) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project of the table being queried. |
queryId required | string (QueryId) Example: query-94f176eb-3cc8-489e-919e-1135802b8c55 The server-generated ID of the query. |
id | string (ResultFormat) Default: "object" Enum: "object" "array" "objectLines" "arrayLines" "csv" Example: id=array Defines the format in which the results are presented. |
page | integer Fetch results based on page numbers. If not specified, all results are returned sequentially starting from page 0 to N in the same response. |
[- [
- {
- "__time": "2023-11-16T18:00:38.624Z",
- "val": "abc"
}
]
]
Retrieves information about the query associated with the given query ID.
The response matches the response from submitting an async query if the query is accepted or running.
projectId required | string (ProjectId1) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project of the table being queried. |
queryId required | string (QueryId) Example: query-94f176eb-3cc8-489e-919e-1135802b8c55 The server-generated ID of the query. |
detail | boolean Default: false Fetch additional details about the query, which includes the information about different stages, counters for each stage, and any warnings. |
{- "queryId": "string",
- "state": "ACCEPTED",
- "createdAt": "2021-06-06T00:00:00.000Z",
- "schema": [
- {
- "name": "continent",
- "type": "VARCHAR",
- "nativeType": "STRING"
}, - {
- "name": "country_count",
- "type": "BIGINT",
- "nativeType": "LONG"
}
], - "durationMs": 36000,
- "result": {
- "numTotalRows": 7,
- "totalSizeInBytes": 279,
- "dataSource": "__query_select",
- "sampleRecords": [ ],
- "pages": [
- {
- "id": 0,
- "numRows": 7,
- "sizeInBytes": 279
}
]
}, - "stages": { },
- "counters": { },
- "warnings": { }
}
Cancels a running or accepted async query.
projectId required | string (ProjectId1) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 Identifies the project of the table being queried. |
queryId required | string (QueryId) Example: query-94f176eb-3cc8-489e-919e-1135802b8c55 The server-generated ID of the query. |
{- "error": "string",
- "errorCode": "string",
- "persona": "string",
- "category": "DEFENSIVE",
- "errorMessage": "string",
- "context": { }
}
Returns all available tables for a project.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The ID of the current project. |
partitioningGranularity | string Default: "day" Enum: "second" "minute" "five_minute" "ten_minute" "fifteen_minute" "thirty_minute" "hour" "six_hour" "eight_hour" "day" "week" "month" "quarter" "year" "all" Example: partitioningGranularity=day Filters results by the partitioning granularity specified. |
segmentCount | integer <int64> >= 0 Filters results by the number of segments specified. |
{- "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",
- "segmentCount": 0,
- "storagePolicy": {
- "cached": {
- "type": "intervals"
}, - "retain": {
- "type": "intervals"
}
}, - "precachedDataSizeBytes": 12345678,
- "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 The ID of the current project. |
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 (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) Default: [] 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 precache.
By default, Polaris retains all data and precaches all data. You can’t set a custom storage policy for a table that’s actively used by a lookup. For more information, see Data lifecycle management. | |
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": "intervals"
}, - "retain": {
- "type": "intervals"
}
}, - "schemaMode": "flexible",
- "queryGranularity": {
- "type": "simple"
}, - "schema": [ ],
- "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": [ ],
- "storagePolicy": {
- "cached": {
- "type": "intervals"
}, - "retain": {
- "type": "intervals"
}
}, - "schemaMode": "flexible",
- "segmentCompactedBytes": 12345678,
- "segmentCount": 0,
- "segmentTotalBytes": 12345678,
- "precachedDataSizeBytes": 12345678,
- "totalDataSizeBytes": 12345678,
- "totalRows": 1234,
- "queryGranularity": {
- "type": "simple"
}, - "schema": [ ],
- "timeResolution": "millisecond"
}
Returns information for a single table.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The ID of the current project. |
tableName 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": [ ],
- "storagePolicy": {
- "cached": {
- "type": "intervals"
}, - "retain": {
- "type": "intervals"
}
}, - "schemaMode": "flexible",
- "segmentCompactedBytes": 12345678,
- "segmentCount": 0,
- "segmentTotalBytes": 12345678,
- "precachedDataSizeBytes": 12345678,
- "totalDataSizeBytes": 12345678,
- "totalRows": 1234,
- "queryGranularity": {
- "type": "simple"
}, - "schema": [ ],
- "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 The ID of the current project. |
tableName 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 (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) Default: [] 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 precache.
By default, Polaris retains all data and precaches all data. You can’t set a custom storage policy for a table that’s actively used by a lookup. For more information, see Data lifecycle management. | |
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": "intervals"
}, - "retain": {
- "type": "intervals"
}
}, - "schemaMode": "flexible",
- "queryGranularity": {
- "type": "simple"
}, - "schema": [ ],
- "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": [ ],
- "storagePolicy": {
- "cached": {
- "type": "intervals"
}, - "retain": {
- "type": "intervals"
}
}, - "schemaMode": "flexible",
- "segmentCompactedBytes": 12345678,
- "segmentCount": 0,
- "segmentTotalBytes": 12345678,
- "precachedDataSizeBytes": 12345678,
- "totalDataSizeBytes": 12345678,
- "totalRows": 1234,
- "queryGranularity": {
- "type": "simple"
}, - "schema": [ ],
- "timeResolution": "millisecond"
}
Returns list of unused segments for the specified table matching query parameters given.
projectId required | string (ProjectId) Example: efebfbc4-79fe-41f8-beb9-b399c1584e28 The ID of the current project. |
tableName required | string (TableName) [ 1 .. 255 ] characters Example: example-table Name of the table for which to get information. |
interval | string Filters results for unused segments by the time interval specified. |
lastSegmentId | string (SegmentId) Example: lastSegmentId=Example_Table_2023-01-01T00:00:00.000Z_2023-01-02T00:00:00.000Z_2023-10-01T00:00:00.000Z The segmentId to use as a marker from which to search. If |
limit | integer Default: 100 The maximum number of segments to return in the response. |
sortOrder | string (SortOrder) Default: "DESC" Enum: "ASC" "DESC" Example: sortOrder=ASC The order with which the resulting segments should be sorted with respect to their |
{- "values": [
- {
- "createdOnTimestamp": "2019-08-24T14:15:22Z",
- "lastUpdatedOnTimestamp": "2019-08-24T14:15:22Z",
- "id": "Example_Table_2023-01-01T00:00:00.000Z_2023-01-02T00:00:00.000Z_2023-10-01T00:00:00.000Z",
- "interval": "2023-01-01T00:00:00.000Z/2023-01-02T00:00:00.000Z",
- "partitionNumber": 1,
- "sizeBytes": 12345678,
- "tableName": "example-table",
- "version": "2023-10-01T00:00:00.000Z"
}
]
}
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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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"
], - "exampleQuery": "string"
}
]
}
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. |
dateTimeToStart | string Date and time to start triggering alerts. The timezone is UTC. |
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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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"
], - "exampleQuery": "string"
}
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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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"
], - "exampleQuery": "string"
}
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. |
dateTimeToStart | string Date and time to start triggering alerts. The timezone is UTC. |
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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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"
], - "exampleQuery": "string"
}
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. |
dateTimeToStart | string Date and time to start triggering alerts. The timezone is UTC. |
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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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"
], - "exampleQuery": "string"
}
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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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"
], - "exampleQuery": "string"
}, - "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",
- "dateTimeToStart": "2025-02-01T10:30:00.000Z",
- "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"
], - "exampleQuery": "string"
}, - "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"
}
Deletes a single collection in a specified project.
id required | integer (CollectionId) Collection ID. |
projectId required | string Project ID. |
{- "code": "string",
- "message": "string",
- "target": "string",
- "details": [
- { }
], - "innererror": {
- "code": "string",
- "message": "string"
}
}