Monitors

37 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 monitor issues

GET/api/v1/monitors/issues/

API key permissionMonitor: Read-onlymonitor:read

Returns what the monitors found, newest extraction first. Each item's type names the monitor type and selects the type-specific fields. The issue id is the id of the extraction log that recorded the issue. Without workspace_scope every issue the API key can see is included: those of its workspace and the workspaces below it, without workspaces scheduled for deletion. workspace_scope=descendants&scope_from_workspace_id=<id> selects the issues of one workspace and the workspaces below it, as the web app's issue page does. date_from and date_to compare the day the extraction started (UTC), both inclusive; date_from after date_to returns 400.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
datastream_idarray of string · uuid
monitor_idarray of string · uuid
Custom monitor ids.
typestring
severitystring
is_acknowledgedboolean
date_fromstring · date
Issues whose extraction started on this day or later (UTC).
date_tostring · date
Issues whose extraction started on this day or earlier (UTC).
pageinteger
Default 1 · Min 1
page_sizeinteger
Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedMonitorIssueSchema

itemsarray of one ofrequired
Items
- ValuesIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - detailed_typestringrequired
    One of missing-field rule-violated
- RowDuplicatesIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
- VolumesIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - anomaly_typestringrequired
    One of spike drop_to_zero drop
  - deviationnumberrequired
  - row_countintegerrequired
- TimelinessIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - expected_deliveryobjectrequired
    Attributes · IssueExpectedDeliverySchema
    timestring · timerequired
    The expected delivery time of the day (UTC).
    offsetintegernullable
    The offset in days.
    Attributes
    integer
    null
  - scheduleobjectrequired
    Attributes · Schedule
    delta_typestringrequired
    Defines the scheduling interval.
    One of day week month quarter year once
    multiplierintegernullable
    Multiplier for the interval (e.g., every 2 weeks).
    Attributes
    integer
    null
    startstring · timerequired
    The start time of the schedule (HH:MM:SS).
  - causestringrequired
    One of stopped_by_error task_not_finished
  - schedule_typestringrequired
    One of smart bundle custom
  - smart_scheduleobjectnullable
    The Smart Schedule range that fired, for Smart Schedule issues. Null for other schedule types and for issues recorded before it was kept.
    Attributes
    SmartScheduleSnapshot
    frequencyobjectrequired
    How often a range is (re-)pulled, e.g. {value: 40, unit: day}.
    Attributes · Frequency
    valueintegerrequired
    Min 1
    unitstringrequired
    One of day week month quarter year
    onobjectnullable
    Attributes
    On
    dayintegerrequired
    Min 1 · Max 28
    day_typestringrequired
    One of week month
    null
    window_labelstringrequired
    Look-back window label, e.g. 'Last 7 Days'.
    start_timestring · timenullable
    Earliest fetch start (UTC). Null means no start bound.
    Attributes
    string · time
    null
    deadline_timestring · timenullable
    Delivery deadline (UTC). Null means as soon as possible.
    Attributes
    string · time
    null
    null
- SchemaConsistencyIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - issue_typesarray of stringrequired
  - auto_restoredbooleanrequired
countintegerrequired

Acknowledge monitor issues

POST/api/v1/monitors/issues/acknowledge/

API key permissionMonitor: Writemonitor:write

Acknowledges the selected issues. issue_ids in the body names issues; the workspace_scope and scope_from_workspace_id query parameters limit the selection as on the list, and without issue_ids select every issue there. At least one of issue_ids and workspace_scope is required, otherwise 400. Responds with the issues that changed: ids the API key cannot see, ids that are not issues and issues already acknowledged are left out, so a repeat returns an empty list. A selection that would change more than 1000 issues returns 400 and changes nothing; narrow it. Issues in workspaces scheduled for deletion are never changed.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.

Request bodyrequired

application/json

Body schema

object IssueAcknowledgeSchema

issue_idsarray of integernullable
Issue ids to act on.
Attributes
- array of integer
- null

Responses

200OKapplication/json

Response schema

object IssueBulkActionResponseSchema

