Skip to main content
Imply Polaris logo
  • Category: analytics
  • Auth: API_KEY, S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 108
  • Triggers: 0
  • Slug: IMPLY_POLARIS
  • Version: 20261101_00

Tools

Slug: IMPLY_POLARIS_CANCEL_ASYNC_SQL_QUERYCancel an async query in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The server-generated ID of the query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CANCEL_JOBIrreversibly cancel a Polaris ingestion job. A canceled job cannot be resumed.

Input Parameters

string
required
Server-generated job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_ALERTCreate an alert in the project configured on the connected Imply Polaris account.

Input Parameters

object
required
Alert configuration using the provider’s native nested field names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_CONNECTIONCreate an Azure, Confluent, Schema Registry, Kafka, Kinesis, push-streaming, or S3 connection in the project configured on the connected Imply Polaris account.

Input Parameters

object
Optional Kafka SSL authentication and encryption settings.
string
required
Unique connection name using letters, numbers, periods, underscores, or hyphens.
string ("azure" | "confluent" | "confluent_schema_registry" | "kafka" | "kinesis" | "push_streaming" | "s3")
required
Type in the connection request.
array
Schema Registry URLs for confluent_schema_registry.
string
S3 bucket name. Required for s3.
string
Optional Azure blob or S3 object-key prefix.
string
Kinesis stream name. Required for kinesis.
string
Connection credentials. Required for azure, confluent, Schema Registry, and kafka; optional for s3.
string
Azure container name. Required for azure.
string
Kafka topic name or pattern. Required for kafka and confluent.
string
Optional physical rack identifier for a Kafka client.
string
AWS service endpoint. Required for kinesis and s3.
string
Description in the connection request.
string
Azure Blob Storage account name. Required for azure.
string
Kafka broker host and port pairs. Required for kafka and confluent.
string
AWS IAM role ARN. Required for kinesis and optional for s3.
boolean
Whether topicName is a regular expression.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_DASHBOARDCreate a dashboard in the project configured on the connected Imply Polaris account.

Input Parameters

object
required
Documented dashboard request body. Preserve provider-native nested keys and validate against the operation schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_DASHBOARD_PAGECreate a dashboard page in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string
Label in the dashboard request.
array
Initial tile definitions. Each item requires type (blank, visualization, or markdown) and may include id, title, position, content, or the provider-native visualization essence.
string
Optional ID for the new dashboard page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_DASHBOARD_PAGE_TILECreate a blank, Markdown, or data-cube visualization tile on a dashboard page.

Input Parameters

string
required
Dashboard ID.
string
required
Blank, Markdown, or visualization tile definition.
string
required
Page ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_DATA_CUBECreate a data cube in the project configured on the connected Imply Polaris account.

Input Parameters

object
required
Documented data cube request body. Preserve provider-native nested keys and validate against the operation schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_DATA_CUBE_DIMENSIONCreate a data cube dimension in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
boolean
Geo in the data cube request.
string
Url in the data cube request.
string ("TIME" | "STRING" | "SET/STRING" | "NUMBER" | "BOOLEAN" | "IP" | "TIME_SERIES")
Type in the data cube request.
string
Group in the data cube request.
integer
Array order of the new dimension
string
Title in the data cube request.
string
Format in the data cube request.
string
Formula in the data cube request.
boolean
Ip Prefix in the data cube request.
string
Description in the data cube request.
string
Optional ID for the new dimension.
string ("ISO 3166-1 Alpha-2" | "ISO 3166-1 Alpha-3" | "ISO 3166-2" | "UN M49" | "Geohash" | "lng-coordinate" | "lat-coordinate")
Geo Encoding in the data cube request.
array
Time granularity definitions available for this dimension, using provider-native granularity names and durations.
string ("defaultBucket" | "defaultNoBucket" | "neverBucket" | "alwaysBucket")
Bucketing Strategy in the data cube request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_DATA_CUBE_MEASURECreate a data cube measure in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
string
Group in the data cube request.
integer
Array order of the new measure
string
Title in the data cube request.
string
Units in the data cube request.
string
Formula in the data cube request.
string ("none" | "percent-of-parent" | "percent-of-root")
Transform in the data cube request.
string
Optional ID for the new measure.
string
Description in the data cube request.
object
Number formatting with provider-native notation, precision, and affix keys.
string ("pin-zero" | "unpinned")
Scale Behavior in the data cube request.
object
Comparison color mapping for positive, negative, and neutral values.
string ("zero" | "none" | "previous" | "interpolate")
Missing Value Fill in the data cube request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_JOBCreate a job in the project configured on the connected Imply Polaris account.

