For the complete documentation index, see llms.txt. This page is also available as Markdown.

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
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
200

User Total Jobs

List the total number of rules per user

get

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

Authorizations
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
200

User Rules

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
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
200

User Daily Jobs

List the total number of clicks per user

get

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

Authorizations
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
200

User Click Activity

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
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
200

Rules Passing Report

List the DQ Jobs with oversized hardware requirements

get

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

Authorizations
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
200

Highest Hardware Usage Jobs Report

Return the average scores of all adaptive rules

get

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

Authorizations
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
200

Observability Report

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
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
200

Missing Jobs Report

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
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
200

Missing Jobs Report Chart

List the DQ Jobs with the highest hardware requirements

get

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

Authorizations
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
200

Highest Hardware Usage Jobs Report

List the row count by dataset

get

Returns a list of row counts by dataset

Authorizations
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
200

Row count by dataset

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
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
200

Alert counts

Last updated

Was this helpful?