GraphQL API Reference
The Validio API is built on GraphQL API and enables interaction with the Validio platform. This API has a Python SDK wrapper called validio-sdk which can be used to interact with the API.
API Endpoints
https://<your-validio-deployment>/apiHeaders
# Your API access key ID and secret access key. Must be included in all API calls.
Authorization: <AccessKeyId>:<SecretAccessKey>Version
0.1.0
Queries
awsAthenaCredentialSecretChanged
Description
Check if secrets for a AWS Athena credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - AwsAthenaCredentialSecretChangedInput!
|
Example
Query
query AwsAthenaCredentialSecretChanged($input: AwsAthenaCredentialSecretChangedInput!) {
awsAthenaCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": AwsAthenaCredentialSecretChangedInput}
Response
{
"data": {
"awsAthenaCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": true
}
}
}
awsAthenaInferSchema
Description
Infer schema from an AWS Athena table. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - AwsAthenaInferSchemaInput!
|
Example
Query
query AwsAthenaInferSchema($input: AwsAthenaInferSchemaInput!) {
awsAthenaInferSchema(input: $input)
}
Variables
{"input": AwsAthenaInferSchemaInput}
Response
{"data": {"awsAthenaInferSchema": JsonTypeDefinition}}
awsCredentialSecretChanged
Description
Check if secrets for a AWS credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - AwsCredentialSecretChangedInput!
|
Example
Query
query AwsCredentialSecretChanged($input: AwsCredentialSecretChangedInput!) {
awsCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": AwsCredentialSecretChangedInput}
Response
{
"data": {
"awsCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": true
}
}
}
awsKinesisInferSchema
Description
Infer schema from an AWS Kinesis stream. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - AwsKinesisInferSchemaInput!
|
Example
Query
query AwsKinesisInferSchema($input: AwsKinesisInferSchemaInput!) {
awsKinesisInferSchema(input: $input)
}
Variables
{"input": AwsKinesisInferSchemaInput}
Response
{"data": {"awsKinesisInferSchema": JsonTypeDefinition}}
awsRedshiftCredentialSecretChanged
Description
Check if secrets for a AWS Redshift credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - AwsRedshiftCredentialSecretChangedInput!
|
Example
Query
query AwsRedshiftCredentialSecretChanged($input: AwsRedshiftCredentialSecretChangedInput!) {
awsRedshiftCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": AwsRedshiftCredentialSecretChangedInput}
Response
{
"data": {
"awsRedshiftCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": false
}
}
}
awsRedshiftInferSchema
Description
Infer schema from an AWS Redshift table. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - AwsRedshiftInferSchemaInput!
|
Example
Query
query AwsRedshiftInferSchema($input: AwsRedshiftInferSchemaInput!) {
awsRedshiftInferSchema(input: $input)
}
Variables
{"input": AwsRedshiftInferSchemaInput}
Response
{"data": {"awsRedshiftInferSchema": JsonTypeDefinition}}
awsS3InferSchema
Description
Infer schema from data in an S3 bucket. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - AwsS3InferSchemaInput!
|
Example
Query
query AwsS3InferSchema($input: AwsS3InferSchemaInput!) {
awsS3InferSchema(input: $input)
}
Variables
{"input": AwsS3InferSchemaInput}
Response
{"data": {"awsS3InferSchema": JsonTypeDefinition}}
azureSynapseEntraIdCredentialSecretChanged
Description
Check if secrets for a Azure Synapse Entra ID credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - AzureSynapseEntraIdCredentialSecretChangedInput!
|
Example
Query
query AzureSynapseEntraIdCredentialSecretChanged($input: AzureSynapseEntraIdCredentialSecretChangedInput!) {
azureSynapseEntraIdCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": AzureSynapseEntraIdCredentialSecretChangedInput}
Response
{
"data": {
"azureSynapseEntraIdCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": false
}
}
}
azureSynapseInferSchema
Description
Infer schema from an Azure Synapse table. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - AzureSynapseInferSchemaInput!
|
Example
Query
query AzureSynapseInferSchema($input: AzureSynapseInferSchemaInput!) {
azureSynapseInferSchema(input: $input)
}
Variables
{"input": AzureSynapseInferSchemaInput}
Response
{"data": {"azureSynapseInferSchema": JsonTypeDefinition}}
azureSynapseSqlCredentialSecretChanged
Description
Check if secrets for a Azure Synapse credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - AzureSynapseSqlCredentialSecretChangedInput!
|
Example
Query
query AzureSynapseSqlCredentialSecretChanged($input: AzureSynapseSqlCredentialSecretChangedInput!) {
azureSynapseSqlCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": AzureSynapseSqlCredentialSecretChangedInput}
Response
{
"data": {
"azureSynapseSqlCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": true
}
}
}
channelByResourceName
Description
Get a channel by resource name. Requires viewer permissions at the namespace level
Response
Returns a Channel
Arguments
| Name | Description |
|---|---|
namespaceId - NamespaceId!
|
|
resourceName - String!
|
Example
Query
query ChannelByResourceName(
$namespaceId: NamespaceId!,
$resourceName: String!
) {
channelByResourceName(
namespaceId: $namespaceId,
resourceName: $resourceName
) {
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
notificationRules {
channel {
...ChannelFragment
}
conditions {
...NotificationRuleConditionFragment
}
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
resourceName
updatedAt
}
}
Variables
{
"namespaceId": NamespaceId,
"resourceName": "xyz789"
}
Response
{
"data": {
"channelByResourceName": {
"createdAt": "2007-12-03T10:15:30Z",
"id": ChannelId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"notificationRules": [NotificationRule],
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
channelsList
Description
Get all channels. Requires viewer permissions at the namespace level
Response
Returns [Channel!]!
Arguments
| Name | Description |
|---|---|
filter - ResourceFilter
|
Example
Query
query ChannelsList($filter: ResourceFilter) {
channelsList(filter: $filter) {
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
notificationRules {
channel {
...ChannelFragment
}
conditions {
...NotificationRuleConditionFragment
}
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
resourceName
updatedAt
}
}
Variables
{"filter": ResourceFilter}
Response
{
"data": {
"channelsList": [
{
"createdAt": "2007-12-03T10:15:30Z",
"id": ChannelId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"notificationRules": [NotificationRule],
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
clickHouseCredentialSecretChanged
Description
Check if secrets for a ClickHouse credential is different compared to the passed input. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - ClickHouseCredentialSecretChangedInput!
|
Example
Query
query ClickHouseCredentialSecretChanged($input: ClickHouseCredentialSecretChangedInput!) {
clickHouseCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": ClickHouseCredentialSecretChangedInput}
Response
{
"data": {
"clickHouseCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": false
}
}
}
clickHouseInferSchema
Description
Infer schema from a ClickHouse table. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - ClickHouseInferSchemaInput!
|
Example
Query
query ClickHouseInferSchema($input: ClickHouseInferSchemaInput!) {
clickHouseInferSchema(input: $input)
}
Variables
{"input": ClickHouseInferSchemaInput}
Response
{"data": {"clickHouseInferSchema": JsonTypeDefinition}}
credentialByResourceName
Description
Get a credential by resource name and namespace. Requires viewer permissions at the namespace level
Response
Returns a Credential
Arguments
| Name | Description |
|---|---|
namespaceId - NamespaceId!
|
|
resourceName - String!
|
Example
Query
query CredentialByResourceName(
$namespaceId: NamespaceId!,
$resourceName: String!
) {
credentialByResourceName(
namespaceId: $namespaceId,
resourceName: $resourceName
) {
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
updatedAt
}
}
Variables
{
"namespaceId": NamespaceId,
"resourceName": "xyz789"
}
Response
{
"data": {
"credentialByResourceName": {
"createdAt": "2007-12-03T10:15:30Z",
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
credentialsList
Description
Get all credentials. Requires viewer permissions at the namespace level
Response
Returns [Credential!]!
Arguments
| Name | Description |
|---|---|
filter - ResourceFilter
|
Example
Query
query CredentialsList($filter: ResourceFilter) {
credentialsList(filter: $filter) {
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
updatedAt
}
}
Variables
{"filter": ResourceFilter}
Response
{
"data": {
"credentialsList": [
{
"createdAt": "2007-12-03T10:15:30Z",
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
databricksCredentialSecretChanged
Description
Check if secrets for a Databricks credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - DatabricksCredentialSecretChangedInput!
|
Example
Query
query DatabricksCredentialSecretChanged($input: DatabricksCredentialSecretChangedInput!) {
databricksCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": DatabricksCredentialSecretChangedInput}
Response
{
"data": {
"databricksCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": false
}
}
}
databricksInferSchema
Description
Infer schema from a Databricks table. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - DatabricksInferSchemaInput!
|
Example
Query
query DatabricksInferSchema($input: DatabricksInferSchemaInput!) {
databricksInferSchema(input: $input)
}
Variables
{"input": DatabricksInferSchemaInput}
Response
{"data": {"databricksInferSchema": JsonTypeDefinition}}
databricksStartWarehouse
Description
For auto scaling Databricks warehouses that shut down, this will start the warehouse making it available. Requires editor permissions at the namespace level
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - DatabricksStartWarehouseInput!
|
Example
Query
query DatabricksStartWarehouse($input: DatabricksStartWarehouseInput!) {
databricksStartWarehouse(input: $input)
}
Variables
{"input": DatabricksStartWarehouseInput}
Response
{"data": {"databricksStartWarehouse": false}}
databricksWarehouseInfo
Description
Get Databricks warehouse information. Requires editor permissions at the namespace level
Response
Returns a DatabricksWarehouseInfo!
Arguments
| Name | Description |
|---|---|
input - DatabricksWarehouseInfoInput!
|
Example
Query
query DatabricksWarehouseInfo($input: DatabricksWarehouseInfoInput!) {
databricksWarehouseInfo(input: $input) {
autoStopMinutes
name
state
}
}
Variables
{"input": DatabricksWarehouseInfoInput}
Response
{
"data": {
"databricksWarehouseInfo": {
"autoStopMinutes": 987,
"name": "xyz789",
"state": "abc123"
}
}
}
dbtCloudCredentialSecretChanged
Description
Check if secrets for a dbt Cloud credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - DbtCloudCredentialSecretChangedInput!
|
Example
Query
query DbtCloudCredentialSecretChanged($input: DbtCloudCredentialSecretChangedInput!) {
dbtCloudCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": DbtCloudCredentialSecretChangedInput}
Response
{
"data": {
"dbtCloudCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": false
}
}
}
dbtModelRunInferSchema
Description
Infer schema from the dbt model run result. Requires editor permissions at the global level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Example
Query
query DbtModelRunInferSchema {
dbtModelRunInferSchema
}
Response
{"data": {"dbtModelRunInferSchema": JsonTypeDefinition}}
dbtTestResultInferSchema
Description
Infer schema from the dbt test result. Requires editor permissions at the global level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Example
Query
query DbtTestResultInferSchema {
dbtTestResultInferSchema
}
Response
{"data": {"dbtTestResultInferSchema": JsonTypeDefinition}}
demoInferSchema
Description
Infer schema for the demo source. Requires viewer permissions at the global level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Example
Query
query DemoInferSchema {
demoInferSchema
}
Response
{"data": {"demoInferSchema": JsonTypeDefinition}}
filter
Description
Get a filter. Requires viewer permissions at the namespace level
Example
Query
query Filter($id: FilterId!) {
filter(id: $id) {
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
updatedAt
}
}
Variables
{"id": FilterId}
Response
{
"data": {
"filter": {
"createdAt": "2007-12-03T10:15:30Z",
"id": FilterId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
filtersList
Description
Get all filters. Requires viewer permissions at the namespace level
Response
Returns [Filter!]!
Arguments
| Name | Description |
|---|---|
filter - ResourceFilter
|
|
sourceId - SourceId
|
Example
Query
query FiltersList(
$filter: ResourceFilter,
$sourceId: SourceId
) {
filtersList(
filter: $filter,
sourceId: $sourceId
) {
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
updatedAt
}
}
Variables
{
"filter": ResourceFilter,
"sourceId": SourceId
}
Response
{
"data": {
"filtersList": [
{
"createdAt": "2007-12-03T10:15:30Z",
"id": FilterId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
gcpBigQueryInferSchema
Description
Infer schema from a Google BigQuery table. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - GcpBigQueryInferSchemaInput!
|
Example
Query
query GcpBigQueryInferSchema($input: GcpBigQueryInferSchemaInput!) {
gcpBigQueryInferSchema(input: $input)
}
Variables
{"input": GcpBigQueryInferSchemaInput}
Response
{"data": {"gcpBigQueryInferSchema": JsonTypeDefinition}}
gcpCredentialSecretChanged
Description
Check if secrets for a Google Cloud Platform credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - GcpCredentialSecretChangedInput!
|
Example
Query
query GcpCredentialSecretChanged($input: GcpCredentialSecretChangedInput!) {
gcpCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": GcpCredentialSecretChangedInput}
Response
{
"data": {
"gcpCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": false
}
}
}
gcpPubSubInferSchema
Description
Infer schema from a Google Pub/Sub topic. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - GcpPubSubInferSchemaInput!
|
Example
Query
query GcpPubSubInferSchema($input: GcpPubSubInferSchemaInput!) {
gcpPubSubInferSchema(input: $input)
}
Variables
{"input": GcpPubSubInferSchemaInput}
Response
{"data": {"gcpPubSubInferSchema": JsonTypeDefinition}}
gcpPubSubLiteInferSchema
Description
Infer schema from a Google Pub/Sub lite topic. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - GcpPubSubLiteInferSchemaInput!
|
Example
Query
query GcpPubSubLiteInferSchema($input: GcpPubSubLiteInferSchemaInput!) {
gcpPubSubLiteInferSchema(input: $input)
}
Variables
{"input": GcpPubSubLiteInferSchemaInput}
Response
{"data": {"gcpPubSubLiteInferSchema": JsonTypeDefinition}}
gcpStorageInferSchema
Description
Infer schema from data in a GCS bucket. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - GcpStorageInferSchemaInput!
|
Example
Query
query GcpStorageInferSchema($input: GcpStorageInferSchemaInput!) {
gcpStorageInferSchema(input: $input)
}
Variables
{"input": GcpStorageInferSchemaInput}
Response
{"data": {"gcpStorageInferSchema": JsonTypeDefinition}}
identityProviderByResourceName
Description
Get an identity provider by resource name. Requires viewer permissions at the global level
Response
Returns an IdentityProvider
Arguments
| Name | Description |
|---|---|
resourceName - String!
|
Example
Query
query IdentityProviderByResourceName($resourceName: String!) {
identityProviderByResourceName(resourceName: $resourceName) {
createdAt
disabled
id
name
resourceName
updatedAt
}
}
Variables
{"resourceName": "abc123"}
Response
{
"data": {
"identityProviderByResourceName": {
"createdAt": "2007-12-03T10:15:30Z",
"disabled": false,
"id": "4",
"name": "abc123",
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
identityProvidersList
Description
Get all identity providers. Requires admin permissions at the global level
Response
Returns [IdentityProvider!]!
Example
Query
query IdentityProvidersList {
identityProvidersList {
createdAt
disabled
id
name
resourceName
updatedAt
}
}
Response
{
"data": {
"identityProvidersList": [
{
"createdAt": "2007-12-03T10:15:30Z",
"disabled": true,
"id": "4",
"name": "xyz789",
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
incidentGroup
Description
Get an incident group. Requires viewer permissions at the namespace level
Response
Returns an IncidentGroup
Arguments
| Name | Description |
|---|---|
id - IncidentGroupId!
|
Example
Query
query IncidentGroup($id: IncidentGroupId!) {
incidentGroup(id: $id) {
firstSeenAt
id
incidents {
elements {
...IncidentFragment
}
index {
...IncidentsIndexFragment
}
pageInfo {
...PageInfoFragment
}
}
lastSeenAt
muteUntil
owner {
avatar
avatarThumbnail
createdAt
displayName
email
fullName
globalRole
id
identities {
... on FederatedIdentity {
...FederatedIdentityFragment
}
... on LocalIdentity {
...LocalIdentityFragment
}
}
lastLoginAt
loginType
namespaces {
...NamespaceFragment
}
resourceName
status
teams {
...TeamFragment
}
updatedAt
}
pastGroups {
elements {
...IncidentGroupFragment
}
index {
...PastIncidentGroupsIndexFragment
}
pageInfo {
...PageInfoFragment
}
}
priority
segment {
dataQuality {
...DataQualityFragment
}
fields {
...SegmentFieldFragment
}
id
muted
}
severityStats {
highCount
lowCount
mediumCount
totalCount
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
status
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"id": IncidentGroupId}
Response
{
"data": {
"incidentGroup": {
"firstSeenAt": "2007-12-03T10:15:30Z",
"id": IncidentGroupId,
"incidents": IncidentsResult,
"lastSeenAt": "2007-12-03T10:15:30Z",
"muteUntil": "2007-12-03T10:15:30Z",
"owner": User,
"pastGroups": PastIncidentGroupsResult,
"priority": "CRITICAL",
"segment": Segment,
"severityStats": SeverityStats,
"source": Source,
"status": "INVESTIGATING",
"validator": Validator
}
}
}
incidentGroups
Description
Get a paginated response of incident groups. Requires viewer permissions at the namespace level
Response
Returns an IncidentGroupsResult!
Arguments
| Name | Description |
|---|---|
filter - IncidentGroupsFilter
|
|
pagination - PaginationInput
|
|
sort - IncidentGroupsSort
|
Example
Query
query IncidentGroups(
$filter: IncidentGroupsFilter,
$pagination: PaginationInput,
$sort: IncidentGroupsSort
) {
incidentGroups(
filter: $filter,
pagination: $pagination,
sort: $sort
) {
elements {
firstSeenAt
id
incidents {
...IncidentsResultFragment
}
lastSeenAt
muteUntil
owner {
...UserFragment
}
pastGroups {
...PastIncidentGroupsResultFragment
}
priority
segment {
...SegmentFragment
}
severityStats {
...SeverityStatsFragment
}
source {
...SourceFragment
}
status
validator {
...ValidatorFragment
}
}
index {
namespace {
...IndexKeyFragment
}
owner {
...IndexKeyFragment
}
priority {
...IndexKeyFragment
}
source {
...IndexKeyFragment
}
status {
...IndexKeyFragment
}
tagLabel {
...IndexKeyFragment
}
validator {
...IndexKeyFragment
}
}
pageInfo {
endCursor
filteredCount
hasNextPage
hasPreviousPage
startCursor
totalCount
}
}
}
Variables
{
"filter": IncidentGroupsFilter,
"pagination": PaginationInput,
"sort": IncidentGroupsSort
}
Response
{
"data": {
"incidentGroups": {
"elements": [IncidentGroup],
"index": IncidentGroupsIndex,
"pageInfo": PageInfo
}
}
}
incidentRelatedGroups
Description
Get related groups from an incident. As an example of a related group that would be an incident group that comes from another source that is connected to the current one and are related in the lineage graph. Requires viewer permissions at the namespace level
Response
Returns an IncidentRelatedGroupsResult!
Arguments
| Name | Description |
|---|---|
id - IncidentGroupId!
|
Example
Query
query IncidentRelatedGroups($id: IncidentGroupId!) {
incidentRelatedGroups(id: $id) {
elements {
field
group {
...IncidentGroupFragment
}
originField
relationship
}
originField
originFields
}
}
Variables
{"id": IncidentGroupId}
Response
{
"data": {
"incidentRelatedGroups": {
"elements": [IncidentRelatedGroup],
"originField": "xyz789",
"originFields": ["xyz789"]
}
}
}
kafkaInferSchema
Description
Infer schema from a Kafka topic. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - KafkaInferSchemaInput!
|
Example
Query
query KafkaInferSchema($input: KafkaInferSchemaInput!) {
kafkaInferSchema(input: $input)
}
Variables
{"input": KafkaInferSchemaInput}
Response
{"data": {"kafkaInferSchema": JsonTypeDefinition}}
kafkaSaslSslPlainCredentialSecretChanged
Description
Check if secrets for a Kafka SASL SSL credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - KafkaSaslSslPlainCredentialSecretChangedInput!
|
Example
Query
query KafkaSaslSslPlainCredentialSecretChanged($input: KafkaSaslSslPlainCredentialSecretChangedInput!) {
kafkaSaslSslPlainCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": KafkaSaslSslPlainCredentialSecretChangedInput}
Response
{
"data": {
"kafkaSaslSslPlainCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": false
}
}
}
kafkaSslCredentialSecretChanged
Description
Check if secrets for a Kafka SSL credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - KafkaSslCredentialSecretChangedInput!
|
Example
Query
query KafkaSslCredentialSecretChanged($input: KafkaSslCredentialSecretChangedInput!) {
kafkaSslCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": KafkaSslCredentialSecretChangedInput}
Response
{
"data": {
"kafkaSslCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": true
}
}
}
lineageEdge
Description
Get a lineage edge. Requires viewer permissions at the global level
Response
Returns a LineageEdge
Arguments
| Name | Description |
|---|---|
id - LineageEdgeId!
|
Example
Query
query LineageEdge($id: LineageEdgeId!) {
lineageEdge(id: $id) {
downstream {
catalogAsset {
...CatalogAssetFragment
}
field
}
id
sqlQuery
upstream {
catalogAsset {
...CatalogAssetFragment
}
field
}
}
}
Variables
{"id": LineageEdgeId}
Response
{
"data": {
"lineageEdge": {
"downstream": LineageNode,
"id": LineageEdgeId,
"sqlQuery": "abc123",
"upstream": LineageNode
}
}
}
lineageGraph
Description
Get a lineage graph. Requires viewer permissions at the global level
Response
Returns a LineageGraph!
Arguments
| Name | Description |
|---|---|
input - LineageGraphInput!
|
Example
Query
query LineageGraph($input: LineageGraphInput!) {
lineageGraph(input: $input) {
edges {
downstream {
...LineageNodeFragment
}
id
sqlQuery
upstream {
...LineageNodeFragment
}
}
nodes {
assetType
createdAt
description
descriptions {
...CatalogAssetDescriptionFragment
}
externalTags {
...TagFragment
}
id
joinedTables {
...CatalogAssetFragment
}
name
queryUsers {
...QueryUserInfoFragment
}
stats {
...CatalogAssetStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
stats {
totalAssetCount
totalEdgeCount
totalSourceCount
}
}
}
Variables
{"input": LineageGraphInput}
Response
{
"data": {
"lineageGraph": {
"edges": [LineageEdge],
"nodes": [CatalogAsset],
"stats": LineageGraphStats
}
}
}
lookerCredentialSecretChanged
Description
Check if secrets for a Looker credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - LookerCredentialSecretChangedInput!
|
Example
Query
query LookerCredentialSecretChanged($input: LookerCredentialSecretChangedInput!) {
lookerCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": LookerCredentialSecretChangedInput}
Response
{
"data": {
"lookerCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": true
}
}
}
msPowerBiCredentialSecretChanged
Description
Check if secrets for a Microsoft Power BI credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - MsPowerBiCredentialSecretChangedInput!
|
Example
Query
query MsPowerBiCredentialSecretChanged($input: MsPowerBiCredentialSecretChangedInput!) {
msPowerBiCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": MsPowerBiCredentialSecretChangedInput}
Response
{
"data": {
"msPowerBiCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": true
}
}
}
msTeamsChannelSecretChanged
Description
Check if secrets for a Microsoft Teams channel is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a MsTeamsChannelSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - MsTeamsChannelSecretChangedInput!
|
Example
Query
query MsTeamsChannelSecretChanged($input: MsTeamsChannelSecretChangedInput!) {
msTeamsChannelSecretChanged(input: $input) {
clientId
clientSecret
errors {
code
message
}
}
}
Variables
{"input": MsTeamsChannelSecretChangedInput}
Response
{
"data": {
"msTeamsChannelSecretChanged": {
"clientId": true,
"clientSecret": false,
"errors": [ApiError]
}
}
}
namespace
Description
Get a namespace. Requires viewer permissions at the global level
Response
Returns a Namespace
Arguments
| Name | Description |
|---|---|
id - NamespaceId!
|
Example
Query
query Namespace($id: NamespaceId!) {
namespace(id: $id) {
apiKeys {
apiKey {
...ApiKeyFragment
}
role
}
avatar
avatarThumbnail
description
id
members {
role
user {
...UserFragment
}
}
name
teams {
role
team {
...TeamFragment
}
}
users {
role
user {
...UserFragment
}
}
}
}
Variables
{"id": NamespaceId}
Response
{
"data": {
"namespace": {
"apiKeys": [ApiKeyRole],
"avatar": DataUrl,
"avatarThumbnail": DataUrl,
"description": "abc123",
"id": NamespaceId,
"members": [UserRole],
"name": "abc123",
"teams": [TeamRole],
"users": [UserRole]
}
}
}
namespaces
Description
Get all namespaces. Requires viewer permissions at the global level
Response
Returns [Namespace!]!
Example
Query
query Namespaces {
namespaces {
apiKeys {
apiKey {
...ApiKeyFragment
}
role
}
avatar
avatarThumbnail
description
id
members {
role
user {
...UserFragment
}
}
name
teams {
role
team {
...TeamFragment
}
}
users {
role
user {
...UserFragment
}
}
}
}
Response
{
"data": {
"namespaces": [
{
"apiKeys": [ApiKeyRole],
"avatar": DataUrl,
"avatarThumbnail": DataUrl,
"description": "xyz789",
"id": NamespaceId,
"members": [UserRole],
"name": "xyz789",
"teams": [TeamRole],
"users": [UserRole]
}
]
}
}
notificationRule
Description
Get a notification rule. Requires viewer permissions at the namespace level
Response
Returns a NotificationRule
Arguments
| Name | Description |
|---|---|
id - NotificationRuleId!
|
Example
Query
query NotificationRule($id: NotificationRuleId!) {
notificationRule(id: $id) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
conditions {
createdAt
id
notificationRuleId
updatedAt
}
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
updatedAt
}
}
Variables
{"id": NotificationRuleId}
Response
{
"data": {
"notificationRule": {
"channel": Channel,
"conditions": [NotificationRuleCondition],
"createdAt": "2007-12-03T10:15:30Z",
"id": NotificationRuleId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
notificationRuleByResourceName
Description
Get a notification rule by resource name. Requires viewer permissions at the namespace level
Response
Returns a NotificationRule
Arguments
| Name | Description |
|---|---|
namespaceId - NamespaceId!
|
|
resourceName - String!
|
Example
Query
query NotificationRuleByResourceName(
$namespaceId: NamespaceId!,
$resourceName: String!
) {
notificationRuleByResourceName(
namespaceId: $namespaceId,
resourceName: $resourceName
) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
conditions {
createdAt
id
notificationRuleId
updatedAt
}
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
updatedAt
}
}
Variables
{
"namespaceId": NamespaceId,
"resourceName": "xyz789"
}
Response
{
"data": {
"notificationRuleByResourceName": {
"channel": Channel,
"conditions": [NotificationRuleCondition],
"createdAt": "2007-12-03T10:15:30Z",
"id": NotificationRuleId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
notificationRulesList
Description
Get all notification rules. Requires viewer permissions at the namespace level
Response
Returns [NotificationRule!]!
Arguments
| Name | Description |
|---|---|
filter - ResourceFilter
|
Example
Query
query NotificationRulesList($filter: ResourceFilter) {
notificationRulesList(filter: $filter) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
conditions {
createdAt
id
notificationRuleId
updatedAt
}
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
updatedAt
}
}
Variables
{"filter": ResourceFilter}
Response
{
"data": {
"notificationRulesList": [
{
"channel": Channel,
"conditions": [NotificationRuleCondition],
"createdAt": "2007-12-03T10:15:30Z",
"id": NotificationRuleId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
postgreSqlCredentialSecretChanged
Description
Check if secrets for a PostgreSQL credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - PostgreSqlCredentialSecretChangedInput!
|
Example
Query
query PostgreSqlCredentialSecretChanged($input: PostgreSqlCredentialSecretChangedInput!) {
postgreSqlCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": PostgreSqlCredentialSecretChangedInput}
Response
{
"data": {
"postgreSqlCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": true
}
}
}
postgreSqlInferSchema
Description
Infer schema from a PostgreSQL table. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - PostgreSqlInferSchemaInput!
|
Example
Query
query PostgreSqlInferSchema($input: PostgreSqlInferSchemaInput!) {
postgreSqlInferSchema(input: $input)
}
Variables
{"input": PostgreSqlInferSchemaInput}
Response
{"data": {"postgreSqlInferSchema": JsonTypeDefinition}}
resourceNamespacesList
Use
namespaces
Description
List all namespace ids. Requires viewer permissions at the global level
Response
Returns [ResourceNamespaceListResult!]!
Example
Query
query ResourceNamespacesList {
resourceNamespacesList {
namespaceId
resourceNamespace
}
}
Response
{
"data": {
"resourceNamespacesList": [
{
"namespaceId": "xyz789",
"resourceNamespace": "abc123"
}
]
}
}
sampleInferSchema
Description
Infer schema from a JSON sample using JTD inference. Requires viewer permissions at the global level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - [JSONObject!]!
|
Example
Query
query SampleInferSchema($input: [JSONObject!]!) {
sampleInferSchema(input: $input)
}
Variables
{"input": [{}]}
Response
{"data": {"sampleInferSchema": JsonTypeDefinition}}
segmentation
Description
Get a segmentation. Requires viewer permissions at the namespace level
Response
Returns a Segmentation
Arguments
| Name | Description |
|---|---|
id - SegmentationId!
|
Example
Query
query Segmentation($id: SegmentationId!) {
segmentation(id: $id) {
createdAt
fields
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
segments {
elements {
...SegmentFragment
}
pageInfo {
...PageInfoFragment
}
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
updatedAt
}
}
Variables
{"id": SegmentationId}
Response
{
"data": {
"segmentation": {
"createdAt": "2007-12-03T10:15:30Z",
"fields": ["abc123"],
"filter": Filter,
"id": SegmentationId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"segments": SegmentsResult,
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
segmentationByResourceName
Description
Get a segmentation by resource name and namespace Requires viewer permissions at the namespace level
Response
Returns a Segmentation
Arguments
| Name | Description |
|---|---|
namespaceId - NamespaceId!
|
|
resourceName - String!
|
Example
Query
query SegmentationByResourceName(
$namespaceId: NamespaceId!,
$resourceName: String!
) {
segmentationByResourceName(
namespaceId: $namespaceId,
resourceName: $resourceName
) {
createdAt
fields
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
segments {
elements {
...SegmentFragment
}
pageInfo {
...PageInfoFragment
}
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
updatedAt
}
}
Variables
{
"namespaceId": NamespaceId,
"resourceName": "abc123"
}
Response
{
"data": {
"segmentationByResourceName": {
"createdAt": "2007-12-03T10:15:30Z",
"fields": ["abc123"],
"filter": Filter,
"id": SegmentationId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"segments": SegmentsResult,
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
segmentationsList
Description
Get all segmentations Requires viewer permissions at the namespace level
Response
Returns [Segmentation!]!
Arguments
| Name | Description |
|---|---|
filter - ResourceFilter
|
Example
Query
query SegmentationsList($filter: ResourceFilter) {
segmentationsList(filter: $filter) {
createdAt
fields
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
segments {
elements {
...SegmentFragment
}
pageInfo {
...PageInfoFragment
}
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
updatedAt
}
}
Variables
{"filter": ResourceFilter}
Response
{
"data": {
"segmentationsList": [
{
"createdAt": "2007-12-03T10:15:30Z",
"fields": ["abc123"],
"filter": Filter,
"id": SegmentationId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"segments": SegmentsResult,
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
segments
Description
Get all segments Requires viewer permissions at the namespace level
Response
Returns [Segment!]!
Arguments
| Name | Description |
|---|---|
id - SegmentationId!
|
Example
Query
query Segments($id: SegmentationId!) {
segments(id: $id) {
dataQuality {
incidentCount
quality
qualityDiff
totalCount
}
fields {
field
value
}
id
muted
}
}
Variables
{"id": SegmentationId}
Response
{
"data": {
"segments": [
{
"dataQuality": DataQuality,
"fields": [SegmentField],
"id": SegmentId,
"muted": false
}
]
}
}
segmentsByResourceName
Description
Get a segment by resource name and namespace Requires viewer permissions at the namespace level
Response
Returns [Segment!]!
Arguments
| Name | Description |
|---|---|
namespaceId - NamespaceId!
|
|
resourceName - String!
|
Example
Query
query SegmentsByResourceName(
$namespaceId: NamespaceId!,
$resourceName: String!
) {
segmentsByResourceName(
namespaceId: $namespaceId,
resourceName: $resourceName
) {
dataQuality {
incidentCount
quality
qualityDiff
totalCount
}
fields {
field
value
}
id
muted
}
}
Variables
{
"namespaceId": NamespaceId,
"resourceName": "abc123"
}
Response
{
"data": {
"segmentsByResourceName": [
{
"dataQuality": DataQuality,
"fields": [SegmentField],
"id": SegmentId,
"muted": true
}
]
}
}
slackChannelSecretChanged
Description
Check if secrets for a Slack channel is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a SlackChannelSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - SlackChannelSecretChangedInput!
|
Example
Query
query SlackChannelSecretChanged($input: SlackChannelSecretChangedInput!) {
slackChannelSecretChanged(input: $input) {
errors {
code
message
}
signingSecret
token
}
}
Variables
{"input": SlackChannelSecretChangedInput}
Response
{
"data": {
"slackChannelSecretChanged": {
"errors": [ApiError],
"signingSecret": false,
"token": true
}
}
}
snowflakeCredentialSecretChanged
Description
Check if secrets for a Snowflake credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - SnowflakeCredentialSecretChangedInput!
|
Example
Query
query SnowflakeCredentialSecretChanged($input: SnowflakeCredentialSecretChangedInput!) {
snowflakeCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": SnowflakeCredentialSecretChangedInput}
Response
{
"data": {
"snowflakeCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": false
}
}
}
snowflakeInferSchema
Description
Infer schema from a Snowflake table. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a JsonTypeDefinition!
Arguments
| Name | Description |
|---|---|
input - SnowflakeInferSchemaInput!
|
Example
Query
query SnowflakeInferSchema($input: SnowflakeInferSchemaInput!) {
snowflakeInferSchema(input: $input)
}
Variables
{"input": SnowflakeInferSchemaInput}
Response
{"data": {"snowflakeInferSchema": JsonTypeDefinition}}
source
Description
Get a source. Requires viewer permissions at the namespace level
Example
Query
query Source($id: SourceId!) {
source(id: $id) {
catalogAsset {
assetType
createdAt
description
descriptions {
...CatalogAssetDescriptionFragment
}
externalTags {
...TagFragment
}
id
joinedTables {
...CatalogAssetFragment
}
name
queryUsers {
...QueryUserInfoFragment
}
stats {
...CatalogAssetStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
createdAt
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
description
filters {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
id
incidentGroups {
elements {
...IncidentGroupFragment
}
index {
...IncidentGroupsIndexFragment
}
pageInfo {
...PageInfoFragment
}
}
jtdSchema
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
recommendedValidators {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
resourceName
segmentations {
createdAt
fields
filter {
...FilterFragment
}
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
segments {
...SegmentsResultFragment
}
source {
...SourceFragment
}
updatedAt
}
state
stateUpdatedAt
tags {
createdAt
id
key
origin
updatedAt
value
}
updatedAt
windows {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"id": SourceId}
Response
{
"data": {
"source": {
"catalogAsset": CatalogAsset,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
}
}
sourceByResourceName
Description
Get a source by resource name and namespace. Requires viewer permissions at the namespace level
Response
Returns a Source
Arguments
| Name | Description |
|---|---|
namespaceId - NamespaceId!
|
|
resourceName - String!
|
Example
Query
query SourceByResourceName(
$namespaceId: NamespaceId!,
$resourceName: String!
) {
sourceByResourceName(
namespaceId: $namespaceId,
resourceName: $resourceName
) {
catalogAsset {
assetType
createdAt
description
descriptions {
...CatalogAssetDescriptionFragment
}
externalTags {
...TagFragment
}
id
joinedTables {
...CatalogAssetFragment
}
name
queryUsers {
...QueryUserInfoFragment
}
stats {
...CatalogAssetStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
createdAt
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
description
filters {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
id
incidentGroups {
elements {
...IncidentGroupFragment
}
index {
...IncidentGroupsIndexFragment
}
pageInfo {
...PageInfoFragment
}
}
jtdSchema
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
recommendedValidators {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
resourceName
segmentations {
createdAt
fields
filter {
...FilterFragment
}
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
segments {
...SegmentsResultFragment
}
source {
...SourceFragment
}
updatedAt
}
state
stateUpdatedAt
tags {
createdAt
id
key
origin
updatedAt
value
}
updatedAt
windows {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{
"namespaceId": NamespaceId,
"resourceName": "xyz789"
}
Response
{
"data": {
"sourceByResourceName": {
"catalogAsset": CatalogAsset,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
}
}
sourcesList
Description
Get all sources. Requires viewer permissions at the namespace level
Response
Returns [Source!]!
Arguments
| Name | Description |
|---|---|
filter - ResourceFilter
|
Example
Query
query SourcesList($filter: ResourceFilter) {
sourcesList(filter: $filter) {
catalogAsset {
assetType
createdAt
description
descriptions {
...CatalogAssetDescriptionFragment
}
externalTags {
...TagFragment
}
id
joinedTables {
...CatalogAssetFragment
}
name
queryUsers {
...QueryUserInfoFragment
}
stats {
...CatalogAssetStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
createdAt
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
description
filters {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
id
incidentGroups {
elements {
...IncidentGroupFragment
}
index {
...IncidentGroupsIndexFragment
}
pageInfo {
...PageInfoFragment
}
}
jtdSchema
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
recommendedValidators {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
resourceName
segmentations {
createdAt
fields
filter {
...FilterFragment
}
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
segments {
...SegmentsResultFragment
}
source {
...SourceFragment
}
updatedAt
}
state
stateUpdatedAt
tags {
createdAt
id
key
origin
updatedAt
value
}
updatedAt
windows {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"filter": ResourceFilter}
Response
{
"data": {
"sourcesList": [
{
"catalogAsset": CatalogAsset,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "xyz789",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
]
}
}
sqlFilterVerification
Description
Validate a SQL filter. Requires viewer permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a SqlFilterVerificationResult!
Arguments
| Name | Description |
|---|---|
input - SqlFilterVerificationInput!
|
Example
Query
query SqlFilterVerification($input: SqlFilterVerificationInput!) {
sqlFilterVerification(input: $input) {
queryError
}
}
Variables
{"input": SqlFilterVerificationInput}
Response
{
"data": {
"sqlFilterVerification": {
"queryError": "abc123"
}
}
}
sqlValidatorQueryVerification
Description
Verify a SQL query to confirm it can be used in a validator. Requires viewer permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a SqlValidatorQueryVerificationResult!
Arguments
| Name | Description |
|---|---|
input - SqlValidatorQueryVerificationInput!
|
Example
Query
query SqlValidatorQueryVerification($input: SqlValidatorQueryVerificationInput!) {
sqlValidatorQueryVerification(input: $input) {
query
queryError
records {
columns
rows
}
}
}
Variables
{"input": SqlValidatorQueryVerificationInput}
Response
{
"data": {
"sqlValidatorQueryVerification": {
"query": "abc123",
"queryError": "abc123",
"records": DebugRecordsSample
}
}
}
tableauConnectedAppCredentialSecretChanged
Description
Check if secrets for a Tableau credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - TableauConnectedAppCredentialSecretChangedInput!
|
Example
Query
query TableauConnectedAppCredentialSecretChanged($input: TableauConnectedAppCredentialSecretChangedInput!) {
tableauConnectedAppCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{"input": TableauConnectedAppCredentialSecretChangedInput}
Response
{
"data": {
"tableauConnectedAppCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": true
}
}
}
tableauPersonalAccessTokenCredentialSecretChanged
Description
Check if secrets for a Tableau personal access token credential is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a CredentialSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - TableauPersonalAccessTokenCredentialSecretChangedInput!
|
Example
Query
query TableauPersonalAccessTokenCredentialSecretChanged($input: TableauPersonalAccessTokenCredentialSecretChangedInput!) {
tableauPersonalAccessTokenCredentialSecretChanged(input: $input) {
errors {
code
message
}
hasChanged
}
}
Variables
{
"input": TableauPersonalAccessTokenCredentialSecretChangedInput
}
Response
{
"data": {
"tableauPersonalAccessTokenCredentialSecretChanged": {
"errors": [ApiError],
"hasChanged": true
}
}
}
tag
Description
Get a tag. Requires viewer permissions at the global level
Example
Query
query Tag($id: TagId!) {
tag(id: $id) {
createdAt
id
key
origin
updatedAt
value
}
}
Variables
{"id": TagId}
Response
{
"data": {
"tag": {
"createdAt": "2007-12-03T10:15:30Z",
"id": TagId,
"key": "xyz789",
"origin": "CATALOG_REFRESH",
"updatedAt": "2007-12-03T10:15:30Z",
"value": "abc123"
}
}
}
team
Description
Get a team. Requires viewer permissions at the global level
Example
Query
query Team($id: TeamId!) {
team(id: $id) {
avatar
avatarThumbnail
createdAt
description
id
members {
avatar
avatarThumbnail
createdAt
displayName
email
fullName
globalRole
id
identities {
... on FederatedIdentity {
...FederatedIdentityFragment
}
... on LocalIdentity {
...LocalIdentityFragment
}
}
lastLoginAt
loginType
namespaces {
...NamespaceFragment
}
resourceName
status
teams {
...TeamFragment
}
updatedAt
}
name
updatedAt
}
}
Variables
{"id": TeamId}
Response
{
"data": {
"team": {
"avatar": DataUrl,
"avatarThumbnail": DataUrl,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"id": TeamId,
"members": [User],
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
teams
Description
Get all teams. Requires viewer permissions at the global level
Response
Returns [Team!]!
Example
Query
query Teams {
teams {
avatar
avatarThumbnail
createdAt
description
id
members {
avatar
avatarThumbnail
createdAt
displayName
email
fullName
globalRole
id
identities {
... on FederatedIdentity {
...FederatedIdentityFragment
}
... on LocalIdentity {
...LocalIdentityFragment
}
}
lastLoginAt
loginType
namespaces {
...NamespaceFragment
}
resourceName
status
teams {
...TeamFragment
}
updatedAt
}
name
updatedAt
}
}
Response
{
"data": {
"teams": [
{
"avatar": DataUrl,
"avatarThumbnail": DataUrl,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"id": TeamId,
"members": [User],
"name": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
translateIncidentV1
Description
Gives the new incident and incident group information from a old type of incident id. Requires viewer permissions at the global level
Response
Returns an IncidentV1Translation
Arguments
| Name | Description |
|---|---|
oldId - ID!
|
Example
Query
query TranslateIncidentV1($oldId: ID!) {
translateIncidentV1(oldId: $oldId) {
groupId
incidentId
oldId
}
}
Variables
{"oldId": "4"}
Response
{
"data": {
"translateIncidentV1": {
"groupId": IncidentGroupId,
"incidentId": IncidentId,
"oldId": 4
}
}
}
userByResourceName
Description
Get a user by resource name. Requires viewer permissions at the global level
Example
Query
query UserByResourceName($resourceName: String!) {
userByResourceName(resourceName: $resourceName) {
avatar
avatarThumbnail
createdAt
displayName
email
fullName
globalRole
id
identities {
... on FederatedIdentity {
...FederatedIdentityFragment
}
... on LocalIdentity {
...LocalIdentityFragment
}
}
lastLoginAt
loginType
namespaces {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
resourceName
status
teams {
avatar
avatarThumbnail
createdAt
description
id
members {
...UserFragment
}
name
updatedAt
}
updatedAt
}
}
Variables
{"resourceName": "abc123"}
Response
{
"data": {
"userByResourceName": {
"avatar": DataUrl,
"avatarThumbnail": DataUrl,
"createdAt": "2007-12-03T10:15:30Z",
"displayName": "xyz789",
"email": "xyz789",
"fullName": "xyz789",
"globalRole": "ADMIN",
"id": UserId,
"identities": [FederatedIdentity],
"lastLoginAt": "2007-12-03T10:15:30Z",
"loginType": "GUEST",
"namespaces": [Namespace],
"resourceName": "abc123",
"status": "ACTIVE",
"teams": [Team],
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
usersList
Description
Get all users. Requires viewer permissions at the global level
Response
Returns [User!]!
Example
Query
query UsersList {
usersList {
avatar
avatarThumbnail
createdAt
displayName
email
fullName
globalRole
id
identities {
... on FederatedIdentity {
...FederatedIdentityFragment
}
... on LocalIdentity {
...LocalIdentityFragment
}
}
lastLoginAt
loginType
namespaces {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
resourceName
status
teams {
avatar
avatarThumbnail
createdAt
description
id
members {
...UserFragment
}
name
updatedAt
}
updatedAt
}
}
Response
{
"data": {
"usersList": [
{
"avatar": DataUrl,
"avatarThumbnail": DataUrl,
"createdAt": "2007-12-03T10:15:30Z",
"displayName": "xyz789",
"email": "xyz789",
"fullName": "abc123",
"globalRole": "ADMIN",
"id": UserId,
"identities": [FederatedIdentity],
"lastLoginAt": "2007-12-03T10:15:30Z",
"loginType": "GUEST",
"namespaces": [Namespace],
"resourceName": "xyz789",
"status": "ACTIVE",
"teams": [Team],
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
validator
Description
Get all validators in the ids list. Requires viewer permissions at the namespace level
Response
Returns a Validator
Arguments
| Name | Description |
|---|---|
id - ValidatorId!
|
Example
Query
query Validator($id: ValidatorId!) {
validator(id: $id) {
createdAt
description
hasCustomName
id
incidents {
backfillMode
createdAt
deviation
endTime
group {
...IncidentGroupFragment
}
id
lowerBound
severity
startTime
status
updatedAt
upperBound
value
}
metricValueFormat
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
progress {
percentage
processed
total
}
resourceName
sourceConfig {
filter
segmentation {
...SegmentationFragment
}
source {
...SourceFragment
}
sourceFilter {
...FilterFragment
}
window {
...WindowFragment
}
}
state
stateUpdatedAt
stats {
lastArtifactAt
lastIncidentAt
}
tags {
createdAt
id
key
origin
updatedAt
value
}
updatedAt
}
}
Variables
{"id": ValidatorId}
Response
{
"data": {
"validator": {
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"hasCustomName": false,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"resourceName": "xyz789",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
validatorByResourceName
Description
Get all validators by resource name and namespace Requires viewer permissions at the namespace level
Response
Returns a Validator
Arguments
| Name | Description |
|---|---|
namespaceId - NamespaceId!
|
|
resourceName - String!
|
Example
Query
query ValidatorByResourceName(
$namespaceId: NamespaceId!,
$resourceName: String!
) {
validatorByResourceName(
namespaceId: $namespaceId,
resourceName: $resourceName
) {
createdAt
description
hasCustomName
id
incidents {
backfillMode
createdAt
deviation
endTime
group {
...IncidentGroupFragment
}
id
lowerBound
severity
startTime
status
updatedAt
upperBound
value
}
metricValueFormat
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
progress {
percentage
processed
total
}
resourceName
sourceConfig {
filter
segmentation {
...SegmentationFragment
}
source {
...SourceFragment
}
sourceFilter {
...FilterFragment
}
window {
...WindowFragment
}
}
state
stateUpdatedAt
stats {
lastArtifactAt
lastIncidentAt
}
tags {
createdAt
id
key
origin
updatedAt
value
}
updatedAt
}
}
Variables
{
"namespaceId": NamespaceId,
"resourceName": "abc123"
}
Response
{
"data": {
"validatorByResourceName": {
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"hasCustomName": true,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"resourceName": "abc123",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
validatorMetricDebugInfo
Description
Given a metric id, get debug information about the data used to produced the metric set. For warehouses this is a SQL query that will be isolated to the passed time range and segmentation passed. Requires editor permissions at the namespace level
Response
Returns a ValidatorMetricDebugInfo!
Arguments
| Name | Description |
|---|---|
input - ValidatorMetricDebugInfoInput!
|
Example
Query
query ValidatorMetricDebugInfo($input: ValidatorMetricDebugInfoInput!) {
validatorMetricDebugInfo(input: $input) {
endTime
startTime
}
}
Variables
{"input": ValidatorMetricDebugInfoInput}
Response
{
"data": {
"validatorMetricDebugInfo": {
"endTime": "2007-12-03T10:15:30Z",
"startTime": "2007-12-03T10:15:30Z"
}
}
}
validatorMetricDebugRecords
Description
Given a metric id, use the query produced by validatorMetricDebugInfo and execute it, returning a sample from the table. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a DebugRecordsSample!
Arguments
| Name | Description |
|---|---|
input - ValidatorMetricDebugInfoInput!
|
Example
Query
query ValidatorMetricDebugRecords($input: ValidatorMetricDebugInfoInput!) {
validatorMetricDebugRecords(input: $input) {
columns
rows
}
}
Variables
{"input": ValidatorMetricDebugInfoInput}
Response
{
"data": {
"validatorMetricDebugRecords": {
"columns": ["abc123"],
"rows": [{}]
}
}
}
validatorSegmentMetrics
Description
Gets metrics for a validator and segment. Requires viewer permissions at the namespace level
Response
Returns a ValidatorMetricWithThresholdHistory!
Arguments
| Name | Description |
|---|---|
input - ValidatorSegmentMetricsInput!
|
Example
Query
query ValidatorSegmentMetrics($input: ValidatorSegmentMetricsInput!) {
validatorSegmentMetrics(input: $input) {
... on ValidatorMetricWithDifferenceThresholdHistory {
values {
...ValidatorMetricWithDifferenceThresholdFragment
}
}
... on ValidatorMetricWithDynamicThresholdHistory {
values {
...ValidatorMetricWithDynamicThresholdFragment
}
}
... on ValidatorMetricWithFixedThresholdHistory {
values {
...ValidatorMetricWithFixedThresholdFragment
}
}
}
}
Variables
{"input": ValidatorSegmentMetricsInput}
Response
{
"data": {
"validatorSegmentMetrics": ValidatorMetricWithDifferenceThresholdHistory
}
}
validatorsList
Description
Get all validators Requires viewer permissions at the namespace level
Response
Returns [Validator!]!
Arguments
| Name | Description |
|---|---|
filter - ResourceFilter
|
|
id - SourceId
|
Example
Query
query ValidatorsList(
$filter: ResourceFilter,
$id: SourceId
) {
validatorsList(
filter: $filter,
id: $id
) {
createdAt
description
hasCustomName
id
incidents {
backfillMode
createdAt
deviation
endTime
group {
...IncidentGroupFragment
}
id
lowerBound
severity
startTime
status
updatedAt
upperBound
value
}
metricValueFormat
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
progress {
percentage
processed
total
}
resourceName
sourceConfig {
filter
segmentation {
...SegmentationFragment
}
source {
...SourceFragment
}
sourceFilter {
...FilterFragment
}
window {
...WindowFragment
}
}
state
stateUpdatedAt
stats {
lastArtifactAt
lastIncidentAt
}
tags {
createdAt
id
key
origin
updatedAt
value
}
updatedAt
}
}
Variables
{
"filter": ResourceFilter,
"id": SourceId
}
Response
{
"data": {
"validatorsList": [
{
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"hasCustomName": false,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"resourceName": "xyz789",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
webhookChannelSecretChanged
Description
Check if secrets for a webhook channel is different compared to the passed input. Requires editor permissions at the namespace level
Response
Returns a WebhookChannelSecretChangedResult!
Arguments
| Name | Description |
|---|---|
input - WebhookChannelSecretChangedInput!
|
Example
Query
query WebhookChannelSecretChanged($input: WebhookChannelSecretChangedInput!) {
webhookChannelSecretChanged(input: $input) {
authHeader
errors {
code
message
}
}
}
Variables
{"input": WebhookChannelSecretChangedInput}
Response
{
"data": {
"webhookChannelSecretChanged": {
"authHeader": true,
"errors": [ApiError]
}
}
}
window
Description
Get all windows in the ids list. Requires viewer permissions at the namespace level
Example
Query
query Window($id: WindowId!) {
window(id: $id) {
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
updatedAt
}
}
Variables
{"id": WindowId}
Response
{
"data": {
"window": {
"createdAt": "2007-12-03T10:15:30Z",
"id": WindowId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
windowByResourceName
Description
Get a window by resource name. Requires viewer permissions at the namespace level
Response
Returns a Window
Arguments
| Name | Description |
|---|---|
namespaceId - NamespaceId!
|
|
resourceName - String!
|
Example
Query
query WindowByResourceName(
$namespaceId: NamespaceId!,
$resourceName: String!
) {
windowByResourceName(
namespaceId: $namespaceId,
resourceName: $resourceName
) {
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
updatedAt
}
}
Variables
{
"namespaceId": NamespaceId,
"resourceName": "xyz789"
}
Response
{
"data": {
"windowByResourceName": {
"createdAt": "2007-12-03T10:15:30Z",
"id": WindowId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
windowsList
Description
Get all windows. Requires viewer permissions at the namespace level
Response
Returns [Window!]!
Arguments
| Name | Description |
|---|---|
filter - ResourceFilter
|
Example
Query
query WindowsList($filter: ResourceFilter) {
windowsList(filter: $filter) {
createdAt
id
name
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
namespaceId
resourceName
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
updatedAt
}
}
Variables
{"filter": ResourceFilter}
Response
{
"data": {
"windowsList": [
{
"createdAt": "2007-12-03T10:15:30Z",
"id": WindowId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
Mutations
awsAthenaCredentialCreate
Description
Create an AWS Athena credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - AwsAthenaCredentialCreateInput!
|
Example
Query
mutation AwsAthenaCredentialCreate($input: AwsAthenaCredentialCreateInput!) {
awsAthenaCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AwsAthenaCredentialCreateInput}
Response
{
"data": {
"awsAthenaCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
awsAthenaCredentialUpdate
Description
Update an AWS Athena credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AwsAthenaCredentialUpdateInput!
|
Example
Query
mutation AwsAthenaCredentialUpdate($input: AwsAthenaCredentialUpdateInput!) {
awsAthenaCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AwsAthenaCredentialUpdateInput}
Response
{
"data": {
"awsAthenaCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
awsAthenaSourceCreate
Description
Create an AWS Athena source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - AwsAthenaSourceCreateInput!
|
Example
Query
mutation AwsAthenaSourceCreate($input: AwsAthenaSourceCreateInput!) {
awsAthenaSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AwsAthenaSourceCreateInput}
Response
{
"data": {
"awsAthenaSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
awsAthenaSourceUpdate
Description
Update an AWS Athena source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AwsAthenaSourceUpdateInput!
|
Example
Query
mutation AwsAthenaSourceUpdate($input: AwsAthenaSourceUpdateInput!) {
awsAthenaSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AwsAthenaSourceUpdateInput}
Response
{
"data": {
"awsAthenaSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
awsCredentialCreate
Description
Create an AWS credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - AwsCredentialCreateInput!
|
Example
Query
mutation AwsCredentialCreate($input: AwsCredentialCreateInput!) {
awsCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AwsCredentialCreateInput}
Response
{
"data": {
"awsCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
awsCredentialUpdate
Description
Update an AWS credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AwsCredentialUpdateInput!
|
Example
Query
mutation AwsCredentialUpdate($input: AwsCredentialUpdateInput!) {
awsCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AwsCredentialUpdateInput}
Response
{
"data": {
"awsCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
awsKinesisSourceCreate
Description
Create an AWS Kinesis source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - AwsKinesisSourceCreateInput!
|
Example
Query
mutation AwsKinesisSourceCreate($input: AwsKinesisSourceCreateInput!) {
awsKinesisSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AwsKinesisSourceCreateInput}
Response
{
"data": {
"awsKinesisSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
awsKinesisSourceUpdate
Description
Update an AWS Kinesis source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AwsKinesisSourceUpdateInput!
|
Example
Query
mutation AwsKinesisSourceUpdate($input: AwsKinesisSourceUpdateInput!) {
awsKinesisSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AwsKinesisSourceUpdateInput}
Response
{
"data": {
"awsKinesisSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
awsRedshiftCredentialCreate
Description
Create an AWS Redshift credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - AwsRedshiftCredentialCreateInput!
|
Example
Query
mutation AwsRedshiftCredentialCreate($input: AwsRedshiftCredentialCreateInput!) {
awsRedshiftCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AwsRedshiftCredentialCreateInput}
Response
{
"data": {
"awsRedshiftCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
awsRedshiftCredentialUpdate
Description
Update an AWS Redshift credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AwsRedshiftCredentialUpdateInput!
|
Example
Query
mutation AwsRedshiftCredentialUpdate($input: AwsRedshiftCredentialUpdateInput!) {
awsRedshiftCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AwsRedshiftCredentialUpdateInput}
Response
{
"data": {
"awsRedshiftCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
awsRedshiftSourceCreate
Description
Create an AWS Redshift source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - AwsRedshiftSourceCreateInput!
|
Example
Query
mutation AwsRedshiftSourceCreate($input: AwsRedshiftSourceCreateInput!) {
awsRedshiftSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AwsRedshiftSourceCreateInput}
Response
{
"data": {
"awsRedshiftSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
awsRedshiftSourceUpdate
Description
Update an AWS Redshift source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AwsRedshiftSourceUpdateInput!
|
Example
Query
mutation AwsRedshiftSourceUpdate($input: AwsRedshiftSourceUpdateInput!) {
awsRedshiftSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AwsRedshiftSourceUpdateInput}
Response
{
"data": {
"awsRedshiftSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
awsS3SourceCreate
Description
Create an AWS S3 source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - AwsS3SourceCreateInput!
|
Example
Query
mutation AwsS3SourceCreate($input: AwsS3SourceCreateInput!) {
awsS3SourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AwsS3SourceCreateInput}
Response
{
"data": {
"awsS3SourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
awsS3SourceUpdate
Description
Update an AWS S3 source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AwsS3SourceUpdateInput!
|
Example
Query
mutation AwsS3SourceUpdate($input: AwsS3SourceUpdateInput!) {
awsS3SourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AwsS3SourceUpdateInput}
Response
{
"data": {
"awsS3SourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
azureSynapseEntraIdCredentialCreate
Description
Create an Azure Synapse Entra ID credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - AzureSynapseEntraIdCredentialCreateInput!
|
Example
Query
mutation AzureSynapseEntraIdCredentialCreate($input: AzureSynapseEntraIdCredentialCreateInput!) {
azureSynapseEntraIdCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AzureSynapseEntraIdCredentialCreateInput}
Response
{
"data": {
"azureSynapseEntraIdCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
azureSynapseEntraIdCredentialUpdate
Description
Update an Azure Synapse Entra ID credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AzureSynapseEntraIdCredentialUpdateInput!
|
Example
Query
mutation AzureSynapseEntraIdCredentialUpdate($input: AzureSynapseEntraIdCredentialUpdateInput!) {
azureSynapseEntraIdCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AzureSynapseEntraIdCredentialUpdateInput}
Response
{
"data": {
"azureSynapseEntraIdCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
azureSynapseSourceCreate
Description
Create an Azure Synapse source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - AzureSynapseSourceCreateInput!
|
Example
Query
mutation AzureSynapseSourceCreate($input: AzureSynapseSourceCreateInput!) {
azureSynapseSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AzureSynapseSourceCreateInput}
Response
{
"data": {
"azureSynapseSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
azureSynapseSourceUpdate
Description
Update an Azure Synapse source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AzureSynapseSourceUpdateInput!
|
Example
Query
mutation AzureSynapseSourceUpdate($input: AzureSynapseSourceUpdateInput!) {
azureSynapseSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": AzureSynapseSourceUpdateInput}
Response
{
"data": {
"azureSynapseSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
azureSynapseSqlCredentialCreate
Description
Create an Azure Synapse credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - AzureSynapseSqlCredentialCreateInput!
|
Example
Query
mutation AzureSynapseSqlCredentialCreate($input: AzureSynapseSqlCredentialCreateInput!) {
azureSynapseSqlCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AzureSynapseSqlCredentialCreateInput}
Response
{
"data": {
"azureSynapseSqlCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
azureSynapseSqlCredentialUpdate
Description
Update an Azure Synapse credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - AzureSynapseSqlCredentialUpdateInput!
|
Example
Query
mutation AzureSynapseSqlCredentialUpdate($input: AzureSynapseSqlCredentialUpdateInput!) {
azureSynapseSqlCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": AzureSynapseSqlCredentialUpdateInput}
Response
{
"data": {
"azureSynapseSqlCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
booleanFilterCreate
Description
Create a boolean filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - BooleanFilterCreateInput!
|
Example
Query
mutation BooleanFilterCreate($input: BooleanFilterCreateInput!) {
booleanFilterCreate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": BooleanFilterCreateInput}
Response
{
"data": {
"booleanFilterCreate": {
"errors": [ApiError],
"filter": Filter
}
}
}
booleanFilterUpdate
Description
Update a boolean filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - BooleanFilterUpdateInput!
|
Example
Query
mutation BooleanFilterUpdate($input: BooleanFilterUpdateInput!) {
booleanFilterUpdate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": BooleanFilterUpdateInput}
Response
{
"data": {
"booleanFilterUpdate": {
"errors": [ApiError],
"filter": Filter
}
}
}
catalogAssetTagsAdd
These APIs are expected to change substantially in the near future. Use catalogAssetUpdate instead
Description
Add tags to a catalog asset. Requires editor permissions at the global level
Response
Returns a TagAddResult!
Arguments
| Name | Description |
|---|---|
input - CatalogAssetTagsAddInput!
|
Example
Query
mutation CatalogAssetTagsAdd($input: CatalogAssetTagsAddInput!) {
catalogAssetTagsAdd(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": CatalogAssetTagsAddInput}
Response
{"data": {"catalogAssetTagsAdd": {"errors": [ApiError]}}}
catalogAssetTagsDelete
These APIs are expected to change substantially in the near future. Use catalogAssetUpdate instead
Description
Delete tags from a catalog asset. Requires editor permissions at the global level
Response
Returns a TagDeleteResult!
Arguments
| Name | Description |
|---|---|
input - CatalogAssetTagsDeleteInput!
|
Example
Query
mutation CatalogAssetTagsDelete($input: CatalogAssetTagsDeleteInput!) {
catalogAssetTagsDelete(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": CatalogAssetTagsDeleteInput}
Response
{
"data": {
"catalogAssetTagsDelete": {"errors": [ApiError]}
}
}
categoricalDistributionValidatorUpdate
Description
Update a categorical distribution validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUpdateResult!
Arguments
| Name | Description |
|---|---|
input - CategoricalDistributionValidatorUpdateInput!
|
Example
Query
mutation CategoricalDistributionValidatorUpdate($input: CategoricalDistributionValidatorUpdateInput!) {
categoricalDistributionValidatorUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": CategoricalDistributionValidatorUpdateInput}
Response
{
"data": {
"categoricalDistributionValidatorUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
categoricalDistributionValidatorWithDifferenceThresholdCreate
Description
Create a categorical distribution validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - CategoricalDistributionValidatorCreateInput!
|
|
threshold - DifferenceThresholdCreateInput!
|
Example
Query
mutation CategoricalDistributionValidatorWithDifferenceThresholdCreate(
$input: CategoricalDistributionValidatorCreateInput!,
$threshold: DifferenceThresholdCreateInput!
) {
categoricalDistributionValidatorWithDifferenceThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": CategoricalDistributionValidatorCreateInput,
"threshold": DifferenceThresholdCreateInput
}
Response
{
"data": {
"categoricalDistributionValidatorWithDifferenceThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
categoricalDistributionValidatorWithDynamicThresholdCreate
Description
Create a categorical distribution validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - CategoricalDistributionValidatorCreateInput!
|
|
threshold - DynamicThresholdCreateInput!
|
Example
Query
mutation CategoricalDistributionValidatorWithDynamicThresholdCreate(
$input: CategoricalDistributionValidatorCreateInput!,
$threshold: DynamicThresholdCreateInput!
) {
categoricalDistributionValidatorWithDynamicThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": CategoricalDistributionValidatorCreateInput,
"threshold": DynamicThresholdCreateInput
}
Response
{
"data": {
"categoricalDistributionValidatorWithDynamicThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
categoricalDistributionValidatorWithFixedThresholdCreate
Description
Create a categorical distribution validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - CategoricalDistributionValidatorCreateInput!
|
|
threshold - FixedThresholdCreateInput!
|
Example
Query
mutation CategoricalDistributionValidatorWithFixedThresholdCreate(
$input: CategoricalDistributionValidatorCreateInput!,
$threshold: FixedThresholdCreateInput!
) {
categoricalDistributionValidatorWithFixedThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": CategoricalDistributionValidatorCreateInput,
"threshold": FixedThresholdCreateInput
}
Response
{
"data": {
"categoricalDistributionValidatorWithFixedThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
channelDelete
Use
channelsDelete instead. Description
Deletes a notification channel. Requires editor permissions at the namespace level
Response
Returns a ChannelDeleteResult!
Arguments
| Name | Description |
|---|---|
input - ChannelDeleteInput!
|
Example
Query
mutation ChannelDelete($input: ChannelDeleteInput!) {
channelDelete(input: $input) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": ChannelDeleteInput}
Response
{
"data": {
"channelDelete": {
"channel": Channel,
"errors": [ApiError]
}
}
}
channelNamespaceUpdate
Description
Move a channel to a different namespace. Requires editor permissions at the namespace level
Response
Returns a ResourceNamespaceUpdatedResult!
Arguments
| Name | Description |
|---|---|
input - ResourceNamespaceUpdateInput!
|
Example
Query
mutation ChannelNamespaceUpdate($input: ResourceNamespaceUpdateInput!) {
channelNamespaceUpdate(input: $input) {
errors {
code
message
}
namespaceId
resourceName
}
}
Variables
{"input": ResourceNamespaceUpdateInput}
Response
{
"data": {
"channelNamespaceUpdate": {
"errors": [ApiError],
"namespaceId": NamespaceId,
"resourceName": "abc123"
}
}
}
clickHouseCredentialCreate
Description
Create a ClickHouse credential. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - ClickHouseCredentialCreateInput!
|
Example
Query
mutation ClickHouseCredentialCreate($input: ClickHouseCredentialCreateInput!) {
clickHouseCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": ClickHouseCredentialCreateInput}
Response
{
"data": {
"clickHouseCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
clickHouseCredentialUpdate
Description
Update a ClickHouse credential. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - ClickHouseCredentialUpdateInput!
|
Example
Query
mutation ClickHouseCredentialUpdate($input: ClickHouseCredentialUpdateInput!) {
clickHouseCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": ClickHouseCredentialUpdateInput}
Response
{
"data": {
"clickHouseCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
clickHouseSourceCreate
Description
Create a ClickHouse source. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - ClickHouseSourceCreateInput!
|
Example
Query
mutation ClickHouseSourceCreate($input: ClickHouseSourceCreateInput!) {
clickHouseSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": ClickHouseSourceCreateInput}
Response
{
"data": {
"clickHouseSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
clickHouseSourceUpdate
Description
Update a ClickHouse source. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - ClickHouseSourceUpdateInput!
|
Example
Query
mutation ClickHouseSourceUpdate($input: ClickHouseSourceUpdateInput!) {
clickHouseSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": ClickHouseSourceUpdateInput}
Response
{
"data": {
"clickHouseSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
credentialNamespaceUpdate
Description
Move a credential to a different namespace. Requires editor permissions at the namespace level
Response
Returns a ResourceNamespaceUpdatedResult!
Arguments
| Name | Description |
|---|---|
input - ResourceNamespaceUpdateInput!
|
Example
Query
mutation CredentialNamespaceUpdate($input: ResourceNamespaceUpdateInput!) {
credentialNamespaceUpdate(input: $input) {
errors {
code
message
}
namespaceId
resourceName
}
}
Variables
{"input": ResourceNamespaceUpdateInput}
Response
{
"data": {
"credentialNamespaceUpdate": {
"errors": [ApiError],
"namespaceId": NamespaceId,
"resourceName": "xyz789"
}
}
}
credentialsDelete
Description
Delete credentials in the ids list. Requires editor permissions at the namespace level
Response
Returns a CredentialsDeleteResult!
Arguments
| Name | Description |
|---|---|
ids - [CredentialId!]!
|
Example
Query
mutation CredentialsDelete($ids: [CredentialId!]!) {
credentialsDelete(ids: $ids) {
errors {
code
message
}
}
}
Variables
{"ids": [CredentialId]}
Response
{"data": {"credentialsDelete": {"errors": [ApiError]}}}
databricksCredentialCreate
Description
Create a Databricks credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - DatabricksCredentialCreateInput!
|
Example
Query
mutation DatabricksCredentialCreate($input: DatabricksCredentialCreateInput!) {
databricksCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": DatabricksCredentialCreateInput}
Response
{
"data": {
"databricksCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
databricksCredentialUpdate
Description
Update a Databricks credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - DatabricksCredentialUpdateInput!
|
Example
Query
mutation DatabricksCredentialUpdate($input: DatabricksCredentialUpdateInput!) {
databricksCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": DatabricksCredentialUpdateInput}
Response
{
"data": {
"databricksCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
databricksSourceCreate
Description
Create a Databricks source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - DatabricksSourceCreateInput!
|
Example
Query
mutation DatabricksSourceCreate($input: DatabricksSourceCreateInput!) {
databricksSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": DatabricksSourceCreateInput}
Response
{
"data": {
"databricksSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
databricksSourceUpdate
Description
Update a Databricks source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - DatabricksSourceUpdateInput!
|
Example
Query
mutation DatabricksSourceUpdate($input: DatabricksSourceUpdateInput!) {
databricksSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": DatabricksSourceUpdateInput}
Response
{
"data": {
"databricksSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
dbtArtifactMultipartUploadAppendPart
Description
Append a part of the artifact during a multipart upload. Requires viewer permissions at the global level. Has a timeout of 120 seconds
Response
Returns a DbtArtifactMultipartUploadResult!
Arguments
| Name | Description |
|---|---|
input - DbtArtifactMultipartUploadAppendPartInput!
|
Example
Query
mutation DbtArtifactMultipartUploadAppendPart($input: DbtArtifactMultipartUploadAppendPartInput!) {
dbtArtifactMultipartUploadAppendPart(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": DbtArtifactMultipartUploadAppendPartInput}
Response
{
"data": {
"dbtArtifactMultipartUploadAppendPart": {
"errors": [ApiError]
}
}
}
dbtArtifactMultipartUploadComplete
Description
After all parts have been appended, this method will start the processing of the uploaded artifact. Requires viewer permissions at the global level. Has a timeout of 120 seconds
Response
Returns a DbtArtifactMultipartUploadResult!
Arguments
| Name | Description |
|---|---|
input - DbtArtifactMultipartUploadCompleteInput!
|
Example
Query
mutation DbtArtifactMultipartUploadComplete($input: DbtArtifactMultipartUploadCompleteInput!) {
dbtArtifactMultipartUploadComplete(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": DbtArtifactMultipartUploadCompleteInput}
Response
{
"data": {
"dbtArtifactMultipartUploadComplete": {
"errors": [ApiError]
}
}
}
dbtArtifactMultipartUploadCreate
Description
Begin multipart upload of a dbt artifact. This returns an upload id to be used with dbtArtifactMultipartUploadAppendPart. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a DbtArtifactMultipartUploadCreateResult!
Arguments
| Name | Description |
|---|---|
input - DbtArtifactMultipartUploadCreateInput!
|
Example
Query
mutation DbtArtifactMultipartUploadCreate($input: DbtArtifactMultipartUploadCreateInput!) {
dbtArtifactMultipartUploadCreate(input: $input) {
errors {
code
message
}
id
}
}
Variables
{"input": DbtArtifactMultipartUploadCreateInput}
Response
{
"data": {
"dbtArtifactMultipartUploadCreate": {
"errors": [ApiError],
"id": DbtArtifactMultipartUploadId
}
}
}
dbtArtifactUpload
Description
Upload dbt artifacts. Requires editor permissions at the namespace level. Has a timeout of 120 seconds
Response
Returns a DbtArtifactUploadResult!
Arguments
| Name | Description |
|---|---|
input - DbtArtifactUploadInput!
|
Example
Query
mutation DbtArtifactUpload($input: DbtArtifactUploadInput!) {
dbtArtifactUpload(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": DbtArtifactUploadInput}
Response
{"data": {"dbtArtifactUpload": {"errors": [ApiError]}}}
dbtCloudCredentialCreate
Description
Create a dbt Cloud credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - DbtCloudCredentialCreateInput!
|
Example
Query
mutation DbtCloudCredentialCreate($input: DbtCloudCredentialCreateInput!) {
dbtCloudCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": DbtCloudCredentialCreateInput}
Response
{
"data": {
"dbtCloudCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
dbtCloudCredentialUpdate
Description
Update a dbt Cloud credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - DbtCloudCredentialUpdateInput!
|
Example
Query
mutation DbtCloudCredentialUpdate($input: DbtCloudCredentialUpdateInput!) {
dbtCloudCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": DbtCloudCredentialUpdateInput}
Response
{
"data": {
"dbtCloudCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
dbtCoreCredentialCreate
Description
Create a dbt Core credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - DbtCoreCredentialCreateInput!
|
Example
Query
mutation DbtCoreCredentialCreate($input: DbtCoreCredentialCreateInput!) {
dbtCoreCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": DbtCoreCredentialCreateInput}
Response
{
"data": {
"dbtCoreCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
dbtCoreCredentialUpdate
Description
Update a dbt Core credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - DbtCoreCredentialUpdateInput!
|
Example
Query
mutation DbtCoreCredentialUpdate($input: DbtCoreCredentialUpdateInput!) {
dbtCoreCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": DbtCoreCredentialUpdateInput}
Response
{
"data": {
"dbtCoreCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
dbtModelRunSourceCreate
Description
Create a dbt model run source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - DbtModelRunSourceCreateInput!
|
Example
Query
mutation DbtModelRunSourceCreate($input: DbtModelRunSourceCreateInput!) {
dbtModelRunSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": DbtModelRunSourceCreateInput}
Response
{
"data": {
"dbtModelRunSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
dbtModelRunSourceUpdate
Description
Update a dbt model run source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - DbtModelRunSourceUpdateInput!
|
Example
Query
mutation DbtModelRunSourceUpdate($input: DbtModelRunSourceUpdateInput!) {
dbtModelRunSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": DbtModelRunSourceUpdateInput}
Response
{
"data": {
"dbtModelRunSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
dbtTestResultSourceCreate
Description
Create a dbt test result source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - DbtTestResultSourceCreateInput!
|
Example
Query
mutation DbtTestResultSourceCreate($input: DbtTestResultSourceCreateInput!) {
dbtTestResultSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": DbtTestResultSourceCreateInput}
Response
{
"data": {
"dbtTestResultSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
dbtTestResultSourceUpdate
Description
Update a dbt test result source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - DbtTestResultSourceUpdateInput!
|
Example
Query
mutation DbtTestResultSourceUpdate($input: DbtTestResultSourceUpdateInput!) {
dbtTestResultSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": DbtTestResultSourceUpdateInput}
Response
{
"data": {
"dbtTestResultSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
demoCredentialCreate
Description
Create a demo credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - DemoCredentialCreateInput!
|
Example
Query
mutation DemoCredentialCreate($input: DemoCredentialCreateInput!) {
demoCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": DemoCredentialCreateInput}
Response
{
"data": {
"demoCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
demoCredentialUpdate
Description
Update a demo credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - DemoCredentialUpdateInput!
|
Example
Query
mutation DemoCredentialUpdate($input: DemoCredentialUpdateInput!) {
demoCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": DemoCredentialUpdateInput}
Response
{
"data": {
"demoCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
demoSourceCreate
Description
Create a demo source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - DemoSourceCreateInput!
|
Example
Query
mutation DemoSourceCreate($input: DemoSourceCreateInput!) {
demoSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": DemoSourceCreateInput}
Response
{
"data": {
"demoSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
demoSourceUpdate
Description
Update a demo source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - DemoSourceUpdateInput!
|
Example
Query
mutation DemoSourceUpdate($input: DemoSourceUpdateInput!) {
demoSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": DemoSourceUpdateInput}
Response
{
"data": {
"demoSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
enumFilterCreate
Description
Create an enum filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - EnumFilterCreateInput!
|
Example
Query
mutation EnumFilterCreate($input: EnumFilterCreateInput!) {
enumFilterCreate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": EnumFilterCreateInput}
Response
{
"data": {
"enumFilterCreate": {
"errors": [ApiError],
"filter": Filter
}
}
}
enumFilterUpdate
Description
Update an enum filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - EnumFilterUpdateInput!
|
Example
Query
mutation EnumFilterUpdate($input: EnumFilterUpdateInput!) {
enumFilterUpdate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": EnumFilterUpdateInput}
Response
{
"data": {
"enumFilterUpdate": {
"errors": [ApiError],
"filter": Filter
}
}
}
fileWindowCreate
Description
Create a file window. Requires editor permissions at the namespace level
Response
Returns a WindowCreateResult!
Arguments
| Name | Description |
|---|---|
input - FileWindowCreateInput!
|
Example
Query
mutation FileWindowCreate($input: FileWindowCreateInput!) {
fileWindowCreate(input: $input) {
errors {
code
message
}
window {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": FileWindowCreateInput}
Response
{
"data": {
"fileWindowCreate": {
"errors": [ApiError],
"window": Window
}
}
}
fileWindowUpdate
Description
Update a file window. Requires editor permissions at the namespace level
Response
Returns a WindowUpdateResult!
Arguments
| Name | Description |
|---|---|
input - FileWindowUpdateInput!
|
Example
Query
mutation FileWindowUpdate($input: FileWindowUpdateInput!) {
fileWindowUpdate(input: $input) {
errors {
code
message
}
window {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": FileWindowUpdateInput}
Response
{
"data": {
"fileWindowUpdate": {
"errors": [ApiError],
"window": Window
}
}
}
filtersDelete
Description
Delete filters in the ids list. Requires editor permissions at the namespace level
Response
Returns a FiltersDeleteResult!
Arguments
| Name | Description |
|---|---|
ids - [FilterId!]!
|
Example
Query
mutation FiltersDelete($ids: [FilterId!]!) {
filtersDelete(ids: $ids) {
errors {
code
message
}
}
}
Variables
{"ids": [FilterId]}
Response
{"data": {"filtersDelete": {"errors": [ApiError]}}}
fixedBatchWindowCreate
Description
Create a fixed batch window. Requires editor permissions at the namespace level
Response
Returns a WindowCreateResult!
Arguments
| Name | Description |
|---|---|
input - FixedBatchWindowCreateInput!
|
Example
Query
mutation FixedBatchWindowCreate($input: FixedBatchWindowCreateInput!) {
fixedBatchWindowCreate(input: $input) {
errors {
code
message
}
window {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": FixedBatchWindowCreateInput}
Response
{
"data": {
"fixedBatchWindowCreate": {
"errors": [ApiError],
"window": Window
}
}
}
fixedBatchWindowUpdate
Description
Update a fixed batch window. Requires editor permissions at the namespace level
Response
Returns a WindowUpdateResult!
Arguments
| Name | Description |
|---|---|
input - FixedBatchWindowUpdateInput!
|
Example
Query
mutation FixedBatchWindowUpdate($input: FixedBatchWindowUpdateInput!) {
fixedBatchWindowUpdate(input: $input) {
errors {
code
message
}
window {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": FixedBatchWindowUpdateInput}
Response
{
"data": {
"fixedBatchWindowUpdate": {
"errors": [ApiError],
"window": Window
}
}
}
freshnessValidatorUpdate
Description
Update a freshness validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUpdateResult!
Arguments
| Name | Description |
|---|---|
input - FreshnessValidatorUpdateInput!
|
Example
Query
mutation FreshnessValidatorUpdate($input: FreshnessValidatorUpdateInput!) {
freshnessValidatorUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": FreshnessValidatorUpdateInput}
Response
{
"data": {
"freshnessValidatorUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
freshnessValidatorWithDifferenceThresholdCreate
Description
Create a freshness validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - FreshnessValidatorCreateInput!
|
|
threshold - DifferenceThresholdCreateInput!
|
Example
Query
mutation FreshnessValidatorWithDifferenceThresholdCreate(
$input: FreshnessValidatorCreateInput!,
$threshold: DifferenceThresholdCreateInput!
) {
freshnessValidatorWithDifferenceThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": FreshnessValidatorCreateInput,
"threshold": DifferenceThresholdCreateInput
}
Response
{
"data": {
"freshnessValidatorWithDifferenceThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
freshnessValidatorWithDynamicThresholdCreate
Description
Create a freshness validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - FreshnessValidatorCreateInput!
|
|
threshold - DynamicThresholdCreateInput!
|
Example
Query
mutation FreshnessValidatorWithDynamicThresholdCreate(
$input: FreshnessValidatorCreateInput!,
$threshold: DynamicThresholdCreateInput!
) {
freshnessValidatorWithDynamicThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": FreshnessValidatorCreateInput,
"threshold": DynamicThresholdCreateInput
}
Response
{
"data": {
"freshnessValidatorWithDynamicThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
freshnessValidatorWithFixedThresholdCreate
Description
Create a freshness validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - FreshnessValidatorCreateInput!
|
|
threshold - FixedThresholdCreateInput!
|
Example
Query
mutation FreshnessValidatorWithFixedThresholdCreate(
$input: FreshnessValidatorCreateInput!,
$threshold: FixedThresholdCreateInput!
) {
freshnessValidatorWithFixedThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": FreshnessValidatorCreateInput,
"threshold": FixedThresholdCreateInput
}
Response
{
"data": {
"freshnessValidatorWithFixedThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
gcpBigQuerySourceCreate
Description
Create a Google BigQuery source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - GcpBigQuerySourceCreateInput!
|
Example
Query
mutation GcpBigQuerySourceCreate($input: GcpBigQuerySourceCreateInput!) {
gcpBigQuerySourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": GcpBigQuerySourceCreateInput}
Response
{
"data": {
"gcpBigQuerySourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
gcpBigQuerySourceUpdate
Description
Update a Google BigQuery source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - GcpBigQuerySourceUpdateInput!
|
Example
Query
mutation GcpBigQuerySourceUpdate($input: GcpBigQuerySourceUpdateInput!) {
gcpBigQuerySourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": GcpBigQuerySourceUpdateInput}
Response
{
"data": {
"gcpBigQuerySourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
gcpCredentialCreate
Description
Create a Google Cloud Platform credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - GcpCredentialCreateInput!
|
Example
Query
mutation GcpCredentialCreate($input: GcpCredentialCreateInput!) {
gcpCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": GcpCredentialCreateInput}
Response
{
"data": {
"gcpCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
gcpCredentialUpdate
Description
Update a Google Cloud Platform credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - GcpCredentialUpdateInput!
|
Example
Query
mutation GcpCredentialUpdate($input: GcpCredentialUpdateInput!) {
gcpCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": GcpCredentialUpdateInput}
Response
{
"data": {
"gcpCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
gcpPubSubLiteSourceCreate
Description
Create a Google Pub/Sub lite source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - GcpPubSubLiteSourceCreateInput!
|
Example
Query
mutation GcpPubSubLiteSourceCreate($input: GcpPubSubLiteSourceCreateInput!) {
gcpPubSubLiteSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": GcpPubSubLiteSourceCreateInput}
Response
{
"data": {
"gcpPubSubLiteSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
gcpPubSubLiteSourceUpdate
Description
Update a Google Pub/Sub lite source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - GcpPubSubLiteSourceUpdateInput!
|
Example
Query
mutation GcpPubSubLiteSourceUpdate($input: GcpPubSubLiteSourceUpdateInput!) {
gcpPubSubLiteSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": GcpPubSubLiteSourceUpdateInput}
Response
{
"data": {
"gcpPubSubLiteSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
gcpPubSubSourceCreate
Description
Create a Google Pub/Sub source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - GcpPubSubSourceCreateInput!
|
Example
Query
mutation GcpPubSubSourceCreate($input: GcpPubSubSourceCreateInput!) {
gcpPubSubSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": GcpPubSubSourceCreateInput}
Response
{
"data": {
"gcpPubSubSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
gcpPubSubSourceUpdate
Description
Update a Google Pub/Sub source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - GcpPubSubSourceUpdateInput!
|
Example
Query
mutation GcpPubSubSourceUpdate($input: GcpPubSubSourceUpdateInput!) {
gcpPubSubSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": GcpPubSubSourceUpdateInput}
Response
{
"data": {
"gcpPubSubSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
gcpStorageSourceCreate
Description
Create a Google Cloud Storage source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - GcpStorageSourceCreateInput!
|
Example
Query
mutation GcpStorageSourceCreate($input: GcpStorageSourceCreateInput!) {
gcpStorageSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": GcpStorageSourceCreateInput}
Response
{
"data": {
"gcpStorageSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
gcpStorageSourceUpdate
Description
Update a Google Cloud Storage source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - GcpStorageSourceUpdateInput!
|
Example
Query
mutation GcpStorageSourceUpdate($input: GcpStorageSourceUpdateInput!) {
gcpStorageSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": GcpStorageSourceUpdateInput}
Response
{
"data": {
"gcpStorageSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
globalWindowCreate
Description
Create a global window. Requires editor permissions at the namespace level
Response
Returns a WindowCreateResult!
Arguments
| Name | Description |
|---|---|
input - GlobalWindowCreateInput!
|
Example
Query
mutation GlobalWindowCreate($input: GlobalWindowCreateInput!) {
globalWindowCreate(input: $input) {
errors {
code
message
}
window {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": GlobalWindowCreateInput}
Response
{
"data": {
"globalWindowCreate": {
"errors": [ApiError],
"window": Window
}
}
}
globalWindowUpdate
Description
Update a global window. Requires editor permissions at the namespace level
Response
Returns a WindowUpdateResult!
Arguments
| Name | Description |
|---|---|
input - GlobalWindowUpdateInput!
|
Example
Query
mutation GlobalWindowUpdate($input: GlobalWindowUpdateInput!) {
globalWindowUpdate(input: $input) {
errors {
code
message
}
window {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": GlobalWindowUpdateInput}
Response
{
"data": {
"globalWindowUpdate": {
"errors": [ApiError],
"window": Window
}
}
}
identityDelete
Description
Deletes an identity provider connection for a user. Requires admin permissions at the global level
Response
Returns an IdentityDeleteResult!
Arguments
| Name | Description |
|---|---|
input - IdentityDeleteInput!
|
Example
Query
mutation IdentityDelete($input: IdentityDeleteInput!) {
identityDelete(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": IdentityDeleteInput}
Response
{
"data": {
"identityDelete": {"errors": [IdentityDeleteError]}
}
}
identityProviderDelete
Description
Deletes an identity provider configuration. Requires admin permissions at the global level
Response
Returns an IdentityProviderDeleteResult!
Arguments
| Name | Description |
|---|---|
input - IdentityProviderDeleteInput!
|
Example
Query
mutation IdentityProviderDelete($input: IdentityProviderDeleteInput!) {
identityProviderDelete(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": IdentityProviderDeleteInput}
Response
{
"data": {
"identityProviderDelete": {
"errors": [IdentityProviderDeleteError]
}
}
}
incidentGroupMute
Use 'incidentsMute'
Description
Mute an incident group, stopping reports from one specific incident group. Requires editor permissions at the namespace level
Response
Returns an IncidentGroupMuteResult!
Arguments
| Name | Description |
|---|---|
id - IncidentGroupId!
|
|
until - DateTime!
|
Example
Query
mutation IncidentGroupMute(
$id: IncidentGroupId!,
$until: DateTime!
) {
incidentGroupMute(
id: $id,
until: $until
) {
errors {
code
message
}
}
}
Variables
{
"id": IncidentGroupId,
"until": "2007-12-03T10:15:30Z"
}
Response
{"data": {"incidentGroupMute": {"errors": [ApiError]}}}
incidentGroupOwnerUpdate
Description
Update owner of an incident group. Requires editor permissions at the namespace level
Response
Returns an IncidentGroupOwnerUpdateResult!
Arguments
| Name | Description |
|---|---|
input - IncidentGroupOwnerUpdateInput!
|
Example
Query
mutation IncidentGroupOwnerUpdate($input: IncidentGroupOwnerUpdateInput!) {
incidentGroupOwnerUpdate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": IncidentGroupOwnerUpdateInput}
Response
{
"data": {
"incidentGroupOwnerUpdate": {"errors": [ApiError]}
}
}
incidentGroupStatusUpdate
Description
Requires editor permissions at the namespace level
Response
Returns an IncidentStatusUpdateResult!
Arguments
| Name | Description |
|---|---|
input - IncidentGroupStatusUpdateInput!
|
Example
Query
mutation IncidentGroupStatusUpdate($input: IncidentGroupStatusUpdateInput!) {
incidentGroupStatusUpdate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": IncidentGroupStatusUpdateInput}
Response
{
"data": {
"incidentGroupStatusUpdate": {"errors": [ApiError]}
}
}
incidentGroupUnmute
Use 'incidentsUnmute'
Description
Unmute an incident group, resuming reports of incidents from one specific incident group. Requires editor permissions at the namespace level
Response
Returns an IncidentGroupUnmuteResult!
Arguments
| Name | Description |
|---|---|
id - IncidentGroupId!
|
Example
Query
mutation IncidentGroupUnmute($id: IncidentGroupId!) {
incidentGroupUnmute(id: $id) {
errors {
code
message
}
}
}
Variables
{"id": IncidentGroupId}
Response
{"data": {"incidentGroupUnmute": {"errors": [ApiError]}}}
incidentStatusUpdate
Description
Update status of an incident. Requires editor permissions at the namespace level
Response
Returns an IncidentStatusUpdateResult!
Arguments
| Name | Description |
|---|---|
input - IncidentStatusUpdateInput!
|
Example
Query
mutation IncidentStatusUpdate($input: IncidentStatusUpdateInput!) {
incidentStatusUpdate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": IncidentStatusUpdateInput}
Response
{"data": {"incidentStatusUpdate": {"errors": [ApiError]}}}
incidentsMute
Description
Requires editor permissions at the namespace level
Response
Returns an IncidentsMuteResult!
Arguments
| Name | Description |
|---|---|
input - MuteIncidentsInput!
|
|
until - DateTime!
|
Example
Query
mutation IncidentsMute(
$input: MuteIncidentsInput!,
$until: DateTime!
) {
incidentsMute(
input: $input,
until: $until
) {
errors {
code
message
}
}
}
Variables
{
"input": MuteIncidentsInput,
"until": "2007-12-03T10:15:30Z"
}
Response
{"data": {"incidentsMute": {"errors": [ApiError]}}}
incidentsUnmute
Description
Requires editor permissions at the namespace level
Response
Returns an IncidentsUnmuteResult!
Arguments
| Name | Description |
|---|---|
input - MuteIncidentsInput!
|
Example
Query
mutation IncidentsUnmute($input: MuteIncidentsInput!) {
incidentsUnmute(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": MuteIncidentsInput}
Response
{"data": {"incidentsUnmute": {"errors": [ApiError]}}}
kafkaSaslSslPlainCredentialCreate
Description
Create a Kafka SASL SSL credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - KafkaSaslSslPlainCredentialCreateInput!
|
Example
Query
mutation KafkaSaslSslPlainCredentialCreate($input: KafkaSaslSslPlainCredentialCreateInput!) {
kafkaSaslSslPlainCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": KafkaSaslSslPlainCredentialCreateInput}
Response
{
"data": {
"kafkaSaslSslPlainCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
kafkaSaslSslPlainCredentialUpdate
Description
Update a Kafka SASL SSL credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - KafkaSaslSslPlainCredentialUpdateInput!
|
Example
Query
mutation KafkaSaslSslPlainCredentialUpdate($input: KafkaSaslSslPlainCredentialUpdateInput!) {
kafkaSaslSslPlainCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": KafkaSaslSslPlainCredentialUpdateInput}
Response
{
"data": {
"kafkaSaslSslPlainCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
kafkaSourceCreate
Description
Create a Kafka source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - KafkaSourceCreateInput!
|
Example
Query
mutation KafkaSourceCreate($input: KafkaSourceCreateInput!) {
kafkaSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": KafkaSourceCreateInput}
Response
{
"data": {
"kafkaSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
kafkaSourceUpdate
Description
Update a Kafka source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - KafkaSourceUpdateInput!
|
Example
Query
mutation KafkaSourceUpdate($input: KafkaSourceUpdateInput!) {
kafkaSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": KafkaSourceUpdateInput}
Response
{
"data": {
"kafkaSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
kafkaSslCredentialCreate
Description
Create a Kafka SSL credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - KafkaSslCredentialCreateInput!
|
Example
Query
mutation KafkaSslCredentialCreate($input: KafkaSslCredentialCreateInput!) {
kafkaSslCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": KafkaSslCredentialCreateInput}
Response
{
"data": {
"kafkaSslCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
kafkaSslCredentialUpdate
Description
Update a Kafka SSL credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - KafkaSslCredentialUpdateInput!
|
Example
Query
mutation KafkaSslCredentialUpdate($input: KafkaSslCredentialUpdateInput!) {
kafkaSslCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": KafkaSslCredentialUpdateInput}
Response
{
"data": {
"kafkaSslCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
lineageEdgeCreate
Description
Create a lineage edge. Requires editor permissions at the global level
Response
Returns a LineageEdgeCreateResult!
Arguments
| Name | Description |
|---|---|
input - LineageEdgeCreateInput!
|
Example
Query
mutation LineageEdgeCreate($input: LineageEdgeCreateInput!) {
lineageEdgeCreate(input: $input) {
edge {
downstream {
...LineageNodeFragment
}
id
sqlQuery
upstream {
...LineageNodeFragment
}
}
errors {
code
message
}
}
}
Variables
{"input": LineageEdgeCreateInput}
Response
{
"data": {
"lineageEdgeCreate": {
"edge": LineageEdge,
"errors": [ApiError]
}
}
}
lineageEdgesDelete
Description
Delete a lineage edge. Requires editor permissions at the global level
Response
Returns a LineageEdgesDeleteResult!
Arguments
| Name | Description |
|---|---|
ids - [LineageEdgeId!]!
|
Example
Query
mutation LineageEdgesDelete($ids: [LineageEdgeId!]!) {
lineageEdgesDelete(ids: $ids) {
errors {
code
message
}
}
}
Variables
{"ids": [LineageEdgeId]}
Response
{"data": {"lineageEdgesDelete": {"errors": [ApiError]}}}
localIdentityProviderUpdate
Description
Updates the local identity provider configuration. Requires admin permissions at the global level
Response
Returns an IdentityProviderUpdateResult!
Arguments
| Name | Description |
|---|---|
input - LocalIdentityProviderUpdateInput!
|
Example
Query
mutation LocalIdentityProviderUpdate($input: LocalIdentityProviderUpdateInput!) {
localIdentityProviderUpdate(input: $input) {
errors {
code
message
}
identityProvider {
createdAt
disabled
id
name
resourceName
updatedAt
}
}
}
Variables
{"input": LocalIdentityProviderUpdateInput}
Response
{
"data": {
"localIdentityProviderUpdate": {
"errors": [IdentityProviderUpdateError],
"identityProvider": IdentityProvider
}
}
}
lookerCredentialCreate
Description
Create a Looker credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - LookerCredentialCreateInput!
|
Example
Query
mutation LookerCredentialCreate($input: LookerCredentialCreateInput!) {
lookerCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": LookerCredentialCreateInput}
Response
{
"data": {
"lookerCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
lookerCredentialUpdate
Description
Update a Looker credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - LookerCredentialUpdateInput!
|
Example
Query
mutation LookerCredentialUpdate($input: LookerCredentialUpdateInput!) {
lookerCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": LookerCredentialUpdateInput}
Response
{
"data": {
"lookerCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
msPowerBiCredentialCreate
Description
Create a Microsoft Power BI credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - MsPowerBiCredentialCreateInput!
|
Example
Query
mutation MsPowerBiCredentialCreate($input: MsPowerBiCredentialCreateInput!) {
msPowerBiCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": MsPowerBiCredentialCreateInput}
Response
{
"data": {
"msPowerBiCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
msPowerBiCredentialUpdate
Description
Update a Microsoft Power BI credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - MsPowerBiCredentialUpdateInput!
|
Example
Query
mutation MsPowerBiCredentialUpdate($input: MsPowerBiCredentialUpdateInput!) {
msPowerBiCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": MsPowerBiCredentialUpdateInput}
Response
{
"data": {
"msPowerBiCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
msTeamsChannelCreate
Description
Create a Microsoft Teams channel. Requires editor permissions at the namespace level
Response
Returns a ChannelCreateResult!
Arguments
| Name | Description |
|---|---|
input - MsTeamsChannelCreateInput!
|
Example
Query
mutation MsTeamsChannelCreate($input: MsTeamsChannelCreateInput!) {
msTeamsChannelCreate(input: $input) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": MsTeamsChannelCreateInput}
Response
{
"data": {
"msTeamsChannelCreate": {
"channel": Channel,
"errors": [ApiError]
}
}
}
msTeamsChannelUpdate
Description
Update a Microsoft Teams channel. Requires editor permissions at the namespace level
Response
Returns a ChannelUpdateResult!
Arguments
| Name | Description |
|---|---|
input - MsTeamsChannelUpdateInput!
|
Example
Query
mutation MsTeamsChannelUpdate($input: MsTeamsChannelUpdateInput!) {
msTeamsChannelUpdate(input: $input) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": MsTeamsChannelUpdateInput}
Response
{
"data": {
"msTeamsChannelUpdate": {
"channel": Channel,
"errors": [ApiError]
}
}
}
namespaceCreate
Description
Create a namespace. Namespaces are logical groups to structure resource but also serves as a base for Validio's role based access control (RBAC). Requires admin permissions at the global level
Response
Returns a NamespaceCreateResult!
Arguments
| Name | Description |
|---|---|
input - NamespaceCreateInput!
|
Example
Query
mutation NamespaceCreate($input: NamespaceCreateInput!) {
namespaceCreate(input: $input) {
errors {
code
message
}
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
}
}
Variables
{"input": NamespaceCreateInput}
Response
{
"data": {
"namespaceCreate": {
"errors": [ApiError],
"namespace": Namespace
}
}
}
namespaceRolesRevoke
Description
Requires admin permissions at the namespace level
Response
Returns a NamespaceUpdateRolesResult!
Arguments
| Name | Description |
|---|---|
input - NamespaceRolesRevokeInput!
|
Example
Query
mutation NamespaceRolesRevoke($input: NamespaceRolesRevokeInput!) {
namespaceRolesRevoke(input: $input) {
errors {
code
message
}
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
}
}
Variables
{"input": NamespaceRolesRevokeInput}
Response
{
"data": {
"namespaceRolesRevoke": {
"errors": [ApiError],
"namespace": Namespace
}
}
}
namespaceRolesUpdate
Description
Requires admin permissions at the namespace level
Response
Returns a NamespaceUpdateRolesResult!
Arguments
| Name | Description |
|---|---|
input - NamespaceRolesUpdateInput!
|
Example
Query
mutation NamespaceRolesUpdate($input: NamespaceRolesUpdateInput!) {
namespaceRolesUpdate(input: $input) {
errors {
code
message
}
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
}
}
Variables
{"input": NamespaceRolesUpdateInput}
Response
{
"data": {
"namespaceRolesUpdate": {
"errors": [ApiError],
"namespace": Namespace
}
}
}
namespaceUpdate
Description
Update a namespace. Requires admin permissions at the namespace level
Response
Returns a NamespaceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - NamespaceUpdateInput!
|
Example
Query
mutation NamespaceUpdate($input: NamespaceUpdateInput!) {
namespaceUpdate(input: $input) {
errors {
code
message
}
namespace {
apiKeys {
...ApiKeyRoleFragment
}
avatar
avatarThumbnail
description
id
members {
...UserRoleFragment
}
name
teams {
...TeamRoleFragment
}
users {
...UserRoleFragment
}
}
}
}
Variables
{"input": NamespaceUpdateInput}
Response
{
"data": {
"namespaceUpdate": {
"errors": [ApiError],
"namespace": Namespace
}
}
}
namespacesDelete
Description
Delete a namespace. Requires admin permissions at the namespace level
Response
Returns a NamespaceDeleteResult!
Arguments
| Name | Description |
|---|---|
ids - [String!]!
|
Example
Query
mutation NamespacesDelete($ids: [String!]!) {
namespacesDelete(ids: $ids) {
errors {
code
message
}
}
}
Variables
{"ids": ["abc123"]}
Response
{"data": {"namespacesDelete": {"errors": [ApiError]}}}
notificationRuleCreate
Description
Create a notification rule. Requires editor permissions at the namespace level
Response
Returns a NotificationRuleCreateResult!
Arguments
| Name | Description |
|---|---|
input - NotificationRuleCreateInput!
|
Example
Query
mutation NotificationRuleCreate($input: NotificationRuleCreateInput!) {
notificationRuleCreate(input: $input) {
errors {
code
message
}
notificationRule {
channel {
...ChannelFragment
}
conditions {
...NotificationRuleConditionFragment
}
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
}
}
Variables
{"input": NotificationRuleCreateInput}
Response
{
"data": {
"notificationRuleCreate": {
"errors": [ApiError],
"notificationRule": NotificationRule
}
}
}
notificationRuleDelete
Description
Deletes a notification rule. Requires editor permissions at the namespace level
Response
Returns a NotificationRuleDeleteResult!
Arguments
| Name | Description |
|---|---|
input - NotificationRuleDeleteInput!
|
Example
Query
mutation NotificationRuleDelete($input: NotificationRuleDeleteInput!) {
notificationRuleDelete(input: $input) {
errors {
code
message
}
notificationRule {
channel {
...ChannelFragment
}
conditions {
...NotificationRuleConditionFragment
}
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
}
}
Variables
{"input": NotificationRuleDeleteInput}
Response
{
"data": {
"notificationRuleDelete": {
"errors": [ApiError],
"notificationRule": NotificationRule
}
}
}
notificationRuleUpdate
Description
Update a notification rule. Requires editor permissions at the namespace level
Response
Returns a NotificationRuleUpdateResult!
Arguments
| Name | Description |
|---|---|
input - NotificationRuleUpdateInput!
|
Example
Query
mutation NotificationRuleUpdate($input: NotificationRuleUpdateInput!) {
notificationRuleUpdate(input: $input) {
errors {
code
message
}
notificationRule {
channel {
...ChannelFragment
}
conditions {
...NotificationRuleConditionFragment
}
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
}
}
Variables
{"input": NotificationRuleUpdateInput}
Response
{
"data": {
"notificationRuleUpdate": {
"errors": [ApiError],
"notificationRule": NotificationRule
}
}
}
nullFilterCreate
Description
Create a null filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - NullFilterCreateInput!
|
Example
Query
mutation NullFilterCreate($input: NullFilterCreateInput!) {
nullFilterCreate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": NullFilterCreateInput}
Response
{
"data": {
"nullFilterCreate": {
"errors": [ApiError],
"filter": Filter
}
}
}
nullFilterUpdate
Description
Update a null filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - NullFilterUpdateInput!
|
Example
Query
mutation NullFilterUpdate($input: NullFilterUpdateInput!) {
nullFilterUpdate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": NullFilterUpdateInput}
Response
{
"data": {
"nullFilterUpdate": {
"errors": [ApiError],
"filter": Filter
}
}
}
numericAnomalyValidatorUpdate
Description
Update a numeric anomaly validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUpdateResult!
Arguments
| Name | Description |
|---|---|
input - NumericAnomalyValidatorUpdateInput!
|
Example
Query
mutation NumericAnomalyValidatorUpdate($input: NumericAnomalyValidatorUpdateInput!) {
numericAnomalyValidatorUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": NumericAnomalyValidatorUpdateInput}
Response
{
"data": {
"numericAnomalyValidatorUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericAnomalyValidatorWithDifferenceThresholdCreate
Description
Create a numeric anomaly validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - NumericAnomalyValidatorCreateInput!
|
|
threshold - DifferenceThresholdCreateInput!
|
Example
Query
mutation NumericAnomalyValidatorWithDifferenceThresholdCreate(
$input: NumericAnomalyValidatorCreateInput!,
$threshold: DifferenceThresholdCreateInput!
) {
numericAnomalyValidatorWithDifferenceThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": NumericAnomalyValidatorCreateInput,
"threshold": DifferenceThresholdCreateInput
}
Response
{
"data": {
"numericAnomalyValidatorWithDifferenceThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericAnomalyValidatorWithDynamicThresholdCreate
Description
Create a numeric anomaly validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - NumericAnomalyValidatorCreateInput!
|
|
threshold - DynamicThresholdCreateInput!
|
Example
Query
mutation NumericAnomalyValidatorWithDynamicThresholdCreate(
$input: NumericAnomalyValidatorCreateInput!,
$threshold: DynamicThresholdCreateInput!
) {
numericAnomalyValidatorWithDynamicThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": NumericAnomalyValidatorCreateInput,
"threshold": DynamicThresholdCreateInput
}
Response
{
"data": {
"numericAnomalyValidatorWithDynamicThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericAnomalyValidatorWithFixedThresholdCreate
Description
Create a numeric anomaly validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - NumericAnomalyValidatorCreateInput!
|
|
threshold - FixedThresholdCreateInput!
|
Example
Query
mutation NumericAnomalyValidatorWithFixedThresholdCreate(
$input: NumericAnomalyValidatorCreateInput!,
$threshold: FixedThresholdCreateInput!
) {
numericAnomalyValidatorWithFixedThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": NumericAnomalyValidatorCreateInput,
"threshold": FixedThresholdCreateInput
}
Response
{
"data": {
"numericAnomalyValidatorWithFixedThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericDistributionValidatorUpdate
Description
Update a numeric distribution validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUpdateResult!
Arguments
| Name | Description |
|---|---|
input - NumericDistributionValidatorUpdateInput!
|
Example
Query
mutation NumericDistributionValidatorUpdate($input: NumericDistributionValidatorUpdateInput!) {
numericDistributionValidatorUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": NumericDistributionValidatorUpdateInput}
Response
{
"data": {
"numericDistributionValidatorUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericDistributionValidatorWithDifferenceThresholdCreate
Description
Create a numeric distribution validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - NumericDistributionValidatorCreateInput!
|
|
threshold - DifferenceThresholdCreateInput!
|
Example
Query
mutation NumericDistributionValidatorWithDifferenceThresholdCreate(
$input: NumericDistributionValidatorCreateInput!,
$threshold: DifferenceThresholdCreateInput!
) {
numericDistributionValidatorWithDifferenceThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": NumericDistributionValidatorCreateInput,
"threshold": DifferenceThresholdCreateInput
}
Response
{
"data": {
"numericDistributionValidatorWithDifferenceThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericDistributionValidatorWithDynamicThresholdCreate
Description
Create a numeric distribution validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - NumericDistributionValidatorCreateInput!
|
|
threshold - DynamicThresholdCreateInput!
|
Example
Query
mutation NumericDistributionValidatorWithDynamicThresholdCreate(
$input: NumericDistributionValidatorCreateInput!,
$threshold: DynamicThresholdCreateInput!
) {
numericDistributionValidatorWithDynamicThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": NumericDistributionValidatorCreateInput,
"threshold": DynamicThresholdCreateInput
}
Response
{
"data": {
"numericDistributionValidatorWithDynamicThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericDistributionValidatorWithFixedThresholdCreate
Description
Create a numeric distribution validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - NumericDistributionValidatorCreateInput!
|
|
threshold - FixedThresholdCreateInput!
|
Example
Query
mutation NumericDistributionValidatorWithFixedThresholdCreate(
$input: NumericDistributionValidatorCreateInput!,
$threshold: FixedThresholdCreateInput!
) {
numericDistributionValidatorWithFixedThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": NumericDistributionValidatorCreateInput,
"threshold": FixedThresholdCreateInput
}
Response
{
"data": {
"numericDistributionValidatorWithFixedThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericValidatorUpdate
Description
Update a numeric validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUpdateResult!
Arguments
| Name | Description |
|---|---|
input - NumericValidatorUpdateInput!
|
Example
Query
mutation NumericValidatorUpdate($input: NumericValidatorUpdateInput!) {
numericValidatorUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": NumericValidatorUpdateInput}
Response
{
"data": {
"numericValidatorUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericValidatorWithDifferenceThresholdCreate
Description
Create a numeric validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - NumericValidatorCreateInput!
|
|
threshold - DifferenceThresholdCreateInput!
|
Example
Query
mutation NumericValidatorWithDifferenceThresholdCreate(
$input: NumericValidatorCreateInput!,
$threshold: DifferenceThresholdCreateInput!
) {
numericValidatorWithDifferenceThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": NumericValidatorCreateInput,
"threshold": DifferenceThresholdCreateInput
}
Response
{
"data": {
"numericValidatorWithDifferenceThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericValidatorWithDynamicThresholdCreate
Description
Create a numeric validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - NumericValidatorCreateInput!
|
|
threshold - DynamicThresholdCreateInput!
|
Example
Query
mutation NumericValidatorWithDynamicThresholdCreate(
$input: NumericValidatorCreateInput!,
$threshold: DynamicThresholdCreateInput!
) {
numericValidatorWithDynamicThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": NumericValidatorCreateInput,
"threshold": DynamicThresholdCreateInput
}
Response
{
"data": {
"numericValidatorWithDynamicThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
numericValidatorWithFixedThresholdCreate
Description
Create a numeric validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - NumericValidatorCreateInput!
|
|
threshold - FixedThresholdCreateInput!
|
Example
Query
mutation NumericValidatorWithFixedThresholdCreate(
$input: NumericValidatorCreateInput!,
$threshold: FixedThresholdCreateInput!
) {
numericValidatorWithFixedThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": NumericValidatorCreateInput,
"threshold": FixedThresholdCreateInput
}
Response
{
"data": {
"numericValidatorWithFixedThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
ownerNotificationRuleConditionCreate
Use 'notificationRuleUpdate'
Description
Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - OwnerNotificationRuleConditionCreateInput!
|
Example
Query
mutation OwnerNotificationRuleConditionCreate($input: OwnerNotificationRuleConditionCreateInput!) {
ownerNotificationRuleConditionCreate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": OwnerNotificationRuleConditionCreateInput}
Response
{
"data": {
"ownerNotificationRuleConditionCreate": {
"errors": [ApiError]
}
}
}
ownerNotificationRuleConditionUpdate
Use 'notificationRuleUpdate'
Description
Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - OwnerNotificationRuleConditionUpdateInput!
|
Example
Query
mutation OwnerNotificationRuleConditionUpdate($input: OwnerNotificationRuleConditionUpdateInput!) {
ownerNotificationRuleConditionUpdate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": OwnerNotificationRuleConditionUpdateInput}
Response
{
"data": {
"ownerNotificationRuleConditionUpdate": {
"errors": [ApiError]
}
}
}
postgreSqlCredentialCreate
Description
Create an PostgreSQL credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - PostgreSqlCredentialCreateInput!
|
Example
Query
mutation PostgreSqlCredentialCreate($input: PostgreSqlCredentialCreateInput!) {
postgreSqlCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": PostgreSqlCredentialCreateInput}
Response
{
"data": {
"postgreSqlCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
postgreSqlCredentialUpdate
Description
Update an PostgreSQL credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - PostgreSqlCredentialUpdateInput!
|
Example
Query
mutation PostgreSqlCredentialUpdate($input: PostgreSqlCredentialUpdateInput!) {
postgreSqlCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": PostgreSqlCredentialUpdateInput}
Response
{
"data": {
"postgreSqlCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
postgreSqlSourceCreate
Description
Create a PostgreSQL source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - PostgreSqlSourceCreateInput!
|
Example
Query
mutation PostgreSqlSourceCreate($input: PostgreSqlSourceCreateInput!) {
postgreSqlSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": PostgreSqlSourceCreateInput}
Response
{
"data": {
"postgreSqlSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
postgreSqlSourceUpdate
Description
Update a PostgreSQL source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - PostgreSqlSourceUpdateInput!
|
Example
Query
mutation PostgreSqlSourceUpdate($input: PostgreSqlSourceUpdateInput!) {
postgreSqlSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": PostgreSqlSourceUpdateInput}
Response
{
"data": {
"postgreSqlSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
relativeTimeValidatorUpdate
Description
Update a relative time validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUpdateResult!
Arguments
| Name | Description |
|---|---|
input - RelativeTimeValidatorUpdateInput!
|
Example
Query
mutation RelativeTimeValidatorUpdate($input: RelativeTimeValidatorUpdateInput!) {
relativeTimeValidatorUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": RelativeTimeValidatorUpdateInput}
Response
{
"data": {
"relativeTimeValidatorUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
relativeTimeValidatorWithDifferenceThresholdCreate
Description
Create a relative time validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - RelativeTimeValidatorCreateInput!
|
|
threshold - DifferenceThresholdCreateInput!
|
Example
Query
mutation RelativeTimeValidatorWithDifferenceThresholdCreate(
$input: RelativeTimeValidatorCreateInput!,
$threshold: DifferenceThresholdCreateInput!
) {
relativeTimeValidatorWithDifferenceThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": RelativeTimeValidatorCreateInput,
"threshold": DifferenceThresholdCreateInput
}
Response
{
"data": {
"relativeTimeValidatorWithDifferenceThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
relativeTimeValidatorWithDynamicThresholdCreate
Description
Create a relative time validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - RelativeTimeValidatorCreateInput!
|
|
threshold - DynamicThresholdCreateInput!
|
Example
Query
mutation RelativeTimeValidatorWithDynamicThresholdCreate(
$input: RelativeTimeValidatorCreateInput!,
$threshold: DynamicThresholdCreateInput!
) {
relativeTimeValidatorWithDynamicThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": RelativeTimeValidatorCreateInput,
"threshold": DynamicThresholdCreateInput
}
Response
{
"data": {
"relativeTimeValidatorWithDynamicThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
relativeTimeValidatorWithFixedThresholdCreate
Description
Create a relative time validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - RelativeTimeValidatorCreateInput!
|
|
threshold - FixedThresholdCreateInput!
|
Example
Query
mutation RelativeTimeValidatorWithFixedThresholdCreate(
$input: RelativeTimeValidatorCreateInput!,
$threshold: FixedThresholdCreateInput!
) {
relativeTimeValidatorWithFixedThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": RelativeTimeValidatorCreateInput,
"threshold": FixedThresholdCreateInput
}
Response
{
"data": {
"relativeTimeValidatorWithFixedThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
relativeVolumeValidatorUpdate
Description
Update a relative volume validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUpdateResult!
Arguments
| Name | Description |
|---|---|
input - RelativeVolumeValidatorUpdateInput!
|
Example
Query
mutation RelativeVolumeValidatorUpdate($input: RelativeVolumeValidatorUpdateInput!) {
relativeVolumeValidatorUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": RelativeVolumeValidatorUpdateInput}
Response
{
"data": {
"relativeVolumeValidatorUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
relativeVolumeValidatorWithDifferenceThresholdCreate
Description
Create a relative volume validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - RelativeVolumeValidatorCreateInput!
|
|
threshold - DifferenceThresholdCreateInput!
|
Example
Query
mutation RelativeVolumeValidatorWithDifferenceThresholdCreate(
$input: RelativeVolumeValidatorCreateInput!,
$threshold: DifferenceThresholdCreateInput!
) {
relativeVolumeValidatorWithDifferenceThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": RelativeVolumeValidatorCreateInput,
"threshold": DifferenceThresholdCreateInput
}
Response
{
"data": {
"relativeVolumeValidatorWithDifferenceThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
relativeVolumeValidatorWithDynamicThresholdCreate
Description
Create a relative volume validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - RelativeVolumeValidatorCreateInput!
|
|
threshold - DynamicThresholdCreateInput!
|
Example
Query
mutation RelativeVolumeValidatorWithDynamicThresholdCreate(
$input: RelativeVolumeValidatorCreateInput!,
$threshold: DynamicThresholdCreateInput!
) {
relativeVolumeValidatorWithDynamicThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": RelativeVolumeValidatorCreateInput,
"threshold": DynamicThresholdCreateInput
}
Response
{
"data": {
"relativeVolumeValidatorWithDynamicThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
relativeVolumeValidatorWithFixedThresholdCreate
Description
Create a relative volume validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - RelativeVolumeValidatorCreateInput!
|
|
threshold - FixedThresholdCreateInput!
|
Example
Query
mutation RelativeVolumeValidatorWithFixedThresholdCreate(
$input: RelativeVolumeValidatorCreateInput!,
$threshold: FixedThresholdCreateInput!
) {
relativeVolumeValidatorWithFixedThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": RelativeVolumeValidatorCreateInput,
"threshold": FixedThresholdCreateInput
}
Response
{
"data": {
"relativeVolumeValidatorWithFixedThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
samlIdentityProviderCreate
Description
Creates a new SAML identity provider configuration. Requires admin permissions at the global level
Response
Returns an IdentityProviderCreateResult!
Arguments
| Name | Description |
|---|---|
input - SamlIdentityProviderCreateInput!
|
Example
Query
mutation SamlIdentityProviderCreate($input: SamlIdentityProviderCreateInput!) {
samlIdentityProviderCreate(input: $input) {
errors {
code
message
}
identityProvider {
createdAt
disabled
id
name
resourceName
updatedAt
}
}
}
Variables
{"input": SamlIdentityProviderCreateInput}
Response
{
"data": {
"samlIdentityProviderCreate": {
"errors": [IdentityProviderError],
"identityProvider": IdentityProvider
}
}
}
samlIdentityProviderUpdate
Description
Updates an existing SAML identity provider configuration. Requires admin permissions at the global level
Response
Returns an IdentityProviderUpdateResult!
Arguments
| Name | Description |
|---|---|
input - SamlIdentityProviderUpdateInput!
|
Example
Query
mutation SamlIdentityProviderUpdate($input: SamlIdentityProviderUpdateInput!) {
samlIdentityProviderUpdate(input: $input) {
errors {
code
message
}
identityProvider {
createdAt
disabled
id
name
resourceName
updatedAt
}
}
}
Variables
{"input": SamlIdentityProviderUpdateInput}
Response
{
"data": {
"samlIdentityProviderUpdate": {
"errors": [IdentityProviderUpdateError],
"identityProvider": IdentityProvider
}
}
}
segmentNotificationRuleConditionCreate
Use 'notificationRuleUpdate'
Description
Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - SegmentNotificationRuleConditionCreateInput!
|
Example
Query
mutation SegmentNotificationRuleConditionCreate($input: SegmentNotificationRuleConditionCreateInput!) {
segmentNotificationRuleConditionCreate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": SegmentNotificationRuleConditionCreateInput}
Response
{
"data": {
"segmentNotificationRuleConditionCreate": {
"errors": [ApiError]
}
}
}
segmentNotificationRuleConditionUpdate
Use 'notificationRuleUpdate'
Description
Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - SegmentNotificationRuleConditionUpdateInput!
|
Example
Query
mutation SegmentNotificationRuleConditionUpdate($input: SegmentNotificationRuleConditionUpdateInput!) {
segmentNotificationRuleConditionUpdate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": SegmentNotificationRuleConditionUpdateInput}
Response
{
"data": {
"segmentNotificationRuleConditionUpdate": {
"errors": [ApiError]
}
}
}
segmentationCreate
Description
Create a segmentation. Requires editor permissions at the namespace level
Response
Returns a SegmentationCreateResult!
Arguments
| Name | Description |
|---|---|
input - SegmentationCreateInput!
|
Example
Query
mutation SegmentationCreate($input: SegmentationCreateInput!) {
segmentationCreate(input: $input) {
errors {
code
message
}
segmentation {
createdAt
fields
filter {
...FilterFragment
}
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
segments {
...SegmentsResultFragment
}
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": SegmentationCreateInput}
Response
{
"data": {
"segmentationCreate": {
"errors": [ApiError],
"segmentation": Segmentation
}
}
}
segmentationUpdate
Description
Update a segmentation. Requires editor permissions at the namespace level
Response
Returns a SegmentationUpdateResult!
Arguments
| Name | Description |
|---|---|
input - SegmentationUpdateInput!
|
Example
Query
mutation SegmentationUpdate($input: SegmentationUpdateInput!) {
segmentationUpdate(input: $input) {
errors {
code
message
}
segmentation {
createdAt
fields
filter {
...FilterFragment
}
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
segments {
...SegmentsResultFragment
}
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": SegmentationUpdateInput}
Response
{
"data": {
"segmentationUpdate": {
"errors": [ApiError],
"segmentation": Segmentation
}
}
}
segmentationsDelete
Description
Delete a segmentation. Requires editor permissions at the namespace level
Response
Returns a SegmentationsDeleteResult!
Arguments
| Name | Description |
|---|---|
ids - [SegmentationId!]!
|
Example
Query
mutation SegmentationsDelete($ids: [SegmentationId!]!) {
segmentationsDelete(ids: $ids) {
errors {
code
message
}
}
}
Variables
{"ids": [SegmentationId]}
Response
{"data": {"segmentationsDelete": {"errors": [ApiError]}}}
severityNotificationRuleConditionCreate
Use 'notificationRuleUpdate'
Description
Creates a severity notification rule condition. Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - SeverityNotificationRuleConditionCreateInput!
|
Example
Query
mutation SeverityNotificationRuleConditionCreate($input: SeverityNotificationRuleConditionCreateInput!) {
severityNotificationRuleConditionCreate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": SeverityNotificationRuleConditionCreateInput}
Response
{
"data": {
"severityNotificationRuleConditionCreate": {
"errors": [ApiError]
}
}
}
severityNotificationRuleConditionUpdate
Use 'notificationRuleUpdate'
Description
Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - SeverityNotificationRuleConditionUpdateInput!
|
Example
Query
mutation SeverityNotificationRuleConditionUpdate($input: SeverityNotificationRuleConditionUpdateInput!) {
severityNotificationRuleConditionUpdate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": SeverityNotificationRuleConditionUpdateInput}
Response
{
"data": {
"severityNotificationRuleConditionUpdate": {
"errors": [ApiError]
}
}
}
slackChannelCreate
Description
Create a Slack channel. Requires editor permissions at the namespace level
Response
Returns a ChannelCreateResult!
Arguments
| Name | Description |
|---|---|
input - SlackChannelCreateInput!
|
Example
Query
mutation SlackChannelCreate($input: SlackChannelCreateInput!) {
slackChannelCreate(input: $input) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": SlackChannelCreateInput}
Response
{
"data": {
"slackChannelCreate": {
"channel": Channel,
"errors": [ApiError]
}
}
}
slackChannelUpdate
Description
Update a Slack channel. Requires editor permissions at the namespace level
Response
Returns a ChannelUpdateResult!
Arguments
| Name | Description |
|---|---|
input - SlackChannelUpdateInput!
|
Example
Query
mutation SlackChannelUpdate($input: SlackChannelUpdateInput!) {
slackChannelUpdate(input: $input) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": SlackChannelUpdateInput}
Response
{
"data": {
"slackChannelUpdate": {
"channel": Channel,
"errors": [ApiError]
}
}
}
snowflakeCredentialCreate
Description
Create a Snowflake credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - SnowflakeCredentialCreateInput!
|
Example
Query
mutation SnowflakeCredentialCreate($input: SnowflakeCredentialCreateInput!) {
snowflakeCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": SnowflakeCredentialCreateInput}
Response
{
"data": {
"snowflakeCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
snowflakeCredentialUpdate
Description
Update a Snowflake credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - SnowflakeCredentialUpdateInput!
|
Example
Query
mutation SnowflakeCredentialUpdate($input: SnowflakeCredentialUpdateInput!) {
snowflakeCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": SnowflakeCredentialUpdateInput}
Response
{
"data": {
"snowflakeCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
snowflakeSourceCreate
Description
Create a Snowflake source. Requires editor permissions at the namespace level
Response
Returns a SourceCreateResult!
Arguments
| Name | Description |
|---|---|
input - SnowflakeSourceCreateInput!
|
Example
Query
mutation SnowflakeSourceCreate($input: SnowflakeSourceCreateInput!) {
snowflakeSourceCreate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": SnowflakeSourceCreateInput}
Response
{
"data": {
"snowflakeSourceCreate": {
"errors": [ApiError],
"source": Source
}
}
}
snowflakeSourceUpdate
Description
Update a Snowflake source. Requires editor permissions at the namespace level
Response
Returns a SourceUpdateResult!
Arguments
| Name | Description |
|---|---|
input - SnowflakeSourceUpdateInput!
|
Example
Query
mutation SnowflakeSourceUpdate($input: SnowflakeSourceUpdateInput!) {
snowflakeSourceUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": SnowflakeSourceUpdateInput}
Response
{
"data": {
"snowflakeSourceUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
sourceBackfill
Description
Backfill a source. Requires editor permissions at the namespace level
Response
Returns a SourceRequestStateResult!
Arguments
| Name | Description |
|---|---|
id - SourceId!
|
Example
Query
mutation SourceBackfill($id: SourceId!) {
sourceBackfill(id: $id) {
errors {
code
message
}
state
}
}
Variables
{"id": SourceId}
Response
{
"data": {
"sourceBackfill": {
"errors": [ApiError],
"state": "BACKFILLING"
}
}
}
sourceManualPoll
Description
Manually poll a source that doesn't have a schedule for polling. Requires editor permissions at the namespace level
Response
Returns a SourcePollResult!
Arguments
| Name | Description |
|---|---|
id - SourceId!
|
Example
Query
mutation SourceManualPoll($id: SourceId!) {
sourceManualPoll(id: $id) {
errors {
code
message
}
id
}
}
Variables
{"id": SourceId}
Response
{
"data": {
"sourceManualPoll": {
"errors": [ApiError],
"id": SourcePollId
}
}
}
sourceManualPollProgress
Description
Check progress for manually polling a source. The API is rate limited and will only allow you to query for progress with some seconds between each call. Requires editor permissions at the namespace level
Response
Returns a SourcePollProgressResult!
Arguments
| Name | Description |
|---|---|
id - SourcePollId!
|
Example
Query
mutation SourceManualPollProgress($id: SourcePollId!) {
sourceManualPollProgress(id: $id) {
description
errors {
code
message
}
status
}
}
Variables
{"id": SourcePollId}
Response
{
"data": {
"sourceManualPollProgress": {
"description": "abc123",
"errors": [ApiError],
"status": "FAILED"
}
}
}
sourceMute
Use 'incidentsMute'
Description
Mute a source, stopping reports of incidents from one specific source. Requires editor permissions at the namespace level
Response
Returns a SourceMuteResult!
Example
Query
mutation SourceMute(
$id: SourceId!,
$until: DateTime!
) {
sourceMute(
id: $id,
until: $until
) {
errors {
code
message
}
}
}
Variables
{
"id": SourceId,
"until": "2007-12-03T10:15:30Z"
}
Response
{"data": {"sourceMute": {"errors": [ApiError]}}}
sourceNotificationRuleConditionCreate
Use 'notificationRuleUpdate'
Description
Creates a source notification rule condition. Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - SourceNotificationRuleConditionCreateInput!
|
Example
Query
mutation SourceNotificationRuleConditionCreate($input: SourceNotificationRuleConditionCreateInput!) {
sourceNotificationRuleConditionCreate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": SourceNotificationRuleConditionCreateInput}
Response
{
"data": {
"sourceNotificationRuleConditionCreate": {
"errors": [ApiError]
}
}
}
sourceNotificationRuleConditionUpdate
Use 'notificationRuleUpdate'
Description
Updates a source notification rule condition. Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - SourceNotificationRuleConditionUpdateInput!
|
Example
Query
mutation SourceNotificationRuleConditionUpdate($input: SourceNotificationRuleConditionUpdateInput!) {
sourceNotificationRuleConditionUpdate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": SourceNotificationRuleConditionUpdateInput}
Response
{
"data": {
"sourceNotificationRuleConditionUpdate": {
"errors": [ApiError]
}
}
}
sourceOwnerUpdate
Description
Updates the owner of a source. Requires editor permissions at the namespace level
Response
Returns a SourceOwnerUpdateResult!
Arguments
| Name | Description |
|---|---|
input - SourceOwnerUpdateInput!
|
Example
Query
mutation SourceOwnerUpdate($input: SourceOwnerUpdateInput!) {
sourceOwnerUpdate(input: $input) {
errors {
code
message
}
source {
catalogAsset {
...CatalogAssetFragment
}
createdAt
credential {
...CredentialFragment
}
description
filters {
...FilterFragment
}
id
incidentGroups {
...IncidentGroupsResultFragment
}
jtdSchema
name
namespace {
...NamespaceFragment
}
namespaceId
recommendedValidators {
...ValidatorFragment
}
resourceName
segmentations {
...SegmentationFragment
}
state
stateUpdatedAt
tags {
...TagFragment
}
updatedAt
windows {
...WindowFragment
}
}
}
}
Variables
{"input": SourceOwnerUpdateInput}
Response
{
"data": {
"sourceOwnerUpdate": {
"errors": [ApiError],
"source": Source
}
}
}
sourcePoll
Use sourceManualPoll and sourceManualPollProgress instead
Description
Deprecated. Requires editor permissions at the namespace level
Response
Returns a SourceRequestStateResult
Arguments
| Name | Description |
|---|---|
id - SourceId!
|
Example
Query
mutation SourcePoll($id: SourceId!) {
sourcePoll(id: $id) {
errors {
code
message
}
state
}
}
Variables
{"id": SourceId}
Response
{
"data": {
"sourcePoll": {
"errors": [ApiError],
"state": "BACKFILLING"
}
}
}
sourceReset
Description
Reset a source, clearing all previous metrics and state, simulating deleting and setting up the source from scratch. Requires editor permissions at the namespace level
Response
Returns a SourceRequestStateResult!
Arguments
| Name | Description |
|---|---|
id - SourceId!
|
Example
Query
mutation SourceReset($id: SourceId!) {
sourceReset(id: $id) {
errors {
code
message
}
state
}
}
Variables
{"id": SourceId}
Response
{
"data": {
"sourceReset": {
"errors": [ApiError],
"state": "BACKFILLING"
}
}
}
sourceSchemaVerify
Description
Verify the source's schema. Requires editor permissions at the namespace level
Response
Returns a SourceSchemaVerifyResult!
Arguments
| Name | Description |
|---|---|
id - SourceId!
|
|
input - JsonTypeDefinition!
|
Example
Query
mutation SourceSchemaVerify(
$id: SourceId!,
$input: JsonTypeDefinition!
) {
sourceSchemaVerify(
id: $id,
input: $input
) {
segmentationConflicts {
fields
segmentation {
...SegmentationFragment
}
}
validatorConflicts {
fields
validator {
...ValidatorFragment
}
}
windowConflicts {
fields
window {
...WindowFragment
}
}
}
}
Variables
{
"id": SourceId,
"input": JsonTypeDefinition
}
Response
{
"data": {
"sourceSchemaVerify": {
"segmentationConflicts": [
SegmentationSchemaConflict
],
"validatorConflicts": [ValidatorSchemaConflict],
"windowConflicts": [WindowSchemaConflict]
}
}
}
sourceStart
Description
Start a source. Requires editor permissions at the namespace level
Response
Returns a SourceRequestStateResult!
Arguments
| Name | Description |
|---|---|
id - SourceId!
|
Example
Query
mutation SourceStart($id: SourceId!) {
sourceStart(id: $id) {
errors {
code
message
}
state
}
}
Variables
{"id": SourceId}
Response
{
"data": {
"sourceStart": {
"errors": [ApiError],
"state": "BACKFILLING"
}
}
}
sourceStop
Description
Stop a source. Requires editor permissions at the namespace level
Response
Returns a SourceRequestStateResult!
Arguments
| Name | Description |
|---|---|
id - SourceId!
|
Example
Query
mutation SourceStop($id: SourceId!) {
sourceStop(id: $id) {
errors {
code
message
}
state
}
}
Variables
{"id": SourceId}
Response
{
"data": {
"sourceStop": {
"errors": [ApiError],
"state": "BACKFILLING"
}
}
}
sourceUnmute
Use 'incidentsUnmute'
Description
Unmute a source, resuming reports of incidents from one specific source. Requires editor permissions at the namespace level
Response
Returns a SourceUnmuteResult!
Arguments
| Name | Description |
|---|---|
id - SourceId!
|
Example
Query
mutation SourceUnmute($id: SourceId!) {
sourceUnmute(id: $id) {
errors {
code
message
}
}
}
Variables
{"id": SourceId}
Response
{"data": {"sourceUnmute": {"errors": [ApiError]}}}
sourcesDelete
Description
Delete a source. Requires editor permissions at the namespace level
Response
Returns a SourcesDeleteResult!
Arguments
| Name | Description |
|---|---|
ids - [SourceId!]!
|
Example
Query
mutation SourcesDelete($ids: [SourceId!]!) {
sourcesDelete(ids: $ids) {
errors {
code
message
}
}
}
Variables
{"ids": [SourceId]}
Response
{"data": {"sourcesDelete": {"errors": [ApiError]}}}
sqlFilterCreate
Description
Create a SQL filter. For warehouses a SQL filter will be added to the WHERE clause when doing the select so the query should only be the expression to evaluate. E.g.
Age > 20 AND User <> 'Robot'
Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - SqlFilterCreateInput!
|
Example
Query
mutation SqlFilterCreate($input: SqlFilterCreateInput!) {
sqlFilterCreate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": SqlFilterCreateInput}
Response
{
"data": {
"sqlFilterCreate": {
"errors": [ApiError],
"filter": Filter
}
}
}
sqlFilterUpdate
Description
Update a SQL filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - SqlFilterUpdateInput!
|
Example
Query
mutation SqlFilterUpdate($input: SqlFilterUpdateInput!) {
sqlFilterUpdate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": SqlFilterUpdateInput}
Response
{
"data": {
"sqlFilterUpdate": {
"errors": [ApiError],
"filter": Filter
}
}
}
sqlValidatorUpdate
Description
Update a SQL validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUpdateResult!
Arguments
| Name | Description |
|---|---|
input - SqlValidatorUpdateInput!
|
Example
Query
mutation SqlValidatorUpdate($input: SqlValidatorUpdateInput!) {
sqlValidatorUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": SqlValidatorUpdateInput}
Response
{
"data": {
"sqlValidatorUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
sqlValidatorWithDifferenceThresholdCreate
Description
Create a SQL validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - SqlValidatorCreateInput!
|
|
threshold - DifferenceThresholdCreateInput!
|
Example
Query
mutation SqlValidatorWithDifferenceThresholdCreate(
$input: SqlValidatorCreateInput!,
$threshold: DifferenceThresholdCreateInput!
) {
sqlValidatorWithDifferenceThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": SqlValidatorCreateInput,
"threshold": DifferenceThresholdCreateInput
}
Response
{
"data": {
"sqlValidatorWithDifferenceThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
sqlValidatorWithDynamicThresholdCreate
Description
Create a SQL validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - SqlValidatorCreateInput!
|
|
threshold - DynamicThresholdCreateInput!
|
Example
Query
mutation SqlValidatorWithDynamicThresholdCreate(
$input: SqlValidatorCreateInput!,
$threshold: DynamicThresholdCreateInput!
) {
sqlValidatorWithDynamicThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": SqlValidatorCreateInput,
"threshold": DynamicThresholdCreateInput
}
Response
{
"data": {
"sqlValidatorWithDynamicThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
sqlValidatorWithFixedThresholdCreate
Description
Create a SQL validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - SqlValidatorCreateInput!
|
|
threshold - FixedThresholdCreateInput!
|
Example
Query
mutation SqlValidatorWithFixedThresholdCreate(
$input: SqlValidatorCreateInput!,
$threshold: FixedThresholdCreateInput!
) {
sqlValidatorWithFixedThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": SqlValidatorCreateInput,
"threshold": FixedThresholdCreateInput
}
Response
{
"data": {
"sqlValidatorWithFixedThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
stringFilterCreate
Description
Create a string filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - StringFilterCreateInput!
|
Example
Query
mutation StringFilterCreate($input: StringFilterCreateInput!) {
stringFilterCreate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": StringFilterCreateInput}
Response
{
"data": {
"stringFilterCreate": {
"errors": [ApiError],
"filter": Filter
}
}
}
stringFilterUpdate
Description
Update a string filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - StringFilterUpdateInput!
|
Example
Query
mutation StringFilterUpdate($input: StringFilterUpdateInput!) {
stringFilterUpdate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": StringFilterUpdateInput}
Response
{
"data": {
"stringFilterUpdate": {
"errors": [ApiError],
"filter": Filter
}
}
}
tableauConnectedAppCredentialCreate
Description
Create a Tableau connected app credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - TableauConnectedAppCredentialCreateInput!
|
Example
Query
mutation TableauConnectedAppCredentialCreate($input: TableauConnectedAppCredentialCreateInput!) {
tableauConnectedAppCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": TableauConnectedAppCredentialCreateInput}
Response
{
"data": {
"tableauConnectedAppCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
tableauConnectedAppCredentialUpdate
Description
Update a Tableau connected app credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - TableauConnectedAppCredentialUpdateInput!
|
Example
Query
mutation TableauConnectedAppCredentialUpdate($input: TableauConnectedAppCredentialUpdateInput!) {
tableauConnectedAppCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": TableauConnectedAppCredentialUpdateInput}
Response
{
"data": {
"tableauConnectedAppCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
tableauPersonalAccessTokenCredentialCreate
Description
Create a Tableau personal access token credential. Requires editor permissions at the namespace level
Response
Returns a CredentialCreateResult!
Arguments
| Name | Description |
|---|---|
input - TableauPersonalAccessTokenCredentialCreateInput!
|
Example
Query
mutation TableauPersonalAccessTokenCredentialCreate($input: TableauPersonalAccessTokenCredentialCreateInput!) {
tableauPersonalAccessTokenCredentialCreate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": TableauPersonalAccessTokenCredentialCreateInput}
Response
{
"data": {
"tableauPersonalAccessTokenCredentialCreate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
tableauPersonalAccessTokenCredentialUpdate
Description
Update a Tableau personal access token credential. Requires editor permissions at the namespace level
Response
Returns a CredentialUpdateResult!
Arguments
| Name | Description |
|---|---|
input - TableauPersonalAccessTokenCredentialUpdateInput!
|
Example
Query
mutation TableauPersonalAccessTokenCredentialUpdate($input: TableauPersonalAccessTokenCredentialUpdateInput!) {
tableauPersonalAccessTokenCredentialUpdate(input: $input) {
credential {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": TableauPersonalAccessTokenCredentialUpdateInput}
Response
{
"data": {
"tableauPersonalAccessTokenCredentialUpdate": {
"credential": Credential,
"errors": [ApiError]
}
}
}
tagCreate
Description
Create a tag. Requires editor permissions at the global level
Response
Returns a TagCreateResult!
Arguments
| Name | Description |
|---|---|
input - TagCreateInput!
|
Example
Query
mutation TagCreate($input: TagCreateInput!) {
tagCreate(input: $input) {
errors {
code
message
}
tag {
createdAt
id
key
origin
updatedAt
value
}
}
}
Variables
{"input": TagCreateInput}
Response
{
"data": {
"tagCreate": {
"errors": [ApiError],
"tag": Tag
}
}
}
tagNotificationRuleConditionCreate
Use 'notificationRuleUpdate'
Description
Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - TagNotificationRuleConditionCreateInput!
|
Example
Query
mutation TagNotificationRuleConditionCreate($input: TagNotificationRuleConditionCreateInput!) {
tagNotificationRuleConditionCreate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": TagNotificationRuleConditionCreateInput}
Response
{
"data": {
"tagNotificationRuleConditionCreate": {
"errors": [ApiError]
}
}
}
tagNotificationRuleConditionUpdate
Use 'notificationRuleUpdate'
Description
Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - TagNotificationRuleConditionUpdateInput!
|
Example
Query
mutation TagNotificationRuleConditionUpdate($input: TagNotificationRuleConditionUpdateInput!) {
tagNotificationRuleConditionUpdate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": TagNotificationRuleConditionUpdateInput}
Response
{
"data": {
"tagNotificationRuleConditionUpdate": {
"errors": [ApiError]
}
}
}
tagUpdate
Description
Update a tag. Requires editor permissions at the global level
Response
Returns a TagUpdateResult!
Arguments
| Name | Description |
|---|---|
input - TagUpdateInput!
|
Example
Query
mutation TagUpdate($input: TagUpdateInput!) {
tagUpdate(input: $input) {
errors {
code
message
}
tag {
createdAt
id
key
origin
updatedAt
value
}
}
}
Variables
{"input": TagUpdateInput}
Response
{
"data": {
"tagUpdate": {
"errors": [ApiError],
"tag": Tag
}
}
}
teamCreate
Description
Requires admin permissions at the global level
Response
Returns a TeamCreateResult!
Arguments
| Name | Description |
|---|---|
input - TeamCreateInput!
|
Example
Query
mutation TeamCreate($input: TeamCreateInput!) {
teamCreate(input: $input) {
errors {
code
message
}
team {
avatar
avatarThumbnail
createdAt
description
id
members {
...UserFragment
}
name
updatedAt
}
}
}
Variables
{"input": TeamCreateInput}
Response
{
"data": {
"teamCreate": {
"errors": [ApiError],
"team": Team
}
}
}
teamDelete
Description
Requires admin permissions at the global level
Response
Returns a TeamDeleteResult!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation TeamDelete($id: String!) {
teamDelete(id: $id) {
errors {
code
message
}
}
}
Variables
{"id": "abc123"}
Response
{"data": {"teamDelete": {"errors": [ApiError]}}}
teamMembersAdd
Description
Requires admin permissions at the global level
Response
Returns a TeamUpdateResult!
Arguments
| Name | Description |
|---|---|
input - TeamMembersUpdateInput!
|
Example
Query
mutation TeamMembersAdd($input: TeamMembersUpdateInput!) {
teamMembersAdd(input: $input) {
errors {
code
message
}
team {
avatar
avatarThumbnail
createdAt
description
id
members {
...UserFragment
}
name
updatedAt
}
}
}
Variables
{"input": TeamMembersUpdateInput}
Response
{
"data": {
"teamMembersAdd": {
"errors": [ApiError],
"team": Team
}
}
}
teamMembersRemove
Description
Requires admin permissions at the global level
Response
Returns a TeamUpdateResult!
Arguments
| Name | Description |
|---|---|
input - TeamMembersUpdateInput!
|
Example
Query
mutation TeamMembersRemove($input: TeamMembersUpdateInput!) {
teamMembersRemove(input: $input) {
errors {
code
message
}
team {
avatar
avatarThumbnail
createdAt
description
id
members {
...UserFragment
}
name
updatedAt
}
}
}
Variables
{"input": TeamMembersUpdateInput}
Response
{
"data": {
"teamMembersRemove": {
"errors": [ApiError],
"team": Team
}
}
}
teamUpdate
Description
Requires admin permissions at the global level
Response
Returns a TeamUpdateResult!
Arguments
| Name | Description |
|---|---|
input - TeamUpdateInput!
|
Example
Query
mutation TeamUpdate($input: TeamUpdateInput!) {
teamUpdate(input: $input) {
errors {
code
message
}
team {
avatar
avatarThumbnail
createdAt
description
id
members {
...UserFragment
}
name
updatedAt
}
}
}
Variables
{"input": TeamUpdateInput}
Response
{
"data": {
"teamUpdate": {
"errors": [ApiError],
"team": Team
}
}
}
thresholdFilterCreate
Description
Create a threshold filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - ThresholdFilterCreateInput!
|
Example
Query
mutation ThresholdFilterCreate($input: ThresholdFilterCreateInput!) {
thresholdFilterCreate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": ThresholdFilterCreateInput}
Response
{
"data": {
"thresholdFilterCreate": {
"errors": [ApiError],
"filter": Filter
}
}
}
thresholdFilterUpdate
Description
Update a threshold filter. Requires editor permissions at the namespace level
Response
Returns a FilterResult!
Arguments
| Name | Description |
|---|---|
input - ThresholdFilterUpdateInput!
|
Example
Query
mutation ThresholdFilterUpdate($input: ThresholdFilterUpdateInput!) {
thresholdFilterUpdate(input: $input) {
errors {
code
message
}
filter {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": ThresholdFilterUpdateInput}
Response
{
"data": {
"thresholdFilterUpdate": {
"errors": [ApiError],
"filter": Filter
}
}
}
tumblingWindowCreate
Description
Create a tumbling window. Requires editor permissions at the namespace level
Response
Returns a WindowCreateResult!
Arguments
| Name | Description |
|---|---|
input - TumblingWindowCreateInput!
|
Example
Query
mutation TumblingWindowCreate($input: TumblingWindowCreateInput!) {
tumblingWindowCreate(input: $input) {
errors {
code
message
}
window {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": TumblingWindowCreateInput}
Response
{
"data": {
"tumblingWindowCreate": {
"errors": [ApiError],
"window": Window
}
}
}
tumblingWindowUpdate
Description
Update a tumbling window. Requires editor permissions at the namespace level
Response
Returns a WindowUpdateResult!
Arguments
| Name | Description |
|---|---|
input - TumblingWindowUpdateInput!
|
Example
Query
mutation TumblingWindowUpdate($input: TumblingWindowUpdateInput!) {
tumblingWindowUpdate(input: $input) {
errors {
code
message
}
window {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
resourceName
source {
...SourceFragment
}
updatedAt
}
}
}
Variables
{"input": TumblingWindowUpdateInput}
Response
{
"data": {
"tumblingWindowUpdate": {
"errors": [ApiError],
"window": Window
}
}
}
typeNotificationRuleConditionCreate
Use 'notificationRuleUpdate'
Description
Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - TypeNotificationRuleConditionCreateInput!
|
Example
Query
mutation TypeNotificationRuleConditionCreate($input: TypeNotificationRuleConditionCreateInput!) {
typeNotificationRuleConditionCreate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": TypeNotificationRuleConditionCreateInput}
Response
{
"data": {
"typeNotificationRuleConditionCreate": {
"errors": [ApiError]
}
}
}
typeNotificationRuleConditionUpdate
Use 'notificationRuleUpdate'
Description
Requires editor permissions at the namespace level
Response
Returns a NotificationRuleConditionCreateResult!
Arguments
| Name | Description |
|---|---|
input - TypeNotificationRuleConditionUpdateInput!
|
Example
Query
mutation TypeNotificationRuleConditionUpdate($input: TypeNotificationRuleConditionUpdateInput!) {
typeNotificationRuleConditionUpdate(input: $input) {
errors {
code
message
}
}
}
Variables
{"input": TypeNotificationRuleConditionUpdateInput}
Response
{
"data": {
"typeNotificationRuleConditionUpdate": {
"errors": [ApiError]
}
}
}
userCreate
Description
Creates a new user account. Requires admin permissions at the global level
Response
Returns a UserCreateResult!
Arguments
| Name | Description |
|---|---|
input - UserCreateInput!
|
Example
Query
mutation UserCreate($input: UserCreateInput!) {
userCreate(input: $input) {
errors {
code
message
}
user {
avatar
avatarThumbnail
createdAt
displayName
email
fullName
globalRole
id
identities {
... on FederatedIdentity {
...FederatedIdentityFragment
}
... on LocalIdentity {
...LocalIdentityFragment
}
}
lastLoginAt
loginType
namespaces {
...NamespaceFragment
}
resourceName
status
teams {
...TeamFragment
}
updatedAt
}
}
}
Variables
{"input": UserCreateInput}
Response
{
"data": {
"userCreate": {
"errors": [UserError],
"user": User
}
}
}
userDelete
Description
Requires admin permissions at the global level
Response
Returns a UserDeleteResult!
Arguments
| Name | Description |
|---|---|
input - UserDeleteInput!
|
Example
Query
mutation UserDelete($input: UserDeleteInput!) {
userDelete(input: $input) {
errors {
code
message
}
user {
avatar
avatarThumbnail
createdAt
displayName
email
fullName
globalRole
id
identities {
... on FederatedIdentity {
...FederatedIdentityFragment
}
... on LocalIdentity {
...LocalIdentityFragment
}
}
lastLoginAt
loginType
namespaces {
...NamespaceFragment
}
resourceName
status
teams {
...TeamFragment
}
updatedAt
}
}
}
Variables
{"input": UserDeleteInput}
Response
{
"data": {
"userDelete": {
"errors": [UserDeleteError],
"user": User
}
}
}
userUpdate
Description
Requires admin permissions at the global level
Response
Returns a UserUpdateResult!
Arguments
| Name | Description |
|---|---|
input - UserUpdateInput!
|
Example
Query
mutation UserUpdate($input: UserUpdateInput!) {
userUpdate(input: $input) {
errors {
code
message
}
user {
avatar
avatarThumbnail
createdAt
displayName
email
fullName
globalRole
id
identities {
... on FederatedIdentity {
...FederatedIdentityFragment
}
... on LocalIdentity {
...LocalIdentityFragment
}
}
lastLoginAt
loginType
namespaces {
...NamespaceFragment
}
resourceName
status
teams {
...TeamFragment
}
updatedAt
}
}
}
Variables
{"input": UserUpdateInput}
Response
{
"data": {
"userUpdate": {
"errors": [UserUpdateError],
"user": User
}
}
}
validatorMute
Use 'incidentsMute'
Description
Mute a validator, stopping reports of incidents from one specific validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorMuteResult!
Arguments
| Name | Description |
|---|---|
id - ValidatorId!
|
|
until - DateTime!
|
Example
Query
mutation ValidatorMute(
$id: ValidatorId!,
$until: DateTime!
) {
validatorMute(
id: $id,
until: $until
) {
errors {
code
message
}
}
}
Variables
{
"id": ValidatorId,
"until": "2007-12-03T10:15:30Z"
}
Response
{"data": {"validatorMute": {"errors": [ApiError]}}}
validatorRecommendationApply
Description
Requires editor permissions at the namespace level
Response
Returns a ValidatorRecommendationApplyResult!
Arguments
| Name | Description |
|---|---|
input - ValidatorRecommendationApplyInput!
|
Example
Query
mutation ValidatorRecommendationApply($input: ValidatorRecommendationApplyInput!) {
validatorRecommendationApply(input: $input) {
failedIds
successIds
}
}
Variables
{"input": ValidatorRecommendationApplyInput}
Response
{
"data": {
"validatorRecommendationApply": {
"failedIds": [RecommendationId],
"successIds": ["4"]
}
}
}
validatorRecommendationDismiss
Description
Requires editor permissions at the namespace level
Response
Returns a ValidatorRecommendationDismissResult!
Arguments
| Name | Description |
|---|---|
input - ValidatorRecommendationDismissInput!
|
Example
Query
mutation ValidatorRecommendationDismiss($input: ValidatorRecommendationDismissInput!) {
validatorRecommendationDismiss(input: $input) {
errors {
code
message
}
recommendationIds
}
}
Variables
{"input": ValidatorRecommendationDismissInput}
Response
{
"data": {
"validatorRecommendationDismiss": {
"errors": [ApiError],
"recommendationIds": ["4"]
}
}
}
validatorUnmute
Use 'incidentsUnmute'
Description
Unmute a validator, resuming reports of incidents from one specific validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUnmuteResult!
Arguments
| Name | Description |
|---|---|
id - ValidatorId!
|
Example
Query
mutation ValidatorUnmute($id: ValidatorId!) {
validatorUnmute(id: $id) {
errors {
code
message
}
}
}
Variables
{"id": ValidatorId}
Response
{"data": {"validatorUnmute": {"errors": [ApiError]}}}
validatorWithDifferenceThresholdUpdate
Description
Update a validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorWithThresholdUpdateResult!
Arguments
| Name | Description |
|---|---|
input - ValidatorWithDifferenceThresholdUpdateInput!
|
Example
Query
mutation ValidatorWithDifferenceThresholdUpdate($input: ValidatorWithDifferenceThresholdUpdateInput!) {
validatorWithDifferenceThresholdUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": ValidatorWithDifferenceThresholdUpdateInput}
Response
{
"data": {
"validatorWithDifferenceThresholdUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
validatorWithDynamicThresholdUpdate
Description
Update a validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorWithThresholdUpdateResult!
Arguments
| Name | Description |
|---|---|
input - ValidatorWithDynamicThresholdUpdateInput!
|
Example
Query
mutation ValidatorWithDynamicThresholdUpdate($input: ValidatorWithDynamicThresholdUpdateInput!) {
validatorWithDynamicThresholdUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": ValidatorWithDynamicThresholdUpdateInput}
Response
{
"data": {
"validatorWithDynamicThresholdUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
validatorWithFixedThresholdUpdate
Description
Update a validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorWithThresholdUpdateResult!
Arguments
| Name | Description |
|---|---|
input - ValidatorWithFixedThresholdUpdateInput!
|
Example
Query
mutation ValidatorWithFixedThresholdUpdate($input: ValidatorWithFixedThresholdUpdateInput!) {
validatorWithFixedThresholdUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": ValidatorWithFixedThresholdUpdateInput}
Response
{
"data": {
"validatorWithFixedThresholdUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
validatorsDelete
Description
Delete validators in the ids list. Requires editor permissions at the namespace level
Response
Returns a ValidatorsDeleteResult!
Arguments
| Name | Description |
|---|---|
ids - [ValidatorId!]!
|
Example
Query
mutation ValidatorsDelete($ids: [ValidatorId!]!) {
validatorsDelete(ids: $ids) {
errors {
code
message
}
}
}
Variables
{"ids": [ValidatorId]}
Response
{"data": {"validatorsDelete": {"errors": [ApiError]}}}
volumeValidatorUpdate
Description
Update a volume validator. Requires editor permissions at the namespace level
Response
Returns a ValidatorUpdateResult!
Arguments
| Name | Description |
|---|---|
input - VolumeValidatorUpdateInput!
|
Example
Query
mutation VolumeValidatorUpdate($input: VolumeValidatorUpdateInput!) {
volumeValidatorUpdate(input: $input) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{"input": VolumeValidatorUpdateInput}
Response
{
"data": {
"volumeValidatorUpdate": {
"errors": [ApiError],
"validator": Validator
}
}
}
volumeValidatorWithDifferenceThresholdCreate
Description
Create a volume validator with difference threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - VolumeValidatorCreateInput!
|
|
threshold - DifferenceThresholdCreateInput!
|
Example
Query
mutation VolumeValidatorWithDifferenceThresholdCreate(
$input: VolumeValidatorCreateInput!,
$threshold: DifferenceThresholdCreateInput!
) {
volumeValidatorWithDifferenceThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": VolumeValidatorCreateInput,
"threshold": DifferenceThresholdCreateInput
}
Response
{
"data": {
"volumeValidatorWithDifferenceThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
volumeValidatorWithDynamicThresholdCreate
Description
Create a volume validator with dynamic threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - VolumeValidatorCreateInput!
|
|
threshold - DynamicThresholdCreateInput!
|
Example
Query
mutation VolumeValidatorWithDynamicThresholdCreate(
$input: VolumeValidatorCreateInput!,
$threshold: DynamicThresholdCreateInput!
) {
volumeValidatorWithDynamicThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": VolumeValidatorCreateInput,
"threshold": DynamicThresholdCreateInput
}
Response
{
"data": {
"volumeValidatorWithDynamicThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
volumeValidatorWithFixedThresholdCreate
Description
Create a volume validator with fixed threshold. Requires editor permissions at the namespace level
Response
Returns a ValidatorCreateResult!
Arguments
| Name | Description |
|---|---|
input - VolumeValidatorCreateInput!
|
|
threshold - FixedThresholdCreateInput!
|
Example
Query
mutation VolumeValidatorWithFixedThresholdCreate(
$input: VolumeValidatorCreateInput!,
$threshold: FixedThresholdCreateInput!
) {
volumeValidatorWithFixedThresholdCreate(
input: $input,
threshold: $threshold
) {
errors {
code
message
}
validator {
createdAt
description
hasCustomName
id
incidents {
...IncidentFragment
}
metricValueFormat
name
namespace {
...NamespaceFragment
}
namespaceId
progress {
...ValidatorProgressFragment
}
resourceName
sourceConfig {
...SourceConfigFragment
}
state
stateUpdatedAt
stats {
...ValidatorStatsFragment
}
tags {
...TagFragment
}
updatedAt
}
}
}
Variables
{
"input": VolumeValidatorCreateInput,
"threshold": FixedThresholdCreateInput
}
Response
{
"data": {
"volumeValidatorWithFixedThresholdCreate": {
"errors": [ApiError],
"validator": Validator
}
}
}
webhookChannelCreate
Description
Create a webhook channel. Requires editor permissions at the namespace level
Response
Returns a ChannelCreateResult!
Arguments
| Name | Description |
|---|---|
input - WebhookChannelCreateInput!
|
Example
Query
mutation WebhookChannelCreate($input: WebhookChannelCreateInput!) {
webhookChannelCreate(input: $input) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": WebhookChannelCreateInput}
Response
{
"data": {
"webhookChannelCreate": {
"channel": Channel,
"errors": [ApiError]
}
}
}
webhookChannelUpdate
Description
Update a webhook channel. Requires editor permissions at the namespace level
Response
Returns a ChannelUpdateResult!
Arguments
| Name | Description |
|---|---|
input - WebhookChannelUpdateInput!
|
Example
Query
mutation WebhookChannelUpdate($input: WebhookChannelUpdateInput!) {
webhookChannelUpdate(input: $input) {
channel {
createdAt
id
name
namespace {
...NamespaceFragment
}
namespaceId
notificationRules {
...NotificationRuleFragment
}
resourceName
updatedAt
}
errors {
code
message
}
}
}
Variables
{"input": WebhookChannelUpdateInput}
Response
{
"data": {
"webhookChannelUpdate": {
"channel": Channel,
"errors": [ApiError]
}
}
}
windowsDelete
Description
Delete windows in the ids list. Requires editor permissions at the namespace level
Response
Returns a WindowsDeleteResult!
Arguments
| Name | Description |
|---|---|
ids - [WindowId!]!
|
Example
Query
mutation WindowsDelete($ids: [WindowId!]!) {
windowsDelete(ids: $ids) {
errors {
code
message
}
}
}
Variables
{"ids": [WindowId]}
Response
{"data": {"windowsDelete": {"errors": [ApiError]}}}
Types
ApiError
Description
An API error consists of an error code and a message that tells what caused an error if the API request fails
Fields
| Field Name | Description |
|---|---|
code - ApiErrorCode!
|
A code identifying the specific type of error |
message - String!
|
A description of the error and why it occured |
Example
{"code": "UNKNOWN", "message": "xyz789"}
ApiErrorCode
Description
Error code to categorize the error from the API if a request fails
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNKNOWN"
ApiKey
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"globalRole": "ADMIN",
"id": ApiKeyId,
"lastUsedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
ApiKeyId
Example
ApiKeyId
ApiKeyRole
AwsAthenaCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - AwsAthenaCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
isDbtModel - Boolean!
|
|
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": AwsAthenaCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 123,
"id": CatalogAssetId,
"isDbtModel": false,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
AwsAthenaCatalogAssetConfig
AwsAthenaCredential
Description
An AWS Athena credential is used to connect to AWS Athena
Fields
| Field Name | Description |
|---|---|
config - AwsAthenaCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": AwsAthenaCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": true,
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
AwsAthenaCredentialConfig
AwsAthenaCredentialCreateInput
Description
Input for creating AWS Athena credential
Fields
| Input Field | Description |
|---|---|
accessKey - String!
|
Amazon access key, see AWS IAM documentation for more details |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
queryResultLocation - String!
|
Where the query result is located, e.g. an S3 output location. See Athena documentation for more information |
region - String!
|
Region from which Athena should run queries |
resourceName - String
|
The resource name of the credential |
secretKey - String!
|
Amazon secret key, see AWS IAM documentation for more details |
Example
{
"accessKey": "xyz789",
"enableCatalog": false,
"name": "abc123",
"namespaceId": NamespaceId,
"queryResultLocation": "abc123",
"region": "xyz789",
"resourceName": "xyz789",
"secretKey": "xyz789"
}
AwsAthenaCredentialSecretChangedInput
Description
Input for checking if AWS Athena credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
secretKey - String!
|
The secret key to compare |
Example
{
"id": CredentialId,
"secretKey": "xyz789"
}
AwsAthenaCredentialUpdateInput
Description
Input for updating AWS Athena credential
Fields
| Input Field | Description |
|---|---|
accessKey - String
|
Amazon access key, see AWS IAM documentation for more details |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
queryResultLocation - String
|
Where the query result is located, e.g. an S3 output location. See Athena documentation for more information |
region - String
|
Region from which Athena should run queries |
secretKey - String
|
Amazon secret key, see AWS IAM documentation for more details |
Example
{
"accessKey": "xyz789",
"enableCatalog": false,
"id": CredentialId,
"name": "abc123",
"queryResultLocation": "abc123",
"region": "xyz789",
"secretKey": "abc123"
}
AwsAthenaInferSchemaInput
Description
Input for inferring AWS Athena JTD schema
Fields
| Input Field | Description |
|---|---|
catalog - String!
|
Catalog name |
credentialId - CredentialId!
|
Credential used to connect to the source |
database - String!
|
Database name |
table - String!
|
Table name |
Example
{
"catalog": "abc123",
"credentialId": CredentialId,
"database": "abc123",
"table": "abc123"
}
AwsAthenaSource
Description
An AWS Athena source monitor tables in an Amazon Athena database
Fields
| Field Name | Description |
|---|---|
catalogAsset - AwsAthenaCatalogAsset
|
Catalog asset for the source |
config - AwsAthenaSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": AwsAthenaCatalogAsset,
"config": AwsAthenaSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "abc123",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
AwsAthenaSourceConfig
Description
Configuration for an AWS Athena source
Fields
| Field Name | Description |
|---|---|
catalog - String!
|
Catalog name |
cursorField - String
|
Field holding timestamp used for some windowing |
database - String!
|
Database name |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
table - String!
|
Table name |
Example
{
"catalog": "abc123",
"cursorField": "xyz789",
"database": "abc123",
"lookbackDays": 123,
"schedule": CronExpression,
"table": "abc123"
}
AwsAthenaSourceCreateInput
Description
Input for creating an AWS Athena source
Fields
| Input Field | Description |
|---|---|
catalog - String!
|
Catalog name |
credentialId - CredentialId!
|
Credential used to connect to the source |
cursorField - String
|
Field holding timestamp used for some windowing |
database - String!
|
Database name |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
name - String!
|
The display name of the source |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
table - String!
|
Table name |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"catalog": "xyz789",
"credentialId": CredentialId,
"cursorField": "xyz789",
"database": "abc123",
"description": "abc123",
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "abc123",
"resourceName": "xyz789",
"schedule": CronExpression,
"table": "xyz789",
"tagIds": [TagId]
}
AwsAthenaSourceDebugInfo
Description
Debug information for AWS Athena
Example
{
"endTime": "2007-12-03T10:15:30Z",
"sqlQuery": "abc123",
"startTime": "2007-12-03T10:15:30Z"
}
AwsAthenaSourceUpdateInput
Description
Input for updating an AWS Athena source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
lookbackDays - Int
|
How many days to fetch history for when doing backfilling |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "abc123",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 123,
"name": "abc123",
"schedule": CronExpression,
"tagIds": [TagId]
}
AwsCredential
Description
An AWS credential is used to connect to Amazon Web Services specific integrations such as AWS S3
Fields
| Field Name | Description |
|---|---|
config - AwsCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": AwsCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": true,
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
AwsCredentialConfig
Fields
| Field Name | Description |
|---|---|
accessKey - String!
|
Example
{"accessKey": "xyz789"}
AwsCredentialCreateInput
Description
Input for creating an AWS credential
Fields
| Input Field | Description |
|---|---|
accessKey - String!
|
Amazon access key, see AWS IAM documentation for more details |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
secretKey - String!
|
Amazon secret key, see AWS IAM documentation for more details |
Example
{
"accessKey": "abc123",
"enableCatalog": false,
"name": "xyz789",
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"secretKey": "abc123"
}
AwsCredentialSecretChangedInput
Description
Input for checking if AWS credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
secretKey - String!
|
The secret key to compare |
Example
{
"id": CredentialId,
"secretKey": "abc123"
}
AwsCredentialUpdateInput
Description
Input for updating AWS credential
Fields
| Input Field | Description |
|---|---|
accessKey - String
|
Amazon access key, see AWS IAM documentation for more details |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
secretKey - String
|
Amazon secret key, see AWS IAM documentation for more details |
Example
{
"accessKey": "xyz789",
"enableCatalog": true,
"id": CredentialId,
"name": "abc123",
"secretKey": "xyz789"
}
AwsKinesisCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - AwsKinesisCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": AwsKinesisCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 987,
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
AwsKinesisCatalogAssetConfig
Fields
| Field Name | Description |
|---|---|
streamName - String!
|
Example
{"streamName": "abc123"}
AwsKinesisInferSchemaInput
Description
Input for inferring JTD schema from an AWS Kinesis stream
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
region - String!
|
AWS region |
streamName - String!
|
Stream name |
Example
{
"credentialId": CredentialId,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"region": "abc123",
"streamName": "xyz789"
}
AwsKinesisSource
Description
An AWS Kinesis source monitor streams in AWS Kinesis in real-time
Fields
| Field Name | Description |
|---|---|
catalogAsset - AwsKinesisCatalogAsset
|
Catalog asset for the source |
config - AwsKinesisSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": AwsKinesisCatalogAsset,
"config": AwsKinesisSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "xyz789",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
AwsKinesisSourceConfig
Description
Configuration for an AWS Kinesis source
Fields
| Field Name | Description |
|---|---|
messageFormat - StreamingSourceMessageFormatConfig
|
Message format |
region - String!
|
AWS region |
streamName - String!
|
Stream name |
Example
{
"messageFormat": StreamingSourceMessageFormatConfig,
"region": "abc123",
"streamName": "abc123"
}
AwsKinesisSourceCreateInput
Description
Input for creating an AWS Kinesis source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
name - String!
|
The display name of the source |
region - String!
|
AWS region |
resourceName - String
|
The resource name of the source |
streamName - String!
|
Stream name |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"description": "abc123",
"jtdSchema": JsonTypeDefinition,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"name": "xyz789",
"region": "abc123",
"resourceName": "xyz789",
"streamName": "xyz789",
"tagIds": [TagId]
}
AwsKinesisSourceUpdateInput
Description
Input for updating an AWS Kinesis source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
name - String
|
The resource name of the source |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "xyz789",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"name": "xyz789",
"tagIds": [TagId]
}
AwsRedShiftSourceDebugInfo
Description
Debug information for AWS Redshift
Example
{
"endTime": "2007-12-03T10:15:30Z",
"sqlQuery": "xyz789",
"startTime": "2007-12-03T10:15:30Z"
}
AwsRedshiftCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - AwsRedshiftCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
isDbtModel - Boolean!
|
|
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": AwsRedshiftCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 987,
"id": CatalogAssetId,
"isDbtModel": true,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
AwsRedshiftCatalogAssetConfig
AwsRedshiftCredential
Description
An AWS Redshift credential is used to connect to AWS Redshift
Fields
| Field Name | Description |
|---|---|
config - AwsRedshiftCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": AwsRedshiftCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": false,
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
AwsRedshiftCredentialConfig
AwsRedshiftCredentialCreateInput
Description
Input for creating AWS Redshift credential
Fields
| Input Field | Description |
|---|---|
defaultDatabase - String!
|
Name of the default Redshift database |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String!
|
Endpoint of the Redshift cluster database |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
password - String!
|
Password of the specified Redshift user |
port - Int!
|
Port number of the Redshift database |
resourceName - String
|
The resource name of the credential |
user - String!
|
Username of Redshift account with read access to the desired table |
Example
{
"defaultDatabase": "abc123",
"enableCatalog": false,
"host": "xyz789",
"name": "xyz789",
"namespaceId": NamespaceId,
"password": "abc123",
"port": 123,
"resourceName": "abc123",
"user": "abc123"
}
AwsRedshiftCredentialSecretChangedInput
Description
Input for checking if AWS Redshift credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
password - String!
|
The password to compare |
Example
{
"id": CredentialId,
"password": "abc123"
}
AwsRedshiftCredentialUpdateInput
Description
Input for updating AWS Redshift credential
Fields
| Input Field | Description |
|---|---|
defaultDatabase - String
|
Name of the default Redshift database |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String
|
Endpoint of the Redshift cluster database |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
password - String
|
Password of the specified Redshift user |
port - Int
|
Port number of the Redshift database |
user - String
|
Username of Redshift account with read access to the desired table |
Example
{
"defaultDatabase": "abc123",
"enableCatalog": true,
"host": "xyz789",
"id": CredentialId,
"name": "abc123",
"password": "xyz789",
"port": 123,
"user": "xyz789"
}
AwsRedshiftInferSchemaInput
Description
Input for inferring AWS Redshift JTD schema
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
database - String
|
Database name |
schema - String!
|
Schema name |
table - String!
|
Table name |
Example
{
"credentialId": CredentialId,
"database": "xyz789",
"schema": "abc123",
"table": "xyz789"
}
AwsRedshiftSource
Description
An AWS Redshift source monitor tables in an Amazon Redshift database
Fields
| Field Name | Description |
|---|---|
catalogAsset - AwsRedshiftCatalogAsset
|
Catalog asset for the source |
config - AwsRedshiftSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": AwsRedshiftCatalogAsset,
"config": AwsRedshiftSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "xyz789",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
AwsRedshiftSourceConfig
Description
Configuration for an AWS Redshift source
Fields
| Field Name | Description |
|---|---|
cursorField - String
|
Field holding timestamp used for some windowing |
database - String!
|
Database name |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Schema name |
table - String!
|
Table name |
Example
{
"cursorField": "xyz789",
"database": "abc123",
"lookbackDays": 987,
"schedule": CronExpression,
"schema": "xyz789",
"table": "xyz789"
}
AwsRedshiftSourceCreateInput
Description
Input for creating an AWS Redshift source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
cursorField - String
|
Field holding timestamp used for some windowing |
database - String
|
Database name |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
name - String!
|
The display name of the source |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Schema name |
table - String!
|
Table name |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"cursorField": "abc123",
"database": "abc123",
"description": "abc123",
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 123,
"name": "abc123",
"resourceName": "xyz789",
"schedule": CronExpression,
"schema": "xyz789",
"table": "xyz789",
"tagIds": [TagId]
}
AwsRedshiftSourceUpdateInput
Description
Input for updating an AWS Redshift source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
lookbackDays - Int
|
How many days to fetch history for when doing backfilling |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "abc123",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 123,
"name": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
AwsS3CatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - AwsS3CatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": AwsS3CatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 123,
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
AwsS3CatalogAssetConfig
AwsS3InferSchemaInput
Description
Input for inferring AWS S3 JTD schema
Fields
| Input Field | Description |
|---|---|
bucket - String!
|
Bucket name |
credentialId - CredentialId!
|
Credential used to connect to the source |
csv - CsvParserInput
|
CSV settings |
fileFormat - FileFormat
|
File format of files in bucket |
filePattern - String
|
File pattern in glob format, e.g. sales_* |
prefix - String!
|
Prefix for files, e.g. /path/to/files |
Example
{
"bucket": "xyz789",
"credentialId": CredentialId,
"csv": CsvParserInput,
"fileFormat": "CSV",
"filePattern": "abc123",
"prefix": "xyz789"
}
AwsS3Source
Description
An AWS S3 source monitor files in an AWS S3 bucket
Fields
| Field Name | Description |
|---|---|
catalogAsset - AwsS3CatalogAsset
|
Catalog asset for the source |
config - AwsS3SourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": AwsS3CatalogAsset,
"config": AwsS3SourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
AwsS3SourceConfig
Description
Configuration for an Amazon S3 source
Fields
| Field Name | Description |
|---|---|
bucket - String!
|
Bucket name |
csv - CsvParser
|
CSV settings |
fileFormat - FileFormat
|
File format of files in bucket |
filePattern - String
|
File pattern in glob format, e.g. sales_* |
prefix - String!
|
Prefix for files, e.g. /path/to/files |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
Example
{
"bucket": "xyz789",
"csv": CsvParser,
"fileFormat": "CSV",
"filePattern": "abc123",
"prefix": "abc123",
"schedule": CronExpression
}
AwsS3SourceCreateInput
Description
Input for creating an AWS S3 source
Fields
| Input Field | Description |
|---|---|
bucket - String!
|
Bucket name |
credentialId - CredentialId!
|
Credential used to connect to the source |
csv - CsvParserInput
|
CSV settings |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
fileFormat - FileFormat
|
File format of files in bucket |
filePattern - String
|
File pattern in glob format, e.g. sales_* |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
prefix - String!
|
Prefix for files, e.g. /path/to/files |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"bucket": "abc123",
"credentialId": CredentialId,
"csv": CsvParserInput,
"description": "xyz789",
"fileFormat": "CSV",
"filePattern": "xyz789",
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"prefix": "abc123",
"resourceName": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
AwsS3SourceDebugInfo
Description
Debug information for AWS S3
Fields
| Field Name | Description |
|---|---|
bucket - String!
|
The bucket to read record sample from |
endTime - DateTime!
|
End time of record sample |
filePath - [String!]!
|
The path to the file to sample |
startTime - DateTime!
|
Start time of record sample |
Example
{
"bucket": "abc123",
"endTime": "2007-12-03T10:15:30Z",
"filePath": ["xyz789"],
"startTime": "2007-12-03T10:15:30Z"
}
AwsS3SourceUpdateInput
Description
Input for updating an AWS S3 source
Fields
| Input Field | Description |
|---|---|
csv - CsvParserInput
|
CSV settings |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
filePattern - String
|
File pattern in glob format, e.g. sales_* |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"csv": CsvParserInput,
"description": "abc123",
"filePattern": "abc123",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
AzureSynapseBackendType
Description
Backend type used by Azure Synapse
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DEDICATED_SQL_POOL"
AzureSynapseCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - AzureSynapseCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
isDbtModel - Boolean!
|
|
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": AzureSynapseCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 123,
"id": CatalogAssetId,
"isDbtModel": true,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
AzureSynapseCatalogAssetConfig
AzureSynapseEntraIdCredential
Description
An Azure Synapse Entra ID credential is used to connect to Azure Synapse with Entra. The credential has a backend type which tells what the backend is
Fields
| Field Name | Description |
|---|---|
config - AzureSynapseEntraIdCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": AzureSynapseEntraIdCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": false,
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
AzureSynapseEntraIdCredentialConfig
Fields
| Field Name | Description |
|---|---|
backendType - AzureSynapseBackendType!
|
|
clientId - String!
|
|
database - String
|
|
host - String!
|
|
port - Int!
|
Example
{
"backendType": "DEDICATED_SQL_POOL",
"clientId": "xyz789",
"database": "xyz789",
"host": "xyz789",
"port": 987
}
AzureSynapseEntraIdCredentialCreateInput
Description
Input for creating an Azure Synapse with Entra ID credential
Fields
| Input Field | Description |
|---|---|
backendType - AzureSynapseBackendType!
|
The backend used for Azure Synapse |
clientId - String!
|
Client id for Microsoft Entra ID |
clientSecret - String!
|
Client secret for Microsoft Entra ID |
database - String
|
Name of the Azure Synapse database |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String!
|
DNS hostname or IP address to the database server |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
port - Int!
|
Port number of the database server |
resourceName - String
|
The resource name of the credential |
Example
{
"backendType": "DEDICATED_SQL_POOL",
"clientId": "abc123",
"clientSecret": "xyz789",
"database": "abc123",
"enableCatalog": false,
"host": "xyz789",
"name": "xyz789",
"namespaceId": NamespaceId,
"port": 987,
"resourceName": "abc123"
}
AzureSynapseEntraIdCredentialSecretChangedInput
Description
Input for checking if Azure Synapse with Entra ID credentials changed
Fields
| Input Field | Description |
|---|---|
clientSecret - String!
|
The client secret to compare |
id - CredentialId!
|
Credential identifier |
Example
{
"clientSecret": "xyz789",
"id": CredentialId
}
AzureSynapseEntraIdCredentialUpdateInput
Description
Input for updating an Azure Synapse with Entra ID credential
Fields
| Input Field | Description |
|---|---|
backendType - AzureSynapseBackendType
|
The backend used for Azure Synapse |
clientId - String
|
Client id for Microsoft Entra ID |
clientSecret - String
|
Client secret for Microsoft Entra ID |
database - String
|
Name of the Azure Synapse database |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String
|
DNS hostname or IP address to the database server |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
port - Int
|
Port number of the database server |
Example
{
"backendType": "DEDICATED_SQL_POOL",
"clientId": "xyz789",
"clientSecret": "abc123",
"database": "abc123",
"enableCatalog": false,
"host": "xyz789",
"id": CredentialId,
"name": "xyz789",
"port": 987
}
AzureSynapseInferSchemaInput
Description
Input for inferring Azure Synapse JTD schema
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
database - String!
|
Database name |
schema - String!
|
Schema name |
table - String!
|
Table name |
Example
{
"credentialId": CredentialId,
"database": "abc123",
"schema": "xyz789",
"table": "abc123"
}
AzureSynapseSource
Description
An [Azure Synapse]https://azure.microsoft.com/en-us/products/synapse-analytics) source monitor tables in an Azure Synapse database
Fields
| Field Name | Description |
|---|---|
catalogAsset - GcpBigQueryCatalogAsset
|
Catalog asset for the source |
config - AzureSynapseSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": GcpBigQueryCatalogAsset,
"config": AzureSynapseSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
AzureSynapseSourceConfig
Description
Configuration for an Azure Synapse source
Fields
| Field Name | Description |
|---|---|
cursorField - String
|
Field holding timestamp used for some windowing |
database - String!
|
Database name |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Table name |
table - String!
|
Schema name |
Example
{
"cursorField": "abc123",
"database": "xyz789",
"lookbackDays": 987,
"schedule": CronExpression,
"schema": "xyz789",
"table": "abc123"
}
AzureSynapseSourceCreateInput
Description
Input for creating an Azure Synapse source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
cursorField - String
|
Field holding timestamp used for some windowing |
database - String!
|
Database name |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
name - String!
|
The display name of the source |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Schema name |
table - String!
|
Table name |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"cursorField": "xyz789",
"database": "xyz789",
"description": "xyz789",
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "xyz789",
"resourceName": "abc123",
"schedule": CronExpression,
"schema": "abc123",
"table": "abc123",
"tagIds": [TagId]
}
AzureSynapseSourceDebugInfo
Description
Debug information for Azure Synapse
Example
{
"endTime": "2007-12-03T10:15:30Z",
"sqlQuery": "abc123",
"startTime": "2007-12-03T10:15:30Z"
}
AzureSynapseSourceUpdateInput
Description
Input for updating an Azure Synapse source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
lookbackDays - Int
|
How many days to fetch history for when doing backfilling |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "abc123",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "abc123",
"schedule": CronExpression,
"tagIds": [TagId]
}
AzureSynapseSqlCredential
Description
An Azure Synapse SQL credential is used to connect to Azure Synapse with username
Fields
| Field Name | Description |
|---|---|
config - AzureSynapseSqlCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": AzureSynapseSqlCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": false,
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
AzureSynapseSqlCredentialConfig
Fields
| Field Name | Description |
|---|---|
backendType - AzureSynapseBackendType!
|
|
database - String
|
|
host - String!
|
|
port - Int!
|
|
username - String!
|
Example
{
"backendType": "DEDICATED_SQL_POOL",
"database": "abc123",
"host": "xyz789",
"port": 123,
"username": "xyz789"
}
AzureSynapseSqlCredentialCreateInput
Description
Input for creating an Azure Synapse credential
Fields
| Input Field | Description |
|---|---|
backendType - AzureSynapseBackendType!
|
The backend used for Azure Synapse |
database - String
|
Name of the Azure Synapse database |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String!
|
DNS hostname or IP address to the SQL server |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
password - String!
|
SQL Server password |
port - Int!
|
Port number of the SQL server |
resourceName - String
|
The resource name of the credential |
username - String!
|
SQL Server username |
Example
{
"backendType": "DEDICATED_SQL_POOL",
"database": "xyz789",
"enableCatalog": true,
"host": "xyz789",
"name": "xyz789",
"namespaceId": NamespaceId,
"password": "xyz789",
"port": 123,
"resourceName": "xyz789",
"username": "abc123"
}
AzureSynapseSqlCredentialSecretChangedInput
Description
Input for checking if Azure Synapse credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
password - String!
|
The password to compare |
Example
{
"id": CredentialId,
"password": "abc123"
}
AzureSynapseSqlCredentialUpdateInput
Description
Input for updating an Azure Synapse credential
Fields
| Input Field | Description |
|---|---|
backendType - AzureSynapseBackendType
|
The backend used for Azure Synapse |
database - String
|
Name of the Azure Synapse database |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String
|
DNS hostname or IP address to the SQL server |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
password - String
|
SQL Server password |
port - Int
|
Port number of the SQL server |
username - String
|
SQL Server username |
Example
{
"backendType": "DEDICATED_SQL_POOL",
"database": "xyz789",
"enableCatalog": false,
"host": "xyz789",
"id": CredentialId,
"name": "abc123",
"password": "abc123",
"port": 123,
"username": "abc123"
}
Boolean
Description
The Boolean scalar type represents true or false
BooleanFilter
Description
A boolean filter is a filter that filters boolean values. It can be set to filter for true or false values for a given field
Fields
| Field Name | Description |
|---|---|
config - BooleanFilterConfig!
|
Filter variant specific configuration |
createdAt - DateTime!
|
When the filter was created |
id - FilterId!
|
Filter identifier |
name - String!
|
The display name of the filter |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the filter Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the filter |
source - Source!
|
|
updatedAt - DateTime!
|
When the filter was last updated |
Example
{
"config": BooleanFilterConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": FilterId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
BooleanFilterConfig
Description
Boolean filter specific configuration
Fields
| Field Name | Description |
|---|---|
field - JsonPointer!
|
The field to filter on |
operator - BooleanOperator!
|
The operator to use when filtering |
Example
{"field": JsonPointer, "operator": "IS_FALSE"}
BooleanFilterCreateInput
Description
Input for creating a boolean filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer!
|
The field to filter on |
name - String
|
The display name of the filter |
operator - BooleanOperator!
|
The operator to use when filtering |
resourceName - String
|
The resource name of the filter |
sourceId - SourceId!
|
Source identifier |
Example
{
"field": JsonPointer,
"name": "xyz789",
"operator": "IS_FALSE",
"resourceName": "xyz789",
"sourceId": SourceId
}
BooleanFilterUpdateInput
Description
Input for updating a boolean filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer
|
The field to filter on |
id - FilterId!
|
Filter identifier |
name - String
|
The display name of the filter |
operator - BooleanOperator
|
The operator to use when filtering |
Example
{
"field": JsonPointer,
"id": FilterId,
"name": "abc123",
"operator": "IS_FALSE"
}
BooleanOperator
Description
Operator describing the boolean match
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IS_FALSE"
CatalogAsset
Description
Catalog asset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Possible Types
| CatalogAsset Types |
|---|
Example
{
"assetType": "BUCKET",
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "abc123",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
CatalogAssetDescription
Fields
| Field Name | Description |
|---|---|
description - String!
|
|
origin - CatalogAssetDescriptionOrigin!
|
Example
{
"description": "xyz789",
"origin": "CATALOG_REFRESH"
}
CatalogAssetDescriptionOrigin
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CATALOG_REFRESH"
CatalogAssetId
Description
Catalog asset identifier
Example
CatalogAssetId
CatalogAssetStats
CatalogAssetTagsAddInput
Description
Input for adding tags to a catalog asset
Fields
| Input Field | Description |
|---|---|
catalogAssetId - CatalogAssetId!
|
|
tagIds - [TagId!]!
|
Tag IDs for the asset |
Example
{
"catalogAssetId": CatalogAssetId,
"tagIds": [TagId]
}
CatalogAssetTagsDeleteInput
Description
Input for deleting a tag from a catalog asset
Fields
| Input Field | Description |
|---|---|
catalogAssetId - CatalogAssetId!
|
Catalog asset identifier |
tagIds - [TagId!]!
|
Tag IDs for the asset |
Example
{
"catalogAssetId": CatalogAssetId,
"tagIds": [TagId]
}
CatalogAssetType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BUCKET"
CategoricalDistributionMetric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADDED"
CategoricalDistributionValidator
Description
The categorical distribution validator verifies that only the expected number of categories are added, removed, or changed over time
Fields
| Field Name | Description |
|---|---|
config - CategoricalDistributionValidatorConfig!
|
|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
referenceSourceConfig - ReferenceSourceConfig!
|
Reference source configuration |
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"config": CategoricalDistributionValidatorConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"hasCustomName": true,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"referenceSourceConfig": ReferenceSourceConfig,
"resourceName": "xyz789",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
CategoricalDistributionValidatorConfig
Description
Configuration for categorical distribution validator
Fields
| Field Name | Description |
|---|---|
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - CategoricalDistributionMetric!
|
Metric to use for validation |
referenceSourceField - JsonPointer!
|
Reference field to apply validator on |
sourceField - JsonPointer!
|
Field to apply validator on |
threshold - Threshold!
|
The threshold used to determine if the result is an incident or not |
Example
{
"initializeWithBackfill": true,
"metric": "ADDED",
"referenceSourceField": JsonPointer,
"sourceField": JsonPointer,
"threshold": DifferenceThreshold
}
CategoricalDistributionValidatorCreateInput
Description
Input for creating a categorical distribution validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - CategoricalDistributionMetric!
|
Metric to use for validation |
name - String
|
The display name of the validator |
referenceSourceConfig - ReferenceSourceConfigCreateInput!
|
Reference source configuration |
referenceSourceField - JsonPointer!
|
Reference field to apply validator on |
resourceName - String
|
The resource name of the validator |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
sourceField - JsonPointer!
|
Field to apply validator on |
tagIds - [TagId!]
|
Tag IDs for the validator |
Example
{
"description": "xyz789",
"initializeWithBackfill": false,
"metric": "ADDED",
"name": "xyz789",
"referenceSourceConfig": ReferenceSourceConfigCreateInput,
"referenceSourceField": JsonPointer,
"resourceName": "xyz789",
"sourceConfig": SourceConfigCreateInput,
"sourceField": JsonPointer,
"tagIds": [TagId]
}
CategoricalDistributionValidatorUpdateInput
Description
Input for updating a categorical distribution validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
id - ValidatorId!
|
Validator identifier |
name - String
|
The display name of the validator |
referenceSourceConfig - ReferenceSourceConfigUpdateInput
|
Reference source configuration |
sourceConfig - SourceConfigUpdateInput
|
Source configuration |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
Example
{
"description": "abc123",
"id": ValidatorId,
"name": "xyz789",
"referenceSourceConfig": ReferenceSourceConfigUpdateInput,
"sourceConfig": SourceConfigUpdateInput,
"tagIds": [TagId]
}
Channel
Description
A channel is a destination that can be used together with notification rules to configure where notifications should be sent
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the channel was created |
id - ChannelId!
|
Channel identifier |
name - String!
|
The display name of the channel |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id of the channel Use 'namespace.id' instead |
notificationRules - [NotificationRule!]!
|
|
resourceName - String!
|
The resource name of the channel |
updatedAt - DateTime!
|
When the channel was last updated |
Possible Types
| Channel Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": ChannelId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"notificationRules": [NotificationRule],
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
ChannelCreateResult
Description
Result for creating a channel
Fields
| Field Name | Description |
|---|---|
channel - Channel
|
The channel created after a successful request |
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
Example
{
"channel": Channel,
"errors": [ApiError]
}
ChannelDeleteInput
Fields
| Input Field | Description |
|---|---|
id - ChannelId!
|
Example
{"id": ChannelId}
ChannelDeleteResult
Fields
| Field Name | Description |
|---|---|
channel - Channel
|
|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{
"channel": Channel,
"errors": [ApiError]
}
ChannelId
Description
Channel identifier
Example
ChannelId
ChannelUpdateResult
Description
Result for updating a channel
Fields
| Field Name | Description |
|---|---|
channel - Channel
|
The channel updated after a successful request |
errors - [ApiError!]!
|
A list of errors that occurred during the update process |
Example
{
"channel": Channel,
"errors": [ApiError]
}
ClickHouseCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - ClickHouseCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": ClickHouseCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 123,
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
ClickHouseCatalogAssetConfig
ClickHouseCredential
Description
A ClickHouse credential is used to connect to ClickHouse
Fields
| Field Name | Description |
|---|---|
config - ClickHouseCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": ClickHouseCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": false,
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
ClickHouseCredentialConfig
Fields
| Field Name | Description |
|---|---|
defaultDatabase - String!
|
|
host - String!
|
|
port - Int!
|
|
protocol - ClickHouseProtocol!
|
|
username - String!
|
Example
{
"defaultDatabase": "abc123",
"host": "abc123",
"port": 987,
"protocol": "HTTP",
"username": "abc123"
}
ClickHouseCredentialCreateInput
Description
Input for creating ClickHouse credential
Fields
| Input Field | Description |
|---|---|
defaultDatabase - String!
|
Name of the default ClickHouse database where the table to read is included |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String!
|
DNS hostname or IP address to the ClickHouse server |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
password - String!
|
Password for the ClickHouse user account |
port - Int!
|
Port number of the Clickhouse server. Depending on the protocol, the defaults ports are: 9000 (Native), 8123 (HTTP), 8443 (HTTPS). See the list of default network ports in ClickHouse documentation |
protocol - ClickHouseProtocol!
|
Select the ClickHouse client interface: Native (ClickHouse binary), HTTP, or HTTPS |
resourceName - String
|
The resource name of the credential |
username - String!
|
Username of the ClickHouse user account with adequate permissions to access the specified database |
Example
{
"defaultDatabase": "xyz789",
"enableCatalog": false,
"host": "abc123",
"name": "abc123",
"namespaceId": NamespaceId,
"password": "abc123",
"port": 123,
"protocol": "HTTP",
"resourceName": "abc123",
"username": "xyz789"
}
ClickHouseCredentialSecretChangedInput
Description
Input for checking if ClickHouse credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
password - String!
|
The password to compare |
Example
{
"id": CredentialId,
"password": "xyz789"
}
ClickHouseCredentialUpdateInput
Description
Input for updating ClickHouse credential
Fields
| Input Field | Description |
|---|---|
defaultDatabase - String
|
Name of the default ClickHouse database where the table to read is included |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String
|
Port number of the Clickhouse server. Depending on the protocol, the defaults ports are: 9000 (Native), 8123 (HTTP), 8443 (HTTPS). See the list of default network ports in ClickHouse documentation |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
password - String
|
Password for the ClickHouse user account |
port - Int
|
Username of the ClickHouse user account with adequate permissions to access the specified database |
protocol - ClickHouseProtocol
|
Select the ClickHouse client interface: Native (ClickHouse binary), HTTP, or HTTPS |
username - String
|
Name of the default ClickHouse database where the table to read is included |
Example
{
"defaultDatabase": "abc123",
"enableCatalog": true,
"host": "abc123",
"id": CredentialId,
"name": "xyz789",
"password": "abc123",
"port": 123,
"protocol": "HTTP",
"username": "abc123"
}
ClickHouseInferSchemaInput
Description
Input for inferring ClickHouse JTD schema
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
database - String
|
Database name |
table - String!
|
Table name |
Example
{
"credentialId": CredentialId,
"database": "xyz789",
"table": "abc123"
}
ClickHouseProtocol
Description
Protocol to use when connecting to ClickHouse
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"HTTP"
ClickHouseSource
Description
A ClickHouse source monitor tables in a ClickHouse database
Fields
| Field Name | Description |
|---|---|
catalogAsset - ClickHouseCatalogAsset
|
Catalog asset for the source |
config - ClickHouseSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": ClickHouseCatalogAsset,
"config": ClickHouseSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "abc123",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "xyz789",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
ClickHouseSourceConfig
Description
Configuration for a ClickHouse source
Fields
| Field Name | Description |
|---|---|
cursorField - String
|
Field holding timestamp used for some windowing |
database - String!
|
Database name |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
table - String!
|
Table name |
Example
{
"cursorField": "xyz789",
"database": "xyz789",
"lookbackDays": 987,
"schedule": CronExpression,
"table": "abc123"
}
ClickHouseSourceCreateInput
Description
Input for creating a ClickHouse source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
cursorField - String
|
Field holding timestamp used for some windowing |
database - String
|
Database name |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
name - String!
|
The display name of the source |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
table - String!
|
Table name |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"cursorField": "xyz789",
"database": "xyz789",
"description": "abc123",
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "xyz789",
"resourceName": "abc123",
"schedule": CronExpression,
"table": "abc123",
"tagIds": [TagId]
}
ClickHouseSourceDebugInfo
Description
Debug information for ClickHouse
Example
{
"endTime": "2007-12-03T10:15:30Z",
"sqlQuery": "abc123",
"startTime": "2007-12-03T10:15:30Z"
}
ClickHouseSourceUpdateInput
Description
Input for updating a ClickHouse source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
lookbackDays - Int
|
How many days to fetch history for when doing backfilling |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "abc123",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "abc123",
"schedule": CronExpression,
"tagIds": [TagId]
}
ComparisonOperator
Description
Operator to compare two numeric values
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQUAL"
Credential
Description
Credentials store the authorizations for the user or service accounts used to integrate Validio with data sources. When connecting Validio to an integration, such as a data source or a notification channel, the credential authenticates the connection. More information about channels can be found here
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the credential was created |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id of the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Possible Types
| Credential Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
CredentialCreateResult
Description
Result for creating a credential
Fields
| Field Name | Description |
|---|---|
credential - Credential
|
The credential created after a successful request |
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
Example
{
"credential": Credential,
"errors": [ApiError]
}
CredentialId
Description
Credential identifier
Example
CredentialId
CredentialSecretChangedResult
Description
Result for checking if a secret has been changed
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
hasChanged - Boolean
|
True if the secret is different from the value in the request |
Example
{"errors": [ApiError], "hasChanged": true}
CredentialUpdateResult
Description
Result for updating a credential
Fields
| Field Name | Description |
|---|---|
credential - Credential
|
The credential updated after a successful request |
errors - [ApiError!]!
|
Example
{
"credential": Credential,
"errors": [ApiError]
}
CredentialsDeleteResult
Description
Result for deleting a credential
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{"errors": [ApiError]}
CronExpression
Description
A cron expression used to configure scheduling of a source. For more help with cron expression please refer to a cron editor such as crontab.guru
Example
CronExpression
CsvParser
Description
Settings for how to parse CSV files
Example
{
"delimiter": "abc123",
"nullMarker": "abc123"
}
CsvParserInput
Description
Input for creating CSV parser settings
Example
{
"delimiter": "xyz789",
"nullMarker": "abc123"
}
DashboardCatalogAssetConfig
DataQuality
DataUrl
Example
DataUrl
DatabricksCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - DatabricksCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
isDbtModel - Boolean!
|
|
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": DatabricksCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 123,
"id": CatalogAssetId,
"isDbtModel": false,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
DatabricksCatalogAssetConfig
DatabricksCredential
Description
A Databricks credential is used to connect to Databricks
Fields
| Field Name | Description |
|---|---|
config - DatabricksCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": DatabricksCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": true,
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
DatabricksCredentialConfig
DatabricksCredentialCreateInput
Description
Input for creating Databricks credential
Fields
| Input Field | Description |
|---|---|
accessToken - String!
|
Access token for authentication |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String!
|
Databricks account host |
httpPath - String!
|
SQL warehouse HTTP path. Can also be overridden on a per source basis |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
port - Int!
|
SQL Warehouse port |
resourceName - String
|
The resource name of the credential |
Example
{
"accessToken": "abc123",
"enableCatalog": false,
"host": "xyz789",
"httpPath": "abc123",
"name": "abc123",
"namespaceId": NamespaceId,
"port": 123,
"resourceName": "abc123"
}
DatabricksCredentialSecretChangedInput
Description
Input for checking if Databricks credentials changed
Fields
| Input Field | Description |
|---|---|
accessToken - String!
|
The access token to compare |
id - CredentialId!
|
Credential identifier |
Example
{
"accessToken": "xyz789",
"id": CredentialId
}
DatabricksCredentialUpdateInput
Description
Input for updating Databricks credential
Fields
| Input Field | Description |
|---|---|
accessToken - String
|
Access token for authentication |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String
|
Databricks account host |
httpPath - String
|
SQL warehouse HTTP path. Can also be overridden on a per source basis |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
port - Int
|
SQL Warehouse port |
Example
{
"accessToken": "xyz789",
"enableCatalog": false,
"host": "abc123",
"httpPath": "abc123",
"id": CredentialId,
"name": "xyz789",
"port": 987
}
DatabricksInferSchemaInput
Fields
| Input Field | Description |
|---|---|
catalog - String!
|
Catalog name |
credentialId - CredentialId!
|
Credential used to connect to the source |
httpPath - String
|
SQL warehouse HTTP path |
schema - String!
|
Schema name |
table - String!
|
Table name |
Example
{
"catalog": "xyz789",
"credentialId": CredentialId,
"httpPath": "abc123",
"schema": "xyz789",
"table": "xyz789"
}
DatabricksSource
Description
A Databricks source monitor tables in a Databricks catalog
Fields
| Field Name | Description |
|---|---|
catalogAsset - DatabricksCatalogAsset
|
Catalog asset for the source |
config - DatabricksSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": DatabricksCatalogAsset,
"config": DatabricksSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "xyz789",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
DatabricksSourceConfig
Description
Configuration for a Databricks source
Fields
| Field Name | Description |
|---|---|
catalog - String!
|
Catalog name |
cursorField - String
|
Field holding timestamp used for some windowing |
httpPath - String
|
Source specific HTTP Path, overriding the one on the credential |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Database name |
table - String!
|
Table name |
Example
{
"catalog": "abc123",
"cursorField": "abc123",
"httpPath": "abc123",
"lookbackDays": 123,
"schedule": CronExpression,
"schema": "xyz789",
"table": "xyz789"
}
DatabricksSourceCreateInput
Description
Input for creating a Databricks source
Fields
| Input Field | Description |
|---|---|
catalog - String!
|
Catalog name |
credentialId - CredentialId!
|
Credential used to connect to the source |
cursorField - String
|
Field holding timestamp used for some windowing |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
httpPath - String
|
Source specific HTTP Path, overriding the one on the credential |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
name - String!
|
The display name of the source |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Database name |
table - String!
|
Table name |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"catalog": "abc123",
"credentialId": CredentialId,
"cursorField": "xyz789",
"description": "xyz789",
"httpPath": "abc123",
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "xyz789",
"resourceName": "abc123",
"schedule": CronExpression,
"schema": "xyz789",
"table": "abc123",
"tagIds": [TagId]
}
DatabricksSourceDebugInfo
Description
Debug information for Databricks
Example
{
"endTime": "2007-12-03T10:15:30Z",
"sqlQuery": "xyz789",
"startTime": "2007-12-03T10:15:30Z"
}
DatabricksSourceUpdateInput
Description
Input for updating a Databricks source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
httpPath - String
|
Source specific HTTP Path, overriding the one on the credential |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
lookbackDays - Int
|
How many days to fetch history for when doing backfilling |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "xyz789",
"httpPath": "abc123",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
DatabricksStartWarehouseInput
Description
Input for starting a Databricks warehouse
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
Example
{"credentialId": CredentialId}
DatabricksWarehouseInfo
DatabricksWarehouseInfoInput
Description
Input for getting Databricks warehouse information
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
Example
{"credentialId": CredentialId}
DateTime
Description
A representation of a date and time, optionally including timezone
Example
"2007-12-03T10:15:30Z"
DbtArtifactMultipartUploadAppendPartInput
Description
Append to a multipart upload. The payload upon completion should have the format.
{
"manifest": {},
"run_result": {}
}
Where the manifest and run_result fields contain the respective artifact JSON
Fields
| Input Field | Description |
|---|---|
id - DbtArtifactMultipartUploadId!
|
The id of the multipart upload |
part - String!
|
The chunk of the upload |
Example
{
"id": DbtArtifactMultipartUploadId,
"part": "xyz789"
}
DbtArtifactMultipartUploadCompleteInput
Description
Input for creating a multipart complete message
Fields
| Input Field | Description |
|---|---|
id - DbtArtifactMultipartUploadId!
|
The id of the multipart upload |
Example
{"id": DbtArtifactMultipartUploadId}
DbtArtifactMultipartUploadCreateInput
Description
Input for multipart upload of dbt artifacts
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
The id of the credential to tie to the assets in the dbt manifest |
jobName - String!
|
An associate name for the run of this job. Will be used to group jobs together |
Example
{
"credentialId": CredentialId,
"jobName": "abc123"
}
DbtArtifactMultipartUploadCreateResult
Description
Result for dbt artifact multipart uploading
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
id - DbtArtifactMultipartUploadId!
|
The id of the multipart upload |
Example
{
"errors": [ApiError],
"id": DbtArtifactMultipartUploadId
}
DbtArtifactMultipartUploadId
Description
An identifier to group multipart uploads
Example
DbtArtifactMultipartUploadId
DbtArtifactMultipartUploadResult
Description
Result for dbt artifact multipart upload
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
Example
{"errors": [ApiError]}
DbtArtifactUploadInput
Description
Input for uploading dbt artifacts
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
The id of the credential to tie to the assets in the dbt manifest |
jobName - String!
|
An associate name for the run of this job. Will be used to group jobs together |
manifest - JsonObject!
|
The dbt manifest contents as a JSON blob |
runResults - JsonObject
|
The run result contents as a JSON blob |
Example
{
"credentialId": CredentialId,
"jobName": "abc123",
"manifest": JsonObject,
"runResults": JsonObject
}
DbtArtifactUploadResult
Description
Result for uploading dbt artifacts
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
Example
{"errors": [ApiError]}
DbtCloudCredential
Description
A dbt Cloud credential is used to connect to dbt Cloud
Fields
| Field Name | Description |
|---|---|
config - DbtCloudCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": DbtCloudCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
DbtCloudCredentialConfig
Fields
| Field Name | Description |
|---|---|
accountId - String!
|
|
apiBaseUrl - String
|
|
warehouseCredential - Credential!
|
Example
{
"accountId": "abc123",
"apiBaseUrl": "abc123",
"warehouseCredential": Credential
}
DbtCloudCredentialCreateInput
Description
Input for creating dbt Cloud credential
Fields
| Input Field | Description |
|---|---|
accountId - String!
|
dbt Cloud Account id |
apiBaseUrl - String
|
dbt Cloud base URL. Defaults to https://cloud.getdbt.com |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
token - String!
|
dbt Cloud API token |
warehouseCredentialId - CredentialId!
|
Credential for the table where your dbt output is stored |
Example
{
"accountId": "xyz789",
"apiBaseUrl": "xyz789",
"name": "xyz789",
"namespaceId": NamespaceId,
"resourceName": "abc123",
"token": "xyz789",
"warehouseCredentialId": CredentialId
}
DbtCloudCredentialSecretChangedInput
Description
Input for checking if dbt Cloud credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
token - String!
|
The token to compare |
Example
{
"id": CredentialId,
"token": "abc123"
}
DbtCloudCredentialUpdateInput
Description
Input for updating dbt Cloud credential
Fields
| Input Field | Description |
|---|---|
accountId - String
|
dbt Cloud Account id |
apiBaseUrl - String
|
dbt Cloud base URL. Defaults to https://cloud.getdbt.com |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
token - String
|
dbt Cloud API token |
warehouseCredentialId - CredentialId
|
Credential for the table where your dbt output is stored |
Example
{
"accountId": "xyz789",
"apiBaseUrl": "xyz789",
"id": CredentialId,
"name": "xyz789",
"token": "abc123",
"warehouseCredentialId": CredentialId
}
DbtCoreCredential
Description
A dbt Core credential is used to reference resources discovered by manually uploaded dbt artifacts
Fields
| Field Name | Description |
|---|---|
config - DbtCoreCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": DbtCoreCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
DbtCoreCredentialConfig
Fields
| Field Name | Description |
|---|---|
warehouseCredential - Credential!
|
Example
{"warehouseCredential": Credential}
DbtCoreCredentialCreateInput
Description
Input for creating a dbt Core credential
Fields
| Input Field | Description |
|---|---|
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
warehouseCredentialId - CredentialId!
|
Credential for the table where your dbt output is stored |
Example
{
"name": "xyz789",
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"warehouseCredentialId": CredentialId
}
DbtCoreCredentialUpdateInput
Description
Input for updating a dbt Core credential
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
warehouseCredentialId - CredentialId
|
Credential for the table where your dbt output is stored |
Example
{
"id": CredentialId,
"name": "abc123",
"warehouseCredentialId": CredentialId
}
DbtModelCatalogAsset
Fields
| Field Name | Description |
|---|---|
isDbtModel - Boolean!
|
Possible Types
| DbtModelCatalogAsset Types |
|---|
Example
{"isDbtModel": false}
DbtModelRunSource
Description
A dbt model run source is monitoring the run results from dbt. When using dbt Cloud or dbt Core in Validio the run results and test results are stored internally. This validator will allow you to create validations on these metrics
Fields
| Field Name | Description |
|---|---|
catalogAsset - CatalogAsset
|
Catalog asset for the source |
config - DbtModelRunSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": CatalogAsset,
"config": DbtModelRunSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "abc123",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
DbtModelRunSourceConfig
Description
Configuration for a dbt model run source
Fields
| Field Name | Description |
|---|---|
jobName - String!
|
Job name |
projectName - String!
|
Project name |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
Example
{
"jobName": "xyz789",
"projectName": "abc123",
"schedule": CronExpression
}
DbtModelRunSourceCreateInput
Description
Input for creating a dbt model run source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jobName - String!
|
Job name |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
projectName - String!
|
Project name |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"description": "xyz789",
"jobName": "abc123",
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"projectName": "xyz789",
"resourceName": "abc123",
"schedule": CronExpression,
"tagIds": [TagId]
}
DbtModelRunSourceUpdateInput
Description
Input for updating a dbt model run source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "abc123",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
DbtTestResultSource
Description
A dbt test result source is monitoring the test results from dbt. When using dbt Cloud or dbt Core in Validio the run results and test results are stored internally. This validator will allow you to create validations on these metrics
Fields
| Field Name | Description |
|---|---|
catalogAsset - CatalogAsset
|
Catalog asset for the source |
config - DbtTestResultSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": CatalogAsset,
"config": DbtTestResultSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
DbtTestResultSourceConfig
Description
Configuration for a dbt test result source
Fields
| Field Name | Description |
|---|---|
jobName - String!
|
Job name |
projectName - String!
|
Project name |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
Example
{
"jobName": "xyz789",
"projectName": "abc123",
"schedule": CronExpression
}
DbtTestResultSourceCreateInput
Description
Input for creating a dbt test result source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jobName - String!
|
Job name |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
projectName - String!
|
Project name |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"description": "xyz789",
"jobName": "abc123",
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"projectName": "abc123",
"resourceName": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
DbtTestResultSourceUpdateInput
Description
Input for updating a dbt test result source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "xyz789",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"schedule": CronExpression,
"tagIds": [TagId]
}
DebugRecordsSample
Description
A sample of records from debugging a validator
Fields
| Field Name | Description |
|---|---|
columns - [String!]!
|
Columns in the sample set |
rows - [JSON!]!
|
Values in the sample set, in the same order as the columns |
Example
{"columns": ["xyz789"], "rows": [{}]}
DecisionBoundsType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LOWER"
DemoCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - DemoCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": DemoCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 987,
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
DemoCatalogAssetConfig
Fields
| Field Name | Description |
|---|---|
streamName - String!
|
Example
{"streamName": "xyz789"}
DemoCredential
Description
A demo credential is used for demonstration purposes only
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the credential was created |
id - CredentialId!
|
Credential identifier |
name - String!
|
An underlying credential id that is used to access the assets managed by dbt |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The resource name of the credential Use 'namespace.id' instead |
resourceName - String!
|
The display name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
DemoCredentialCreateInput
Description
Input for creating demo credential
Fields
| Input Field | Description |
|---|---|
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
Example
{
"name": "abc123",
"namespaceId": NamespaceId,
"resourceName": "abc123"
}
DemoCredentialUpdateInput
Description
Input for updating demo credential
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
Example
{
"id": CredentialId,
"name": "abc123"
}
DemoSource
Description
A demo source is used purely for demonstration purposes. It works as a streaming source by continuously looping over a file with 50k records
Fields
| Field Name | Description |
|---|---|
catalogAsset - DemoCatalogAsset
|
Catalog asset for the source |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": DemoCatalogAsset,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "abc123",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "xyz789",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
DemoSourceCreateInput
Description
Input for creating a demo source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
resourceName - String
|
The resource name of the source |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"description": "abc123",
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"resourceName": "abc123",
"tagIds": [TagId]
}
DemoSourceUpdateInput
Description
Input for updating a demo source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
name - String
|
The display name of the source |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "abc123",
"id": SourceId,
"name": "abc123",
"tagIds": [TagId]
}
DifferenceOperator
Description
Operator for monitoring consecutive changes
Values
| Enum Value | Description |
|---|---|
|
|
Includes equality |
|
|
Includes equality |
|
|
Does not include equality |
|
|
Does not include equality |
Example
"DECREASING"
DifferenceThreshold
Description
Difference thresholds monitor a metric and alerts when the difference of the metric value between windows deviates from a specified absolute value or percentage value for consecutive windows. See the documentation for more information
Fields
| Field Name | Description |
|---|---|
differenceType - DifferenceType!
|
Absolute or percentage change |
numberOfWindows - Int!
|
Number of consecutive windows for which the threshold event must happen before an incident is created |
operator - DifferenceOperator!
|
Operator determining type of change |
value - Float!
|
Numeric value. For absolute, the value is in the scale of the metric. For percentage, the value is the percentage points |
Example
{
"differenceType": "ABSOLUTE",
"numberOfWindows": 987,
"operator": "DECREASING",
"value": 987.65
}
DifferenceThresholdCreateInput
Description
Input for creating a difference threshold
Fields
| Input Field | Description |
|---|---|
differenceType - DifferenceType!
|
Absolute or percentage change |
numberOfWindows - Int!
|
Number of consecutive windows for which the threshold event must happen before an incident is created |
operator - DifferenceOperator!
|
Operator determining type of change |
value - Float!
|
Numeric value. For absolute, the value is in the scale of the metric. For percentage, the value is the percentage points |
Example
{
"differenceType": "ABSOLUTE",
"numberOfWindows": 123,
"operator": "DECREASING",
"value": 123.45
}
DifferenceType
Description
Difference type to determine if it should be an absolute value or a percentage based on the metric value
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ABSOLUTE"
DynamicThreshold
Description
Dynamic Thresholds use a combination of smart algorithms to automatically detect anomalies in your data. The threshold model infers trends, seasonality, and peaks, and also adapts to shifts in your data. It learns from historical data and is trained on new data, continuously improving as more data is read. See the documentation for more information
Fields
| Field Name | Description |
|---|---|
decisionBoundsType - DecisionBoundsType
|
The decision bound type on the dynamic threshold specifies whether the boundaries for anomaly detection are double or single-sided |
sensitivity - Float!
|
Sensitivity defines the accepted range of values for the dynamic threshold |
Example
{"decisionBoundsType": "LOWER", "sensitivity": 987.65}
DynamicThresholdCreateInput
Description
Input for creating a dynamic threshold
Fields
| Input Field | Description |
|---|---|
decisionBoundsType - DecisionBoundsType
|
Double or single-sided boundary check |
sensitivity - Float!
|
Sensitivity for accepted range |
Example
{"decisionBoundsType": "LOWER", "sensitivity": 123.45}
EnumFilter
Description
An enum filter is a filter that filters multiple string values by configuring a list of values and selecting an operator to either include or exclude these values
Fields
| Field Name | Description |
|---|---|
config - EnumFilterConfig!
|
Filter variant specific configuration |
createdAt - DateTime!
|
When the filter was created |
id - FilterId!
|
Filter identifier |
name - String!
|
The display name of the filter |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the filter Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the filter |
source - Source!
|
|
updatedAt - DateTime!
|
When the filter was last updated |
Example
{
"config": EnumFilterConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": FilterId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
EnumFilterConfig
Description
Enum filter specific configuration
Fields
| Field Name | Description |
|---|---|
field - JsonPointer!
|
The field to filter on |
operator - EnumOperator!
|
The operator to use when filtering |
values - [String!]!
|
The values to use with the operator |
Example
{
"field": JsonPointer,
"operator": "ALLOW",
"values": ["xyz789"]
}
EnumFilterCreateInput
Description
Input for creating an enum filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer!
|
The field to filter on |
name - String
|
The display name of the filter |
operator - EnumOperator!
|
The operator to use when filtering |
resourceName - String
|
The resource name of the filter |
sourceId - SourceId!
|
Source identifier |
values - [String!]!
|
The enum values to apply filter for |
Example
{
"field": JsonPointer,
"name": "xyz789",
"operator": "ALLOW",
"resourceName": "xyz789",
"sourceId": SourceId,
"values": ["abc123"]
}
EnumFilterUpdateInput
Description
Input for updating an enum filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer
|
The field to filter on |
id - FilterId!
|
Filter identifier |
name - String
|
The display name of the filter |
operator - EnumOperator
|
The operator to use when filtering |
values - [String!]
|
The enum values to apply filter for |
Example
{
"field": JsonPointer,
"id": FilterId,
"name": "abc123",
"operator": "ALLOW",
"values": ["abc123"]
}
EnumOperator
Description
Operator describing the enum filter behavior
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ALLOW"
EnumQueryFilter
Fields
| Input Field | Description |
|---|---|
values - [String!]!
|
Example
{"values": ["abc123"]}
ExploreCatalogAssetConfig
FederatedIdentity
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
id - ID!
|
|
idp - IdentityProvider!
|
|
userId - UserId
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"idp": IdentityProvider,
"userId": UserId
}
FileFormat
Description
File format used for objects in object storages
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CSV"
FileWindow
Description
File windows consist of logical batches by file/BLOB. For example, one CSV file is a logical batch
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the window was created |
dataTimeField - JsonPointer!
|
Identifier for the index field used to configure the window |
id - WindowId!
|
Window identifier |
name - String!
|
The display name of the window |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the window Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the window |
source - Source!
|
|
updatedAt - DateTime!
|
When the window was last updated |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"dataTimeField": JsonPointer,
"id": WindowId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
FileWindowCreateInput
Description
Input for creating a file window
Fields
| Input Field | Description |
|---|---|
dataTimeField - JsonPointer!
|
Identifier for the index field used to configure the window |
name - String
|
The display name of the window |
resourceName - String
|
The resource name of the window |
sourceId - SourceId!
|
Source the window belong to |
Example
{
"dataTimeField": JsonPointer,
"name": "xyz789",
"resourceName": "xyz789",
"sourceId": SourceId
}
FileWindowUpdateInput
Filter
Description
A filter is used to filter out individual data points that should not be considered when doing computations and analysis on the data. In a SQL context this is equivalent of a WHERE clause filtering out specific records
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the filter was created |
id - FilterId!
|
Filter identifier |
name - String!
|
The display name of the filter |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id of the filter Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the filter |
source - Source!
|
|
updatedAt - DateTime!
|
When the filter was last updated |
Possible Types
| Filter Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": FilterId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
FilterId
Description
Filter identifier
Example
FilterId
FilterResult
Description
Result for creating, updating or fetching a filter
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
filter - Filter
|
The filter created, updated or selected |
Example
{
"errors": [ApiError],
"filter": Filter
}
FiltersDeleteResult
Description
Result for deleting a filter
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
Example
{"errors": [ApiError]}
FixedBatchWindow
Description
Fixed batch windows are defined by a specified number of datapoints, from a certain data-time field
Fields
| Field Name | Description |
|---|---|
config - FixedBatchWindowConfig!
|
|
createdAt - DateTime!
|
When the window was created |
dataTimeField - JsonPointer!
|
Identifier for the index field used to configure the window |
id - WindowId!
|
Window identifier |
name - String!
|
The display name of the window |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the window Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the window |
source - Source!
|
|
updatedAt - DateTime!
|
When the window was last updated |
Example
{
"config": FixedBatchWindowConfig,
"createdAt": "2007-12-03T10:15:30Z",
"dataTimeField": JsonPointer,
"id": WindowId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
FixedBatchWindowConfig
FixedBatchWindowCreateInput
Description
Input for creating a fixed batch window
Fields
| Input Field | Description |
|---|---|
batchSize - Int!
|
Number of datapoints (rows) of the window, e.g. 256 |
batchTimeoutSecs - Int
|
Number of seconds to wait before unconditionally close a window even if not <batch size> datapoints has been seen |
dataTimeField - JsonPointer!
|
Identifier for the index field used to configure the window |
name - String
|
The display name of the window |
resourceName - String
|
The resource name of the window |
segmentedBatching - Boolean!
|
If True, each segment gets a separate window of batch size length |
sourceId - SourceId!
|
Source the window belong to |
Example
{
"batchSize": 123,
"batchTimeoutSecs": 987,
"dataTimeField": JsonPointer,
"name": "abc123",
"resourceName": "abc123",
"segmentedBatching": false,
"sourceId": SourceId
}
FixedBatchWindowUpdateInput
Description
Input for updating a fixed batch window
Fields
| Input Field | Description |
|---|---|
batchSize - Int
|
Number of datapoints (rows) of the window, e.g. 256 |
batchTimeoutSecs - Int
|
Number of seconds to wait before unconditionally close a window even if not <batch size> datapoints has been seen |
id - WindowId!
|
Window identifier |
name - String
|
The display name of the window |
segmentedBatching - Boolean
|
If True, each segment gets a separate window of batch size length |
Example
{
"batchSize": 123,
"batchTimeoutSecs": 987,
"id": WindowId,
"name": "xyz789",
"segmentedBatching": false
}
FixedThreshold
Description
Fixed thresholds perform comparison operations between numeric metrics and a specified value. For example, you can define a fixed threshold to check that no values in the field “Age” are less than zero. See the documentation for more information
Fields
| Field Name | Description |
|---|---|
operator - ComparisonOperator!
|
Operator to compare two numeric values |
value - Float!
|
The value to compare against |
Example
{"operator": "EQUAL", "value": 987.65}
FixedThresholdCreateInput
Description
Input for creating a fixed threshold
Fields
| Input Field | Description |
|---|---|
operator - ComparisonOperator!
|
Operator to compare two numeric values |
value - Float!
|
The value to compare against |
Example
{"operator": "EQUAL", "value": 987.65}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754
Example
987.65
FreshnessValidator
Description
The freshness validators monitor the time elapsed since the data was last updated on the source
Fields
| Field Name | Description |
|---|---|
config - FreshnessValidatorConfig!
|
|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"config": FreshnessValidatorConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"hasCustomName": false,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"resourceName": "xyz789",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
FreshnessValidatorConfig
Description
Configuration for freshness validator
Fields
| Field Name | Description |
|---|---|
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
sourceField - JsonPointer
|
Field to apply validator on |
threshold - Threshold!
|
The threshold used to determine if the result is an incident or not |
Example
{
"initializeWithBackfill": false,
"sourceField": JsonPointer,
"threshold": DifferenceThreshold
}
FreshnessValidatorCreateInput
Description
Input for creating a freshness validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
name - String
|
The display name of the validator |
resourceName - String
|
The resource name of the validator |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
sourceField - JsonPointer
|
Field to apply validator on |
tagIds - [TagId!]
|
Tag IDs for the validator |
Example
{
"description": "xyz789",
"initializeWithBackfill": false,
"name": "abc123",
"resourceName": "xyz789",
"sourceConfig": SourceConfigCreateInput,
"sourceField": JsonPointer,
"tagIds": [TagId]
}
FreshnessValidatorUpdateInput
Description
Input for updating a freshness validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
id - ValidatorId!
|
Validator identifier |
name - String
|
The display name of the validator |
sourceConfig - SourceConfigUpdateInput
|
Source configuration |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
Example
{
"description": "xyz789",
"id": ValidatorId,
"name": "xyz789",
"sourceConfig": SourceConfigUpdateInput,
"tagIds": [TagId]
}
GcpBigQueryCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - GcpBigQueryCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
isDbtModel - Boolean!
|
|
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": GcpBigQueryCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 987,
"id": CatalogAssetId,
"isDbtModel": true,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
GcpBigQueryCatalogAssetConfig
GcpBigQueryInferSchemaInput
Description
Input for inferring GCP BigQuery JTD schema
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
dataset - String!
|
Dataset name |
project - String!
|
GCP project name |
table - String!
|
Table name |
Example
{
"credentialId": CredentialId,
"dataset": "abc123",
"project": "abc123",
"table": "abc123"
}
GcpBigQuerySource
Description
A Google BigQuery source monitor datasets in a Google BigQuery dataset
Fields
| Field Name | Description |
|---|---|
catalogAsset - GcpBigQueryCatalogAsset
|
Catalog asset for the source |
config - GcpBigQuerySourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": GcpBigQueryCatalogAsset,
"config": GcpBigQuerySourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
GcpBigQuerySourceConfig
Description
Configuration for a Google BigQuery source
Fields
| Field Name | Description |
|---|---|
cursorField - String
|
Field holding timestamp used for some windowing |
dataset - String!
|
Dataset name |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
project - String!
|
GCP project name |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
table - String!
|
Table name |
Example
{
"cursorField": "xyz789",
"dataset": "xyz789",
"lookbackDays": 987,
"project": "abc123",
"schedule": CronExpression,
"table": "abc123"
}
GcpBigQuerySourceCreateInput
Description
Input for creating a Google BigQuery source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
cursorField - String
|
Field holding timestamp used for some windowing |
dataset - String!
|
Dataset name |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
name - String!
|
The display name of the source |
project - String!
|
GCP project name |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
table - String!
|
Table name |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"cursorField": "abc123",
"dataset": "abc123",
"description": "xyz789",
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "xyz789",
"project": "xyz789",
"resourceName": "abc123",
"schedule": CronExpression,
"table": "abc123",
"tagIds": [TagId]
}
GcpBigQuerySourceDebugInfo
Description
Debug information for Google BigQuery
Example
{
"endTime": "2007-12-03T10:15:30Z",
"sqlQuery": "xyz789",
"startTime": "2007-12-03T10:15:30Z"
}
GcpBigQuerySourceUpdateInput
Description
Input for updating a Google BigQuery source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
lookbackDays - Int
|
How many days to fetch history for when doing backfilling |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "xyz789",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 123,
"name": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
GcpCredential
Description
A GCP credential is used to connect to Google Cloud Platform services such as Google Cloud Storage or Google BigQuery
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": true,
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
GcpCredentialCreateInput
Description
Input for creating a GCP credential
Fields
| Input Field | Description |
|---|---|
credential - String!
|
JSON credential file content for a service account |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
Example
{
"credential": "abc123",
"enableCatalog": false,
"name": "abc123",
"namespaceId": NamespaceId,
"resourceName": "xyz789"
}
GcpCredentialSecretChangedInput
Description
Input for checking if GCP credentials changed
Fields
| Input Field | Description |
|---|---|
credential - String!
|
The JSON blob to compare |
id - CredentialId!
|
Credential identifier |
Example
{
"credential": "abc123",
"id": CredentialId
}
GcpCredentialUpdateInput
Description
Input for updating a GCP credential
Fields
| Input Field | Description |
|---|---|
credential - String
|
JSON credential file content for a service account |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
Example
{
"credential": "xyz789",
"enableCatalog": false,
"id": CredentialId,
"name": "abc123"
}
GcpPubSubCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - GcpPubSubCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": GcpPubSubCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 987,
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
GcpPubSubCatalogAssetConfig
Fields
| Field Name | Description |
|---|---|
subscriptionId - String!
|
Example
{"subscriptionId": "xyz789"}
GcpPubSubInferSchemaInput
Description
Input for inferring GCP Pub/Sub JTD schema
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
project - String!
|
GCP project name |
subscriptionId - String!
|
Subscription identifier |
Example
{
"credentialId": CredentialId,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"project": "abc123",
"subscriptionId": "xyz789"
}
GcpPubSubLiteCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - GcpPubSubLiteCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": GcpPubSubLiteCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 123,
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
GcpPubSubLiteCatalogAssetConfig
Fields
| Field Name | Description |
|---|---|
subscriptionId - String!
|
Example
{"subscriptionId": "abc123"}
GcpPubSubLiteInferSchemaInput
Description
Input for inferring GCP Pub/Sub lite JTD schema
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
location - String!
|
Location or region |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
project - String!
|
GCP project name |
subscriptionId - String!
|
Subscription identifier |
Example
{
"credentialId": CredentialId,
"location": "abc123",
"messageFormat": StreamingSourceMessageFormatConfigInput,
"project": "abc123",
"subscriptionId": "abc123"
}
GcpPubSubLiteSource
Description
A Google Pub/Sub Lite source monitor topics in Google Pub/Sub lite in real-time
Fields
| Field Name | Description |
|---|---|
catalogAsset - GcpPubSubLiteCatalogAsset
|
Catalog asset for the source |
config - GcpPubSubLiteSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": GcpPubSubLiteCatalogAsset,
"config": GcpPubSubLiteSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "abc123",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "xyz789",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
GcpPubSubLiteSourceConfig
Description
Configuration for a Google Pub/Sub lite source
Fields
| Field Name | Description |
|---|---|
location - String!
|
Location or region |
messageFormat - StreamingSourceMessageFormatConfig
|
Message format |
project - String!
|
GCP project name |
subscriptionId - String!
|
Subscription identifier |
Example
{
"location": "abc123",
"messageFormat": StreamingSourceMessageFormatConfig,
"project": "abc123",
"subscriptionId": "abc123"
}
GcpPubSubLiteSourceCreateInput
Description
Input for creating a Google Pub/Sub lite source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
location - String!
|
Location or region |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
name - String!
|
The display name of the source |
project - String!
|
GCP project name |
resourceName - String
|
The resource name of the source |
subscriptionId - String!
|
Subscription identifier |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"description": "abc123",
"jtdSchema": JsonTypeDefinition,
"location": "xyz789",
"messageFormat": StreamingSourceMessageFormatConfigInput,
"name": "xyz789",
"project": "xyz789",
"resourceName": "abc123",
"subscriptionId": "xyz789",
"tagIds": [TagId]
}
GcpPubSubLiteSourceUpdateInput
Description
Input for updating a Google Pub/Sub lite source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
name - String
|
The display name of the source |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "xyz789",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"name": "abc123",
"tagIds": [TagId]
}
GcpPubSubSource
Description
A Google Pub/Sub source monitor topics in Google Pub/Sub in real-time
Fields
| Field Name | Description |
|---|---|
catalogAsset - GcpPubSubCatalogAsset
|
Catalog asset for the source |
config - GcpPubSubSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": GcpPubSubCatalogAsset,
"config": GcpPubSubSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "xyz789",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
GcpPubSubSourceConfig
Description
Configuration for a Google Pub/Sub source
Fields
| Field Name | Description |
|---|---|
messageFormat - StreamingSourceMessageFormatConfig
|
Message format |
project - String!
|
GCP project name |
subscriptionId - String!
|
Subscription identifier |
Example
{
"messageFormat": StreamingSourceMessageFormatConfig,
"project": "xyz789",
"subscriptionId": "xyz789"
}
GcpPubSubSourceCreateInput
Description
Input for creating a Google Pub/Sub source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
name - String!
|
The display name of the source |
project - String!
|
GCP project name |
resourceName - String
|
The resource name of the source |
subscriptionId - String!
|
Subscription identifier |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"description": "xyz789",
"jtdSchema": JsonTypeDefinition,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"name": "abc123",
"project": "abc123",
"resourceName": "abc123",
"subscriptionId": "abc123",
"tagIds": [TagId]
}
GcpPubSubSourceUpdateInput
Description
Input for updating a Google Pub/Sub source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
name - String
|
The display name of the source |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "abc123",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"name": "xyz789",
"tagIds": [TagId]
}
GcpStorageCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - GcpStorageCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": GcpStorageCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 987,
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
GcpStorageCatalogAssetConfig
GcpStorageInferSchemaInput
Description
Input for inferring Google Cloud Storage JTD schema
Fields
| Input Field | Description |
|---|---|
bucket - String!
|
Bucket name |
credentialId - CredentialId!
|
Credential used to connect to the source |
csv - CsvParserInput
|
CSV settings |
fileFormat - FileFormat
|
File format of files in bucket |
filePattern - String
|
File pattern in glob format, e.g. sales_* |
folder - String!
|
Folder for files, e.g. /path/to/files |
project - String!
|
GCP project name |
Example
{
"bucket": "xyz789",
"credentialId": CredentialId,
"csv": CsvParserInput,
"fileFormat": "CSV",
"filePattern": "xyz789",
"folder": "abc123",
"project": "xyz789"
}
GcpStorageSource
Description
A Google Cloud Storage source monitor files in a GCS bucket
Fields
| Field Name | Description |
|---|---|
catalogAsset - GcpStorageCatalogAsset
|
Catalog asset for the source |
config - GcpStorageSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": GcpStorageCatalogAsset,
"config": GcpStorageSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "abc123",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
GcpStorageSourceConfig
Description
Configuration for a Google Cloud Storage source
Fields
| Field Name | Description |
|---|---|
bucket - String!
|
Bucket name |
csv - CsvParser
|
CSV settings |
fileFormat - FileFormat
|
File format of files in bucket |
filePattern - String
|
File pattern in glob format, e.g. sales_* |
folder - String!
|
Folder name. Will be used as root directory for the source |
project - String!
|
GCP project name |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
Example
{
"bucket": "abc123",
"csv": CsvParser,
"fileFormat": "CSV",
"filePattern": "xyz789",
"folder": "abc123",
"project": "abc123",
"schedule": CronExpression
}
GcpStorageSourceCreateInput
Description
Input for creating a Google Cloud Storage source
Fields
| Input Field | Description |
|---|---|
bucket - String!
|
Bucket name |
credentialId - CredentialId!
|
Credential used to connect to the source |
csv - CsvParserInput
|
CSV settings |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
fileFormat - FileFormat
|
File format of files in bucket |
filePattern - String
|
File pattern in glob format, e.g. sales_* |
folder - String!
|
Folder name. Will be used as root directory for the source |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
project - String!
|
GCP project name |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"bucket": "abc123",
"credentialId": CredentialId,
"csv": CsvParserInput,
"description": "xyz789",
"fileFormat": "CSV",
"filePattern": "abc123",
"folder": "xyz789",
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"project": "abc123",
"resourceName": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
GcpStorageSourceDebugInfo
Description
Debug information for Google Cloud Storage
Fields
| Field Name | Description |
|---|---|
bucket - String!
|
The bucket to read record sample from |
endTime - DateTime!
|
End time of record sample |
filePath - [String!]!
|
The path to the file to sample |
startTime - DateTime!
|
Start time of record sample |
Example
{
"bucket": "xyz789",
"endTime": "2007-12-03T10:15:30Z",
"filePath": ["abc123"],
"startTime": "2007-12-03T10:15:30Z"
}
GcpStorageSourceUpdateInput
Description
Input for updating a Google Cloud Storage source
Fields
| Input Field | Description |
|---|---|
csv - CsvParserInput
|
CSV settings |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
filePattern - String
|
File pattern in glob format, e.g. sales_* |
id - SourceId!
|
Credential used to connect to the source |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"csv": CsvParserInput,
"description": "abc123",
"filePattern": "xyz789",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
GlobalWindow
Description
Utilizing a global window is akin to performing a full load during every polling cycle. In simpler terms, for each poll, all validator metrics are computed for the entire Source, rather than for a sequence of windows
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the window was created |
id - WindowId!
|
Window identifier |
name - String!
|
The display name of the window |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the window Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the window |
source - Source!
|
|
updatedAt - DateTime!
|
When the window was last updated |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": WindowId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
GlobalWindowCreateInput
Description
Input for creating a global window
Example
{
"name": "xyz789",
"resourceName": "abc123",
"sourceId": SourceId
}
GlobalWindowUpdateInput
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID
Example
"4"
Identity
Types
| Union Types |
|---|
Example
FederatedIdentity
IdentityDeleteError
Fields
| Field Name | Description |
|---|---|
code - IdentityDeleteErrorCode!
|
|
message - String!
|
Example
{"code": "UNKNOWN", "message": "xyz789"}
IdentityDeleteErrorCode
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNKNOWN"
IdentityDeleteInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
IdentityDeleteResult
Fields
| Field Name | Description |
|---|---|
errors - [IdentityDeleteError!]!
|
Example
{"errors": [IdentityDeleteError]}
IdentityProvider
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
disabled - Boolean!
|
|
id - ID!
|
|
name - String!
|
|
resourceName - String!
|
|
updatedAt - DateTime!
|
Possible Types
| IdentityProvider Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"disabled": false,
"id": 4,
"name": "abc123",
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
IdentityProviderCreateErrorCode
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNKNOWN"
IdentityProviderCreateResult
Fields
| Field Name | Description |
|---|---|
errors - [IdentityProviderError!]!
|
A list of errors that occurred during the create process |
identityProvider - IdentityProvider
|
Example
{
"errors": [IdentityProviderError],
"identityProvider": IdentityProvider
}
IdentityProviderDeleteError
Fields
| Field Name | Description |
|---|---|
code - IdentityProviderDeleteErrorCode!
|
|
message - String
|
Example
{"code": "UNKNOWN", "message": "abc123"}
IdentityProviderDeleteErrorCode
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNKNOWN"
IdentityProviderDeleteInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
IdentityProviderDeleteResult
Fields
| Field Name | Description |
|---|---|
errors - [IdentityProviderDeleteError!]!
|
Example
{"errors": [IdentityProviderDeleteError]}
IdentityProviderError
Fields
| Field Name | Description |
|---|---|
code - IdentityProviderCreateErrorCode!
|
|
message - String
|
Example
{"code": "UNKNOWN", "message": "abc123"}
IdentityProviderUpdateError
Fields
| Field Name | Description |
|---|---|
code - IdentityProviderUpdateErrorCode!
|
|
message - String
|
Example
{"code": "UNKNOWN", "message": "abc123"}
IdentityProviderUpdateErrorCode
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNKNOWN"
IdentityProviderUpdateResult
Fields
| Field Name | Description |
|---|---|
errors - [IdentityProviderUpdateError!]!
|
|
identityProvider - IdentityProvider
|
Example
{
"errors": [IdentityProviderUpdateError],
"identityProvider": IdentityProvider
}
Incident
Fields
| Field Name | Description |
|---|---|
backfillMode - Boolean!
|
|
createdAt - DateTime!
|
|
deviation - Float!
|
|
endTime - DateTime!
|
|
group - IncidentGroup!
|
|
id - IncidentId!
|
|
lowerBound - Float
|
|
severity - IncidentSeverity!
|
|
startTime - DateTime!
|
|
status - IncidentStatus!
|
|
updatedAt - DateTime!
|
|
upperBound - Float
|
|
value - Float!
|
Example
{
"backfillMode": true,
"createdAt": "2007-12-03T10:15:30Z",
"deviation": 987.65,
"endTime": "2007-12-03T10:15:30Z",
"group": IncidentGroup,
"id": IncidentId,
"lowerBound": 123.45,
"severity": "HIGH",
"startTime": "2007-12-03T10:15:30Z",
"status": "INVESTIGATING",
"updatedAt": "2007-12-03T10:15:30Z",
"upperBound": 123.45,
"value": 987.65
}
IncidentGroup
Fields
| Field Name | Description |
|---|---|
firstSeenAt - DateTime!
|
|
id - IncidentGroupId!
|
|
incidents - IncidentsResult!
|
|
Arguments |
|
lastSeenAt - DateTime!
|
|
muteUntil - DateTime
|
|
owner - User
|
|
pastGroups - PastIncidentGroupsResult!
|
|
Arguments |
|
priority - IncidentGroupPriority!
|
|
segment - Segment!
|
|
severityStats - SeverityStats!
|
|
source - Source!
|
|
status - IncidentStatus!
|
|
validator - Validator!
|
|
Example
{
"firstSeenAt": "2007-12-03T10:15:30Z",
"id": IncidentGroupId,
"incidents": IncidentsResult,
"lastSeenAt": "2007-12-03T10:15:30Z",
"muteUntil": "2007-12-03T10:15:30Z",
"owner": User,
"pastGroups": PastIncidentGroupsResult,
"priority": "CRITICAL",
"segment": Segment,
"severityStats": SeverityStats,
"source": Source,
"status": "INVESTIGATING",
"validator": Validator
}
IncidentGroupId
Description
Incident group identifier
Example
IncidentGroupId
IncidentGroupMuteResult
Description
Result for fetching incident group metadata
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the mute operation |
Example
{"errors": [ApiError]}
IncidentGroupOwnerUpdateInput
Description
Input for updating owner of one or more incidents
Fields
| Input Field | Description |
|---|---|
ids - [IncidentGroupId!]!
|
The incident identifiers to update status for |
ownerId - OwnerId
|
Owner identifier |
Example
{
"ids": [IncidentGroupId],
"ownerId": OwnerId
}
IncidentGroupOwnerUpdateResult
Description
Result for updating incident group owner
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
Example
{"errors": [ApiError]}
IncidentGroupPriority
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CRITICAL"
IncidentGroupStatusUpdateInput
Fields
| Input Field | Description |
|---|---|
ids - [IncidentGroupId!]!
|
|
status - IncidentStatus!
|
Example
{"ids": [IncidentGroupId], "status": "INVESTIGATING"}
IncidentGroupUnmuteResult
Description
Result for unmuting an incident group
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the unmute operation |
Example
{"errors": [ApiError]}
IncidentGroupsFilter
Fields
| Input Field | Description |
|---|---|
namespace - EnumQueryFilter
|
|
owner - EnumQueryFilter
|
|
priority - EnumQueryFilter
|
|
range - TimeRangeInput
|
|
source - EnumQueryFilter
|
|
status - EnumQueryFilter
|
|
tagLabel - EnumQueryFilter
|
|
validator - EnumQueryFilter
|
Example
{
"namespace": EnumQueryFilter,
"owner": EnumQueryFilter,
"priority": EnumQueryFilter,
"range": TimeRangeInput,
"source": EnumQueryFilter,
"status": EnumQueryFilter,
"tagLabel": EnumQueryFilter,
"validator": EnumQueryFilter
}
IncidentGroupsIndex
Fields
| Field Name | Description |
|---|---|
namespace - [IndexKey!]!
|
|
owner - [IndexKey!]!
|
|
priority - [IndexKey!]!
|
|
source - [IndexKey!]!
|
|
status - [IndexKey!]!
|
|
tagLabel - [IndexKey!]!
|
|
validator - [IndexKey!]!
|
Example
{
"namespace": [IndexKey],
"owner": [IndexKey],
"priority": [IndexKey],
"source": [IndexKey],
"status": [IndexKey],
"tagLabel": [IndexKey],
"validator": [IndexKey]
}
IncidentGroupsResult
Fields
| Field Name | Description |
|---|---|
elements - [IncidentGroup!]!
|
|
index - IncidentGroupsIndex!
|
|
pageInfo - PageInfo!
|
Example
{
"elements": [IncidentGroup],
"index": IncidentGroupsIndex,
"pageInfo": PageInfo
}
IncidentGroupsSort
IncidentId
Description
Incident identifier
Example
IncidentId
IncidentRelatedGroup
Fields
| Field Name | Description |
|---|---|
field - String
|
|
group - IncidentGroup!
|
|
originField - String
|
|
relationship - IncidentRelationship!
|
Example
{
"field": "xyz789",
"group": IncidentGroup,
"originField": "xyz789",
"relationship": "FIELD_LINEAGE_DOWNSTREAM"
}
IncidentRelatedGroupsResult
Description
Result when fetching related incident groups
Fields
| Field Name | Description |
|---|---|
elements - [IncidentRelatedGroup!]!
|
|
originField - String
|
Source field from which upstream/downstream field level lineage incident groups originate Use originFields.
|
originFields - [String!]
|
Source fields from which upstream/downstream field level lineage incident groups originate. Replaces origin field with support for more than one source field on a validator |
Example
{
"elements": [IncidentRelatedGroup],
"originField": "abc123",
"originFields": ["abc123"]
}
IncidentRelationship
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIELD_LINEAGE_DOWNSTREAM"
IncidentSeverity
Description
Severity of an incident, is determined based on how much it deviates from the target metric. More information can be found here
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"HIGH"
IncidentStatus
Description
Status of an incident within an incident group
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"INVESTIGATING"
IncidentStatusUpdateInput
Description
Input for updating the status of one or more incidents
Fields
| Input Field | Description |
|---|---|
ids - [IncidentId!]!
|
The incident identifiers to update status for |
status - IncidentStatus!
|
The status to set on the incidents |
Example
{"ids": [IncidentId], "status": "INVESTIGATING"}
IncidentStatusUpdateResult
Description
Result for updating incident statuses
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
Example
{"errors": [ApiError]}
IncidentV1Translation
Fields
| Field Name | Description |
|---|---|
groupId - IncidentGroupId!
|
|
incidentId - IncidentId!
|
|
oldId - ID!
|
Example
{
"groupId": IncidentGroupId,
"incidentId": IncidentId,
"oldId": "4"
}
IncidentsFilter
Fields
| Input Field | Description |
|---|---|
range - TimeRangeInput
|
|
severity - EnumQueryFilter
|
|
status - EnumQueryFilter
|
Example
{
"range": TimeRangeInput,
"severity": EnumQueryFilter,
"status": EnumQueryFilter
}
IncidentsIndex
Fields
| Field Name | Description |
|---|---|
severity - [IndexKey!]!
|
|
status - [IndexKey!]!
|
Example
{
"severity": [IndexKey],
"status": [IndexKey]
}
IncidentsMuteResult
Description
Represents the result of unmuting an incident group, source, or validator
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the mute operation |
Example
{"errors": [ApiError]}
IncidentsResult
Fields
| Field Name | Description |
|---|---|
elements - [Incident!]!
|
|
index - IncidentsIndex!
|
|
pageInfo - PageInfo!
|
Example
{
"elements": [Incident],
"index": IncidentsIndex,
"pageInfo": PageInfo
}
IncidentsSort
IncidentsUnmuteResult
Description
Represents the result of unmuting an incident group, source, or validator
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the unmute operation |
Example
{"errors": [ApiError]}
IndexKey
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1
Example
987
IssueTypename
Description
Types of issues that can be matched to produce notifications
Values
| Enum Value | Description |
|---|---|
|
|
Generic errors produced by a source |
|
|
A change in a source schema is detected |
|
|
Too many segments produced for a segmentation |
|
|
A validator produced an incident or incident group |
Example
"GenericSourceError"
JSON
Example
{}
JSONObject
Example
{}
JsonFilterExpression
Description
NOTE JsonFilterExpression is deprecated in favor of creating a filter separately and passing the filter identifier in the source config. A JSON filter expression is a JSON blob that represents a filter. Each filter expression has the same values as the filter types defined as *FilterConfig. The only addition is that the JSON blob also needs to contain the __typename key which is always named <Type>FilterExpression. Example of filter expressions for each available filter type.
BooleanFilterExpression
{
"__typename": "BooleanFilterExpression",
"field": "has_logged_in",
"operator": "IS_TRUE"
}
EnumFilterExpression
{
"__typename": "EnumFilterExpression",
"field": "created_at",
"values": [
"val1",
"val2"
],
"operator": "ALLOW"
}
NullFilterExpression
{
"__typename": "NullFilterExpression",
"field": "created_at",
"OPERATOR": "IS_NOT"
}
StringFilterExpression
{
"__typename": "StringFilterExpression",
"field": "created_at",
"operator": "CONTAINS",
"value": "test"
}
ThresholdFilterExpression
{
"__typename": "ThresholdFilterExpression",
"field": "created_at",
"operator": "EQUAL",
"value": 1.0
}
Example
JsonFilterExpression
JsonObject
Description
An untyped JSON blob that can be used to represents unknown data such as record samples when inferring JTD Schema or for DBT manifests
Example
JsonObject
JsonPointer
Description
A JSON pointer represents a path to a field which can be a nested field in a semi-structured context. The name comes from the JSON Pointer specification because just like JSON Pointers we don't support complex features or methods. The syntax however is closer to JSON Path given the dot notation. When specifying simple top level fields without special characters, just putting the name of the field is most reasonable. However, for fields with characters that might require escaping or for semi structured fields this should use proper JSON notation. For an object that looks like this:
{
"user": {
"name": "Validio User",
"tags": ["Data Engineer", "Data Science"]
}
}
The JsonPath for referencing name should be one of the following formats:
user.nameuser["name"]user['name']['user']['name']['user'].nameNot that the first syntax only works if bothuserandnamecontains no special characters needing escaping. For arrays such as tags Validio can do validations as well. Validation on the first element in the array is done by referencing its index;user.tags[0]. Validation of the length of the array can be done by using thelengthfunction;users.tags.length(). Full documentation can be found here
Example
JsonPointer
JsonTypeDefinition
Description
A JSON Type Definition representing a schema of a source. It represents the schema of a source and is used in various places to allow the right monitoring and metric support for a source
Example
JsonTypeDefinition
KafkaCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - KafkaCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": KafkaCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 123,
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
KafkaCatalogAssetConfig
Fields
| Field Name | Description |
|---|---|
topic - String!
|
Example
{"topic": "xyz789"}
KafkaInferSchemaInput
Description
Input for inferring Kafka JTD schema
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
topic - String!
|
Topic name |
Example
{
"credentialId": CredentialId,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"topic": "abc123"
}
KafkaSaslSslPlainCredential
Description
Kafka SASL SSL uses SSL and the SASL framework to connect to Kafka
Fields
| Field Name | Description |
|---|---|
config - KafkaSaslSslPlainCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": KafkaSaslSslPlainCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": false,
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
KafkaSaslSslPlainCredentialConfig
Fields
| Field Name | Description |
|---|---|
bootstrapServers - [String!]!
|
|
username - String!
|
Example
{
"bootstrapServers": ["abc123"],
"username": "xyz789"
}
KafkaSaslSslPlainCredentialCreateInput
Description
Input for creating Kafka SASL SSL plain credential
Fields
| Input Field | Description |
|---|---|
bootstrapServers - [String!]!
|
The address of Kafka load balancer or Kafka cluster address |
caCertificate - String
|
A certificate of Certificate authority (CA) in CRT format |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
password - String!
|
Password for the SASL Plain Credential |
resourceName - String
|
The resource name of the credential |
username - String!
|
Username for the SASL Plain Credential |
Example
{
"bootstrapServers": ["abc123"],
"caCertificate": "xyz789",
"enableCatalog": false,
"name": "abc123",
"namespaceId": NamespaceId,
"password": "abc123",
"resourceName": "abc123",
"username": "xyz789"
}
KafkaSaslSslPlainCredentialSecretChangedInput
Description
Input for checking if Kafka SASL SSL plain credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
password - String!
|
The password to compare |
Example
{
"id": CredentialId,
"password": "abc123"
}
KafkaSaslSslPlainCredentialUpdateInput
Description
Input for updating Kafka SASL SSL plain credential
Fields
| Input Field | Description |
|---|---|
bootstrapServers - [String!]
|
The address of Kafka load balancer or Kafka cluster address |
caCertificate - String
|
A certificate of Certificate authority (CA) in CRT format |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
password - String
|
Password for the SASL Plain Credential |
username - String
|
Username for the SASL Plain Credential |
Example
{
"bootstrapServers": ["abc123"],
"caCertificate": "abc123",
"enableCatalog": false,
"id": CredentialId,
"name": "xyz789",
"password": "abc123",
"username": "abc123"
}
KafkaSource
Description
A Kafka source monitor topics in Apache Kafka in real-time
Fields
| Field Name | Description |
|---|---|
catalogAsset - KafkaCatalogAsset
|
Catalog asset for the source |
config - KafkaSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": KafkaCatalogAsset,
"config": KafkaSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "abc123",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "xyz789",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
KafkaSourceConfig
Description
Configuration for a Kafka source
Fields
| Field Name | Description |
|---|---|
messageFormat - StreamingSourceMessageFormatConfig
|
Message format |
topic - String!
|
Topic name |
Example
{
"messageFormat": StreamingSourceMessageFormatConfig,
"topic": "xyz789"
}
KafkaSourceCreateInput
Description
Input for creating a Kafka source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
name - String!
|
The display name of the source |
resourceName - String
|
The resource name of the source |
tagIds - [TagId!]
|
Tag IDs for the source |
topic - String!
|
Topic name |
Example
{
"credentialId": CredentialId,
"description": "abc123",
"jtdSchema": JsonTypeDefinition,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"name": "abc123",
"resourceName": "abc123",
"tagIds": [TagId],
"topic": "abc123"
}
KafkaSourceUpdateInput
Description
Input for updating a Kafka source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
messageFormat - StreamingSourceMessageFormatConfigInput
|
Message format |
name - String
|
The display name of the source |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "xyz789",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"messageFormat": StreamingSourceMessageFormatConfigInput,
"name": "abc123",
"tagIds": [TagId]
}
KafkaSslCredential
Description
Kafka SSL credentials uses certificates and SSL to connect to Kafka
Fields
| Field Name | Description |
|---|---|
config - KafkaSslCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": KafkaSslCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": true,
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
KafkaSslCredentialConfig
Fields
| Field Name | Description |
|---|---|
bootstrapServers - [String!]!
|
|
caCertificate - String!
|
Example
{
"bootstrapServers": ["xyz789"],
"caCertificate": "abc123"
}
KafkaSslCredentialCreateInput
Description
Input for creating Kafka SSL credential
Fields
| Input Field | Description |
|---|---|
bootstrapServers - [String!]!
|
The address of Kafka load balancer or Kafka cluster address |
caCertificate - String!
|
A certificate of Certificate authority (CA) in CRT format |
clientCertificate - String!
|
Client SSL certificate in PEM format |
clientPrivateKey - String!
|
Private keys of client certificate in PEM format |
clientPrivateKeyPassword - String!
|
Password or passphrase of private keys for the client certificate |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
Example
{
"bootstrapServers": ["xyz789"],
"caCertificate": "abc123",
"clientCertificate": "abc123",
"clientPrivateKey": "abc123",
"clientPrivateKeyPassword": "xyz789",
"enableCatalog": false,
"name": "xyz789",
"namespaceId": NamespaceId,
"resourceName": "abc123"
}
KafkaSslCredentialSecretChangedInput
Description
Input for checking if Kafka SSL credentials changed
Fields
| Input Field | Description |
|---|---|
caCertificate - String!
|
CA certificate to compare |
clientCertificate - String!
|
Client certificate to compare |
clientPrivateKey - String!
|
Client private key to compare |
clientPrivateKeyPassword - String!
|
Client private key password or passphrase to compare |
id - CredentialId!
|
Credential identifier |
Example
{
"caCertificate": "xyz789",
"clientCertificate": "abc123",
"clientPrivateKey": "abc123",
"clientPrivateKeyPassword": "abc123",
"id": CredentialId
}
KafkaSslCredentialUpdateInput
Description
Input for updating a Kafka SSL credential
Fields
| Input Field | Description |
|---|---|
bootstrapServers - [String!]
|
The address of Kafka load balancer or Kafka cluster address |
caCertificate - String
|
A certificate of Certificate authority (CA) in CRT format |
clientCertificate - String
|
Client SSL certificate in PEM format |
clientPrivateKey - String
|
Private keys of client certificate in PEM format |
clientPrivateKeyPassword - String
|
Password or passphrase of private keys for the client certificate |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
Example
{
"bootstrapServers": ["xyz789"],
"caCertificate": "abc123",
"clientCertificate": "xyz789",
"clientPrivateKey": "xyz789",
"clientPrivateKeyPassword": "abc123",
"enableCatalog": true,
"id": CredentialId,
"name": "xyz789"
}
LineageEdge
Description
A lineage edge represents two nodes that are connected together as upstream and downstream
Fields
| Field Name | Description |
|---|---|
downstream - LineageNode!
|
The downstream lineage node which references the upstream node |
id - LineageEdgeId!
|
Unique id for the two nodes connected |
sqlQuery - String
|
|
upstream - LineageNode!
|
The upstream lineage node which is referenced from the downstream node. This can be as a filter node (from a WHERE clause) or for data, e.g. a VIEW |
Example
{
"downstream": LineageNode,
"id": LineageEdgeId,
"sqlQuery": "abc123",
"upstream": LineageNode
}
LineageEdgeCreateInput
Description
Input for creating a new lineage edge
Fields
| Input Field | Description |
|---|---|
downstreamField - JsonPointer
|
|
downstreamId - CatalogAssetId!
|
|
upstreamField - JsonPointer
|
|
upstreamId - CatalogAssetId!
|
Example
{
"downstreamField": JsonPointer,
"downstreamId": CatalogAssetId,
"upstreamField": JsonPointer,
"upstreamId": CatalogAssetId
}
LineageEdgeCreateResult
Description
Result for creating a lineage edge
Fields
| Field Name | Description |
|---|---|
edge - LineageEdge
|
The edge created after a successful request |
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
Example
{
"edge": LineageEdge,
"errors": [ApiError]
}
LineageEdgeId
Example
LineageEdgeId
LineageEdgesDeleteResult
Description
Result for deleting lineage edges
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{"errors": [ApiError]}
LineageGraph
Fields
| Field Name | Description |
|---|---|
edges - [LineageEdge!]!
|
|
nodes - [CatalogAsset!]!
|
|
stats - LineageGraphStats!
|
Example
{
"edges": [LineageEdge],
"nodes": [CatalogAsset],
"stats": LineageGraphStats
}
LineageGraphInput
Fields
| Input Field | Description |
|---|---|
catalogAssetId - CatalogAssetId!
|
|
fields - [JsonPointer!]
|
|
limit - Int!
|
Example
{
"catalogAssetId": CatalogAssetId,
"fields": [JsonPointer],
"limit": 123
}
LineageGraphStats
LineageNode
Description
A node that is represented in the lineage graph
Fields
| Field Name | Description |
|---|---|
catalogAsset - CatalogAsset!
|
|
field - JsonPointer
|
The field on the asset if the node has a field |
Example
{
"catalogAsset": CatalogAsset,
"field": JsonPointer
}
LocalIdentity
LocalIdentityProvider
LocalIdentityProviderUpdateInput
LoginType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"GUEST"
LookerCredential
Description
A Looker credential is used to connect to Looker Studio
Fields
| Field Name | Description |
|---|---|
config - LookerCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": LookerCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": true,
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
LookerCredentialConfig
LookerCredentialCreateInput
Description
INput for creating a Looker credential
Fields
| Input Field | Description |
|---|---|
baseUrl - String!
|
The URL to the Looker instance. The default API path uses the following format: https://<instance_name>.cloud.looker.com:<port> |
clientId - String!
|
The Looker API client ID |
clientSecret - String!
|
The Looker API client secret |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
Example
{
"baseUrl": "abc123",
"clientId": "abc123",
"clientSecret": "abc123",
"enableCatalog": false,
"name": "abc123",
"namespaceId": NamespaceId,
"resourceName": "xyz789"
}
LookerCredentialSecretChangedInput
Description
Input for checking if Looker credentials changed
Fields
| Input Field | Description |
|---|---|
clientSecret - String!
|
The client secret to compare |
id - CredentialId!
|
Credential identifier |
Example
{
"clientSecret": "abc123",
"id": CredentialId
}
LookerCredentialUpdateInput
Description
Input for updating a Looker credential
Fields
| Input Field | Description |
|---|---|
baseUrl - String
|
The URL to the Looker instance. The default API path uses the following format: https://<instance_name>.cloud.looker.com:<port> |
clientId - String
|
The Looker API client ID |
clientSecret - String
|
The Looker API client secret |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
Example
{
"baseUrl": "abc123",
"clientId": "abc123",
"clientSecret": "abc123",
"enableCatalog": false,
"id": CredentialId,
"name": "abc123"
}
LookerDashboardCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - DashboardCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": DashboardCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "abc123",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
LookerLookCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - TileCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": TileCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "abc123",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
MetricValueFormat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NUMBER"
MsPowerBiCredential
Description
A Microsoft Power BI credential is used to connect to Microsoft Power BI
Fields
| Field Name | Description |
|---|---|
config - MsPowerBiCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": MsPowerBiCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": false,
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
MsPowerBiCredentialAuth
Types
| Union Types |
|---|
Example
MsPowerBiCredentialAuthEntraId
MsPowerBiCredentialAuthCreateInput
Description
Input for creating a Microsoft Power BI auth type
Fields
| Input Field | Description |
|---|---|
entraId - MsPowerBiCredentialEntraIdCreateInput
|
Example
{"entraId": MsPowerBiCredentialEntraIdCreateInput}
MsPowerBiCredentialAuthEntraId
MsPowerBiCredentialAuthEntraIdSecretChangedInput
Description
Input for checking if Microsoft Power BI Entra ID credentials changed
Fields
| Input Field | Description |
|---|---|
clientSecret - String!
|
The client secret to compare |
Example
{"clientSecret": "xyz789"}
MsPowerBiCredentialAuthSecretChangedInput
Description
Input for checking if Microsoft Power BI authentication method credentials changed
Fields
| Input Field | Description |
|---|---|
entraId - MsPowerBiCredentialAuthEntraIdSecretChangedInput
|
Example
{
"entraId": MsPowerBiCredentialAuthEntraIdSecretChangedInput
}
MsPowerBiCredentialAuthUpdateInput
Description
Input to update a Microsoft Power BI auth type
Fields
| Input Field | Description |
|---|---|
entraId - MsPowerBiCredentialEntraIdUpdateInput
|
Example
{"entraId": MsPowerBiCredentialEntraIdUpdateInput}
MsPowerBiCredentialConfig
Fields
| Field Name | Description |
|---|---|
auth - MsPowerBiCredentialAuth!
|
Example
{"auth": MsPowerBiCredentialAuthEntraId}
MsPowerBiCredentialCreateInput
Description
Input for creating a Microsoft Power BI credential
Fields
| Input Field | Description |
|---|---|
auth - MsPowerBiCredentialAuthCreateInput!
|
Authentication method for Microsoft Power BI |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId!
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
Example
{
"auth": MsPowerBiCredentialAuthCreateInput,
"enableCatalog": false,
"name": "abc123",
"namespaceId": NamespaceId,
"resourceName": "abc123"
}
MsPowerBiCredentialEntraIdCreateInput
Description
Input for creating Microsoft Power BI Entra ID credential
Example
{
"clientId": "xyz789",
"clientSecret": "xyz789",
"tenantId": "abc123"
}
MsPowerBiCredentialEntraIdUpdateInput
Description
Input to update a Microsoft Power BI Entra ID credential
Example
{
"clientId": "abc123",
"clientSecret": "xyz789",
"tenantId": "abc123"
}
MsPowerBiCredentialSecretChangedInput
Description
Input for checking if Microsoft Power BI credentials changed
Fields
| Input Field | Description |
|---|---|
auth - MsPowerBiCredentialAuthSecretChangedInput!
|
The auth method to compare |
id - CredentialId!
|
Credential identifier |
Example
{
"auth": MsPowerBiCredentialAuthSecretChangedInput,
"id": CredentialId
}
MsPowerBiCredentialUpdateInput
Description
Input for updating a Microsoft Power BI credential
Fields
| Input Field | Description |
|---|---|
auth - MsPowerBiCredentialAuthUpdateInput
|
Authentication method for Microsoft Power BI |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
Example
{
"auth": MsPowerBiCredentialAuthUpdateInput,
"enableCatalog": false,
"id": CredentialId,
"name": "xyz789"
}
MsPowerBiDataflowCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - ExploreCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": ExploreCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "abc123",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
MsPowerBiReportCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - WorkbookCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": WorkbookCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "abc123",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
MsTeamsChannel
Description
A Microsoft Teams channel is a channel that will post messages to Microsoft Teams
Fields
| Field Name | Description |
|---|---|
config - MsTeamsChannelConfig!
|
Microsoft Teams specific configuration for the channel |
createdAt - DateTime!
|
When the channel was created |
id - ChannelId!
|
Channel identifier |
name - String!
|
The display name of the channel |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the channel Use 'namespace.id' instead |
notificationRules - [NotificationRule!]!
|
|
resourceName - String!
|
The resource name of the channel |
updatedAt - DateTime!
|
When the channel was last updated |
Example
{
"config": MsTeamsChannelConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": ChannelId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"notificationRules": [NotificationRule],
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
MsTeamsChannelConfig
Description
Configuration for a Microsoft Teams channel that will post messages to Microsoft Teams
Fields
| Field Name | Description |
|---|---|
applicationLinkUrl - String!
|
URL to the Validio application |
interactiveMessageEnabled - Boolean!
|
If interactive notification messages should be used |
msTeamsChannelId - String
|
The id for the MS Teams channel to where the message should be posted |
timezone - String
|
No longer supported |
webhookUrl - String!
|
The webhook URL to where the message should be posted. See the Microsoft documentation on how to get this URL No longer supported |
Example
{
"applicationLinkUrl": "xyz789",
"interactiveMessageEnabled": false,
"msTeamsChannelId": "xyz789",
"timezone": "xyz789",
"webhookUrl": "abc123"
}
MsTeamsChannelCreateInput
Description
Input for creating a Microsoft Teams channel
Fields
| Input Field | Description |
|---|---|
applicationLinkUrl - String!
|
URL to the Validio application |
clientId - String
|
Client id for the bot used for sending messages |
clientSecret - String
|
Client secret for the bot used for sending messages |
interactiveMessageEnabled - Boolean
|
If interactive notification messages should be used |
msTeamsChannelId - String
|
The id for the Teams channel to where the message should be posted |
name - String!
|
The display name of the channel |
namespaceId - NamespaceId!
|
The namespace id for the channel |
resourceName - String
|
The resource name of the channel |
Example
{
"applicationLinkUrl": "abc123",
"clientId": "xyz789",
"clientSecret": "abc123",
"interactiveMessageEnabled": false,
"msTeamsChannelId": "xyz789",
"name": "xyz789",
"namespaceId": NamespaceId,
"resourceName": "xyz789"
}
MsTeamsChannelSecretChangedInput
Description
Input for checking if Microsoft Teams channel secrets changed
Fields
| Input Field | Description |
|---|---|
clientId - String!
|
Client id for the bot used for sending messages |
clientSecret - String!
|
Client secret for the bot used for sending messages |
id - ChannelId!
|
Channel identifier |
Example
{
"clientId": "abc123",
"clientSecret": "abc123",
"id": ChannelId
}
MsTeamsChannelSecretChangedResult
Description
Result for checking if Microsoft Teams channel secrets changed
Fields
| Field Name | Description |
|---|---|
clientId - Boolean!
|
True if the stored client id is different from the value in the request |
clientSecret - Boolean!
|
True if the stored client secret is different from the value in the request |
errors - [ApiError!]!
|
Example
{
"clientId": true,
"clientSecret": false,
"errors": [ApiError]
}
MsTeamsChannelUpdateInput
Description
Input for updating a Microsoft Teams Channel
Fields
| Input Field | Description |
|---|---|
applicationLinkUrl - String
|
URL to the Validio application |
clientId - String
|
Client id for the bot used for sending messages |
clientSecret - String
|
Client secret for the bot used for sending messages |
id - ChannelId!
|
Channel identifier |
interactiveMessageEnabled - Boolean
|
If interactive notification messages should be used |
msTeamsChannelId - String
|
The id for the Teams channel to where the message should be posted |
name - String
|
The display name of the channel |
Example
{
"applicationLinkUrl": "abc123",
"clientId": "xyz789",
"clientSecret": "abc123",
"id": ChannelId,
"interactiveMessageEnabled": false,
"msTeamsChannelId": "abc123",
"name": "xyz789"
}
MuteIncidentsInput
Fields
| Input Field | Description |
|---|---|
incidentGroupIds - [IncidentGroupId!]
|
|
sourceIds - [SourceId!]
|
|
validatorIds - [ValidatorId!]
|
Example
{
"incidentGroupIds": [IncidentGroupId],
"sourceIds": [SourceId],
"validatorIds": [ValidatorId]
}
Namespace
Description
A namespace is a logical group of resources. It's used both for RBAC to manage access control and as isolation when working with Validio's infrastructure as code
Fields
| Field Name | Description |
|---|---|
apiKeys - [ApiKeyRole!]!
|
|
avatar - DataUrl!
|
|
avatarThumbnail - DataUrl!
|
|
description - String
|
Namespace description |
id - NamespaceId!
|
Namespace identifier |
members - [UserRole!]!
|
List of users that has been directly assigned to the namespace |
name - String!
|
Namespace name |
teams - [TeamRole!]!
|
|
users - [UserRole!]!
|
List of all users that has access to the namespace: directly or via teams |
Example
{
"apiKeys": [ApiKeyRole],
"avatar": DataUrl,
"avatarThumbnail": DataUrl,
"description": "xyz789",
"id": NamespaceId,
"members": [UserRole],
"name": "abc123",
"teams": [TeamRole],
"users": [UserRole]
}
NamespaceCreateInput
Description
Input for creating a namespace
Fields
| Input Field | Description |
|---|---|
apiKeys - [NamespaceRoleWithId!]
|
|
avatar - DataUrl
|
|
description - String
|
Namespace description |
id - NamespaceId!
|
Namespace identifier |
members - [NamespaceRoleWithId!]
|
|
name - String!
|
Namespace name |
teams - [NamespaceRoleWithId!]
|
Example
{
"apiKeys": [NamespaceRoleWithId],
"avatar": DataUrl,
"description": "abc123",
"id": NamespaceId,
"members": [NamespaceRoleWithId],
"name": "xyz789",
"teams": [NamespaceRoleWithId]
}
NamespaceCreateResult
Description
Result for creating a namespace
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
namespace - Namespace
|
The namespace created after a successful request |
Example
{
"errors": [ApiError],
"namespace": Namespace
}
NamespaceDeleteResult
Description
Result for deleting a namespace
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{"errors": [ApiError]}
NamespaceId
Example
NamespaceId
NamespaceRoleWithId
NamespaceRolesRevokeInput
Description
Input for revoking roles within a namespace
Fields
| Input Field | Description |
|---|---|
apiKeyIds - [ApiKeyId!]
|
List of API key IDs to revoke roles from |
memberIds - [UserId!]
|
List of member IDs to revoke roles from |
namespaceId - NamespaceId!
|
ID of the namespace to revoke roles from |
teamIds - [TeamId!]
|
List of team IDs to revoke roles from |
Example
{
"apiKeyIds": [ApiKeyId],
"memberIds": [UserId],
"namespaceId": NamespaceId,
"teamIds": [TeamId]
}
NamespaceRolesUpdateInput
Description
Input for updating roles within a namespace
Fields
| Input Field | Description |
|---|---|
apiKeys - [NamespaceRoleWithId!]
|
List of API key roles to update |
members - [NamespaceRoleWithId!]
|
List of member roles to update |
namespaceId - NamespaceId!
|
ID of the namespace to update |
teams - [NamespaceRoleWithId!]
|
List of team roles to update |
Example
{
"apiKeys": [NamespaceRoleWithId],
"members": [NamespaceRoleWithId],
"namespaceId": NamespaceId,
"teams": [NamespaceRoleWithId]
}
NamespaceUpdateInput
Description
Input for updating a namespace
Fields
| Input Field | Description |
|---|---|
description - String
|
Namespace description |
id - NamespaceId!
|
Namespace identifier |
name - String
|
Namespace name |
Example
{
"description": "xyz789",
"id": NamespaceId,
"name": "xyz789"
}
NamespaceUpdateResult
Description
Result for updating a namespace
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
namespace - Namespace
|
The namespace updated after a successful request |
Example
{
"errors": [ApiError],
"namespace": Namespace
}
NamespaceUpdateRolesResult
Description
Represents the result of updating roles within a namespace
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the update process |
namespace - Namespace
|
The updated namespace |
Example
{
"errors": [ApiError],
"namespace": Namespace
}
NotificationRule
Description
A notification rule is a set of rules that will be matched on notifications such as incidents and produce output to the configured channel, e.g. a Slack channel
Fields
| Field Name | Description |
|---|---|
channel - Channel!
|
|
conditions - [NotificationRuleCondition!]!
|
Use 'config' instead |
createdAt - DateTime!
|
When the notification rule was created |
id - NotificationRuleId!
|
Notification rule identifier |
name - String!
|
The display name of the notification rule |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the channel Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the notification rule |
updatedAt - DateTime!
|
When the notification rule was last updated |
Example
{
"channel": Channel,
"conditions": [NotificationRuleCondition],
"createdAt": "2007-12-03T10:15:30Z",
"id": NotificationRuleId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
NotificationRuleCondition
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
|
id - String!
|
|
notificationRuleId - NotificationRuleId!
|
|
updatedAt - DateTime!
|
Possible Types
| NotificationRuleCondition Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "xyz789",
"notificationRuleId": NotificationRuleId,
"updatedAt": "2007-12-03T10:15:30Z"
}
NotificationRuleConditionCreateResult
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
Example
{"errors": [ApiError]}
NotificationRuleConfigInput
Description
Configuration for the notification rule. Each element within a field will be ORed and the elements in different fields will beANDed, e.g:
{
"source_condition": [CondA, CondB],
"type_condition": [CondC, CondD]
}
Would result in something like `(CondA OR CondB) AND (CondC OR CondD)`
Fields
| Input Field | Description |
|---|---|
ownerCondition - OwnerNotificationRuleConditionConfigInput
|
|
segmentConditions - [SegmentNotificationRuleConditionConfigInput!]
|
|
severityCondition - SeverityNotificationRuleConditionConfigInput
|
|
sourceCondition - SourceNotificationRuleConditionConfigInput
|
|
tagConditions - [TagNotificationRuleConditionConfigInput!]
|
|
typeCondition - TypeNotificationRuleConditionConfigInput
|
Example
{
"ownerCondition": OwnerNotificationRuleConditionConfigInput,
"segmentConditions": [
SegmentNotificationRuleConditionConfigInput
],
"severityCondition": SeverityNotificationRuleConditionConfigInput,
"sourceCondition": SourceNotificationRuleConditionConfigInput,
"tagConditions": [
TagNotificationRuleConditionConfigInput
],
"typeCondition": TypeNotificationRuleConditionConfigInput
}
NotificationRuleCreateInput
Description
Input for creating a notification rule
Fields
| Input Field | Description |
|---|---|
channelId - ChannelId!
|
Channel for where to send the notifications |
config - NotificationRuleConfigInput
|
Configuration for the notification rule |
name - String!
|
The display name of the notification rule |
resourceName - String
|
The resource name of the notification rule |
Example
{
"channelId": ChannelId,
"config": NotificationRuleConfigInput,
"name": "abc123",
"resourceName": "xyz789"
}
NotificationRuleCreateResult
Description
Result for creating a notification rule
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
notificationRule - NotificationRule
|
The notification rule created after a successful request |
Example
{
"errors": [ApiError],
"notificationRule": NotificationRule
}
NotificationRuleDeleteInput
Fields
| Input Field | Description |
|---|---|
id - NotificationRuleId!
|
Example
{"id": NotificationRuleId}
NotificationRuleDeleteResult
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
notificationRule - NotificationRule
|
Example
{
"errors": [ApiError],
"notificationRule": NotificationRule
}
NotificationRuleId
Example
NotificationRuleId
NotificationRuleUpdateInput
Description
Input for updating a notification rule
Fields
| Input Field | Description |
|---|---|
config - NotificationRuleConfigInput
|
Configuration for the notification rule |
id - NotificationRuleId!
|
Notification rule identifier |
name - String
|
The display name of the notification rule |
Example
{
"config": NotificationRuleConfigInput,
"id": NotificationRuleId,
"name": "abc123"
}
NotificationRuleUpdateResult
Description
Result for updating a notification rule
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
notificationRule - NotificationRule
|
The notification rule updated after a successful request |
Example
{
"errors": [ApiError],
"notificationRule": NotificationRule
}
NullFilter
Description
A null filter filter null values by configuring a column and either filter values that are NULL or that are NOT NULL
Fields
| Field Name | Description |
|---|---|
config - NullFilterConfig!
|
Filter variant specific configuration |
createdAt - DateTime!
|
When the filter was created |
id - FilterId!
|
Filter identifier |
name - String!
|
The display name of the filter |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the filter Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the filter |
source - Source!
|
|
updatedAt - DateTime!
|
When the filter was last updated |
Example
{
"config": NullFilterConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": FilterId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
NullFilterConfig
Description
Null filter specific configuration
Fields
| Field Name | Description |
|---|---|
field - JsonPointer!
|
|
operator - NullOperator!
|
Example
{"field": JsonPointer, "operator": "IS"}
NullFilterCreateInput
Description
Input for creating a null filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer!
|
The field to filter on |
name - String
|
The display name of the filter |
operator - NullOperator!
|
The operator to use when filtering |
resourceName - String
|
The resource name of the filter |
sourceId - SourceId!
|
Source identifier |
Example
{
"field": JsonPointer,
"name": "xyz789",
"operator": "IS",
"resourceName": "xyz789",
"sourceId": SourceId
}
NullFilterUpdateInput
Description
Input for updating a null filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer
|
The field to filter on |
id - FilterId!
|
Filter identifier |
name - String
|
The display name of the filter |
operator - NullOperator
|
The operator to use when filtering |
Example
{
"field": JsonPointer,
"id": FilterId,
"name": "xyz789",
"operator": "IS"
}
NullOperator
Description
Operator describing the null filter match
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IS"
NumericAnomalyMetric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COUNT"
NumericAnomalyValidator
Description
Numeric anomaly validator will validate individual field values for every datapoint Validio reads, by comparing the field value in a reference source. Dynamic anomaly bounds are configured with the sensitivity parameter
Fields
| Field Name | Description |
|---|---|
config - NumericAnomalyValidatorConfig!
|
|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
referenceSourceConfig - ReferenceSourceConfig!
|
Reference source configuration |
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"config": NumericAnomalyValidatorConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"hasCustomName": true,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"referenceSourceConfig": ReferenceSourceConfig,
"resourceName": "xyz789",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
NumericAnomalyValidatorConfig
Description
Configuration for numeric anomaly validator
Fields
| Field Name | Description |
|---|---|
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - NumericAnomalyMetric!
|
Metric to use for validation |
minimumAbsoluteDifference - Float!
|
Minimum absolute difference for absolute computation |
minimumReferenceDatapoints - Float
|
Minimum amount of reference points to compute anomaly |
minimumRelativeDifferencePercent - Float!
|
Minimum relative difference for percentage computation |
referenceSourceField - JsonPointer!
|
Reference field to apply validator on |
sensitivity - Float!
|
Sensitivity to use for dynamic measurements |
sourceField - JsonPointer!
|
Field to apply validator on |
threshold - Threshold!
|
The threshold used to determine if the result is an incident or not |
Example
{
"initializeWithBackfill": false,
"metric": "COUNT",
"minimumAbsoluteDifference": 987.65,
"minimumReferenceDatapoints": 123.45,
"minimumRelativeDifferencePercent": 123.45,
"referenceSourceField": JsonPointer,
"sensitivity": 123.45,
"sourceField": JsonPointer,
"threshold": DifferenceThreshold
}
NumericAnomalyValidatorCreateInput
Description
Input for creating a numeric anomaly validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - NumericAnomalyMetric!
|
Metric to use for validation |
minimumAbsoluteDifference - Float!
|
Minimum absolute difference for absolute computation |
minimumReferenceDatapoints - Float
|
Minimum amount of reference points to compute anomaly |
minimumRelativeDifferencePercent - Float!
|
Minimum relative difference for percentage computation |
name - String
|
The display name of the validator |
referenceSourceConfig - ReferenceSourceConfigCreateInput!
|
Reference source configuration |
referenceSourceField - JsonPointer!
|
Reference field to apply validator on |
resourceName - String
|
The resource name of the validator |
sensitivity - Float!
|
Sensitivity to use for dynamic measurements |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
sourceField - JsonPointer!
|
Field to apply validator on |
tagIds - [TagId!]
|
Tag IDs for the validator |
Example
{
"description": "abc123",
"initializeWithBackfill": false,
"metric": "COUNT",
"minimumAbsoluteDifference": 987.65,
"minimumReferenceDatapoints": 123.45,
"minimumRelativeDifferencePercent": 123.45,
"name": "abc123",
"referenceSourceConfig": ReferenceSourceConfigCreateInput,
"referenceSourceField": JsonPointer,
"resourceName": "abc123",
"sensitivity": 123.45,
"sourceConfig": SourceConfigCreateInput,
"sourceField": JsonPointer,
"tagIds": [TagId]
}
NumericAnomalyValidatorUpdateInput
Description
Input for updating a numeric anomaly validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
id - ValidatorId!
|
Validator identifier |
name - String
|
The display name of the validator |
referenceSourceConfig - ReferenceSourceConfigUpdateInput
|
Reference source configuration |
sourceConfig - SourceConfigUpdateInput
|
Source configuration |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
Example
{
"description": "abc123",
"id": ValidatorId,
"name": "abc123",
"referenceSourceConfig": ReferenceSourceConfigUpdateInput,
"sourceConfig": SourceConfigUpdateInput,
"tagIds": [TagId]
}
NumericDistributionMetric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MAXIMUM_RATIO"
NumericDistributionValidator
Description
Numeric distribution validator will make sure that your numeric fields have stable properties over time
Fields
| Field Name | Description |
|---|---|
config - NumericDistributionValidatorConfig!
|
|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
referenceSourceConfig - ReferenceSourceConfig!
|
Reference source configuration |
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"config": NumericDistributionValidatorConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"hasCustomName": false,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"referenceSourceConfig": ReferenceSourceConfig,
"resourceName": "abc123",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
NumericDistributionValidatorConfig
Description
Configuration for numeric distribution validator
Fields
| Field Name | Description |
|---|---|
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - NumericDistributionMetric!
|
Metric to use for validation |
referenceSourceField - JsonPointer!
|
Reference field to apply validator on |
sourceField - JsonPointer!
|
Field to apply validator on |
threshold - Threshold!
|
The threshold used to determine if the result is an incident or not |
Example
{
"initializeWithBackfill": true,
"metric": "MAXIMUM_RATIO",
"referenceSourceField": JsonPointer,
"sourceField": JsonPointer,
"threshold": DifferenceThreshold
}
NumericDistributionValidatorCreateInput
Description
Input for creating a numeric distribution validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - NumericDistributionMetric!
|
Metric to use for validation |
name - String
|
The display name of the validator |
referenceSourceConfig - ReferenceSourceConfigCreateInput!
|
Reference source configuration |
referenceSourceField - JsonPointer!
|
Reference field to apply validator on |
resourceName - String
|
The resource name of the validator |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
sourceField - JsonPointer!
|
Field to apply validator on |
tagIds - [TagId!]
|
Tag IDs for the validator |
Example
{
"description": "xyz789",
"initializeWithBackfill": false,
"metric": "MAXIMUM_RATIO",
"name": "abc123",
"referenceSourceConfig": ReferenceSourceConfigCreateInput,
"referenceSourceField": JsonPointer,
"resourceName": "abc123",
"sourceConfig": SourceConfigCreateInput,
"sourceField": JsonPointer,
"tagIds": [TagId]
}
NumericDistributionValidatorUpdateInput
Description
Input for updating a numeric distribution validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
id - ValidatorId!
|
Validator identifier |
name - String
|
The display name of the validator |
referenceSourceConfig - ReferenceSourceConfigUpdateInput
|
Reference source configuration |
sourceConfig - SourceConfigUpdateInput
|
Source configuration |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
Example
{
"description": "abc123",
"id": ValidatorId,
"name": "xyz789",
"referenceSourceConfig": ReferenceSourceConfigUpdateInput,
"sourceConfig": SourceConfigUpdateInput,
"tagIds": [TagId]
}
NumericMetric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MAX"
NumericValidator
Description
Numeric validator will do aggregate computations such as max, min, mean, and standard deviation
Fields
| Field Name | Description |
|---|---|
config - NumericValidatorConfig!
|
|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"config": NumericValidatorConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"hasCustomName": true,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"resourceName": "xyz789",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
NumericValidatorConfig
Description
Configuration for numeric validator
Fields
| Field Name | Description |
|---|---|
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - NumericMetric!
|
Metric to use for validation |
sourceField - JsonPointer!
|
Field to apply validator on |
threshold - Threshold!
|
The threshold used to determine if the result is an incident or not |
Example
{
"initializeWithBackfill": false,
"metric": "MAX",
"sourceField": JsonPointer,
"threshold": DifferenceThreshold
}
NumericValidatorCreateInput
Description
Input for creating a numeric validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - NumericMetric!
|
Metric to use for validation |
name - String
|
The display name of the validator |
resourceName - String
|
The resource name of the validator |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
sourceField - JsonPointer!
|
Field to apply validator on |
tagIds - [TagId!]
|
Tag IDs for the validator |
Example
{
"description": "xyz789",
"initializeWithBackfill": true,
"metric": "MAX",
"name": "xyz789",
"resourceName": "xyz789",
"sourceConfig": SourceConfigCreateInput,
"sourceField": JsonPointer,
"tagIds": [TagId]
}
NumericValidatorUpdateInput
Description
Input for updating a numeric validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
id - ValidatorId!
|
Validator identifier |
name - String
|
The display name of the validator |
sourceConfig - SourceConfigUpdateInput
|
Source configuration |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
Example
{
"description": "xyz789",
"id": ValidatorId,
"name": "abc123",
"sourceConfig": SourceConfigUpdateInput,
"tagIds": [TagId]
}
OwnerId
Description
Owner identifier
Example
OwnerId
OwnerNotificationRuleCondition
Fields
| Field Name | Description |
|---|---|
config - OwnerNotificationRuleConditionConfig!
|
|
createdAt - DateTime!
|
|
id - String!
|
|
notificationRuleId - NotificationRuleId!
|
|
updatedAt - DateTime!
|
Example
{
"config": OwnerNotificationRuleConditionConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": "abc123",
"notificationRuleId": NotificationRuleId,
"updatedAt": "2007-12-03T10:15:30Z"
}
OwnerNotificationRuleConditionConfig
Description
Owner notification rule condition
Fields
| Field Name | Description |
|---|---|
owners - [User!]!
|
Example
{"owners": [User]}
OwnerNotificationRuleConditionConfigInput
Description
Input for owner notification condition
Fields
| Input Field | Description |
|---|---|
ownerIds - [OwnerId!]!
|
Owner identifiers |
Example
{"ownerIds": [OwnerId]}
OwnerNotificationRuleConditionCreateInput
Fields
| Input Field | Description |
|---|---|
notificationRuleId - NotificationRuleId
|
|
owners - [ID!]!
|
Example
{
"notificationRuleId": NotificationRuleId,
"owners": ["4"]
}
OwnerNotificationRuleConditionUpdateInput
PageInfo
Example
{
"endCursor": "xyz789",
"filteredCount": 987,
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789",
"totalCount": 987
}
PaginationInput
PastIncidentGroupsFilter
Fields
| Input Field | Description |
|---|---|
owner - EnumQueryFilter
|
|
priority - EnumQueryFilter
|
|
source - EnumQueryFilter
|
|
status - EnumQueryFilter
|
|
validator - EnumQueryFilter
|
Example
{
"owner": EnumQueryFilter,
"priority": EnumQueryFilter,
"source": EnumQueryFilter,
"status": EnumQueryFilter,
"validator": EnumQueryFilter
}
PastIncidentGroupsIndex
Fields
| Field Name | Description |
|---|---|
owner - [IndexKey!]!
|
|
priority - [IndexKey!]!
|
|
status - [IndexKey!]!
|
Example
{
"owner": [IndexKey],
"priority": [IndexKey],
"status": [IndexKey]
}
PastIncidentGroupsResult
Fields
| Field Name | Description |
|---|---|
elements - [IncidentGroup!]!
|
|
index - PastIncidentGroupsIndex!
|
|
pageInfo - PageInfo!
|
Example
{
"elements": [IncidentGroup],
"index": PastIncidentGroupsIndex,
"pageInfo": PageInfo
}
PostgreSQLSourceDebugInfo
Description
Debug information for PostgreSQL
Example
{
"endTime": "2007-12-03T10:15:30Z",
"sqlQuery": "xyz789",
"startTime": "2007-12-03T10:15:30Z"
}
PostgreSqlCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - PostgreSqlCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
isDbtModel - Boolean!
|
|
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": PostgreSqlCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 987,
"id": CatalogAssetId,
"isDbtModel": true,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
PostgreSqlCatalogAssetConfig
PostgreSqlCredential
Description
A PostgreSQL credential is used to connect to PostgreSQL
Fields
| Field Name | Description |
|---|---|
config - PostgreSqlCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": PostgreSqlCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": false,
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
PostgreSqlCredentialConfig
PostgreSqlCredentialCreateInput
Description
Input for creating a PostgreSQL credential
Fields
| Input Field | Description |
|---|---|
defaultDatabase - String!
|
Name of the default PostgreSQL database where the table to read is included |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String!
|
DNS hostname or IP address to the PostgreSQL database server |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
password - String!
|
Password of the specified PostgreSQL user |
port - Int!
|
Port number of the PostgreSQL database server |
resourceName - String
|
The resource name of the credential |
user - String!
|
Username of PostgreSQL account with read access to the desired table |
Example
{
"defaultDatabase": "xyz789",
"enableCatalog": false,
"host": "xyz789",
"name": "abc123",
"namespaceId": NamespaceId,
"password": "abc123",
"port": 987,
"resourceName": "abc123",
"user": "xyz789"
}
PostgreSqlCredentialSecretChangedInput
Description
Input for checking if PostgreSQL credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
password - String!
|
The password to compare |
Example
{
"id": CredentialId,
"password": "abc123"
}
PostgreSqlCredentialUpdateInput
Description
Input for updating a PostgreSQL credential
Fields
| Input Field | Description |
|---|---|
defaultDatabase - String
|
Name of the default PostgreSQL database where the table to read is included |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String
|
DNS hostname or IP address to the PostgreSQL database server |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
password - String
|
Password of the specified PostgreSQL user |
port - Int
|
Port number of the PostgreSQL database server |
user - String
|
Username of PostgreSQL account with read access to the desired table |
Example
{
"defaultDatabase": "xyz789",
"enableCatalog": false,
"host": "abc123",
"id": CredentialId,
"name": "abc123",
"password": "xyz789",
"port": 987,
"user": "xyz789"
}
PostgreSqlInferSchemaInput
Description
Input for inferring PostgreSQL JTD schema
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
database - String
|
Database name |
schema - String!
|
Schema name |
table - String!
|
Table name |
Example
{
"credentialId": CredentialId,
"database": "xyz789",
"schema": "abc123",
"table": "xyz789"
}
PostgreSqlSource
Description
A PostgreSQL source monitor tables in a PostgreSQL database
Fields
| Field Name | Description |
|---|---|
catalogAsset - PostgreSqlCatalogAsset
|
Catalog asset for the source |
config - PostgreSqlSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": PostgreSqlCatalogAsset,
"config": PostgreSqlSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "xyz789",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
PostgreSqlSourceConfig
Description
Configuration for a PostgreSQL source
Fields
| Field Name | Description |
|---|---|
cursorField - String
|
Field holding timestamp used for some windowing |
database - String!
|
Database name |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Schema name |
table - String!
|
Table name |
Example
{
"cursorField": "abc123",
"database": "abc123",
"lookbackDays": 123,
"schedule": CronExpression,
"schema": "xyz789",
"table": "xyz789"
}
PostgreSqlSourceCreateInput
Description
Input for creating a PostgreSQL source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
cursorField - String
|
Field holding timestamp used for some windowing |
database - String
|
Database name |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
name - String!
|
The display name of the source |
resourceName - String
|
The resource name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Schema name |
table - String!
|
Table name |
tagIds - [TagId!]
|
Tag IDs for the source |
Example
{
"credentialId": CredentialId,
"cursorField": "abc123",
"database": "abc123",
"description": "abc123",
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 123,
"name": "xyz789",
"resourceName": "abc123",
"schedule": CronExpression,
"schema": "abc123",
"table": "xyz789",
"tagIds": [TagId]
}
PostgreSqlSourceUpdateInput
Description
Input for updating a PostgreSQL source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
lookbackDays - Int
|
How many days to fetch history for when doing backfilling |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "abc123",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "abc123",
"schedule": CronExpression,
"tagIds": [TagId]
}
QueryUserInfo
RecommendationId
Example
RecommendationId
ReferenceSourceConfig
Description
Source config for source that is used for reference for validators doing reference analysis
Example
{
"filter": JsonFilterExpression,
"history": 987,
"offset": 123,
"source": Source,
"sourceFilter": Filter,
"window": Window
}
ReferenceSourceConfigCreateInput
Description
Input for creating reference source configuration
Example
{
"filter": JsonFilterExpression,
"filterId": FilterId,
"history": 987,
"offset": 987,
"sourceId": SourceId,
"windowId": WindowId
}
ReferenceSourceConfigUpdateInput
Description
Input for updating reference source configuration
Fields
| Input Field | Description |
|---|---|
filter - JsonFilterExpression
|
Deprecated |
filterId - FilterId
|
Filter identifier |
history - Int
|
How many windows back to consider |
offset - Int
|
How many windows to skip |
Example
{
"filter": JsonFilterExpression,
"filterId": FilterId,
"history": 123,
"offset": 123
}
RelativeTimeMetric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MAXIMUM_DIFFERENCE"
RelativeTimeValidator
Description
Relative time validator will the difference between two timestamp fields. Calculates either the mean time difference, minimum time difference, or maximum time difference
Fields
| Field Name | Description |
|---|---|
config - RelativeTimeValidatorConfig!
|
|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"config": RelativeTimeValidatorConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"hasCustomName": false,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"resourceName": "abc123",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
RelativeTimeValidatorConfig
Description
Configuration for relative time validator
Fields
| Field Name | Description |
|---|---|
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - RelativeTimeMetric!
|
Metric to use for validation |
sourceFieldMinuend - JsonPointer!
|
Source field with time or date value to subtract from |
sourceFieldSubtrahend - JsonPointer!
|
Source field with time or date value to subtract from source field |
threshold - Threshold!
|
The threshold used to determine if the result is an incident or not |
Example
{
"initializeWithBackfill": false,
"metric": "MAXIMUM_DIFFERENCE",
"sourceFieldMinuend": JsonPointer,
"sourceFieldSubtrahend": JsonPointer,
"threshold": DifferenceThreshold
}
RelativeTimeValidatorCreateInput
Description
Input for creating a relative time validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - RelativeTimeMetric!
|
Metric to use for validation |
name - String
|
The display name of the validator |
resourceName - String
|
The resource name of the validator |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
sourceFieldMinuend - JsonPointer!
|
Source field with time or date value to subtract from |
sourceFieldSubtrahend - JsonPointer!
|
Source field with time or date value to subtract from source field |
tagIds - [TagId!]
|
Tag IDs for the validator |
Example
{
"description": "xyz789",
"initializeWithBackfill": false,
"metric": "MAXIMUM_DIFFERENCE",
"name": "xyz789",
"resourceName": "xyz789",
"sourceConfig": SourceConfigCreateInput,
"sourceFieldMinuend": JsonPointer,
"sourceFieldSubtrahend": JsonPointer,
"tagIds": [TagId]
}
RelativeTimeValidatorUpdateInput
Description
Input for updating a relative time validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
id - ValidatorId!
|
Validator identifier |
name - String
|
The display name of the validator |
sourceConfig - SourceConfigUpdateInput
|
Source configuration |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
Example
{
"description": "xyz789",
"id": ValidatorId,
"name": "abc123",
"sourceConfig": SourceConfigUpdateInput,
"tagIds": [TagId]
}
RelativeVolumeMetric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COUNT_RATIO"
RelativeVolumeValidator
Description
The relative volume validator calculates the time difference on two rows for each record:
- Count ratio: Calculates the ratio between the number of rows in the source and the number of rows in the reference source.
- Percentage ratio: Calculates the ratio between the percentage of rows in the source and the percentage of rows in the reference source that pass a given filter criteria
Fields
| Field Name | Description |
|---|---|
config - RelativeVolumeValidatorConfig!
|
|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
referenceSourceConfig - ReferenceSourceConfig!
|
Reference source configuration |
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"config": RelativeVolumeValidatorConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"hasCustomName": true,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"referenceSourceConfig": ReferenceSourceConfig,
"resourceName": "abc123",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
RelativeVolumeValidatorConfig
Description
Configuration for relative volume validator
Fields
| Field Name | Description |
|---|---|
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - RelativeVolumeMetric!
|
Metric to use for validation |
referenceSourceField - JsonPointer
|
Reference field to apply validator on |
sourceField - JsonPointer
|
Field to apply validator on |
threshold - Threshold!
|
The threshold used to determine if the result is an incident or not |
Example
{
"initializeWithBackfill": true,
"metric": "COUNT_RATIO",
"referenceSourceField": JsonPointer,
"sourceField": JsonPointer,
"threshold": DifferenceThreshold
}
RelativeVolumeValidatorCreateInput
Description
Input for creating a relative volume validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - RelativeVolumeMetric!
|
Metric to use for validation |
name - String
|
The display name of the validator |
referenceSourceConfig - ReferenceSourceConfigCreateInput!
|
Reference source configuration |
referenceSourceField - JsonPointer
|
Field to use for counting, e.g. COUNT(id). This is assigned default value "*" if unspecified meaning COUNT(*)` |
resourceName - String
|
The resource name of the validator |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
sourceField - JsonPointer
|
Field to use for counting, e.g. COUNT(id). This is assigned default value "*" if unspecified meaning COUNT(*)` |
tagIds - [TagId!]
|
Tag IDs for the validator |
Example
{
"description": "abc123",
"initializeWithBackfill": true,
"metric": "COUNT_RATIO",
"name": "xyz789",
"referenceSourceConfig": ReferenceSourceConfigCreateInput,
"referenceSourceField": JsonPointer,
"resourceName": "abc123",
"sourceConfig": SourceConfigCreateInput,
"sourceField": JsonPointer,
"tagIds": [TagId]
}
RelativeVolumeValidatorUpdateInput
Description
Input for updating a relative volume validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
id - ValidatorId!
|
Validator identifier |
name - String
|
The display name of the validator |
referenceSourceConfig - ReferenceSourceConfigUpdateInput
|
Reference source configuration |
sourceConfig - SourceConfigUpdateInput
|
Source configuration |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
Example
{
"description": "abc123",
"id": ValidatorId,
"name": "xyz789",
"referenceSourceConfig": ReferenceSourceConfigUpdateInput,
"sourceConfig": SourceConfigUpdateInput,
"tagIds": [TagId]
}
ResourceFilter
Fields
| Input Field | Description |
|---|---|
namespaceId - NamespaceId
|
Example
{"namespaceId": NamespaceId}
ResourceNamespaceListResult
ResourceNamespaceUpdateInput
Description
Input for updating the namespace of a resource
Fields
| Input Field | Description |
|---|---|
namespaceId - NamespaceId!
|
The namespace id of the resource before namespace is updated |
newNamespaceId - NamespaceId!
|
The new namespace id to move the resource to |
resourceName - String!
|
The resource name that should be updated |
Example
{
"namespaceId": NamespaceId,
"newNamespaceId": NamespaceId,
"resourceName": "xyz789"
}
ResourceNamespaceUpdatedResult
Description
Result for updating a resource namespace
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the update process |
namespaceId - NamespaceId
|
The namespace id of the resource before namespace is updated |
resourceName - String
|
The resource name that should be updated |
Example
{
"errors": [ApiError],
"namespaceId": NamespaceId,
"resourceName": "abc123"
}
Role
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ADMIN"
SamlIdentityProvider
Example
{
"config": SamlIdentityProviderConfig,
"createdAt": "2007-12-03T10:15:30Z",
"disabled": false,
"id": "4",
"name": "abc123",
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
SamlIdentityProviderConfig
SamlIdentityProviderCreateInput
SamlIdentityProviderUpdateInput
Scope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GLOBAL"
Segment
Fields
| Field Name | Description |
|---|---|
dataQuality - DataQuality
|
|
fields - [SegmentField!]!
|
|
id - SegmentId!
|
|
muted - Boolean!
|
No longer supported |
Example
{
"dataQuality": DataQuality,
"fields": [SegmentField],
"id": SegmentId,
"muted": false
}
SegmentField
Description
A representation of a segmented field and its value, used e.g. when creating notification rules to select what segment to notify on
Fields
| Field Name | Description |
|---|---|
field - JsonPointer!
|
The field to use for segmentation |
value - String!
|
The value for the segmented field |
Example
{
"field": JsonPointer,
"value": "xyz789"
}
SegmentFieldInput
Description
Field and value for segmentation when creating a debug query
Fields
| Input Field | Description |
|---|---|
field - JsonPointer!
|
The field to use for segmentation |
value - String!
|
The value for the segmented field |
Example
{
"field": JsonPointer,
"value": "abc123"
}
SegmentId
Example
SegmentId
SegmentNotificationRuleCondition
Fields
| Field Name | Description |
|---|---|
config - SegmentNotificationRuleConditionConfig!
|
|
createdAt - DateTime!
|
|
id - String!
|
|
notificationRuleId - NotificationRuleId!
|
|
updatedAt - DateTime!
|
Example
{
"config": SegmentNotificationRuleConditionConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": "xyz789",
"notificationRuleId": NotificationRuleId,
"updatedAt": "2007-12-03T10:15:30Z"
}
SegmentNotificationRuleConditionConfig
Description
Segment notification rule condition
Fields
| Field Name | Description |
|---|---|
segments - [SegmentField!]!
|
Segment field and values |
Example
{"segments": [SegmentField]}
SegmentNotificationRuleConditionConfigInput
Description
Input for segment notification condition
Fields
| Input Field | Description |
|---|---|
segments - [SegmentFieldInput!]!
|
Segment field and values |
Example
{"segments": [SegmentFieldInput]}
SegmentNotificationRuleConditionCreateInput
Fields
| Input Field | Description |
|---|---|
notificationRuleId - NotificationRuleId
|
|
segments - [SegmentFieldInput!]!
|
Example
{
"notificationRuleId": NotificationRuleId,
"segments": [SegmentFieldInput]
}
SegmentNotificationRuleConditionUpdateInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
segments - [SegmentFieldInput!]!
|
Example
{
"id": "xyz789",
"segments": [SegmentFieldInput]
}
Segmentation
Description
A segmentation is a way of grouping or partitioning data based on multiple field values. See the documentation for more details
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the segmentation was created |
fields - [String!]!
|
Fields that should be grouped by value to create a segment, e.g. if fields are Whereas a segmentation on only |
filter - Filter
|
|
id - SegmentationId!
|
Segmentation identifier |
name - String!
|
The display name of the segmentation |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the segmentation Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the segmentation |
segments - SegmentsResult!
|
|
source - Source!
|
|
updatedAt - DateTime!
|
When the segmentation was last updated |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"fields": ["abc123"],
"filter": Filter,
"id": SegmentationId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"segments": SegmentsResult,
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
SegmentationCreateInput
Description
Input for creating a segmentation
Fields
| Input Field | Description |
|---|---|
fields - [String!]!
|
Segmentation fields |
filterId - FilterId
|
ID of the filter attached to the segmentation. This is used to filter in datapoints that will be processed by validators attached to this segmentation |
name - String
|
The display name of the segmentation |
resourceName - String
|
The resource name of the segmentation |
sourceId - SourceId!
|
Source identifier |
Example
{
"fields": ["abc123"],
"filterId": FilterId,
"name": "abc123",
"resourceName": "abc123",
"sourceId": SourceId
}
SegmentationCreateResult
Description
Result for creating a segmentation
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
segmentation - Segmentation
|
Segmentation after a successful request |
Example
{
"errors": [ApiError],
"segmentation": Segmentation
}
SegmentationId
Description
Segmentation identifier
Example
SegmentationId
SegmentationSchemaConflict
Description
Fields on a segmentation that failed schema validation after a schema change was detected
Fields
| Field Name | Description |
|---|---|
fields - [JsonPointer!]!
|
Fields changed that caused validation to fail |
segmentation - Segmentation!
|
Example
{
"fields": [JsonPointer],
"segmentation": Segmentation
}
SegmentationUpdateInput
Description
Input for updating a segmentation
Fields
| Input Field | Description |
|---|---|
filterId - FilterId
|
Segmentation filter |
id - SegmentationId!
|
Segmentation identifier |
name - String
|
The display name of the segmentation |
Example
{
"filterId": FilterId,
"id": SegmentationId,
"name": "xyz789"
}
SegmentationUpdateResult
Description
Result for updating a segmentation
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
segmentation - Segmentation
|
The segmentation created after a successful request |
Example
{
"errors": [ApiError],
"segmentation": Segmentation
}
SegmentationsDeleteResult
Description
Result for deleting a segmentation
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{"errors": [ApiError]}
SegmentsResult
Fields
| Field Name | Description |
|---|---|
elements - [Segment!]!
|
|
pageInfo - PageInfo
|
Example
{
"elements": [Segment],
"pageInfo": PageInfo
}
SeverityNotificationRuleCondition
Fields
| Field Name | Description |
|---|---|
config - SeverityNotificationRuleConditionConfig!
|
|
createdAt - DateTime!
|
|
id - String!
|
|
notificationRuleId - NotificationRuleId!
|
|
updatedAt - DateTime!
|
Example
{
"config": SeverityNotificationRuleConditionConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": "abc123",
"notificationRuleId": NotificationRuleId,
"updatedAt": "2007-12-03T10:15:30Z"
}
SeverityNotificationRuleConditionConfig
Description
Severity notification rule condition
Fields
| Field Name | Description |
|---|---|
severities - [IncidentSeverity!]!
|
Incident severities |
Example
{"severities": ["HIGH"]}
SeverityNotificationRuleConditionConfigInput
Description
Input for notification severity condition
Fields
| Input Field | Description |
|---|---|
severities - [IncidentSeverity!]!
|
Incident severities |
Example
{"severities": ["HIGH"]}
SeverityNotificationRuleConditionCreateInput
Fields
| Input Field | Description |
|---|---|
notificationRuleId - NotificationRuleId
|
|
severities - [IncidentSeverity!]!
|
Example
{
"notificationRuleId": NotificationRuleId,
"severities": ["HIGH"]
}
SeverityNotificationRuleConditionUpdateInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
severities - [IncidentSeverity!]!
|
Example
{"id": "abc123", "severities": ["HIGH"]}
SeverityStats
SlackChannel
Description
A Slack channel is a channel that will post messages to Slack
Fields
| Field Name | Description |
|---|---|
config - SlackChannelConfig!
|
Slack specific configuration for the channel |
createdAt - DateTime!
|
When the channel was created |
id - ChannelId!
|
Channel identifier |
name - String!
|
The display name of the channel |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the channel Use 'namespace.id' instead |
notificationRules - [NotificationRule!]!
|
|
resourceName - String!
|
The resource name of the channel |
updatedAt - DateTime!
|
When the channel was last updated |
Example
{
"config": SlackChannelConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": ChannelId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"notificationRules": [NotificationRule],
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
SlackChannelConfig
Description
Configuration for a Slack channel
Fields
| Field Name | Description |
|---|---|
applicationLinkUrl - String!
|
URL to the Validio application |
interactiveMessageEnabled - Boolean!
|
If interactive notification messages should be used |
slackChannelId - String
|
The id for the Slack channel to where the message should be posted |
timezone - String
|
No longer supported |
webhookUrl - String!
|
The webhook URL to where the message should be posted. See the Slack documentation on how to get this URL No longer supported |
Example
{
"applicationLinkUrl": "abc123",
"interactiveMessageEnabled": false,
"slackChannelId": "abc123",
"timezone": "abc123",
"webhookUrl": "abc123"
}
SlackChannelCreateInput
Description
Input for creating a Slack channel
Fields
| Input Field | Description |
|---|---|
applicationLinkUrl - String!
|
URL to the Validio application |
interactiveMessageEnabled - Boolean
|
If interactive notification messages should be used |
name - String!
|
The display name of the channel |
namespaceId - NamespaceId!
|
The namespace id for the channel |
resourceName - String
|
The resource name of the channel |
signingSecret - String
|
Signing secret used for verifying incoming requests from Slack |
slackChannelId - String
|
The id for the Slack channel to where the message should be posted |
token - String
|
Token for the bot used for sending messages |
Example
{
"applicationLinkUrl": "abc123",
"interactiveMessageEnabled": false,
"name": "abc123",
"namespaceId": NamespaceId,
"resourceName": "abc123",
"signingSecret": "abc123",
"slackChannelId": "abc123",
"token": "abc123"
}
SlackChannelSecretChangedInput
Description
Input for checking if Slack channel secrets changed
Fields
| Input Field | Description |
|---|---|
id - ChannelId!
|
Channel identifier |
signingSecret - String!
|
Signing secret used for verifying incoming requests from Slack |
token - String!
|
Token for the bot used for sending messages |
Example
{
"id": ChannelId,
"signingSecret": "abc123",
"token": "abc123"
}
SlackChannelSecretChangedResult
Description
Result for checking if Microsoft Teams channel secrets changed
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
signingSecret - Boolean!
|
True if the stored signing secret is different from the value in the request |
token - Boolean!
|
True if the stored token is different from the value in the request |
Example
{
"errors": [ApiError],
"signingSecret": true,
"token": true
}
SlackChannelUpdateInput
Description
Input for updating a Slack channel
Fields
| Input Field | Description |
|---|---|
applicationLinkUrl - String
|
URL to the Validio application |
id - ChannelId!
|
Channel identifier |
interactiveMessageEnabled - Boolean
|
If interactive notification messages should be used |
name - String
|
The display name of the channel |
signingSecret - String
|
Signing secret used for verifying incoming requests from Slack |
slackChannelId - String
|
The id for the Slack channel to where the message should be posted |
token - String
|
Token for the bot used for sending messages |
Example
{
"applicationLinkUrl": "abc123",
"id": ChannelId,
"interactiveMessageEnabled": false,
"name": "abc123",
"signingSecret": "abc123",
"slackChannelId": "abc123",
"token": "xyz789"
}
SnowflakeCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - SnowflakeCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
fieldCount - Int!
|
The number of fields in the asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
isDbtModel - Boolean!
|
|
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
sources - [Source!]!
|
The sources associated with the asset |
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": SnowflakeCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"fieldCount": 987,
"id": CatalogAssetId,
"isDbtModel": false,
"joinedTables": [CatalogAsset],
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"sources": [Source],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
SnowflakeCatalogAssetConfig
SnowflakeCredential
Description
A Snowflake credential is used to connect to a Snowflake warehouse
Fields
| Field Name | Description |
|---|---|
config - SnowflakeCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": SnowflakeCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": false,
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
SnowflakeCredentialAuth
Description
Representation of which authentication method to use when connecting to Snowflake. It can be either a key-pair or a username and password
Types
| Union Types |
|---|
Example
SnowflakeCredentialKeyPair
SnowflakeCredentialAuthInput
Description
Auth mechanism to use for Snowflake
Fields
| Input Field | Description |
|---|---|
keyPair - SnowflakeCredentialKeyPairInput
|
|
userPassword - SnowflakeCredentialUserPasswordInput
|
Example
{
"keyPair": SnowflakeCredentialKeyPairInput,
"userPassword": SnowflakeCredentialUserPasswordInput
}
SnowflakeCredentialConfig
Fields
| Field Name | Description |
|---|---|
account - String!
|
|
auth - SnowflakeCredentialAuth
|
|
role - String
|
|
user - String!
|
Use auth
|
warehouse - String
|
Example
{
"account": "xyz789",
"auth": SnowflakeCredentialKeyPair,
"role": "abc123",
"user": "abc123",
"warehouse": "xyz789"
}
SnowflakeCredentialCreateInput
Description
Input for creating a Snowflake credential
Fields
| Input Field | Description |
|---|---|
account - String!
|
The account name in Snowflake |
auth - SnowflakeCredentialAuthInput
|
Auth method to use for Snowflake |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
role - String
|
Role used to access data |
warehouse - String
|
Snowflake warehouse used to process data |
Example
{
"account": "abc123",
"auth": SnowflakeCredentialAuthInput,
"enableCatalog": false,
"name": "abc123",
"namespaceId": NamespaceId,
"resourceName": "abc123",
"role": "abc123",
"warehouse": "abc123"
}
SnowflakeCredentialKeyPair
Description
Snowflake key-pair credentials to use key-pair to authenticate a user
Fields
| Field Name | Description |
|---|---|
user - String!
|
Username |
Example
{"user": "abc123"}
SnowflakeCredentialKeyPairInput
Description
Input for creating Snowflake credential with key-pair
Example
{
"privateKey": "xyz789",
"privateKeyPassphrase": "xyz789",
"user": "abc123"
}
SnowflakeCredentialSecretChangedInput
Description
Input for checking if Snowflake credentials changed
Fields
| Input Field | Description |
|---|---|
auth - SnowflakeCredentialAuthInput
|
The auth method to compare |
id - CredentialId!
|
Credential identifier |
password - String
|
Example
{
"auth": SnowflakeCredentialAuthInput,
"id": CredentialId,
"password": "xyz789"
}
SnowflakeCredentialUpdateInput
Description
Input for updating a Snowflake credential
Fields
| Input Field | Description |
|---|---|
account - String
|
The account name in Snowflake |
auth - SnowflakeCredentialAuthInput
|
Auth method to use for Snowflake |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
role - String
|
Role used to access data |
warehouse - String
|
Snowflake warehouse used to process data |
Example
{
"account": "abc123",
"auth": SnowflakeCredentialAuthInput,
"enableCatalog": true,
"id": CredentialId,
"name": "abc123",
"role": "xyz789",
"warehouse": "abc123"
}
SnowflakeCredentialUserPassword
Description
Snowflake username and password to use basic auth for a user
Fields
| Field Name | Description |
|---|---|
user - String!
|
Credential identifier |
Example
{"user": "xyz789"}
SnowflakeCredentialUserPasswordInput
SnowflakeInferSchemaInput
Description
Input for inferring Snowflake JTD schema
Example
{
"credentialId": CredentialId,
"database": "abc123",
"role": "xyz789",
"schema": "abc123",
"table": "abc123",
"warehouse": "abc123"
}
SnowflakeSource
Description
A Snowflake source monitor tables in a Snowflake warehouse
Fields
| Field Name | Description |
|---|---|
catalogAsset - SnowflakeCatalogAsset
|
Catalog asset for the source |
config - SnowflakeSourceConfig!
|
Source specific configuration |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential used to connect to the source |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id for the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Example
{
"catalogAsset": SnowflakeCatalogAsset,
"config": SnowflakeSourceConfig,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "abc123",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
SnowflakeSourceConfig
Description
Configuration for a Snowflake source
Fields
| Field Name | Description |
|---|---|
cursorField - String
|
Field holding timestamp used for some windowing |
database - String!
|
Database name |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
role - String
|
Role used to access data |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Schema name |
table - String!
|
Table name |
warehouse - String
|
Snowflake warehouse used to process data |
Example
{
"cursorField": "xyz789",
"database": "xyz789",
"lookbackDays": 987,
"role": "xyz789",
"schedule": CronExpression,
"schema": "xyz789",
"table": "abc123",
"warehouse": "abc123"
}
SnowflakeSourceCreateInput
Description
Input for creating a Snowflake source
Fields
| Input Field | Description |
|---|---|
credentialId - CredentialId!
|
Credential used to connect to the source |
cursorField - String
|
Field holding timestamp used for some windowing |
database - String!
|
Database name |
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
lookbackDays - Int!
|
How many days to fetch history for when doing backfilling |
name - String!
|
The display name of the source |
resourceName - String
|
The resource name of the source |
role - String
|
Role used to access data |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
schema - String!
|
Schema name |
table - String!
|
Table name |
tagIds - [TagId!]
|
Tag IDs for the source |
warehouse - String
|
Snowflake warehouse used to process data |
Example
{
"credentialId": CredentialId,
"cursorField": "abc123",
"database": "abc123",
"description": "abc123",
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 987,
"name": "xyz789",
"resourceName": "xyz789",
"role": "xyz789",
"schedule": CronExpression,
"schema": "abc123",
"table": "xyz789",
"tagIds": [TagId],
"warehouse": "abc123"
}
SnowflakeSourceDebugInfo
Description
Debug information for Snowflake
Example
{
"endTime": "2007-12-03T10:15:30Z",
"sqlQuery": "abc123",
"startTime": "2007-12-03T10:15:30Z"
}
SnowflakeSourceUpdateInput
Description
Input for updating a Snowflake source
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the source. Maximum length for this field is 1024 characters |
id - SourceId!
|
Source identifier |
jtdSchema - JsonTypeDefinition
|
JTD schema for the source |
lookbackDays - Int
|
How many days to fetch history for when doing backfilling |
name - String
|
The display name of the source |
schedule - CronExpression
|
When to poll the source if on schedule. Format is cron expression |
tagIds - [TagId!]
|
Tag IDs for the source. All tag IDs specified here will replace all currently associated tag IDs with the source |
Example
{
"description": "xyz789",
"id": SourceId,
"jtdSchema": JsonTypeDefinition,
"lookbackDays": 123,
"name": "xyz789",
"schedule": CronExpression,
"tagIds": [TagId]
}
SortIndex
Fields
| Input Field | Description |
|---|---|
index - Int!
|
|
order - SortOrder!
|
Example
{"index": 123, "order": "ASCENDING"}
SortOrder
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASCENDING"
Source
Fields
| Field Name | Description |
|---|---|
catalogAsset - CatalogAsset
|
Catalog asset for the source |
createdAt - DateTime!
|
When the source was created |
credential - Credential!
|
Credential identifier |
description - String
|
Description of the source |
filters - [Filter!]!
|
Filters on the source |
id - SourceId!
|
Source identifier |
incidentGroups - IncidentGroupsResult!
|
IncidentGroups generated by the source |
Arguments |
|
jtdSchema - JsonTypeDefinition!
|
JTD schema for the source |
name - String!
|
The display name of the source |
namespace - Namespace!
|
Namespace the source belongs to |
namespaceId - NamespaceId!
|
The namespace id of the source Use 'namespace.id' instead |
recommendedValidators - [Validator!]!
|
Validators recommended in this source |
resourceName - String!
|
The resource name of the source |
segmentations - [Segmentation!]!
|
Segmentations on the source |
state - SourceState!
|
State of the source |
stateUpdatedAt - DateTime!
|
When the source state was last updated |
tags - [Tag!]!
|
Tags linked to the source |
updatedAt - DateTime!
|
When the source was last updated |
windows - [Window!]!
|
Windows on the source |
Possible Types
| Source Types |
|---|
Example
{
"catalogAsset": CatalogAsset,
"createdAt": "2007-12-03T10:15:30Z",
"credential": Credential,
"description": "abc123",
"filters": [Filter],
"id": SourceId,
"incidentGroups": IncidentGroupsResult,
"jtdSchema": JsonTypeDefinition,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"recommendedValidators": [Validator],
"resourceName": "abc123",
"segmentations": [Segmentation],
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z",
"windows": [Window]
}
SourceConfig
Description
Source configuration that determines what source attributes should be used for a validator
Fields
| Field Name | Description |
|---|---|
filter - JsonFilterExpression
|
Deprecated |
segmentation - Segmentation!
|
|
source - Source!
|
|
sourceFilter - Filter
|
|
window - Window!
|
Example
{
"filter": JsonFilterExpression,
"segmentation": Segmentation,
"source": Source,
"sourceFilter": Filter,
"window": Window
}
SourceConfigCreateInput
Description
Input for creating source configuration
Fields
| Input Field | Description |
|---|---|
filter - JsonFilterExpression
|
Deprecated |
filterId - FilterId
|
Filter identifier |
segmentationId - SegmentationId!
|
Segmentation identifier |
sourceId - SourceId!
|
Source identifier |
windowId - WindowId!
|
Window identifier |
Example
{
"filter": JsonFilterExpression,
"filterId": FilterId,
"segmentationId": SegmentationId,
"sourceId": SourceId,
"windowId": WindowId
}
SourceConfigUpdateInput
Description
Input for updating source configuration
Fields
| Input Field | Description |
|---|---|
filter - JsonFilterExpression
|
Deprecated |
filterId - FilterId
|
Filter identifier |
Example
{
"filter": JsonFilterExpression,
"filterId": FilterId
}
SourceCreateResult
Description
Result for creating a source
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
source - Source
|
The source after a successful request |
Example
{
"errors": [ApiError],
"source": Source
}
SourceId
Description
Source identifier
Example
SourceId
SourceMuteResult
Description
Result for muting a source
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the mute operation |
Example
{"errors": [ApiError]}
SourceNotificationRuleCondition
Fields
| Field Name | Description |
|---|---|
config - SourceNotificationRuleConditionConfig!
|
|
createdAt - DateTime!
|
|
id - String!
|
|
notificationRuleId - NotificationRuleId!
|
|
updatedAt - DateTime!
|
Example
{
"config": SourceNotificationRuleConditionConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": "abc123",
"notificationRuleId": NotificationRuleId,
"updatedAt": "2007-12-03T10:15:30Z"
}
SourceNotificationRuleConditionConfig
Description
Source notification rule condition
Fields
| Field Name | Description |
|---|---|
sources - [Source]!
|
Example
{"sources": [Source]}
SourceNotificationRuleConditionConfigInput
Description
Input for source condition
Fields
| Input Field | Description |
|---|---|
sourceIds - [SourceId!]!
|
Source identifiers |
Example
{"sourceIds": [SourceId]}
SourceNotificationRuleConditionCreateInput
Fields
| Input Field | Description |
|---|---|
notificationRuleId - NotificationRuleId
|
|
sources - [SourceId]!
|
Example
{
"notificationRuleId": NotificationRuleId,
"sources": [SourceId]
}
SourceNotificationRuleConditionUpdateInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
sources - [SourceId]!
|
Example
{
"id": "abc123",
"sources": [SourceId]
}
SourceOwnerUpdateInput
SourceOwnerUpdateResult
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
source - Source
|
Example
{
"errors": [ApiError],
"source": Source
}
SourcePollId
Description
Source poll identifier
Example
SourcePollId
SourcePollProgressResult
Description
Result for checking source poll progress
Fields
| Field Name | Description |
|---|---|
description - String
|
Any additional context to the status |
errors - [ApiError!]!
|
|
status - SourcePollProgressStatus
|
The current status of the poll |
Example
{
"description": "abc123",
"errors": [ApiError],
"status": "FAILED"
}
SourcePollProgressStatus
Description
The source poll progress status tells what status the requested poll has
Values
| Enum Value | Description |
|---|---|
|
|
The poll is completed but didn't run successfully |
|
|
The poll is requested but not started |
|
|
The poll is currently running |
|
|
The poll is completed and finished successfully |
Example
"FAILED"
SourcePollResult
Description
Result for starting a source poll
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
id - SourcePollId
|
The source poll identifier after a successful request |
Example
{
"errors": [ApiError],
"id": SourcePollId
}
SourceRequestStateResult
Description
Result when requesting a new state of a source
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
state - SourceState
|
The state after a successful request |
Example
{"errors": [ApiError], "state": "BACKFILLING"}
SourceSchemaVerifyResult
Description
Result after verifying a schema after a schema change was detected
Fields
| Field Name | Description |
|---|---|
segmentationConflicts - [SegmentationSchemaConflict!]!
|
Segmentation conflicts |
validatorConflicts - [ValidatorSchemaConflict!]!
|
Validator conflicts |
windowConflicts - [WindowSchemaConflict!]!
|
Window conflicts |
Example
{
"segmentationConflicts": [SegmentationSchemaConflict],
"validatorConflicts": [ValidatorSchemaConflict],
"windowConflicts": [WindowSchemaConflict]
}
SourceState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BACKFILLING"
SourceUnmuteResult
Description
Result for unmuting a source
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the unmute operation |
Example
{"errors": [ApiError]}
SourceUpdateResult
Description
Result for updating a source
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the update process |
source - Source
|
The source after a successful request |
Example
{
"errors": [ApiError],
"source": Source
}
SourcesCatalogAsset
Fields
| Field Name | Description |
|---|---|
fieldCount - Int!
|
The number of fields in the asset |
jtdSchema - JsonTypeDefinition!
|
The JSON Type Definition schema of the asset |
sources - [Source!]!
|
The sources associated with the asset |
Possible Types
| SourcesCatalogAsset Types |
|---|
Example
{
"fieldCount": 123,
"jtdSchema": JsonTypeDefinition,
"sources": [Source]
}
SourcesDeleteResult
Description
Result for deleting a source
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{"errors": [ApiError]}
SqlFilter
Description
An SQL filter will parse a SQL query and filter based on the query. The filter only contains a query which will include the field(s) to filter. The query supports standard SQL operators
Fields
| Field Name | Description |
|---|---|
config - SqlFilterConfig!
|
Filter variant specific configuration |
createdAt - DateTime!
|
When the filter was created |
id - FilterId!
|
Filter identifier |
name - String!
|
The display name of the filter |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the filter Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the filter |
source - Source!
|
|
updatedAt - DateTime!
|
When the filter was last updated |
Example
{
"config": SqlFilterConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": FilterId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
SqlFilterConfig
Description
SQL filter specific configuration
Fields
| Field Name | Description |
|---|---|
query - String!
|
The SQL expression to use when filtering, e.g. Age > 20 |
Example
{"query": "abc123"}
SqlFilterCreateInput
Description
Input for creating an SQL filter
Example
{
"name": "abc123",
"query": "abc123",
"resourceName": "abc123",
"sourceId": SourceId
}
SqlFilterUpdateInput
SqlFilterVerificationInput
Description
Input for verifying a SQL filter
Fields
| Input Field | Description |
|---|---|
query - String!
|
The SQL query to use for filtering |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
Example
{
"query": "xyz789",
"sourceConfig": SourceConfigCreateInput
}
SqlFilterVerificationResult
Description
Result for verifying a SQL filter
Fields
| Field Name | Description |
|---|---|
queryError - String
|
Errors specific to the query execution, not to be confused with ApiError |
Example
{"queryError": "abc123"}
SqlValidator
Description
For data from data warehouse or query engine sources, you can leverage SQL to create validators customized for your business needs with a Custom SQL validator
Fields
| Field Name | Description |
|---|---|
config - SqlValidatorConfig!
|
|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"config": SqlValidatorConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"hasCustomName": false,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"resourceName": "abc123",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
SqlValidatorConfig
Description
Configuration for SQL validator
Fields
| Field Name | Description |
|---|---|
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
query - String!
|
The SQL query to be executed |
threshold - Threshold!
|
The threshold used to determine if the result is an incident or not |
Example
{
"initializeWithBackfill": false,
"query": "abc123",
"threshold": DifferenceThreshold
}
SqlValidatorCreateInput
Description
Input for creating a SQL validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
name - String
|
The display name of the validator |
query - String!
|
The SQL query to execute |
resourceName - String
|
The resource name of the validator |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
tagIds - [TagId!]
|
Tag IDs for the validator |
Example
{
"description": "xyz789",
"initializeWithBackfill": false,
"name": "xyz789",
"query": "abc123",
"resourceName": "abc123",
"sourceConfig": SourceConfigCreateInput,
"tagIds": [TagId]
}
SqlValidatorQueryVerificationInput
Description
Input type for verifying a SQL query for a SQL validator
Fields
| Input Field | Description |
|---|---|
query - String!
|
The SQL query to execute |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
Example
{
"query": "abc123",
"sourceConfig": SourceConfigCreateInput
}
SqlValidatorQueryVerificationResult
Fields
| Field Name | Description |
|---|---|
query - String
|
The SQL query executed |
queryError - String
|
Errors specific to the query execution, not to be confused with ApiError |
records - DebugRecordsSample
|
The result for running a query successfully |
Example
{
"query": "xyz789",
"queryError": "abc123",
"records": DebugRecordsSample
}
SqlValidatorUpdateInput
Description
Input for updating a SQL validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
id - ValidatorId!
|
Validator identifier |
name - String
|
The display name of the validator |
query - String
|
The SQL query to execute |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
Example
{
"description": "abc123",
"id": ValidatorId,
"name": "xyz789",
"query": "xyz789",
"tagIds": [TagId]
}
StreamingSourceMessageFormat
Description
Format used in streaming sources that supports multiple formats, e.g. Kafka
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AVRO"
StreamingSourceMessageFormatConfig
Description
Message format configuration for streaming sources
Fields
| Field Name | Description |
|---|---|
format - StreamingSourceMessageFormat!
|
The message format of the messages |
schema - String
|
An optional schema if required, e.g. for Protobuf this is the proto file |
Example
{"format": "AVRO", "schema": "abc123"}
StreamingSourceMessageFormatConfigInput
Description
Input for creating streaming source message format
Fields
| Input Field | Description |
|---|---|
format - StreamingSourceMessageFormat!
|
The message format of the messages |
schema - String
|
An optional schema if required, e.g. for Protobuf this is the proto file |
Example
{"format": "AVRO", "schema": "xyz789"}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text
Example
"xyz789"
StringFilter
Description
A string filter will use an operator combined with a value to filter a field by the string being, empty, not empty, having a specific prefix or other string operators defined by string operator
Fields
| Field Name | Description |
|---|---|
config - StringFilterConfig!
|
The display name of the filter. Filter variant specific configuration |
createdAt - DateTime!
|
When the filter was created |
id - FilterId!
|
Filter identifier |
name - String!
|
The display name of the filter |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the filter Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the filter |
source - Source!
|
|
updatedAt - DateTime!
|
When the filter was last updated |
Example
{
"config": StringFilterConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": FilterId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
StringFilterConfig
Description
String filter specific configuration
Fields
| Field Name | Description |
|---|---|
field - JsonPointer!
|
The field to filter on |
operator - StringOperator!
|
The operator to use when filtering |
value - String
|
The value to use with the operator |
Example
{
"field": JsonPointer,
"operator": "CONTAINS",
"value": "xyz789"
}
StringFilterCreateInput
Description
Input for creating a string filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer!
|
The field to filter on |
name - String
|
The display name of the filter |
operator - StringOperator!
|
The operator to use when filtering |
resourceName - String
|
The resource name of the filter |
sourceId - SourceId!
|
Source identifier |
value - String
|
The value to use with the operator |
Example
{
"field": JsonPointer,
"name": "abc123",
"operator": "CONTAINS",
"resourceName": "xyz789",
"sourceId": SourceId,
"value": "abc123"
}
StringFilterUpdateInput
Description
Input for updating a string filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer
|
The field to filter on |
id - FilterId!
|
Filter identifier |
name - String
|
The display name of the filter |
operator - StringOperator
|
The operator to use when filtering |
value - String
|
The value to use with the operator |
Example
{
"field": JsonPointer,
"id": FilterId,
"name": "xyz789",
"operator": "CONTAINS",
"value": "abc123"
}
StringOperator
Description
Operator for string values
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTAINS"
TableauConnectedAppCredential
Description
A Tableau credential is used to connect to Tableau as a connected app
Fields
| Field Name | Description |
|---|---|
config - TableauConnectedAppCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": TableauConnectedAppCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": false,
"id": CredentialId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
TableauConnectedAppCredentialConfig
TableauConnectedAppCredentialCreateInput
Description
Input for creating a Tableau connected app credential
Fields
| Input Field | Description |
|---|---|
clientId - String!
|
The Client ID of your Tableau Connected Apps configuration |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String!
|
The URL of your Tableau server |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
secretId - String!
|
The Secret ID of your Tableau Connected Apps configuration |
secretValue - String!
|
The Secret value of your Tableau Connected Apps configuration |
site - String
|
The name of your Tableau site. The site ID is optional when using Tableau Server, but needs to be specified when using Tableau Cloud |
user - String!
|
The username of an authenticated Tableau user on your server |
Example
{
"clientId": "abc123",
"enableCatalog": true,
"host": "abc123",
"name": "abc123",
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"secretId": "abc123",
"secretValue": "abc123",
"site": "abc123",
"user": "abc123"
}
TableauConnectedAppCredentialSecretChangedInput
Description
Input for checking if Tableau connected app credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
secretValue - String!
|
The secret value to compare |
Example
{
"id": CredentialId,
"secretValue": "xyz789"
}
TableauConnectedAppCredentialUpdateInput
Description
Input for updating a Tableau connected app credential
Fields
| Input Field | Description |
|---|---|
clientId - String
|
The Client ID of your Tableau Connected Apps configuration |
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String
|
The URL of your Tableau server |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
secretId - String
|
The Secret ID of your Tableau Connected Apps configuration |
secretValue - String
|
The Secret value of your Tableau Connected Apps configuration |
site - String
|
The name of your Tableau site. The site ID is optional when using Tableau Server, but needs to be specified when using Tableau Cloud |
user - String
|
The username of an authenticated Tableau user on your server |
Example
{
"clientId": "xyz789",
"enableCatalog": true,
"host": "xyz789",
"id": CredentialId,
"name": "xyz789",
"secretId": "xyz789",
"secretValue": "xyz789",
"site": "xyz789",
"user": "xyz789"
}
TableauCustomSQLTableCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - ExploreCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": ExploreCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "abc123",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
TableauDashboardCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - DashboardCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": DashboardCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
TableauDatasourceCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - ExploreCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": ExploreCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
TableauFlowCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - ExploreCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": ExploreCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "abc123",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
TableauPersonalAccessTokenCredential
Description
A Tableau personal access token credential is used to connect to Tableau with a personal access token
Fields
| Field Name | Description |
|---|---|
config - TableauPersonalAccessTokenCredentialConfig!
|
|
createdAt - DateTime!
|
When the credential was created |
enableCatalog - Boolean!
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
id - CredentialId!
|
Credential identifier |
name - String!
|
The display name of the credential |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the credential Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the credential |
updatedAt - DateTime!
|
When the credential was last updated |
Example
{
"config": TableauPersonalAccessTokenCredentialConfig,
"createdAt": "2007-12-03T10:15:30Z",
"enableCatalog": true,
"id": CredentialId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
TableauPersonalAccessTokenCredentialConfig
TableauPersonalAccessTokenCredentialCreateInput
Description
Input for creating a Tableau personal access token credential
Fields
| Input Field | Description |
|---|---|
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String!
|
The URL of your Tableau server |
name - String!
|
The display name of the credential |
namespaceId - NamespaceId
|
The namespace id for the credential |
resourceName - String
|
The resource name of the credential |
site - String
|
The name of your Tableau site. The site ID is optional when using Tableau Server, but needs to be specified when using Tableau Cloud |
tokenName - String!
|
The name of the Tableau personal access token |
tokenValue - String!
|
The value of the Tableau personal access token |
Example
{
"enableCatalog": true,
"host": "abc123",
"name": "xyz789",
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"site": "xyz789",
"tokenName": "abc123",
"tokenValue": "abc123"
}
TableauPersonalAccessTokenCredentialSecretChangedInput
Description
Input for checking if Tableau personal access token credentials changed
Fields
| Input Field | Description |
|---|---|
id - CredentialId!
|
Credential identifier |
tokenValue - String!
|
The token value to compare |
Example
{
"id": CredentialId,
"tokenValue": "xyz789"
}
TableauPersonalAccessTokenCredentialUpdateInput
Description
Input for updating a Tableau personal access token secret
Fields
| Input Field | Description |
|---|---|
enableCatalog - Boolean
|
If the credential should be used for cataloging by trying to discover assets and asset relations (linage) |
host - String
|
The URL of your Tableau server |
id - CredentialId!
|
Credential identifier |
name - String
|
The display name of the credential |
site - String
|
The name of your Tableau site. The site ID is optional when using Tableau Server, but needs to be specified when using Tableau Cloud |
tokenName - String
|
The name of the Tableau personal access token |
tokenValue - String
|
The value of the Tableau personal access token |
Example
{
"enableCatalog": false,
"host": "xyz789",
"id": CredentialId,
"name": "xyz789",
"site": "xyz789",
"tokenName": "abc123",
"tokenValue": "xyz789"
}
TableauWorkbookCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - WorkbookCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": WorkbookCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
TableauWorksheetCatalogAsset
Fields
| Field Name | Description |
|---|---|
assetType - CatalogAssetType!
|
The type of the catalog asset |
config - TileCatalogAssetConfig!
|
|
createdAt - DateTime!
|
The time the catalog asset was created |
description - String
|
The description of the catalog asset |
descriptions - [CatalogAssetDescription!]!
|
The descriptions of the catalog asset from different origins |
externalTags - [Tag!]!
|
External tags associated with the catalog asset |
id - CatalogAssetId!
|
The unique identifier for the catalog asset |
joinedTables - [CatalogAsset!]!
|
Joined tables related to the catalog asset |
Arguments
|
|
name - String!
|
The name of the catalog asset |
queryUsers - [QueryUserInfo!]!
|
Users who queried the catalog asset |
Arguments
|
|
stats - CatalogAssetStats
|
Statistics about the catalog asset |
tags - [Tag!]!
|
Tags associated with the catalog asset |
updatedAt - DateTime!
|
The time the catalog asset was last updated |
Example
{
"assetType": "BUCKET",
"config": TileCatalogAssetConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"descriptions": [CatalogAssetDescription],
"externalTags": [Tag],
"id": CatalogAssetId,
"joinedTables": [CatalogAsset],
"name": "xyz789",
"queryUsers": [QueryUserInfo],
"stats": CatalogAssetStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
Tag
Description
A tag can be applied on resources within Validio to make searching and filtering easier. It can also be used as conditions for notification rules.
A tag can be either a key-value pair or a label. If the tag is just a label, the key will be set to the string label.
See more information in the docs
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": TagId,
"key": "xyz789",
"origin": "CATALOG_REFRESH",
"updatedAt": "2007-12-03T10:15:30Z",
"value": "abc123"
}
TagAddResult
Description
Result for adding a tag to a resource
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
Example
{"errors": [ApiError]}
TagCreateInput
TagCreateResult
Description
Result for creating a tag
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
tag - Tag
|
The tag created after a successful request |
Example
{"errors": [ApiError], "tag": Tag}
TagDeleteResult
Description
Result for deleting a tag
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{"errors": [ApiError]}
TagId
Description
Tag identifier
Example
TagId
TagNotificationRuleCondition
Fields
| Field Name | Description |
|---|---|
config - TagNotificationRuleConditionConfig!
|
|
createdAt - DateTime!
|
|
id - String!
|
|
notificationRuleId - NotificationRuleId!
|
|
updatedAt - DateTime!
|
Example
{
"config": TagNotificationRuleConditionConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": "xyz789",
"notificationRuleId": NotificationRuleId,
"updatedAt": "2007-12-03T10:15:30Z"
}
TagNotificationRuleConditionConfig
Description
Tag notification rule condition
Fields
| Field Name | Description |
|---|---|
tags - [Tag!]!
|
Example
{"tags": [Tag]}
TagNotificationRuleConditionConfigInput
Description
Input for tag notification condition
Fields
| Input Field | Description |
|---|---|
tagIds - [TagId!]!
|
Tag IDs for the notification rule |
Example
{"tagIds": [TagId]}
TagNotificationRuleConditionCreateInput
Fields
| Input Field | Description |
|---|---|
notificationRuleId - NotificationRuleId
|
|
tags - [TagCreateInput!]!
|
Example
{
"notificationRuleId": NotificationRuleId,
"tags": [TagCreateInput]
}
TagNotificationRuleConditionUpdateInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
tags - [TagCreateInput!]!
|
Example
{
"id": "xyz789",
"tags": [TagCreateInput]
}
TagOrigin
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CATALOG_REFRESH"
TagUpdateInput
TagUpdateResult
Description
Result for updating a tag
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
tag - Tag
|
The tag updated after a successful request |
Example
{"errors": [ApiError], "tag": Tag}
Team
Description
Represents a team in the system, consisting of multiple users with shared responsibilities and access
Fields
| Field Name | Description |
|---|---|
avatar - DataUrl!
|
Full-size avatar image URL for the team |
avatarThumbnail - DataUrl!
|
Thumbnail version of the team's avatar image URL |
createdAt - DateTime!
|
Timestamp when the team was created |
description - String
|
Optional description of the team's purpose or role |
id - TeamId!
|
Unique identifier for the team |
members - [User!]!
|
List of users who are members of this team |
name - String!
|
Name of the team |
updatedAt - DateTime!
|
Timestamp of the last update to the team's information |
Example
{
"avatar": DataUrl,
"avatarThumbnail": DataUrl,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"id": TeamId,
"members": [User],
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
TeamCreateInput
Description
Input for creating a new team
Example
{
"avatar": DataUrl,
"description": "abc123",
"members": ["abc123"],
"name": "xyz789"
}
TeamCreateResult
Description
Represents the result of creating a new team
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
team - Team
|
The newly created team, if successful |
Example
{"errors": [ApiError], "team": Team}
TeamDeleteResult
Description
Represents the result of deleting a team
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{"errors": [ApiError]}
TeamId
Example
TeamId
TeamMembersUpdateInput
Description
Input for updating team members
Fields
| Input Field | Description |
|---|---|
teamId - TeamId!
|
Team ID |
userIds - [UserId!]!
|
List of user IDs to be team members |
Example
{
"teamId": TeamId,
"userIds": [UserId]
}
TeamRole
TeamUpdateInput
TeamUpdateResult
Description
Represents the result of updating an existing team
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the update process |
team - Team
|
The updated team, if successful |
Example
{"errors": [ApiError], "team": Team}
Threshold
Types
| Union Types |
|---|
Example
DifferenceThreshold
ThresholdFilter
Description
A threshold filter filters numeric values in the configured fields by specifying an operator such as equality, greater, less etc. See [ThresholdOperator] for available operators
Fields
| Field Name | Description |
|---|---|
config - ThresholdFilterConfig!
|
Filter variant specific configuration |
createdAt - DateTime!
|
When the filter was created |
id - FilterId!
|
Filter identifier |
name - String!
|
The display name of the filter |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the filter Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the filter |
source - Source!
|
|
updatedAt - DateTime!
|
When the filter was last updated |
Example
{
"config": ThresholdFilterConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": FilterId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
ThresholdFilterConfig
Description
Threshold filter specific configuration
Fields
| Field Name | Description |
|---|---|
field - JsonPointer!
|
The field to filter on |
operator - ComparisonOperator!
|
The operator to use when filtering |
value - Float!
|
The value to use with the operator |
Example
{
"field": JsonPointer,
"operator": "EQUAL",
"value": 123.45
}
ThresholdFilterCreateInput
Description
Input for creating a threshold filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer!
|
The field to filter on |
name - String
|
The display name of the filter |
operator - ComparisonOperator!
|
The operator to use when filtering |
resourceName - String
|
The resource name of the filter |
sourceId - SourceId!
|
Source identifier |
value - Float!
|
The value to use with the operator |
Example
{
"field": JsonPointer,
"name": "xyz789",
"operator": "EQUAL",
"resourceName": "abc123",
"sourceId": SourceId,
"value": 987.65
}
ThresholdFilterUpdateInput
Description
Input for updating a threshold filter
Fields
| Input Field | Description |
|---|---|
field - JsonPointer
|
The field to filter on |
id - FilterId!
|
Filter identifier |
name - String
|
The display name of the filter |
operator - ComparisonOperator
|
The operator to use when filtering |
value - Float
|
The value to use with the operator |
Example
{
"field": JsonPointer,
"id": FilterId,
"name": "xyz789",
"operator": "EQUAL",
"value": 123.45
}
TileCatalogAssetConfig
TimeRangeInput
TumblingWindow
Description
Tumbling windows are a series of fixed-sized, non-overlapping, and contiguous time intervals. For example, hourly or weekly.
Validators with a Tumbling window always follow data time, which means that the time used in graphs and metrics represents the time of the dataset (such as, the time of the data in the warehouse)
Fields
| Field Name | Description |
|---|---|
config - TumblingWindowConfig!
|
|
createdAt - DateTime!
|
When the window was created |
dataTimeField - JsonPointer!
|
Identifier for the index field used to configure the window |
id - WindowId!
|
Window identifier |
name - String!
|
The display name of the window |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the window Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the window |
source - Source!
|
|
updatedAt - DateTime!
|
When the window was last updated |
Example
{
"config": TumblingWindowConfig,
"createdAt": "2007-12-03T10:15:30Z",
"dataTimeField": JsonPointer,
"id": WindowId,
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "abc123",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
TumblingWindowConfig
Fields
| Field Name | Description |
|---|---|
timeUnit - WindowTimeUnit!
|
|
windowSize - Int!
|
|
windowTimeoutDisabled - Boolean!
|
Example
{"timeUnit": "DAY", "windowSize": 123, "windowTimeoutDisabled": false}
TumblingWindowCreateInput
Description
Input for creating a tumbling window
Fields
| Input Field | Description |
|---|---|
dataTimeField - JsonPointer!
|
Identifier for the index field used to configure the window |
name - String
|
The display name of the window |
resourceName - String
|
The resource name of the window |
sourceId - SourceId!
|
Source the window belong to |
timeUnit - WindowTimeUnit!
|
Unit of time to define Window size |
windowSize - Int!
|
Length of the Window in the selected time unit, e.g. 1 |
windowTimeoutDisabled - Boolean
|
Set to True if the window should be automatically closed without considering the most |
Example
{
"dataTimeField": JsonPointer,
"name": "abc123",
"resourceName": "abc123",
"sourceId": SourceId,
"timeUnit": "DAY",
"windowSize": 123,
"windowTimeoutDisabled": true
}
TumblingWindowUpdateInput
TypeNotificationRuleCondition
Fields
| Field Name | Description |
|---|---|
config - TypeNotificationRuleConditionConfig!
|
|
createdAt - DateTime!
|
|
id - String!
|
|
notificationRuleId - NotificationRuleId!
|
|
updatedAt - DateTime!
|
Example
{
"config": TypeNotificationRuleConditionConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": "abc123",
"notificationRuleId": NotificationRuleId,
"updatedAt": "2007-12-03T10:15:30Z"
}
TypeNotificationRuleConditionConfig
Description
Type notification rule condition
Fields
| Field Name | Description |
|---|---|
types - [IssueTypename!]!
|
Notification type names |
Example
{"types": ["GenericSourceError"]}
TypeNotificationRuleConditionConfigInput
Description
Input for notification type condition
Fields
| Input Field | Description |
|---|---|
types - [IssueTypename!]!
|
Notification type names |
Example
{"types": ["GenericSourceError"]}
TypeNotificationRuleConditionCreateInput
Fields
| Input Field | Description |
|---|---|
notificationRuleId - NotificationRuleId
|
|
types - [IssueTypename!]!
|
Example
{
"notificationRuleId": NotificationRuleId,
"types": ["GenericSourceError"]
}
TypeNotificationRuleConditionUpdateInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
types - [IssueTypename!]!
|
Example
{
"id": "abc123",
"types": ["GenericSourceError"]
}
User
Description
Represents a user in the system
Fields
| Field Name | Description |
|---|---|
avatar - DataUrl!
|
URL of the user's avatar |
avatarThumbnail - DataUrl!
|
URL of the user's avatar thumbnail |
createdAt - DateTime!
|
Timestamp when the user was created |
displayName - String!
|
Display name of the user |
email - String
|
Email address of the user |
fullName - String
|
Full name of the user |
globalRole - Role!
|
Global role of the user |
id - UserId!
|
Unique identifier for the user |
identities - [Identity!]!
|
List of identities associated with the user |
lastLoginAt - DateTime
|
Timestamp of the user's last login |
loginType - LoginType!
|
Type of login for the user |
namespaces - [Namespace!]!
|
Namespaces the user has access to |
resourceName - String!
|
Unique resource name for the user |
status - UserStatus!
|
Current status of the user |
teams - [Team!]!
|
Teams the user belongs to |
updatedAt - DateTime!
|
Timestamp when the user was last updated |
Example
{
"avatar": DataUrl,
"avatarThumbnail": DataUrl,
"createdAt": "2007-12-03T10:15:30Z",
"displayName": "xyz789",
"email": "abc123",
"fullName": "abc123",
"globalRole": "ADMIN",
"id": UserId,
"identities": [FederatedIdentity],
"lastLoginAt": "2007-12-03T10:15:30Z",
"loginType": "GUEST",
"namespaces": [Namespace],
"resourceName": "xyz789",
"status": "ACTIVE",
"teams": [Team],
"updatedAt": "2007-12-03T10:15:30Z"
}
UserCreateInput
Description
Input for creating a new user
Fields
| Input Field | Description |
|---|---|
displayName - String!
|
Display name for the new user |
email - String!
|
Email address for the new user |
fullName - String
|
Full name for the new user |
globalRole - Role!
|
Global role for the new user |
loginType - LoginType!
|
Login type for the new user |
password - String
|
Password for the new user |
resourceName - String
|
Resource name for the new user |
status - UserStatus!
|
Initial status for the new user |
username - String
|
Username for the new user |
Example
{
"displayName": "abc123",
"email": "xyz789",
"fullName": "xyz789",
"globalRole": "ADMIN",
"loginType": "GUEST",
"password": "abc123",
"resourceName": "abc123",
"status": "ACTIVE",
"username": "xyz789"
}
UserCreateResult
Description
Result of a user create operation
Fields
| Field Name | Description |
|---|---|
errors - [UserError!]!
|
A list of errors that occurred during the create process |
user - User
|
Newly created user object |
Example
{
"errors": [UserError],
"user": User
}
UserDeleteError
Description
Error that occurred during user deletion
Fields
| Field Name | Description |
|---|---|
code - UserDeleteErrorCode!
|
Error code |
message - String!
|
Error message |
Example
{"code": "UNKNOWN", "message": "abc123"}
UserDeleteErrorCode
Description
Error codes for user delete operations
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNKNOWN"
UserDeleteInput
Description
Input for deleting a user
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the user to delete |
Example
{"id": 4}
UserDeleteResult
Description
Result of a user delete operation
Fields
| Field Name | Description |
|---|---|
errors - [UserDeleteError!]!
|
List of errors that occurred |
user - User
|
Deleted user object |
Example
{
"errors": [UserDeleteError],
"user": User
}
UserError
UserId
Description
Represents a unique identifier for a user
Example
UserId
UserRole
UserStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
UserUpdateError
Description
Error that occurred during user update
Fields
| Field Name | Description |
|---|---|
code - UserUpdateErrorCode!
|
Error code |
message - String!
|
Error message |
Example
{"code": "UNKNOWN", "message": "xyz789"}
UserUpdateErrorCode
Description
Error codes for user update operations
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNKNOWN"
UserUpdateInput
Description
Input for updating an existing user
Example
{
"displayName": "abc123",
"email": "xyz789",
"fullName": "abc123",
"globalRole": "ADMIN",
"id": 4,
"password": "xyz789",
"status": "ACTIVE",
"username": "abc123"
}
UserUpdateResult
Description
Result of a user update operation
Fields
| Field Name | Description |
|---|---|
errors - [UserUpdateError!]!
|
List of errors that occurred |
user - User
|
Updated user object |
Example
{
"errors": [UserUpdateError],
"user": User
}
Validator
Description
A validator computes metrics on one or more datasets depending on the metric type. A validator is the core feature of Validio's data quality feature and produces metrics and potential incidents if the metric value falls outside the configured boundaries
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id of the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"hasCustomName": false,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"resourceName": "xyz789",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
ValidatorCreateResult
Description
Result for creating a validator
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the create process |
validator - Validator
|
The validator created after a successful request |
Example
{
"errors": [ApiError],
"validator": Validator
}
ValidatorId
Description
Validator identifier
Example
ValidatorId
ValidatorMetric
Fields
| Field Name | Description |
|---|---|
deviation - Float!
|
No longer supported |
endTime - DateTime!
|
|
isIncident - Boolean!
|
|
severity - IncidentSeverity
|
|
startTime - DateTime!
|
|
value - Float!
|
Possible Types
| ValidatorMetric Types |
|---|
Example
{
"deviation": 987.65,
"endTime": "2007-12-03T10:15:30Z",
"isIncident": false,
"severity": "HIGH",
"startTime": "2007-12-03T10:15:30Z",
"value": 123.45
}
ValidatorMetricDebugInfo
Description
Information needed to do debugging for a specific metric point, usually in the form of a SQL query to get records for the given period
Fields
| Field Name | Description |
|---|---|
endTime - DateTime!
|
Start time of record sample |
startTime - DateTime!
|
Start time of record sample |
Possible Types
| ValidatorMetricDebugInfo Types |
|---|
Example
{
"endTime": "2007-12-03T10:15:30Z",
"startTime": "2007-12-03T10:15:30Z"
}
ValidatorMetricDebugInfoInput
Description
Input for getting a sample of records related to a metric
Fields
| Input Field | Description |
|---|---|
incidentId - IncidentId!
|
Example
{"incidentId": IncidentId}
ValidatorMetricWithDifferenceThreshold
Example
{
"deviation": 123.45,
"endTime": "2007-12-03T10:15:30Z",
"isIncident": true,
"lowerBound": 123.45,
"severity": "HIGH",
"startTime": "2007-12-03T10:15:30Z",
"upperBound": 987.65,
"value": 123.45
}
ValidatorMetricWithDifferenceThresholdHistory
Fields
| Field Name | Description |
|---|---|
values - [ValidatorMetricWithDifferenceThreshold!]!
|
Example
{"values": [ValidatorMetricWithDifferenceThreshold]}
ValidatorMetricWithDynamicThreshold
Fields
| Field Name | Description |
|---|---|
decisionBoundsType - DecisionBoundsType!
|
|
deviation - Float!
|
|
endTime - DateTime!
|
|
isBurnIn - Boolean!
|
|
isIncident - Boolean!
|
|
lowerBound - Float!
|
|
severity - IncidentSeverity
|
|
startTime - DateTime!
|
|
upperBound - Float!
|
|
value - Float!
|
Example
{
"decisionBoundsType": "LOWER",
"deviation": 987.65,
"endTime": "2007-12-03T10:15:30Z",
"isBurnIn": true,
"isIncident": false,
"lowerBound": 987.65,
"severity": "HIGH",
"startTime": "2007-12-03T10:15:30Z",
"upperBound": 123.45,
"value": 987.65
}
ValidatorMetricWithDynamicThresholdHistory
Fields
| Field Name | Description |
|---|---|
values - [ValidatorMetricWithDynamicThreshold!]!
|
Example
{"values": [ValidatorMetricWithDynamicThreshold]}
ValidatorMetricWithFixedThreshold
Fields
| Field Name | Description |
|---|---|
bound - Float!
|
|
deviation - Float!
|
|
endTime - DateTime!
|
|
isIncident - Boolean!
|
|
operator - ComparisonOperator!
|
|
severity - IncidentSeverity
|
|
startTime - DateTime!
|
|
value - Float!
|
Example
{
"bound": 987.65,
"deviation": 987.65,
"endTime": "2007-12-03T10:15:30Z",
"isIncident": true,
"operator": "EQUAL",
"severity": "HIGH",
"startTime": "2007-12-03T10:15:30Z",
"value": 123.45
}
ValidatorMetricWithFixedThresholdHistory
Fields
| Field Name | Description |
|---|---|
values - [ValidatorMetricWithFixedThreshold!]!
|
Example
{"values": [ValidatorMetricWithFixedThreshold]}
ValidatorMetricWithThresholdHistory
Example
ValidatorMetricWithDifferenceThresholdHistory
ValidatorMuteResult
Description
Result for muting a validator
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the mute operation |
Example
{"errors": [ApiError]}
ValidatorProgress
ValidatorRecommendationApplyInput
Fields
| Input Field | Description |
|---|---|
ids - [RecommendationId!]!
|
|
initializeWithBackfill - Boolean
|
Example
{
"ids": [RecommendationId],
"initializeWithBackfill": true
}
ValidatorRecommendationApplyResult
Fields
| Field Name | Description |
|---|---|
failedIds - [RecommendationId!]!
|
|
successIds - [ID!]!
|
Example
{"failedIds": [RecommendationId], "successIds": [4]}
ValidatorRecommendationDismissInput
Fields
| Input Field | Description |
|---|---|
ids - [RecommendationId!]!
|
Example
{"ids": [RecommendationId]}
ValidatorRecommendationDismissResult
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
recommendationIds - [ID!]!
|
Example
{
"errors": [ApiError],
"recommendationIds": ["4"]
}
ValidatorSchemaConflict
Description
Fields on a validator that failed schema validation after a schema change was detected
Fields
| Field Name | Description |
|---|---|
fields - [JsonPointer!]!
|
Field changes that caused validation to fail |
validator - Validator!
|
Example
{
"fields": [JsonPointer],
"validator": Validator
}
ValidatorSegmentMetricsInput
Fields
| Input Field | Description |
|---|---|
segmentId - SegmentId!
|
|
timeRange - TimeRangeInput!
|
|
validatorId - ValidatorId!
|
Example
{
"segmentId": SegmentId,
"timeRange": TimeRangeInput,
"validatorId": ValidatorId
}
ValidatorState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BACKFILLING"
ValidatorStats
ValidatorUnmuteResult
Description
Result for unmuting a validator
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the unmute operation |
Example
{"errors": [ApiError]}
ValidatorUpdateResult
Description
Result for updating a validator
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
validator - Validator
|
The validator updated after a successful request |
Example
{
"errors": [ApiError],
"validator": Validator
}
ValidatorWithDifferenceThresholdUpdateInput
Description
Input for updating a validator with difference threshold
Fields
| Input Field | Description |
|---|---|
differenceType - DifferenceType
|
Absolute or percentage change |
numberOfWindows - Int
|
Number of consecutive windows for which the threshold event must happen before an incident is created |
operator - DifferenceOperator
|
Operator determining type of change |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
validatorId - ValidatorId!
|
Validator identifier |
value - Float
|
Numeric value. For absolute, the value is in the scale of the metric. For percentage, the value is the percentage points |
Example
{
"differenceType": "ABSOLUTE",
"numberOfWindows": 123,
"operator": "DECREASING",
"tagIds": [TagId],
"validatorId": ValidatorId,
"value": 987.65
}
ValidatorWithDynamicThresholdUpdateInput
Description
Input for updating a validator with dynamic threshold
Fields
| Input Field | Description |
|---|---|
decisionBoundsType - DecisionBoundsType
|
The decision bound type on the dynamic threshold specifies whether the boundaries for anomaly detection are double or single-sided |
sensitivity - Float!
|
Sensitivity defines the accepted range of values for the dynamic threshold |
validatorId - ValidatorId!
|
Validator identifier |
Example
{
"decisionBoundsType": "LOWER",
"sensitivity": 123.45,
"validatorId": ValidatorId
}
ValidatorWithFixedThresholdUpdateInput
Description
Input for updating a validator with fixed threshold
Fields
| Input Field | Description |
|---|---|
operator - ComparisonOperator!
|
Operator to compare two numeric values |
validatorId - ValidatorId!
|
Validator identifier |
value - Float!
|
The value to compare against |
Example
{
"operator": "EQUAL",
"validatorId": ValidatorId,
"value": 123.45
}
ValidatorWithThresholdUpdateResult
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
validator - Validator
|
Example
{
"errors": [ApiError],
"validator": Validator
}
ValidatorsDeleteResult
Description
Result for deleting a validator
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{"errors": [ApiError]}
VolumeMetric
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COUNT"
VolumeValidator
Fields
| Field Name | Description |
|---|---|
config - VolumeValidatorConfig!
|
|
createdAt - DateTime!
|
When the validator was created |
description - String
|
|
hasCustomName - Boolean!
|
Not available anymore. |
id - ValidatorId!
|
Validator identifier |
incidents - [Incident!]!
|
|
Arguments
|
|
metricValueFormat - MetricValueFormat!
|
|
name - String!
|
The display name of the validator |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the validator Use 'namespace.id' instead |
progress - ValidatorProgress
|
|
resourceName - String!
|
The resource name of the validator |
sourceConfig - SourceConfig!
|
Source configuration |
state - ValidatorState!
|
|
stateUpdatedAt - DateTime!
|
|
stats - ValidatorStats!
|
|
tags - [Tag!]!
|
|
updatedAt - DateTime!
|
When the validator was last updated |
Example
{
"config": VolumeValidatorConfig,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"hasCustomName": true,
"id": ValidatorId,
"incidents": [Incident],
"metricValueFormat": "NUMBER",
"name": "abc123",
"namespace": Namespace,
"namespaceId": NamespaceId,
"progress": ValidatorProgress,
"resourceName": "xyz789",
"sourceConfig": SourceConfig,
"state": "BACKFILLING",
"stateUpdatedAt": "2007-12-03T10:15:30Z",
"stats": ValidatorStats,
"tags": [Tag],
"updatedAt": "2007-12-03T10:15:30Z"
}
VolumeValidatorConfig
Fields
| Field Name | Description |
|---|---|
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - VolumeMetric!
|
Metric to use for validation |
sourceField - JsonPointer
|
Deprecated |
sourceFields - [JsonPointer!]!
|
Fields to apply validator on. For Count and Percentage the list can be empty which is the equivalent of COUNT(*) |
threshold - Threshold!
|
The threshold used to determine if the result is an incident or not |
Example
{
"initializeWithBackfill": false,
"metric": "COUNT",
"sourceField": JsonPointer,
"sourceFields": [JsonPointer],
"threshold": DifferenceThreshold
}
VolumeValidatorCreateInput
Description
Input for creating a volume validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
initializeWithBackfill - Boolean!
|
If the validator should be backfilled when created |
metric - VolumeMetric!
|
Metric to use for validation |
name - String
|
The display name of the validator |
resourceName - String
|
The resource name of the validator |
sourceConfig - SourceConfigCreateInput!
|
Source configuration |
sourceField - JsonPointer
|
Deprecated |
sourceFields - [JsonPointer!]!
|
Fields to apply validator on. For Count and Percentage the list can be empty which is the equivalent of COUNT(*) |
tagIds - [TagId!]
|
Tag IDs for the validator |
Example
{
"description": "abc123",
"initializeWithBackfill": false,
"metric": "COUNT",
"name": "xyz789",
"resourceName": "xyz789",
"sourceConfig": SourceConfigCreateInput,
"sourceField": JsonPointer,
"sourceFields": [JsonPointer],
"tagIds": [TagId]
}
VolumeValidatorUpdateInput
Description
Input for updating a volume validator
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the validator. Maximum length for this field is 1024 characters |
id - ValidatorId!
|
Validator identifier |
name - String
|
The display name of the validator |
sourceConfig - SourceConfigUpdateInput
|
Source configuration |
tagIds - [TagId!]
|
Tag IDs for the validator. All tag IDs specified here will replace all currently associated tag IDs with the validator |
Example
{
"description": "abc123",
"id": ValidatorId,
"name": "abc123",
"sourceConfig": SourceConfigUpdateInput,
"tagIds": [TagId]
}
WebhookChannel
Description
A webhook channel is a channel that will post a JSON payload to a webhook URL
Fields
| Field Name | Description |
|---|---|
config - WebhookChannelConfig!
|
Webhook specific configuration for the channel |
createdAt - DateTime!
|
When the channel was created |
id - ChannelId!
|
Channel identifier |
name - String!
|
The display name of the channel |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id for the channel Use 'namespace.id' instead |
notificationRules - [NotificationRule!]!
|
|
resourceName - String!
|
The resource name of the channel |
updatedAt - DateTime!
|
When the channel was last updated |
Example
{
"config": WebhookChannelConfig,
"createdAt": "2007-12-03T10:15:30Z",
"id": ChannelId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"notificationRules": [NotificationRule],
"resourceName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
WebhookChannelConfig
Description
Configuration for a webhook channel. A webhook is an arbitrary endpoint to which a JSON payload will be sent if used as a channel
Example
{
"applicationLinkUrl": "abc123",
"authHeader": "xyz789",
"webhookUrl": "xyz789"
}
WebhookChannelCreateInput
Description
Input for creating a webhook channel
Fields
| Input Field | Description |
|---|---|
applicationLinkUrl - String!
|
URL to the Validio application |
authHeader - String
|
Value to put in Authorization header |
name - String!
|
The display name of the channel |
namespaceId - NamespaceId!
|
The namespace id for the channel |
resourceName - String
|
The resource name of the channel |
webhookUrl - String!
|
The webhook URL to where the message should be posted |
Example
{
"applicationLinkUrl": "xyz789",
"authHeader": "abc123",
"name": "xyz789",
"namespaceId": NamespaceId,
"resourceName": "abc123",
"webhookUrl": "xyz789"
}
WebhookChannelSecretChangedInput
Description
Input for checking if Webhook channel secrets changed
Fields
| Input Field | Description |
|---|---|
authHeader - String
|
Value to put in Authorization header |
id - ChannelId!
|
Channel identifier |
Example
{
"authHeader": "xyz789",
"id": ChannelId
}
WebhookChannelSecretChangedResult
Description
Result for checking if Webhook channel secrets changed
Fields
| Field Name | Description |
|---|---|
authHeader - Boolean!
|
True if the stored auth header is different from the value in the request |
errors - [ApiError!]!
|
Example
{"authHeader": false, "errors": [ApiError]}
WebhookChannelUpdateInput
Description
Input for updating a webhook channel
Fields
| Input Field | Description |
|---|---|
applicationLinkUrl - String!
|
URL to the Validio application |
authHeader - String
|
Value to put in Authorization header |
id - ChannelId!
|
Channel identifier |
name - String
|
The display name of the channel |
webhookUrl - String!
|
The webhook URL to where the message should be posted |
Example
{
"applicationLinkUrl": "abc123",
"authHeader": "xyz789",
"id": ChannelId,
"name": "abc123",
"webhookUrl": "xyz789"
}
Window
Description
You must configure at least one Window on your source to create Validators. You can create several Windows on the same Source, according to your business requirements.
For example, for an aggregate calculation you must define a Window and what datapoints to include to validate the mean, max, or min.
Depending on your Source type, you can configure the following Window types: Fixed Batch, Global, Tumbling, or File.
See the documentation for more details
Fields
| Field Name | Description |
|---|---|
createdAt - DateTime!
|
When the window was created |
id - WindowId!
|
Window identifier |
name - String!
|
The display name of the window |
namespace - Namespace!
|
|
namespaceId - NamespaceId!
|
The namespace id of the window Use 'namespace.id' instead |
resourceName - String!
|
The resource name of the window |
source - Source!
|
|
updatedAt - DateTime!
|
When the window was updated |
Possible Types
| Window Types |
|---|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": WindowId,
"name": "xyz789",
"namespace": Namespace,
"namespaceId": NamespaceId,
"resourceName": "xyz789",
"source": Source,
"updatedAt": "2007-12-03T10:15:30Z"
}
WindowCreateResult
Description
Result for creating a window
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
window - Window
|
The window created after a successful request |
Example
{
"errors": [ApiError],
"window": Window
}
WindowId
Description
Window identifier
Example
WindowId
WindowSchemaConflict
Description
Fields on a window that failed schema validation after a schema change was detected
Fields
| Field Name | Description |
|---|---|
fields - [JsonPointer!]!
|
Fields changed that caused validation to fail |
window - Window!
|
Example
{
"fields": [JsonPointer],
"window": Window
}
WindowTimeUnit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAY"
WindowUpdateResult
Description
Result for updating a window
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
|
window - Window
|
The window updated after a successful request |
Example
{
"errors": [ApiError],
"window": Window
}
WindowsDeleteResult
Description
Result for deleting a window
Fields
| Field Name | Description |
|---|---|
errors - [ApiError!]!
|
A list of errors that occurred during the delete process |
Example
{"errors": [ApiError]}
WorkbookCatalogAssetConfig
Fields
| Field Name | Description |
|---|---|
credentialId - CredentialId!
|
No longer supported |
title - String
|
|
workbookId - String!
|
Example
{
"credentialId": CredentialId,
"title": "abc123",
"workbookId": "abc123"
}