Input Parameters

string ("batch" | "delete_data" | "drop_table" | "restore_data" | "streaming" | "sql")
required
Job type.
string
SQL ingestion statement. Required when type is sql.
object
Job input source. Its keys depend on the job type, such as an uploaded file list, connection, table, or SQL source.
object
Job output target, typically containing type=table and tableName; replacement targets may also include intervals.
object
Optional SQL ingestion context parameters.
string
Single ISO 8601 interval to restore. Required when type is restore_data.
array
Input-to-table mappings. Each item requires columnName and expression and may set isAggregation.
boolean
Delete all rows without specifying target intervals.
array
Positional parameters referenced by the SQL query.
boolean
Replace all target data. Use only with replacement ingestion and no target intervals.
boolean
Retain deleted data for the provider’s restoration grace period.
string ("append" | "replace")
Append new data or replace matching target intervals.
string ("second" | "minute" | "five_minute" | "ten_minute" | "fifteen_minute" | "thirty_minute" | "hour" | "six_hour" | "eight_hour" | "day" | "month" | "quarter" | "year" | "all")
Time partitioning granularity for the ingestion job.
string
SQL expression used to filter source rows.
array
Columns used to cluster data within each partition.
integer
Maximum tolerated parse exceptions.
boolean
Create the target table when it does not exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_LOOKUPCreate a lookup from an existing table in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Name in the lookup request.
object
required
Existing Polaris table used by the lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_PROJECTCreate a project through the connected Imply Polaris regional API.

Input Parameters

object
required
Project plan, lifecycle state, protections, and region.
object
required
Project identity metadata containing the required project name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_REPORTCreate a report in the project configured on the connected Imply Polaris account.

Input Parameters

object
required
Complete Reports v1 body. Required: creationDate and owner. Example: {creationDate: 2019-08-24T14:15:22Z, owner: user-id, title: Daily report, delivery: {frequency: P1D, day: 1}, timeFrame: {interval: previous_day, startDay: 0, startTime: 0}, exploreEssence: {parameters: {}, transferGroups: {}, dataCube: cube-id, moduleName: overall, where: TRUE}}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_CREATE_TABLECreate a table in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Unique table name.
string ("detail" | "aggregate")
required
Detail tables store individual rows; aggregate tables roll up measures.
string
Description in the table request.
string ("flexible" | "strict")
Schema Mode in the table request.
array
Table columns. Each item defines a column name and data type, plus provider-supported column properties.
object
Storage policy using provider-native retention and tiering keys for table data.
string ("millisecond" | "second" | "minute" | "fifteen_minute" | "thirty_minute" | "hour" | "day" | "week" | "month" | "quarter" | "year" | "all")
Resolution used to store and query the primary time column.
object
Rollup query granularity object, such as {type: simple}; period granularities may also set duration, timeZone, and origin.
array
Columns used for sorting within each partition, in priority order. Aggregate tables may use dimensions only.
string ("second" | "minute" | "five_minute" | "ten_minute" | "fifteen_minute" | "thirty_minute" | "hour" | "six_hour" | "eight_hour" | "day" | "week" | "month" | "quarter" | "year" | "all")
Partitioning Granularity in the table request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_ALERTDelete an alert in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Alert ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_CONNECTIONDelete a connection in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The name the connection to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_DASHBOARDDelete a dashboard in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_DASHBOARD_PAGEDelete a page in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string
required
Page ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_DASHBOARD_PAGE_TILEDelete a tile in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string
required
Page ID.
string
required
Tile ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_DATA_CUBEDelete a data cube in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_DATA_CUBE_DIMENSIONDelete a dimension in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
string
required
Dimension identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_DATA_CUBE_MEASUREDelete a measure in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
string
required
Measure identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_FILEDelete a file in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Name of the file (may contain slashes)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_LOOKUPDelete a lookup in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The name of a lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_PROJECTDelete a project through the connected Imply Polaris regional API.

