Monitors¶

23 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List custom monitors¶

GET/api/v1/monitors/

API key permissionMonitor: Read-onlymonitor:read

Returns the custom monitors in the API key's workspace family tree.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
name__icontainsstring
severitystring
workspace_idarray of string · uuid
pageinteger
Default 1 · Min 1
page_sizeinteger
Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedMonitorSummarySchema

itemsarray of objectrequired
Items · MonitorSummarySchema
- idstring · uuidrequired
- namestringrequired
- severitystringrequired
  One of error warning
- workspaceobjectrequired
  Attributes · WorkspaceMinimalSchema
  - idstring · uuidrequired
  - namestringrequired
countintegerrequired

Create a custom monitor¶

POST/api/v1/monitors/

API key permissionMonitor: Writemonitor:write

Creates the monitor in workspace_id, which must be the API key's workspace or one below it. A datastream id the key cannot see, or one outside the monitor's workspace family, fails the request with 400 and nothing is created. A name already in use returns 409.

Request bodyrequired

application/json

Body schema

object MonitorCreateSchema

namestringrequired
Max length 200
workspace_idstring · uuidrequired
severitystringrequired
One of error warning
datastream_idsarray of string · uuid
has_target_columnsboolean
Default false
blocksarray of objectrequired
Items · BlocksSchema
- keystring · uuidrequired
- conditionone ofrequired
  Attributes
  - OuterLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
  - OuterLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
- representationstringnullable
  Attributes
  - RuleRepresentationType
  - null

Responses

201Createdapplication/json

Response schema

object MonitorDetailSchema

idstring · uuidrequired
namestringrequired
severitystringrequired
One of error warning
workspaceobjectrequired
Attributes · WorkspaceMinimalSchema
- idstring · uuidrequired
- namestringrequired
datastream_idsarray of string · uuidrequired
has_target_columnsbooleanrequired
blocksarray of objectrequired
Items · BlocksSchema
- keystring · uuidrequired
- conditionone ofrequired
  Attributes
  - OuterLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
  - OuterLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
- representationstringnullable
  Attributes
  - RuleRepresentationType
  - null

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/v1/monitors/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "severity": "error",
    "datastream_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "has_target_columns": false,
    "blocks": [
      {
        "key": "00000000-0000-0000-0000-000000000000",
        "condition": {
          "key": "00000000-0000-0000-0000-000000000000",
          "operation": "string",
          "conditions": [
            {}
          ]
        },
        "representation": "date-format"
      }
    ]
  }'

Response201

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "severity": "error",
  "workspace": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "datastream_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "has_target_columns": true,
  "blocks": [
    {
      "key": "00000000-0000-0000-0000-000000000000",
      "condition": {
        "key": "00000000-0000-0000-0000-000000000000",
        "operation": "string",
        "conditions": [
          {}
        ]
      },
      "representation": "date-format"
    }
  ]
}

Delete custom monitors¶

DELETE/api/v1/monitors/

API key permissionMonitor: Writemonitor:write

Deletes the monitors listed in the body. The request is all-or-nothing: if one id is unknown or not visible to the API key, it fails with 400 and nothing is deleted.

Request bodyrequired

application/json

Body schema

array of string · uuid UUIDListSchema

Responses

204No Content

List columns common to the given datastreams¶

GET/api/v1/monitors/columns/

API key permissionMonitor: Read-onlymonitor:read

Returns the name and effective type of every column present in all the given datastreams that the API key can see. The effective type of a column mapped to a schema column is the schema column's type. A rule's column_type must be the effective type returned here, because validation checks the operator only against the declared column_type. A datastream id that is unknown or not visible to the API key has no columns, so the list is empty.

Query parameters

datastream_idarray of string · uuidrequired

Responses

200OKapplication/json

Response schema

array of object

namestringrequired
typestringrequired
One of boolean currency date datetime duration float formula json long percentage string timestamp
type_idintegerrequired
One of 6 9 4 5 11 3 10 8 2 7 1 13

Bulk assign monitors to datastreams¶

POST/api/v1/monitors/datastreams/

API key permissionMonitor: Writemonitor:write