affectedobjectrequired
Attributes · AffectedIssuesSchema
- issue_idsarray of integerrequired

Count issues per day

GET/api/v1/monitors/issues/analytics/daily/

API key permissionMonitor: Read-onlymonitor:read

Returns, for each day between date_from and date_to (both inclusive) that has issues, how many are unacknowledged errors and warnings and how many are acknowledged, newest day first. severity and is_acknowledged choose which of the three counts are added up; the others are 0. The range may span at most 366 days, and date_from after date_to returns 400. Without workspace_scope every issue the API key can see is included: those of its workspace and the workspaces below it, without workspaces scheduled for deletion. workspace_scope=descendants&scope_from_workspace_id=<id> selects the issues of one workspace and the workspaces below it, as the web app's issue page does.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
date_fromstring · daterequired
date_tostring · daterequired
datastream_idarray of string · uuid
monitor_idarray of string · uuid
Custom monitor ids.
typestring
severitystring
is_acknowledgedboolean

Responses

200OKapplication/json

Response schema

array of object

datestring · daterequired
errorsintegerrequired
Unacknowledged issues of severity error.
warningsintegerrequired
Unacknowledged issues of severity warning.
acknowledgedintegerrequired

List the datastreams with the most issues

GET/api/v1/monitors/issues/analytics/top-datastreams/

API key permissionMonitor: Read-onlymonitor:read

Returns the monitored datastreams with unacknowledged issues of the given type, the most issues first, at most limit of them. Without workspace_scope every issue the API key can see is included: those of its workspace and the workspaces below it, without workspaces scheduled for deletion. workspace_scope=descendants&scope_from_workspace_id=<id> selects the issues of one workspace and the workspaces below it, as the web app's issue page does.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
typestringrequired
One of row-duplicates values volumes timeliness schema_consistency
limitinteger
Default 5 · Min 1 · Max 30

Responses

200OKapplication/json

Response schema

array of object

datastreamobjectrequired
Attributes · IssueDatastreamRefSchema
- idstring · uuidrequired
- namestringrequired
errorsintegerrequired
Unacknowledged issues of severity error.
warningsintegerrequired
Unacknowledged issues of severity warning.

Compare datastreams with and without issues

GET/api/v1/monitors/issues/analytics/totals/

API key permissionMonitor: Read-onlymonitor:read

Counts the monitored datastreams with and without unacknowledged issues of the given type, and those issues. A datastream counts as monitored when an enabled universal monitor of that type, or an assigned custom monitor, watches it; datastreams pending deletion do not count. is_active is false when no datastream is monitored. Without workspace_scope every issue the API key can see is included: those of its workspace and the workspaces below it, without workspaces scheduled for deletion. workspace_scope=descendants&scope_from_workspace_id=<id> selects the issues of one workspace and the workspaces below it, as the web app's issue page does.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.
typestringrequired
One of row-duplicates values volumes timeliness schema_consistency

Responses

200OKapplication/json

Response schema

object IssueTotalsSchema

datastreams_with_issuesintegerrequired
Monitored datastreams with at least one unacknowledged issue.
datastreams_without_issuesintegerrequired
Monitored datastreams without unacknowledged issues.
issuesintegerrequired
Unacknowledged issues, all time.
issues_yesterdayintegerrequired
Unacknowledged issues up to the end of yesterday (UTC).
is_activebooleanrequired
Whether any datastream in reach is watched by a monitor of this type.

List the issues of an extract

GET/api/v1/monitors/issues/extracts/{extract_id}/

API key permissionMonitor: Read-onlymonitor:read

Returns the issues found on the extract, and on copies of the same source extract that the API key can see. Responds with 404 when the extract is unknown, not visible to the API key, or hidden.

Path parameters

extract_idintegerrequired

Query parameters

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

Responses

200OKapplication/json

Response schema

object PagedMonitorIssueSchema

itemsarray of one ofrequired
Items
- ValuesIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - detailed_typestringrequired
    One of missing-field rule-violated
- RowDuplicatesIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
- VolumesIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - anomaly_typestringrequired
    One of spike drop_to_zero drop
  - deviationnumberrequired
  - row_countintegerrequired
- TimelinessIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - expected_deliveryobjectrequired
    Attributes · IssueExpectedDeliverySchema
    timestring · timerequired
    The expected delivery time of the day (UTC).
    offsetintegernullable
    The offset in days.
    Attributes
    integer
    null
  - scheduleobjectrequired
    Attributes · Schedule
    delta_typestringrequired
    Defines the scheduling interval.
    One of day week month quarter year once
    multiplierintegernullable
    Multiplier for the interval (e.g., every 2 weeks).
    Attributes
    integer
    null
    startstring · timerequired
    The start time of the schedule (HH:MM:SS).
  - causestringrequired
    One of stopped_by_error task_not_finished
  - schedule_typestringrequired
    One of smart bundle custom
  - smart_scheduleobjectnullable
    The Smart Schedule range that fired, for Smart Schedule issues. Null for other schedule types and for issues recorded before it was kept.
    Attributes
    SmartScheduleSnapshot
    frequencyobjectrequired
    How often a range is (re-)pulled, e.g. {value: 40, unit: day}.
    Attributes · Frequency
    valueintegerrequired
    Min 1
    unitstringrequired
    One of day week month quarter year
    onobjectnullable
    Attributes
    On
    dayintegerrequired
    Min 1 · Max 28
    day_typestringrequired
    One of week month
    null
    window_labelstringrequired
    Look-back window label, e.g. 'Last 7 Days'.
    start_timestring · timenullable
    Earliest fetch start (UTC). Null means no start bound.
    Attributes
    string · time
    null
    deadline_timestring · timenullable
    Delivery deadline (UTC). Null means as soon as possible.
    Attributes
    string · time
    null
    null
- SchemaConsistencyIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - issue_typesarray of stringrequired
  - auto_restoredbooleanrequired
countintegerrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/monitors/issues/extracts/{extract_id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "id": 1,
      "severity": "error",
      "start": "2024-01-01T00:00:00Z",
      "is_acknowledged": true,
      "expected": true,
      "violations": 1,
      "message": "string",
      "data_source": "string",
      "job_group_id": 1,
      "datastream": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "workspace": {
          "id": null,
          "name": null
        }
      },
      "monitor": {
        "id": null,
        "name": null
      },
      "extract_id": 1,
      "type": "string",
      "detailed_type": "missing-field"
    }
  ],
  "count": 1
}

List the issues of a job group

GET/api/v1/monitors/issues/job-groups/{job_group_id}/

API key permissionMonitor: Read-onlymonitor:read

Returns the issues raised by the fetch of one job group that the API key can see. An unknown job group, or one the key cannot see, has no issues.

Path parameters

job_group_idintegerrequired

Query parameters

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

Responses

200OKapplication/json

Response schema

object PagedMonitorIssueSchema

itemsarray of one ofrequired
Items
- ValuesIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - detailed_typestringrequired
    One of missing-field rule-violated
- RowDuplicatesIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
- VolumesIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - anomaly_typestringrequired
    One of spike drop_to_zero drop
  - deviationnumberrequired
  - row_countintegerrequired
- TimelinessIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - expected_deliveryobjectrequired
    Attributes · IssueExpectedDeliverySchema
    timestring · timerequired
    The expected delivery time of the day (UTC).
    offsetintegernullable
    The offset in days.
    Attributes
    integer
    null
  - scheduleobjectrequired
    Attributes · Schedule
    delta_typestringrequired
    Defines the scheduling interval.
    One of day week month quarter year once
    multiplierintegernullable
    Multiplier for the interval (e.g., every 2 weeks).
    Attributes
    integer
    null
    startstring · timerequired
    The start time of the schedule (HH:MM:SS).
  - causestringrequired
    One of stopped_by_error task_not_finished
  - schedule_typestringrequired
    One of smart bundle custom
  - smart_scheduleobjectnullable
    The Smart Schedule range that fired, for Smart Schedule issues. Null for other schedule types and for issues recorded before it was kept.
    Attributes
    SmartScheduleSnapshot
    frequencyobjectrequired
    How often a range is (re-)pulled, e.g. {value: 40, unit: day}.
    Attributes · Frequency
    valueintegerrequired
    Min 1
    unitstringrequired
    One of day week month quarter year
    onobjectnullable
    Attributes
    On
    dayintegerrequired
    Min 1 · Max 28
    day_typestringrequired
    One of week month
    null
    window_labelstringrequired
    Look-back window label, e.g. 'Last 7 Days'.
    start_timestring · timenullable
    Earliest fetch start (UTC). Null means no start bound.
    Attributes
    string · time
    null
    deadline_timestring · timenullable
    Delivery deadline (UTC). Null means as soon as possible.
    Attributes
    string · time
    null
    null