Input Parameters

string
required
ID of the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_DELETE_REPORTDelete a report in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Report ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_ALERTGet alert details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Alert ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_ALERT_EVALUATIONGet alert evaluation details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Alert ID.
string
required
Evaluation ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_ASYNC_SQL_RESULTSGet one result page for an async query, or omit cursor to return all pages sequentially.

Input Parameters

string
Zero-based page ID listed by GET_ASYNC_SQL_STATUS. Omit to return all pages sequentially.
string
Optional download filename, at most 255 characters. It cannot contain /, \, :, *, ?, ", <, >, &#124;, null, or newline characters.
string
required
The server-generated ID of the query.
string ("object" | "array" | "objectLines" | "arrayLines" | "csv")
Defines the format in which the results are presented.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_ASYNC_SQL_STATUSGet status of an async query in the project configured on the connected Imply Polaris account.

Input Parameters

boolean
Fetch additional details about the query, which includes the information about different stages, counters for each stage, and any warnings.
string
required
The server-generated ID of the query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_CONNECTIONGet connection details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The name of the connection to get.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_CONNECTION_METADATAGet project-level connection metadata: the external ID and Imply AWS IAM role ARN used when granting Polaris access to AWS resources. Unlike GET_CONNECTION, this parameterless action does not return one named connection’s configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_DASHBOARDGet dashboard details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_DASHBOARD_PAGEGet page details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string
required
Page ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_DASHBOARD_PAGE_TILEGet tile details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string
required
Page ID.
string
required
Tile ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_DATA_CUBEGet data cube details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_DATA_CUBE_DIMENSIONGet dimension details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
string
required
Dimension identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_DATA_CUBE_MEASUREGet measure details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
string
required
Measure identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_FILE_METADATAGet file details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Name of the file (may contain slashes)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_JOBGet job details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The server-generated ID of the job for which to get the metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_JOB_LOGSGet job logs in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The server-generated ID of the job for which to get the metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_JOB_METRICSGet job metrics in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The server-generated ID of the job for which to get the metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_JOB_PROGRESSGet job overall progress in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The server-generated ID of the job for which to get the metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_JOB_STATUSGet job execution status in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Server-generated job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_LOOKUPGet lookup details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The name of a lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_NETWORK_POLICYGet whether the project’s regional API IP allowlist is enabled and return entries keyed by IPv4 address or CIDR.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_PROJECTGet project details through the connected Imply Polaris regional API.

Input Parameters

string
required
The ID of the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_REPORTGet report details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Report ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_REPORT_EVALUATIONGet report evaluation details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Report ID.
string
required
Evaluation ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_GET_TABLEGet table details in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Name of the table for which to get information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_ALERT_EVALUATIONSGet alert evaluations in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Alert ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_ALERTSList all alerts in the project configured on the connected Imply Polaris account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_CONNECTIONSList all connections in the project configured on the connected Imply Polaris account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_DASHBOARD_DATA_CUBESGet dashboard data cubes in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_DASHBOARD_PAGESGet dashboard pages in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_DASHBOARD_PAGE_TILESGet dashboard page tiles in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string
required
Page ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_DASHBOARDSList all dashboards in the project configured on the connected Imply Polaris account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_DATA_CUBE_DIMENSIONSGet data cube dimensions in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_DATA_CUBE_MEASURESGet data cube measures in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_DATA_CUBESList all data cubes in the project configured on the connected Imply Polaris account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_FILESList one offset-based page of files. When has_more is true, pass next_cursor to the next call to continue listing files.

Input Parameters