Assigns the monitors in the body to the datastreams the filters select, where the datastream is in the monitor's workspace family. Without a datastream filter, every datastream the API key can see is selected. The response lists the datastreams that were assigned and those that were skipped.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
datastream_idarray of string · uuid
workspace_idarray of string · uuid
enabledboolean
active_pulling_modestring
scheduled_deletionboolean
tagarray of string
Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.
tag_matchstring
any: carries at least one of the given tags. all: carries every one.
One of any all · Default "any"

Request bodyrequired

application/json

Body schema

array of string · uuid UUIDListSchema

Responses

200OKapplication/json

Response schema

object BulkMonitorAssignmentResponseSchema

assigned_datastream_idsarray of string · uuidrequired
skipped_datastream_idsarray of string · uuidrequired

Bulk unassign monitors from datastreams¶

DELETE/api/v1/monitors/datastreams/

API key permissionMonitor: Writemonitor:write

Removes the given monitors from the datastreams the filters select.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
datastream_idarray of string · uuid
workspace_idarray of string · uuid
enabledboolean
active_pulling_modestring
scheduled_deletionboolean
tagarray of string
Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.
tag_matchstring
any: carries at least one of the given tags. all: carries every one.
One of any all · Default "any"

Request bodyrequired

application/json

Body schema

array of string · uuid UUIDListSchema

Responses

200OKapplication/json

Response schema

array of string · uuid UUIDListSchema

Discover monitors available for bulk datastream assignment¶

OPTIONS/api/v1/monitors/datastreams/

API key permissionMonitor: Read-onlymonitor:read

Without filters, returns all accessible monitors. With datastream filters (e.g. ?datastream_id=), returns only monitors whose workspace family covers all matched datastreams.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
datastream_idarray of string · uuid
workspace_idarray of string · uuid
enabledboolean
active_pulling_modestring
scheduled_deletionboolean
tagarray of string
Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.
tag_matchstring
any: carries at least one of the given tags. all: carries every one.
One of any all · Default "any"
pageinteger
Default 1 · Min 1
page_sizeinteger
Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedMonitorSummarySchema

itemsarray of objectrequired
Items · MonitorSummarySchema
- idstring · uuidrequired
- namestringrequired
- severitystringrequired
  One of error warning
- workspaceobjectrequired
  Attributes · WorkspaceMinimalSchema
  - idstring · uuidrequired
  - namestringrequired
countintegerrequired

List rule operators per column type¶

GET/api/v1/monitors/operators/

API key permissionMonitor: Read-onlymonitor:read

Returns the operators a rule may use for each column type. A rule's operation must be one of the operators listed for its column_type.

Responses

200OKapplication/json

Response schema

array of object

column_typeintegerrequired
One of 6 9 4 5 11 3 10 8 2 7 1 13
column_type_namestringrequired
One of boolean currency date datetime duration float formula json long percentage string timestamp
operatorsarray of objectrequired
Items · OperatorSchema
- valueintegerrequired
- labelstringrequired

List schema columns mapped by all the given datastreams¶

GET/api/v1/monitors/target-columns/

API key permissionMonitor: Read-onlymonitor:read

Returns the schema columns that every given datastream, as visible to the API key, maps. A rule's column_type must be the effective type returned here, because validation checks the operator only against the declared column_type. A datastream id that is unknown or not visible to the API key maps no columns, so the list is empty.

Query parameters

datastream_idarray of string · uuidrequired

Responses

200OKapplication/json

Response schema

array of object

idstring · uuidrequired
namestringrequired
typestringrequired
One of boolean currency date datetime duration float formula json long percentage string timestamp
type_idintegerrequired
One of 6 9 4 5 11 3 10 8 2 7 1 13
usagestringrequired
One of dimension metric

List the universal monitors of a datastream¶

GET/api/v1/monitors/universal/datastreams/{datastream_id}/

API key permissionMonitor: Read-onlymonitor:read

Returns the four universal monitors of the datastream in a fixed order: row-duplicates, volumes, timeliness, schema_consistency. Monitors missing for the datastream are created from the workspace defaults first. Responds with 404 when the datastream is unknown, not visible to the API key, or pending deletion.

Path parameters

datastream_idstring · uuidrequired

Responses

200OKapplication/json

Response schema

array of one of

RowDuplicatesMonitorSchema
- enabledbooleanrequired
- severitystringrequired
  One of error warning