- SchemaConsistencyIssueSchema
  - idintegerrequired
    The issue id: the id of the extraction log that recorded the issue.
  - severitystringrequired
    One of error warning
  - startstring · date-timerequired
    When the extraction that raised the issue started.
  - is_acknowledgedbooleanrequired
  - expectedbooleanrequirednullable
    Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
    Attributes
    boolean
    null
  - violationsintegerrequired
  - messagestringrequired
  - data_sourcestringrequired
    The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
  - job_group_idintegerrequirednullable
    The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
    Attributes
    integer
    null
  - datastreamobjectrequired
    Attributes · DatastreamSummarySchema
    idstring · uuidrequired
    namestringrequired
    workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
  - monitorobjectrequirednullable
    The custom monitor that raised the issue; null for universal monitors.
    Attributes
    IssueMonitorSchema
    idstring · uuidrequired
    namestringrequired
    null
  - extract_idintegerrequirednullable
    The extract the issue was found on; null when it was deleted.
    Attributes
    integer
    null
  - typestringrequired
  - issue_typesarray of stringrequired
  - auto_restoredbooleanrequired
countintegerrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/monitors/issues/job-groups/{job_group_id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "id": 1,
      "severity": "error",
      "start": "2024-01-01T00:00:00Z",
      "is_acknowledged": true,
      "expected": true,
      "violations": 1,
      "message": "string",
      "data_source": "string",
      "job_group_id": 1,
      "datastream": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "workspace": {
          "id": null,
          "name": null
        }
      },
      "monitor": {
        "id": null,
        "name": null
      },
      "extract_id": 1,
      "type": "string",
      "detailed_type": "missing-field"
    }
  ],
  "count": 1
}

Acknowledge the issues of a job group

POST/api/v1/monitors/issues/job-groups/{job_group_id}/acknowledge/

API key permissionMonitor: Writemonitor:write

Acknowledges the issues of the job group that the API key can see: those in issue_ids, or all of them without it, except exclude_issue_ids. Responds with the issues that changed, so a repeat returns an empty list. A job group with more than 1000 issues to change returns 400; name them with issue_ids.

Path parameters

job_group_idintegerrequired

Request bodyrequired

application/json

Body schema

object JobGroupIssueAcknowledgeSchema

issue_idsarray of integernullable
Issue ids to act on.
Attributes
- array of integer
- null
exclude_issue_idsarray of integer
Issue ids to leave out.

Responses

200OKapplication/json

Response schema

object IssueBulkActionResponseSchema

affectedobjectrequired
Attributes · AffectedIssuesSchema
- issue_idsarray of integerrequired

Reopen the acknowledged issues of a job group

POST/api/v1/monitors/issues/job-groups/{job_group_id}/unacknowledge/

API key permissionMonitor: Writemonitor:write

The counterpart of POST /monitors/issues/job-groups/{job_group_id}/acknowledge/, with the same body.

Path parameters

job_group_idintegerrequired

Request bodyrequired

application/json

Body schema

object JobGroupIssueAcknowledgeSchema

issue_idsarray of integernullable
Issue ids to act on.
Attributes
- array of integer
- null
exclude_issue_idsarray of integer
Issue ids to leave out.

Responses

200OKapplication/json

Response schema

object IssueBulkActionResponseSchema

affectedobjectrequired
Attributes · AffectedIssuesSchema
- issue_idsarray of integerrequired

Reopen acknowledged monitor issues

