DQ Report API

The DQ Report API allows you to generate and manage reports.

List the total number of DQ Jobs per user

get

Returns a list of the total number of DQ Jobs per user.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestring · date-timeOptional

Start Date

endDatestring · date-timeOptional

End Date

limitinteger · int32Optional

Limit the number of records to return

Responses

200

User Total Jobs

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/userTotalJobs

HTTPcURLJavaScriptPython

GET /v3/reports/views/userTotalJobs HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

User Total Jobs

{
  "schema": {
    "jobs": "long",
    "username": "string"
  },
  "data": [
    {
      "jobs": 10,
      "username": "user1"
    },
    {
      "jobs": 20,
      "username": "user2"
    }
  ]
}

List the total number of rules per user

get

Returns a list of the total number of rules per user.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestring · date-timeOptional

Start Date

endDatestring · date-timeOptional

End Date

limitinteger · int32Optional

Limit the number of records to return

Responses

200

User Rules

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/userRules

HTTPcURLJavaScriptPython

GET /v3/reports/views/userRules HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

User Rules

{
  "schema": {
    "rules": "long",
    "username": "string"
  },
  "data": [
    {
      "rules": 10,
      "username": "user1"
    },
    {
      "rules": 20,
      "username": "user2"
    }
  ]
}

List the total number of DQ Jobs run per user and day

get

Returns a list of the total number of DQ Jobs run per user and day.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestring · date-timeOptional

Start Date

endDatestring · date-timeOptional

End Date

limitinteger · int32Optional

Limit the number of records to return

Responses

200

User Daily Jobs

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/userDailyJobs

HTTPcURLJavaScriptPython

GET /v3/reports/views/userDailyJobs HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

User Daily Jobs

{
  "schema": {
    "jobs": "long",
    "updtTsStr": "string",
    "username": "string"
  },
  "data": [
    {
      "jobs": 10,
      "updtTsStr": "2022-10-12 00:00:00",
      "username": "user1"
    },
    {
      "jobs": 20,
      "updtTsStr": "2022-10-12 00:00:00",
      "username": "user2"
    }
  ]
}

List the total number of clicks per user

get

Returns a list of the total number of clicks in the application per user.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestring · date-timeOptional

Start Date

endDatestring · date-timeOptional

End Date

limitinteger · int32Optional

Limit the number of records to return

Responses

200

User Click Activity

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/userClickActivity

HTTPcURLJavaScriptPython

GET /v3/reports/views/userClickActivity HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

User Click Activity

{
  "schema": {
    "userClicks": "long",
    "username": "string"
  },
  "data": [
    {
      "userClicks": 10,
      "username": "user1"
    },
    {
      "userClicks": 20,
      "username": "user2"
    }
  ]
}

Return the percentage of passing rows by dimension

get

Returns the average percentage of rows passing divided by the total number of rows scanned, aggregated by dimension.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Rules Passing Report

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/rulespassing

HTTPcURLJavaScriptPython

GET /v3/reports/views/rulespassing HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Rules Passing Report

{
  "schema": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "data": [
    {}
  ]
}

List the DQ Jobs with oversized hardware requirements

get

Returns a list of DQ Jobs with more hardware than is available to run.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Highest Hardware Usage Jobs Report

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/oversizedJobs

HTTPcURLJavaScriptPython

GET /v3/reports/views/oversizedJobs HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Highest Hardware Usage Jobs Report

{
  "schema": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "data": [
    {}
  ]
}

Return the average scores of all adaptive rules

get

Returns the average scores of all adaptive rules, aggregated by check type and dimension.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Observability Report

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/observability

HTTPcURLJavaScriptPython

GET /v3/reports/views/observability HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Observability Report

{
  "schema": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "data": [
    {}
  ]
}

List the DQ Jobs that unexpectedly did not run

get

Returns a list of DQ Jobs that did not run when a run was expected.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Missing Jobs Report

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/missingJobs

HTTPcURLJavaScriptPython

GET /v3/reports/views/missingJobs HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Missing Jobs Report

{
  "schema": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "data": [
    {}
  ]
}

List by date the number of DQ Jobs that unexpectedly did not run

get

Returns a list of the number of DQ Jobs that did not run when a run was expected, aggregated by date.

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Missing Jobs Report Chart

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/missingJobsChart

HTTPcURLJavaScriptPython

GET /v3/reports/views/missingJobsChart HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Missing Jobs Report Chart

{
  "schema": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "data": [
    {}
  ]
}

List the DQ Jobs with the highest hardware requirements

get

Returns a list of of DQ Jobs with the highest hardware requirements

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Highest Hardware Usage Jobs Report

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/highestHardwareUsage

HTTPcURLJavaScriptPython

GET /v3/reports/views/highestHardwareUsage HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Highest Hardware Usage Jobs Report

{
  "schema": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "data": [
    {}
  ]
}

List the row count by dataset

get

Returns a list of row counts by dataset

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestring · date-timeOptional

Start Date

endDatestring · date-timeOptional

End Date

limitinteger · int32Optional

Limit the number of records to return

Responses

200

Row count by dataset

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/datasetRowCount

HTTPcURLJavaScriptPython

GET /v3/reports/views/datasetRowCount HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Row count by dataset

{
  "schema": {
    "rowCount": "long",
    "dataset": "string"
  },
  "data": [
    {
      "rowCount": 10,
      "dataset": "nyse1"
    },
    {
      "rowCount": 20,
      "dataset": "nyse2"
    }
  ]
}

Return a list of alert recipients and the total number of alerts designated to send to them when triggered

get

Returns a list of alert recipients and the number of all possible alerts designated to send to them when triggered

Authorizations

bearer-jwt

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · int32Optional

Limit the number of records to return

Responses

200

Alert counts

application/json

Report Data Transfer Object containing schema and data

dataobject[]Optional

get/v3/reports/views/alertReport

HTTPcURLJavaScriptPython

GET /v3/reports/views/alertReport HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Alert counts

{
  "schema": {
    "alerts": "long",
    "alertFormatValue": "string"
  },
  "data": [
    {
      "alerts": 10,
      "alertFormatValue": "[e-mail]"
    },
    {
      "alerts": 20,
      "alertFormatValue": "[e-mail],[e-mail]"
    }
  ]
}