- typestringrequired
- type_configobjectrequired
  Attributes · RowDuplicatesConfig
  - modestring
    One of include exclude key_columns · Default "include"
  - columnsarray of stringnullable
    Attributes
    array of string
    null
VolumesMonitorSchema
- enabledbooleanrequired
- severitystringrequired
  One of error warning
- typestringrequired
- type_configobjectrequired
TimelinessMonitorSchema
- enabledbooleanrequired
- severitystringrequired
  One of error warning
- typestringrequired
- type_configobjectrequired
  Attributes · TimelinessConfig
  - expected_deliveryobjectnullable
    Attributes
    ExpectedDeliverySchema
    timestring · timerequired
    Expected delivery time of the day in UTC
    offsetintegerrequired
    Offset in days
    null
SchemaConsistencyMonitorSchema
- enabledbooleanrequired
- severitystringrequired
  One of error warning
- typestringrequired
- type_configobjectrequired
  Attributes · SchemaConsistencyConfig
  - auto_restore_enabledboolean
    Default false
  - column_order_check_enabledboolean
    Default false

Update one universal monitor of a datastream¶

PATCH/api/v1/monitors/universal/datastreams/{datastream_id}/

API key permissionMonitor: Writemonitor:write

The body's type selects the monitor. Omitted fields stay unchanged and an explicit null returns 422. A given type_config replaces the stored configuration as a whole. A timeliness type_config requires expected_delivery, and the severity of a timeliness monitor can only be warning. Monitors missing for the datastream are created first. Responds with 404 when the datastream is unknown, not visible to the API key, or pending deletion.

Path parameters

datastream_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

one of UniversalMonitorPatchSchema

RowDuplicatesMonitorPatch
- enabledboolean
- severitystring
  One of error warning
- typestringrequired
- type_configobject
  Attributes · RowDuplicatesConfigInput
  - modestring
    One of include exclude key_columns · Default "include"
  - columnsarray of stringnullable
    Attributes
    array of string
    null
VolumesMonitorPatch
- enabledboolean
- severitystring
  One of error warning
- typestringrequired
TimelinessMonitorPatch
- enabledboolean
- severitystring
- typestringrequired
- type_configobject
  Attributes · TimelinessConfigInput
  - expected_deliveryobjectrequired
    Attributes · ExpectedDeliveryInput
    timestring · timerequired
    Expected delivery time of the day in UTC
    offsetintegerrequired
    Offset in days
SchemaConsistencyMonitorPatch
- enabledboolean
- severitystring
  One of error warning
- typestringrequired
- type_configobject
  Attributes · SchemaConsistencyConfigInput
  - auto_restore_enabledbooleanrequired
  - column_order_check_enabledbooleanrequired

Responses

200OKapplication/json

Response schema

one of

RowDuplicatesMonitorSchema
- enabledbooleanrequired
- severitystringrequired
  One of error warning
- typestringrequired
- type_configobjectrequired
  Attributes · RowDuplicatesConfig
  - modestring
    One of include exclude key_columns · Default "include"
  - columnsarray of stringnullable
    Attributes
    array of string
    null
VolumesMonitorSchema
- enabledbooleanrequired
- severitystringrequired
  One of error warning
- typestringrequired
- type_configobjectrequired
TimelinessMonitorSchema
- enabledbooleanrequired
- severitystringrequired
  One of error warning
- typestringrequired
- type_configobjectrequired
  Attributes · TimelinessConfig
  - expected_deliveryobjectnullable
    Attributes
    ExpectedDeliverySchema
    timestring · timerequired
    Expected delivery time of the day in UTC
    offsetintegerrequired
    Offset in days
    null
SchemaConsistencyMonitorSchema
- enabledbooleanrequired
- severitystringrequired
  One of error warning
- typestringrequired
- type_configobjectrequired
  Attributes · SchemaConsistencyConfig
  - auto_restore_enabledboolean
    Default false
  - column_order_check_enabledboolean
    Default false

Get the baseline schema of a datastream¶

GET/api/v1/monitors/universal/datastreams/{datastream_id}/baseline-schema/

API key permissionMonitor: Read-onlymonitor:read