POST/api/v1/monitors/issues/unacknowledge/

API key permissionMonitor: Writemonitor:write

The counterpart of POST /monitors/issues/acknowledge/, with the same body, query parameters and limit: reopens the selected acknowledged issues and responds with those that changed.

Query parameters

workspace_scopestring
scope_from_workspace_idstring · uuid
Required only for workspace_scope when multiple roots exist.

Request bodyrequired

application/json

Body schema

object IssueAcknowledgeSchema

issue_idsarray of integernullable
Issue ids to act on.
Attributes
- array of integer
- null

Responses

200OKapplication/json

Response schema

object IssueBulkActionResponseSchema

affectedobjectrequired
Attributes · AffectedIssuesSchema
- issue_idsarray of integerrequired

Get a monitor issue

GET/api/v1/monitors/issues/{issue_id}/

API key permissionMonitor: Read-onlymonitor:read

Returns the issue with the details of its type. Values and row duplicates issues summarise the violations the issue recorded; the violating rows themselves are not returned. Responds with 404 when the issue is unknown or not visible to the API key.

Path parameters

issue_idintegerrequired

Responses

200OKapplication/json

Response schema

one of

ValuesIssueDetailSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
- detailed_typestringrequired
  One of missing-field rule-violated
- namesarray of stringnullable
  The fields missing from the extract, for a missing-field issue.
  Attributes
  - array of string
  - null
- rule_violationsarray of objectnullable
  One summary per violated rule block, for a rule-violated issue.
  Attributes
  - array of object
  - null
RowDuplicatesIssueDetailSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
- columnsarray of stringnullable
  The columns the monitor compared, as configured when it ran.
  Attributes
  - array of string
  - null
- columns_modestringnullable
  Attributes
  - string
  - null
- duplicated_rowsintegerrequired
  How many distinct duplicated rows were recorded, up to the row limit.
- rows_truncatedbooleanrequired
- columns_truncatedbooleanrequired
VolumesIssueDetailSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
- anomaly_typestringrequired
  One of spike drop_to_zero drop
- deviationnumberrequired
- row_countintegerrequired
- datapointsarray of objectrequired
  The row counts the anomaly was found in, at most 50.
  Items · VolumesDatapointSchema
  - fetch_range_startstring · date-timerequired
  - fetch_range_endstring · date-timerequired
  - time_range_presetobjectnullable
    Attributes
    RelativeDateRange
    unitstringrequired
    One of day week month year quarter
    valueintegerrequired
    null
  - volumeintegerrequired
  - sourceobjectrequired
    Attributes · OutlierDetectionSource
    job_group_idintegerrequired
  - lower_boundnumberrequired
  - upper_boundnumberrequired
  - is_outlierbooleanrequired
TimelinessIssueDetailSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
- expected_deliveryobjectrequired
  Attributes · IssueExpectedDeliverySchema
  - timestring · timerequired
    The expected delivery time of the day (UTC).
  - offsetintegernullable
    The offset in days.
    Attributes
    integer
    null
- scheduleobjectrequired
  Attributes · Schedule
  - delta_typestringrequired
    Defines the scheduling interval.
    One of day week month quarter year once
  - multiplierintegernullable
    Multiplier for the interval (e.g., every 2 weeks).
    Attributes
    integer
    null
  - startstring · timerequired
    The start time of the schedule (HH:MM:SS).
- causestringrequired
  One of stopped_by_error task_not_finished
- schedule_typestringrequired
  One of smart bundle custom
- smart_scheduleobjectnullable
  The Smart Schedule range that fired, for Smart Schedule issues. Null for other schedule types and for issues recorded before it was kept.
  Attributes
  - SmartScheduleSnapshot
    - frequencyobjectrequired
      How often a range is (re-)pulled, e.g. {value: 40, unit: day}.
      Attributes · Frequency
      valueintegerrequired
      Min 1
      unitstringrequired
      One of day week month quarter year
    - onobjectnullable
      Attributes
      On
      dayintegerrequired
      Min 1 · Max 28
      day_typestringrequired
      One of week month
      null
    - window_labelstringrequired
      Look-back window label, e.g. 'Last 7 Days'.
    - start_timestring · timenullable
      Earliest fetch start (UTC). Null means no start bound.
      Attributes
      string · time
      null
    - deadline_timestring · timenullable
      Delivery deadline (UTC). Null means as soon as possible.
      Attributes
      string · time
      null
  - null