integer
A result limit for pagination.
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("ASC" | "DESC")
The order to sort file results by.
string ("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.
string
Filter the results to only include files that have the provided string contained within one of their fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_JOBSList one page of jobs in the project configured on the connected Imply Polaris account, with a cursor when more results are available.

Input Parameters

array
Return jobs whose type matches any supplied value.
integer
A result limit for pagination.
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string ("ASC" | "DESC")
The order to sort job results by.
string ("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: * created_by_user_name : User that created the job. * created_date_time : Date the job was created. * execution_status : Job’s execution status. * last_updated_date_time : Date the job was last updated. * source_name : Job’s source name, such as a connection name. * source_type : Job’s source type, such as connection or table. * source_connection_name : Deprecated, use source_name instead. * source_table_name : Deprecated, use source_name instead. * target_table_name : Table that the job targets. * type : Job type.
array
Return jobs whose health status matches any supplied value.
string
Filter results to those jobs where the given string is contained in one of the job’s fields.
array
The connection to filter jobs by.
string
Filters results for jobs associated with a particular target table id.
array
Return jobs whose execution status matches any supplied value.
string
Filters results for jobs associated with a particular target table name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_LOOKUP_ALIASESList all aliases for a lookup in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The name of a lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_LOOKUPSList all lookups in the project configured on the connected Imply Polaris account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_REPORT_EVALUATIONSGet report evaluations in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Report ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_REPORTSList all reports in the project configured on the connected Imply Polaris account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_TABLESList all tables in a project in the project configured on the connected Imply Polaris account.

Input Parameters

integer
Filters results by the number of segments specified.
string ("second" | "minute" | "five_minute" | "ten_minute" | "fifteen_minute" | "thirty_minute" | "hour" | "six_hour" | "eight_hour" | "day" | "week" | "month" | "quarter" | "year" | "all")
Return tables with this partitioning granularity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_LIST_UNUSED_TABLE_SEGMENTSList one page of unused table segments, with a cursor when another page may be available.

Input Parameters

integer
The maximum number of segments to return in the response.
string
Opaque continuation cursor returned by the previous call; omit for the first page.
string
Filters results for unused segments by the time interval specified.
string ("ASC" | "DESC")
The order with which the resulting segments should be sorted with respect to their segmentId. If not specified, the order of the results is not guaranteed.
string
required
Name of the table for which to get information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_PUSH_CONNECTION_EVENTSPush events to a Polaris connection in the project configured on the connected Imply Polaris account.

Input Parameters

string
JSON event payload; provide exactly one of json_data, text_data, or binary_file.
string
Plain-text event payload; provide exactly one payload field.
object
A file the caller hands IN. s3key is an S3/R2 reference (production) or a base64 data: URL (self-hosted FILE_BACKEND=base64) — the FileStore knows which. Mirrors mercury/tools/files.py field-for-field.
string
required
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_REPLACE_ALERTReplace the complete alert in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Alert ID.
object
required
Complete replacement alert. Use the provider-native nested field names documented by Imply Polaris.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_REPLACE_DASHBOARDReplace the complete dashboard in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
object
required
Documented dashboard request body. Preserve provider-native nested keys and validate against the operation schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_REPLACE_DASHBOARD_PAGEReplace the complete page in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string
Label in the dashboard request.
array
Complete replacement tile list. Each item requires type and may include id, title, position, content, or provider-native visualization essence fields.
string
required
Page ID.
string
Optional replacement ID stored in the page body; separate from the page path ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_REPLACE_DASHBOARD_PAGE_TILEReplace the complete tile in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string
required
Page ID.
string
required
Tile ID.
object
required
Documented dashboard request body. Preserve provider-native nested keys and validate against the operation schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_REPLACE_DATA_CUBEReplace the complete data cube in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
object
required
Documented data cube request body. Preserve provider-native nested keys and validate against the operation schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_REPLACE_DATA_CUBE_DIMENSIONReplace the complete dimension in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
boolean
Geo in the data cube request.
string
Url in the data cube request.
string ("TIME" | "STRING" | "SET/STRING" | "NUMBER" | "BOOLEAN" | "IP" | "TIME_SERIES")
Type in the data cube request.
string
Group in the data cube request.
string
Title in the data cube request.
string
Format in the data cube request.
string
Formula in the data cube request.
boolean
Ip Prefix in the data cube request.
string
Description in the data cube request.
string
required
Dimension identifier
string ("ISO 3166-1 Alpha-2" | "ISO 3166-1 Alpha-3" | "ISO 3166-2" | "UN M49" | "Geohash" | "lng-coordinate" | "lat-coordinate")
Geo Encoding in the data cube request.
array
Time granularity definitions available for this dimension, using provider-native granularity names and durations.
string ("defaultBucket" | "defaultNoBucket" | "neverBucket" | "alwaysBucket")
Bucketing Strategy in the data cube request.
string
Optional replacement ID stored in the dimension body; separate from the dimension path ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_REPLACE_DATA_CUBE_MEASUREReplace the complete measure in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
string
Group in the data cube request.
string
Title in the data cube request.
string
Units in the data cube request.
string
Formula in the data cube request.
string ("none" | "percent-of-parent" | "percent-of-root")
Transform in the data cube request.
string
required
Measure identifier.
string
Description in the data cube request.
object
Number formatting with provider-native notation, precision, and affix keys.
string ("pin-zero" | "unpinned")
Scale Behavior in the data cube request.
object
Comparison color mapping for positive, negative, and neutral values.
string ("zero" | "none" | "previous" | "interpolate")
Missing Value Fill in the data cube request.
string
Optional replacement ID stored in the measure body; separate from the measure path ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_REPLACE_REPORTReplace the complete report in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Report ID.
object
required
Documented report request body. Preserve provider-native nested keys and validate against the operation schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_REPLACE_TABLEReplace the complete table in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Immutable table name.
string ("detail" | "aggregate")
required
Immutable table type.
integer
required
Current table version used for optimistic concurrency.
string
required
Name of the table for which to get information.
string
Description in the table request.
string ("flexible" | "strict")
Schema Mode in the table request.
array
Updated table columns. Existing columns can be changed or removed only when the table is empty and has no active ingestion jobs.
object
Storage Policy in the table request.
string ("millisecond" | "second" | "minute" | "fifteen_minute" | "thirty_minute" | "hour" | "day" | "week" | "month" | "quarter" | "year" | "all")
Resolution used to store and query the primary time column.
object
Rollup query granularity object, such as {type: simple}; period granularities may also set duration, timeZone, and origin.
array
Columns used for sorting within each partition.
string ("second" | "minute" | "five_minute" | "ten_minute" | "fifteen_minute" | "thirty_minute" | "hour" | "six_hour" | "eight_hour" | "day" | "week" | "month" | "quarter" | "year" | "all")
Partitioning Granularity in the table request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_RESET_JOBReset job to apply streaming ingestion offset in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The server-generated ID of the job

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_RUN_JOBStart or resume a Polaris ingestion job.

Input Parameters

string
required
Server-generated job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_RUN_SQL_QUERYRun a SQL query in the project configured on the connected Imply Polaris account. Returns results in the selected format.

Input Parameters

string
required
Query in the SQL query request.
boolean
Header in the SQL query request.
object
Context in the SQL query request.
array
Parameters in the SQL query request.
boolean
Types Header in the SQL query request.
string ("object" | "array" | "objectLines" | "arrayLines" | "csv")
Result Format in the SQL query request.
boolean
Sql Types Header in the SQL query request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_START_ASYNC_SQL_INGESTIONIrreversibly insert or replace table data by starting an asynchronous SQL ingestion job. This mutates project data; use START_ASYNC_SQL_QUERY for read-only SELECT statements.

Input Parameters

string
required
INSERT or REPLACE SQL statement that asynchronously mutates table data.
object
Optional provider-native SQL execution context.
array
Positional parameter values referenced by placeholders in the statement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_START_ASYNC_SQL_QUERYStart a read-only SELECT query asynchronously. Use START_ASYNC_SQL_INGESTION for INSERT or REPLACE statements that mutate table data.

Input Parameters

string
required
Read-only SELECT statement to run asynchronously.
object
Context in the SQL query request.
array
Positional parameter values referenced by placeholders in the SELECT statement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_SUSPEND_JOBPause a running Polaris ingestion job so it can be resumed later.

Input Parameters

string
required
Server-generated job ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_TEST_CONNECTIONTest a connection in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
The name of the connection to test.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_ALERTUpdate specified alert properties in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Alert ID.
string ("overall" | "within-split")
Whether the alert evaluates overall data or each split.
string
Alert owner.
string
Alert title.
object
Audience allowed to administer the alert.
object
Filters applied before evaluating alert conditions.
string
Split configuration used to group alert evaluations.
object
Comparison configuration for the alert.
boolean
Whether alert evaluation is disabled.
string
Alert instance identifier.
string ("info" | "warning" | "error" | "ok")
Alert severity.
array
Webhook destinations notified by the alert.
string
Data cube queried by the alert.
array
Conditions that trigger the alert.
object
Audience that receives alert notifications.
string
ISO 8601 duration of data evaluated by the alert.
object
Audience allowed to read the alert.
string
Example query associated with the alert.
string
ISO 8601 duration between alert evaluations.
array
External email addresses notified by the alert.
string
Date and time when alert evaluation starts.
string ("and" | "or")
Logical operation joining multiple conditions.
string
Replacement alert ID, when the provider permits changing it.
boolean
Whether to email the configured recipients.
string ("query" | "query-floored-P1D" | "predefined" | "inherit")
Strategy used to select the latest available data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_CONNECTIONUpdate a connection in the project configured on the connected Imply Polaris account.

Input Parameters

object
Kafka SSL authentication and encryption settings.
string
required
The name of the connection to update.
string ("azure" | "confluent" | "confluent_schema_registry" | "kafka" | "kinesis" | "push_streaming" | "s3")
required
Type in the connection request.
array
Confluent Schema Registry URLs.
string
S3 bucket name.
string
Prefix restricting the connection to specific objects.
string
Kinesis stream name.
string
Replacement connection credentials. Omit credential fields that should remain unchanged.
string
Azure Blob Storage container name.
string
Kafka topic name or topic-name pattern.
string
Physical rack identifier for this Kafka client.
string
Description in the connection request.
string
AWS Kinesis or S3 service endpoint.
string
Azure Blob Storage account name.
string
Kafka or Confluent broker host and port pairs.
string
AWS IAM role ARN to assume.
boolean
Whether topic_name is a regular expression.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_DASHBOARDUpdate specified dashboard properties in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string ("classic" | "dashboard2")
Type in the dashboard request.
array
Dashboard pages; each item may contain id, label, and a tiles list.
string
Title in the dashboard request.
object
Dashboard color palette using provider-native color and scale keys.
string ("show" | "hide")
Pages Tile in the dashboard request.
string
Description in the dashboard request.
string ("show" | "hide")
Filter Tile in the dashboard request.
object
Read-access rule containing provider-native user, group, or role assignments.
object
Modify-access rule containing provider-native user, group, or role assignments.
object
Default comparison configuration for dashboards with global comparison enabled.
array
Default filter definitions applied when the dashboard opens.
array
Default measure identifiers for dashboards with global measures enabled.
boolean
Has Global Compare in the dashboard request.
boolean
Enforce Time Filter in the dashboard request.
boolean
Has Global Measures in the dashboard request.
string ("show" | "hide")
Pages Color Summary in the dashboard request.
string
Default Refresh Rate in the dashboard request.
string
Min Auto Refresh Rate in the dashboard request.
string
Optional replacement ID stored in the dashboard body; separate from the dashboard path ID.
string
Filter Query Default Duration in the dashboard request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_DASHBOARD_PAGEUpdate specified page properties in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string
Label in the dashboard request.
array
Replacement tile list. Each item requires type and may include id, title, position, content, or provider-native visualization essence fields.
string
required
Page ID.
string
Optional replacement ID stored in the page body; separate from the page path ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_DASHBOARD_PAGE_TILEUpdate specified tile properties in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Dashboard ID.
string ("blank" | "visualization" | "markdown")
Type in the dashboard request.
string
Title in the dashboard request.
string
Content in the dashboard request.
object
Visualization configuration used by visualization tiles.
string
required
Page ID.
string
required
Tile ID.
object
Tile grid placement using provider-native row, column, width, and height values.
boolean
Can Expand in the dashboard request.
string
Description in the dashboard request.
boolean
Info Hidden in the dashboard request.
string ("none" | "right" | "bottom")
Legend Side in the dashboard request.
boolean
Title Hidden in the dashboard request.
object
Facet visualization configuration used when the tile renders a facet view.
object
Explore visualization configuration used when the tile renders an explore view.
string
Optional replacement ID stored in the tile body; separate from the tile path ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_DATA_CUBEUpdate specified data cube properties in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
string
Title in the data cube request.
boolean
Rollup in the data cube request.
object
Queryable source definition, including the provider-native table or SQL source keys.
object
Provider-native data cube feature options.
object
Visualization color palette using provider-native color and scale keys.
array
Measure definitions, each using provider-native id, title, formula, units, and formatting keys.
object
Named data cube instances keyed by instance ID.
array
Attribute definitions, each using provider-native id, title, formula, and formatting keys.
array
Dimension definitions, each using provider-native id, title, formula, type, and formatting keys.
string ("sql" | "plywood")
Query Mode in the data cube request.
string
Description in the data cube request.
object
Read-access rule containing provider-native user, group, or role assignments.
string
Filter Token in the data cube request.
object
User-specific filter definitions keyed by user ID.
object
Group-level filter definitions keyed by group ID.
object
Modify-access rule containing provider-native assignments.
string ("allow" | "disable")
Query Caching in the data cube request.
object
Provider-native filter expression applied by default.
string
Subset Formula in the data cube request.
object
Download-access rule containing provider-native assignments.
string
Default Duration in the data cube request.
string
Default Timezone in the data cube request.
string
Default Parameters in the data cube request.
boolean
Enforce Time Filter in the data cube request.
string ("show" | "hide")
Formulae Visibility in the data cube request.
string
Min Alert Frequency in the data cube request.
boolean
Allow Filter Combine in the data cube request.
array
Default facet split definitions identifying dimensions and split values.
string
Default Refresh Rate in the data cube request.
string ("query" | "query-floored-P1D" | "predefined")
Latest Data Strategy in the data cube request.
string
Min Alert Time Frame in the data cube request.
array
Named custom facet comparison definitions.
object
Default facet comparison definition.
object
Provider-native aggregate filter applied after grouping.
string
Default Visualization in the data cube request.
string
Min Auto Refresh Rate in the data cube request.
boolean
Require Group Filters in the data cube request.
object
Restricted-edit access rule containing provider-native assignments.
string
Special Time Dimension in the data cube request.
string
Optional replacement ID stored in the data cube body; separate from the data cube path ID.
array
Dimension IDs pinned by default.
array
Measure IDs selected by default.
string
Latest Time Filter Granularity in the data cube request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_DATA_CUBE_DIMENSIONUpdate specified dimension properties in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
boolean
Geo in the data cube request.
string
Url in the data cube request.
string ("TIME" | "STRING" | "SET/STRING" | "NUMBER" | "BOOLEAN" | "IP" | "TIME_SERIES")
Type in the data cube request.
string
Group in the data cube request.
string
Title in the data cube request.
string
Format in the data cube request.
string
Formula in the data cube request.
boolean
Ip Prefix in the data cube request.
string
Description in the data cube request.
string
required
Dimension identifier
string ("ISO 3166-1 Alpha-2" | "ISO 3166-1 Alpha-3" | "ISO 3166-2" | "UN M49" | "Geohash" | "lng-coordinate" | "lat-coordinate")
Geo Encoding in the data cube request.
array
Time granularity definitions available for this dimension, using provider-native granularity names and durations.
string ("defaultBucket" | "defaultNoBucket" | "neverBucket" | "alwaysBucket")
Bucketing Strategy in the data cube request.
string
Optional replacement ID stored in the dimension body; separate from the dimension path ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_DATA_CUBE_MEASUREUpdate specified measure properties in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Data cube identifier
string
Group in the data cube request.
string
Title in the data cube request.
string
Units in the data cube request.
string
Formula in the data cube request.
string ("none" | "percent-of-parent" | "percent-of-root")
Transform in the data cube request.
string
required
Measure identifier.
string
Description in the data cube request.
object
Number formatting with provider-native notation, precision, and affix keys.
string ("pin-zero" | "unpinned")
Scale Behavior in the data cube request.
object
Comparison color mapping for positive, negative, and neutral values.
string ("zero" | "none" | "previous" | "interpolate")
Missing Value Fill in the data cube request.
string
Optional replacement ID stored in the measure body; separate from the measure path ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_LOOKUPUpdate a lookup’s table source in the project configured on the connected Imply Polaris account.

Input Parameters

object
required
Replacement table source for the lookup.
string
required
The name of a lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_NETWORK_POLICYEnable or disable the project’s regional API IP allowlist and set entries keyed by IPv4 address or CIDR.

Input Parameters

boolean
Whether to enforce the network policy. When false, Polaris retains the policy but accepts requests from any IP address.
object
Network policy entries keyed by IPv4 address or CIDR. Each value describes the allow policy for that address or range; set a value to null to remove that entry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_PROJECTUpdate a project through the connected Imply Polaris regional API.

Input Parameters

string
required
ID of the project.
object
required
Project plan, lifecycle state, protections, and region.
object
required
Complete project identity metadata containing the project name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPDATE_REPORTUpdate specified report properties in the project configured on the connected Imply Polaris account.

Input Parameters

string
required
Report ID.
string
Owner in the report request.
string
Title in the report request.
object
Administrative access assignments using provider-native user and group keys.
object
Pivot visualization configuration used when preferred_view is pivot1 or pivot2.
object
Delivery schedule and channel configuration using provider-native frequency and destination keys.
boolean
Disabled in the report request.
string
Timezone in the report request.
object
Internal report recipient assignments using provider-native user and group keys.
boolean
Send Email in the report request.
object
Report time range using provider-native start, end, or relative-duration keys.
string
Description in the report request.
string ("csv" | "tsv" | "xlsx" | "json")
File Format in the report request.
object
Read-access assignments using provider-native user and group keys.
string
Creation Date in the report request.
object
Facet visualization configuration used by the report.
string
Maximum number of rows to include in the report attachment.
string ("pivot1" | "pivot2" | "explore")
Preferred View in the report request.
boolean
Send Data File in the report request.
object
Explore visualization configuration used when preferred_view is explore.
array
External email addresses that receive the report.
boolean
Add Total Row To File in the report request.
string
Optional replacement ID stored in the report body; separate from the report path ID.
boolean
Enforce Decimal Formatting in the report request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPLOAD_FILEUpload a file in the project configured on the connected Imply Polaris account.

Input Parameters

object
required
Local or uploaded file containing data to add to the Polaris project.
string ("avro_ocf" | "avro_stream" | "csv" | "kafka" | "kinesis" | "nd-json" | "orc" | "parquet" | "protobuf" | "regex")
If specified, the format of the data. Otherwise, Polaris infers the data format from the filename or the Content-Type HTTP header in the multipart form request. For more information on supported data formats, see Supported data and file formats.
string ("none" | "bz2" | "gz" | "sz" | "xz" | "zstd")
If specified, the compression used for the file. Otherwise, Polaris infers the compression from the filename or the Content-Type HTTP header in the multipart form request. Supported compression formats: * bz2 - bzip2 * gz - gzip * sz - Snappy framing format * xz - XZ Utils (previously LZMA Utils) * zstd - ZStandard

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMPLY_POLARIS_UPSERT_LOOKUP_ALIASESCreate or update aliases for a lookup in the project configured on the connected Imply Polaris account.

Input Parameters

array
required
Complete alias set to retain. Each item requires key, name, and value; omitted existing aliases are removed.
string
required
The name of a lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not