Responds with 404 when the datastream has no baseline schema, is unknown, not visible to the API key, or pending deletion. extract_id is null when the baseline was saved without an extract (through the API or the web app), when that extract was deleted, or when it has no uuid.

Path parameters

datastream_idstring · uuidrequired

Responses

200OKapplication/json

Response schema

object BaselineSchemaSchema

schema_columnsarray of stringrequired
extract_idstring · uuidrequirednullable
The uuid of the extract the baseline was taken from. It is null when the baseline was saved without an extract (through the API or the web app), when that extract was deleted, or when it has no uuid.
Attributes
- string · uuid
- null
updatedstring · date-timerequired
updated_bystringrequirednullable
Attributes
- string
- null

Create or replace the baseline schema of a datastream¶

PUT/api/v1/monitors/universal/datastreams/{datastream_id}/baseline-schema/

API key permissionMonitor: Writemonitor:write

The body is the list of column names, at most 5000; a longer list returns 422. A baseline saved through the API is not linked to an extract, so extract_id is null. Responds with 404 when the datastream is unknown, not visible to the API key, or pending deletion.

Path parameters

datastream_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

array of string BaselineColumnsSchema

Responses

200OKapplication/json

Response schema

object BaselineSchemaSchema

schema_columnsarray of stringrequired
extract_idstring · uuidrequirednullable
The uuid of the extract the baseline was taken from. It is null when the baseline was saved without an extract (through the API or the web app), when that extract was deleted, or when it has no uuid.
Attributes
- string · uuid
- null
updatedstring · date-timerequired
updated_bystringrequirednullable
Attributes
- string
- null

Preview the difference between the baseline schema and a list of columns¶

POST/api/v1/monitors/universal/datastreams/{datastream_id}/baseline-schema/preview/

API key permissionMonitor: Read-onlymonitor:read

Nothing is saved. The body holds at most 5000 column names, as many as a baseline schema may hold; a longer list returns 422. Responds with 404 when the datastream has no baseline schema, is unknown, not visible to the API key, or pending deletion.

Path parameters

datastream_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

array of string BaselineColumnsPreviewSchema

Responses

200OKapplication/json

Response schema

array of object

opstringrequired
One of equal add remove
valuestringrequired

List the universal monitors of one type across workspaces¶

GET/api/v1/monitors/universal/{monitor_type}/

API key permissionMonitor: Read-onlymonitor:read

Returns the monitors of the given type for the datastreams the filters select, in a stable order by datastream creation. Datastreams pending deletion are left out. monitor_enabled and severity filter the monitors; enabled and the other filters select datastreams. A datastream without a row of this type is not listed: reading creates nothing.

Path parameters

monitor_typestringrequired
One of row-duplicates volumes timeliness schema_consistency

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
datastream_idarray of string · uuid
workspace_idarray of string · uuid
enabledboolean
active_pulling_modestring
scheduled_deletionboolean
tagarray of string
Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.
tag_matchstring
any: carries at least one of the given tags. all: carries every one.
One of any all · Default "any"
monitor_enabledboolean
severitystring
pageinteger
Default 1 · Min 1
page_sizeinteger
Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedUniversalMonitorListItemSchema

itemsarray of one ofrequired
Items
- RowDuplicatesMonitorListItemSchema
  - enabledbooleanrequired
  - severitystringrequired
    One of error warning
  - typestringrequired
  - type_configobjectrequired
    Attributes · RowDuplicatesConfig
    modestring
    One of include exclude key_columns · Default "include"
    columnsarray of stringnullable
    Attributes
    array of string
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- VolumesMonitorListItemSchema
  - enabledbooleanrequired
  - severitystringrequired
    One of error warning
  - typestringrequired
  - type_configobjectrequired
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- TimelinessMonitorListItemSchema
  - enabledbooleanrequired
  - severitystringrequired
    One of error warning
  - typestringrequired
  - type_configobjectrequired
    Attributes · TimelinessConfig
    expected_deliveryobjectnullable
    Attributes
    ExpectedDeliverySchema
    timestring · timerequired
    Expected delivery time of the day in UTC
    offsetintegerrequired
    Offset in days
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- SchemaConsistencyMonitorListItemSchema
  - enabledbooleanrequired
  - severitystringrequired
    One of error warning
  - typestringrequired
  - type_configobjectrequired
    Attributes · SchemaConsistencyConfig
    auto_restore_enabledboolean
    Default false
    column_order_check_enabledboolean
    Default false
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
countintegerrequired