- extraction_log_messagestringnullable
  The message of the extraction log that made the fetch late, as plain text; null when there is none or the API key cannot see it.
  Attributes
  - string
  - null
- due_datestring · date-timerequired
SchemaConsistencyIssueDetailSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
- issue_typesarray of stringrequired
- auto_restoredbooleanrequired
- extract_schemaarray of stringrequired
- baseline_schemaarray of stringrequired
- diffarray of objectrequired
  Items · DiffOperation
  - opstringrequired
    One of equal add remove
  - valuestringrequired
- issue_types_countobjectrequired
  Attributes · SchemaConsistencyIssueTypesCount
  - missing_columnsintegerrequired
  - new_columnsintegerrequired
  - order_mismatchintegerrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/monitors/issues/{issue_id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "severity": "error",
  "start": "2024-01-01T00:00:00Z",
  "is_acknowledged": true,
  "expected": true,
  "violations": 1,
  "message": "string",
  "data_source": "string",
  "job_group_id": 1,
  "datastream": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "workspace": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  },
  "monitor": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "extract_id": 1,
  "type": "string",
  "detailed_type": "missing-field",
  "names": [
    "string"
  ],
  "rule_violations": [
    {
      "rule_key": "00000000-0000-0000-0000-000000000000",
      "violations": 1,
      "distinct_rows": 1,
      "rows_truncated": true,
      "columns_truncated": true,
      "has_target_columns": true
    }
  ]
}

Accept a schema consistency issue's schema into the baseline

POST/api/v1/monitors/issues/{issue_id}/apply-schema/

API key permissionMonitor: Writemonitor:write

Makes the extract schema the issue recorded the baseline schema of its datastream, acknowledges the issue and returns the new baseline. Responds with 404 when the issue is unknown or not visible to the API key, when it is a visible issue of another type than schema_consistency, or when the datastream has no baseline schema, and with 400 when the issue recorded no extract schema.

Path parameters

issue_idintegerrequired

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

Mark whether a monitor issue was expected

PUT/api/v1/monitors/issues/{issue_id}/expected/

API key permissionMonitor: Writemonitor:write

Records whether the issue was expected to occur. Only issues of universal monitors record it: a custom monitor's (values) issue returns 400. Responds with 404 when the issue is unknown or not visible to the API key.

Path parameters

issue_idintegerrequired

Request bodyrequired

application/json

Body schema

object IssueExpectedSchema

expectedbooleanrequired
Whether the issue was expected to occur.

Responses

200OKapplication/json

Response schema

one of

ValuesIssueSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
- detailed_typestringrequired
  One of missing-field rule-violated
RowDuplicatesIssueSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
VolumesIssueSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
- anomaly_typestringrequired
  One of spike drop_to_zero drop
- deviationnumberrequired
- row_countintegerrequired
TimelinessIssueSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
- expected_deliveryobjectrequired
  Attributes · IssueExpectedDeliverySchema
  - timestring · timerequired
    The expected delivery time of the day (UTC).
  - offsetintegernullable
    The offset in days.
    Attributes
    integer
    null
- scheduleobjectrequired
  Attributes · Schedule
  - delta_typestringrequired
    Defines the scheduling interval.
    One of day week month quarter year once
  - multiplierintegernullable
    Multiplier for the interval (e.g., every 2 weeks).
    Attributes
    integer
    null
  - startstring · timerequired
    The start time of the schedule (HH:MM:SS).
- causestringrequired
  One of stopped_by_error task_not_finished
- schedule_typestringrequired
  One of smart bundle custom