Bulk update the universal monitors of one type¶

PATCH/api/v1/monitors/universal/{monitor_type}/

API key permissionMonitor: Writemonitor:write

Sets enabled and/or severity on the monitors that GET on the same path returns for the same query. At least one datastream filter such as workspace_id is required. The body accepts enabled and severity only, stricter than the web app: any type_config returns 422. A timeliness monitor's severity is always warning. Responds with the datastreams whose monitor changed, so a repeat changes nothing and returns an empty list.

Path parameters

monitor_typestringrequired
One of row-duplicates volumes timeliness schema_consistency

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
datastream_idarray of string · uuid
workspace_idarray of string · uuid
enabledboolean
active_pulling_modestring
scheduled_deletionboolean
tagarray of string
Tag name, ignoring case, matched in every workspace the key can see: the same name in two workspaces is two tags, and this matches both. Combine with workspace_id to match the tag of one workspace. Repeatable.
tag_matchstring
any: carries at least one of the given tags. all: carries every one.
One of any all · Default "any"
monitor_enabledboolean
severitystring

Request bodyrequired

application/json

Body schema

object UniversalMonitorBulkPatchSchema

enabledboolean
severitystring
One of error warning

Responses

200OKapplication/json

Response schema

object BulkActionResponseSchema

affectedobjectrequired
Attributes · AffectedDatastreamsSchema
- datastream_idsarray of string · uuidrequired

Get a custom monitor¶

GET/api/v1/monitors/{monitor_id}/

API key permissionMonitor: Read-onlymonitor:read

Returns the monitor with its rule blocks. datastream_ids lists only the assigned datastreams the API key can see. An unknown monitor, or one the API key cannot see, returns 404.

Path parameters

monitor_idstring · uuidrequired

Responses

200OKapplication/json

Response schema

object MonitorDetailSchema

idstring · uuidrequired
namestringrequired
severitystringrequired
One of error warning
workspaceobjectrequired
Attributes · WorkspaceMinimalSchema
- idstring · uuidrequired
- namestringrequired
datastream_idsarray of string · uuidrequired
has_target_columnsbooleanrequired
blocksarray of objectrequired
Items · BlocksSchema
- keystring · uuidrequired
- conditionone ofrequired
  Attributes
  - OuterLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
  - OuterLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
- representationstringnullable
  Attributes
  - RuleRepresentationType
  - null

Update a custom monitor¶

PATCH/api/v1/monitors/{monitor_id}/

API key permissionMonitor: Writemonitor:write

Changes only the fields in the body: an omitted field stays unchanged and an explicit null returns 422. datastream_ids replaces the assignments the API key can see; assignments it cannot see stay. Changing workspace_id without datastream_ids keeps the existing assignments, and returns 400 when one the API key can see lies outside the new workspace's family. A datastream id the key cannot see, or one outside the monitor's workspace family, fails the request with 400 and nothing changes. A name already in use returns 409. An unknown monitor, or one the API key cannot see, returns 404.

Path parameters

monitor_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

object MonitorPatchSchema

namestring
Max length 200
workspace_idstring · uuid
severitystring
One of error warning
datastream_idsarray of string · uuid
has_target_columnsboolean
blocksarray of object
Items · BlocksSchema
- keystring · uuidrequired
- conditionone ofrequired
  Attributes
  - OuterLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
  - OuterLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
- representationstringnullable
  Attributes
  - RuleRepresentationType
  - null

Responses

200OKapplication/json

Response schema

object MonitorDetailSchema