- smart_scheduleobjectnullable
  The Smart Schedule range that fired, for Smart Schedule issues. Null for other schedule types and for issues recorded before it was kept.
  Attributes
  - SmartScheduleSnapshot
    - frequencyobjectrequired
      How often a range is (re-)pulled, e.g. {value: 40, unit: day}.
      Attributes · Frequency
      valueintegerrequired
      Min 1
      unitstringrequired
      One of day week month quarter year
    - onobjectnullable
      Attributes
      On
      dayintegerrequired
      Min 1 · Max 28
      day_typestringrequired
      One of week month
      null
    - window_labelstringrequired
      Look-back window label, e.g. 'Last 7 Days'.
    - start_timestring · timenullable
      Earliest fetch start (UTC). Null means no start bound.
      Attributes
      string · time
      null
    - deadline_timestring · timenullable
      Delivery deadline (UTC). Null means as soon as possible.
      Attributes
      string · time
      null
  - null
SchemaConsistencyIssueSchema
- idintegerrequired
  The issue id: the id of the extraction log that recorded the issue.
- severitystringrequired
  One of error warning
- startstring · date-timerequired
  When the extraction that raised the issue started.
- is_acknowledgedbooleanrequired
- expectedbooleanrequirednullable
  Whether a reader marked the issue as expected; null until someone answers. Only issues of universal monitors carry it.
  Attributes
  - boolean
  - null
- violationsintegerrequired
- messagestringrequired
- data_sourcestringrequired
  The display label of the datastream's connector, as the web app shows it. A label, not an identifier: it may change and is not unique.
- job_group_idintegerrequirednullable
  The job group whose fetch raised the issue; null when the issue is not tied to one. The job group routes select issues by the job of their extraction log, so a timeliness issue recorded without a fetch job is not listed there.
  Attributes
  - integer
  - null
- datastreamobjectrequired
  Attributes · DatastreamSummarySchema
  - idstring · uuidrequired
  - namestringrequired
  - workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema
    idstring · uuidrequired
    namestringrequired
- monitorobjectrequirednullable
  The custom monitor that raised the issue; null for universal monitors.
  Attributes
  - IssueMonitorSchema
    - idstring · uuidrequired
    - namestringrequired
  - null
- extract_idintegerrequirednullable
  The extract the issue was found on; null when it was deleted.
  Attributes
  - integer
  - null
- typestringrequired
- issue_typesarray of stringrequired
- auto_restoredbooleanrequired

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/v1/monitors/issues/{issue_id}/expected/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "expected": true
  }'

Response200

{
  "id": 1,
  "severity": "error",
  "start": "2024-01-01T00:00:00Z",
  "is_acknowledged": true,
  "expected": true,
  "violations": 1,
  "message": "string",
  "data_source": "string",
  "job_group_id": 1,
  "datastream": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "workspace": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  },
  "monitor": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "extract_id": 1,
  "type": "string",
  "detailed_type": "missing-field"
}

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

Preview custom monitor rules on an extract

POST/api/v1/monitors/preview/

API key permissionsMonitor: Read-onlymonitor:readDatastream: Read-onlydatastream:read

Checks the rule blocks on the first rows of an extract the API key can see and returns, per block, the indices of the rows that violate it. Nothing is saved, so the blocks need not belong to a monitor. limit bounds the rows checked, and at most 50 blocks are accepted. Because the answer reveals row values, the key needs both monitor:read and datastream:read. A value table condition must name, by its id, a value table the API key can see; otherwise the request returns 400. Responds with 404 when the extract is unknown, not visible to the API key or hidden, or when its data is no longer stored. Requests are limited to 20/m per key issuer (429 above it).

Request bodyrequired

application/json

Body schema

object MonitorPreviewSchema

extract_idintegerrequired
The extract whose rows the rules are checked on.
has_target_columnsboolean
Whether the rules name target (schema) columns instead of source ones.
Default false
limitinteger
How many rows of the extract to check.
Default 100 · Min 1 · Max 1000
blocksarray of objectrequired
The rule blocks to check.
Items · RuleBlockSchema
- 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

array of object

keystring · uuidrequired
The key of the rule block.
violated_rowsarray of integerrequired
The 0-based indices of the checked rows that violate the block.

429Too Many Requestsapplication/json

Response schema

object ThrottlingError

detailstringrequired

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