idstring · uuidrequired
namestringrequired
severitystringrequired
One of error warning
workspaceobjectrequired
Attributes · WorkspaceMinimalSchema
- idstring · uuidrequired
- namestringrequired
datastream_idsarray of string · uuidrequired
has_target_columnsbooleanrequired
blocksarray of objectrequired
Items · BlocksSchema
- keystring · uuidrequired
- conditionone ofrequired
  Attributes
  - OuterLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
  - OuterLogicalDisjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · InnerLogicalConjunctionSchema
    keystring · uuidrequired
    operationstringrequired
    conditionsarray of objectrequired
    Items · ConditionalExpressionSchema
    keystring · uuidrequired
    columnstringrequired
    columnTypeintegerrequired
    One of 6 9 4 5 13 3 2 7 1
    operationintegerrequired
    One of 1 2 3 4 5 6 7 8 10 11 12 13 14 15 16 17 18 19 20 21 22
    valueone ofrequired
    Attributes
    integer
    number
    string
    string · date
    string · date-time
    caseSensitiveboolean
    Default false
- representationstringnullable
  Attributes
  - RuleRepresentationType
  - null

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/v1/monitors/{monitor_id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "severity": "error",
    "datastream_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "has_target_columns": true,
    "blocks": [
      {
        "key": "00000000-0000-0000-0000-000000000000",
        "condition": {
          "key": "00000000-0000-0000-0000-000000000000",
          "operation": "string",
          "conditions": [
            {}
          ]
        },
        "representation": "date-format"
      }
    ]
  }'

Response200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "severity": "error",
  "workspace": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "datastream_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "has_target_columns": true,
  "blocks": [
    {
      "key": "00000000-0000-0000-0000-000000000000",
      "condition": {
        "key": "00000000-0000-0000-0000-000000000000",
        "operation": "string",
        "conditions": [
          {}
        ]
      },
      "representation": "date-format"
    }
  ]
}

Delete a custom monitor¶

DELETE/api/v1/monitors/{monitor_id}/

API key permissionMonitor: Writemonitor:write

Deletes the monitor. Returns 404 when it is unknown or not visible to the API key.

Path parameters

monitor_idstring · uuidrequired

Responses

204No Content

List datastreams assigned to a monitor¶

GET/api/v1/monitors/{monitor_id}/datastreams/

API key permissionMonitor: Read-onlymonitor:read

Returns the datastreams assigned to the monitor that the API key can see. An unknown monitor, or one the API key cannot see, returns 404.

Path parameters

monitor_idstring · uuidrequired

Query parameters

pageinteger
Default 1 · Min 1
page_sizeinteger
Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedDatastreamSummarySchema

itemsarray of objectrequired
Items · DatastreamSummarySchema
- idstring · uuidrequired
- namestringrequired
- workspaceobjectrequired
  Attributes · WorkspaceMinimalSchema
  - idstring · uuidrequired
  - namestringrequired
countintegerrequired

Extend current list of assignments with the given datastreams¶

POST/api/v1/monitors/{monitor_id}/datastreams/

API key permissionMonitor: Writemonitor:write

Adds the datastreams to the monitor's assignments. A datastream id the key cannot see, or one outside the monitor's workspace family, fails the request with 400 and nothing is assigned. An unknown monitor, or one the API key cannot see, returns 404.

Path parameters

monitor_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

array of string · uuid UUIDListSchema

Responses

200OKapplication/json

Response schema

array of string · uuid UUIDListSchema

Unassign datastreams from a monitor¶

DELETE/api/v1/monitors/{monitor_id}/datastreams/

API key permissionMonitor: Writemonitor:write

Removes the datastreams from the monitor's assignments. A datastream id the key cannot see fails the request with 400 and nothing is removed. An unknown monitor, or one the API key cannot see, returns 404.

Path parameters

monitor_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

array of string · uuid UUIDListSchema

Responses

200OKapplication/json

Response schema

array of string · uuid UUIDListSchema

Discover datastreams assignable to a monitor¶

OPTIONS/api/v1/monitors/{monitor_id}/datastreams/

API key permissionMonitor: Read-onlymonitor:read

Returns the datastreams in the monitor's workspace family that the API key can see and that are not assigned yet. An unknown monitor, or one the API key cannot see, returns 404.

Path parameters

monitor_idstring · uuidrequired

Query parameters

pageinteger
Default 1 · Min 1
page_sizeinteger
Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedDatastreamSummarySchema

itemsarray of objectrequired
Items · DatastreamSummarySchema
- idstring · uuidrequired
- namestringrequired
- workspaceobjectrequired
  Attributes · WorkspaceMinimalSchema
  - idstring · uuidrequired
  - namestringrequired
countintegerrequired