Data Health
Endpoints for Data Health
ReferenceView as Markdown
Stay in the loop 🚀
Endpoints for Data Health
GET/api/v1/data-health/scans
Authentication: Bearer token (JWT)
pagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderBystringOptional"createdAt"Allowed values: "createdAt", "id", "updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"itemsarray of HealthScanSummaryDtoRequired10 fieldsitemsidnumberRequired when parent is presentField path: items[].idcurlcurl https://api.subrite.no/api/v1/data-health/scans \
--header 'Authorization: Bearer <token>'POST/api/v1/data-health/scans
Authentication: Bearer token (JWT)
workflowIdstringRequiredGET/api/v1/data-health/scans/{scanId}
Authentication: Bearer token (JWT)
scanIdnumberRequiredGET/api/v1/data-health/scans/{scanId}/checks/{checkKey}
Authentication: Bearer token (JWT)
scanIdnumberRequiredcheckKeystringRequiredpagenumberOptional1minimum: 1takenumberOptional10minimum: GET/api/v1/data-health/scans/{scanId}/checks/{checkKey}/records/{issueId}
Authentication: Bearer token (JWT)
scanIdnumberRequiredcheckKeystringRequiredissueIdnumberRequiredstatusstringRequired when parent is present"running", "completed", "failed"triggeredBystringRequired when parent is presentField path: items[].triggeredBy"schedule", "manual"startedAtstring (date-time)Required when parent is presentField path: items[].startedAtfinishedAtstring (date-time)Required when parent is presentField path: items[].finishedAtdurationMsnumberRequired when parent is presentField path: items[].durationMsrecordsScannednumberRequired when parent is presentField path: items[].recordsScannedissuesFoundnumberRequired when parent is presentField path: items[].issuesFoundchecksTotalnumberRequired when parent is presentField path: items[].checksTotalchecksFailingnumberRequired when parent is presentField path: items[].checksFailingmetaPageMetaRequired6 fieldsmetapagenumberRequiredField path: meta.pagetakenumberRequiredField path: meta.takecountnumberRequiredField path: meta.countpageCountnumberRequiredField path: meta.pageCounthasPreviousPagebooleanRequiredField path: meta.hasPreviousPagehasNextPagebooleanRequiredField path: meta.hasNextPage{
"items": [
{}
],
"meta": {
"page": 0,
"take": 0,
"count": 0,
"pageCount": 0,
"hasPreviousPage": true,
"hasNextPage": true
}
}unauthorized
This response has no body.
forbiddenResource
messageCodestringRequiredmessagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}{
"workflowId": "string"
}unauthorized
This response has no body.
forbiddenResource
Same fields as List health scans for the tenant (paginated) (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/data-health/scans \
--request POST \
--header 'Authorization: Bearer <token>'idnumberRequiredstatusstringRequired"running", "completed", "failed"triggeredBystringRequired"schedule", "manual"startedAtstring (date-time)RequiredfinishedAtstring (date-time)RequireddurationMsnumberRequiredrecordsScannednumberRequiredissuesFoundnumberRequiredchecksTotalnumberRequiredchecksFailingnumberRequiredchecksarray of HealthCheckResultDtoRequired8 fieldscheckscheckKeystringRequired when parent is presentField path: checks[].checkKeynamestringRequired when parent is presentField path: checks[].namedescriptionstringRequired when parent is presentField path: checks[].descriptioncategorystringRequired when parent is presentField path: checks[].category"subscriptions", "payments", "members"statusstringRequired when parent is presentField path: checks[].status{
"id": 0,
"status": "running",
"triggeredBy": "schedule",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"durationMs": 0,
"recordsScanned": 0,
"issuesFound": 0,
"checksTotal": 0,
"checksFailing": 0,
"checks": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as List health scans for the tenant (paginated) (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/data-health/scans/{scanId}' \
--header 'Authorization: Bearer <token>'1maximum: 50orderBystringOptional"createdAt"Allowed values: "createdAt", "id", "updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"checkHealthCheckResultDtoRequired8 fieldscheckcheckKeystringRequiredField path: check.checkKeynamestringRequiredField path: check.namedescriptionstringRequiredField path: check.descriptioncategorystringRequiredField path: check.category"subscriptions", "payments", "members"statusstringRequiredField path: check.status"passing", "failing", "error"flaggedCountnumberRequiredField path: check.flaggedCountrecordsScannednumberRequiredField path: check.recordsScannederrorMessagestringRequiredField path: check.errorMessagescanStartedAtstring (date-time)RequiredrecordsPaginateRequired2 fieldsrecordsitemsarray of objectRequiredField path: records.itemsmetaPageMetaRequiredField path: records.meta6 fieldsrecords.metapagenumberRequiredField path: records.meta.pagetakenumberRequiredField path: records.meta.takecountnumberRequiredField path: records.meta.count{
"check": {
"checkKey": "<checkKey>",
"name": "string",
"description": "string",
"category": "subscriptions",
"status": "passing",
"flaggedCount": 0,
"recordsScanned": 0,
"errorMessage": "string"
},
"scanStartedAt": "2019-08-24T14:15:22Z",
"records": {
"items": [
{}
],
"meta": {}
}
}unauthorized
This response has no body.
forbiddenResource
Same fields as List health scans for the tenant (paginated) (403).
curlcurl 'https://api.subrite.no/api/v1/data-health/scans/{scanId}/checks/{checkKey}' \
--header 'Authorization: Bearer <token>'application/jsonissueIdnumberRequiredentityIdstringRequiredmemberIdstringRequireddetailstringRequireddetectedAtstring (date-time)Requiredcontextobject with any valuesRequired{
"issueId": 0,
"entityId": "string",
"memberId": "string",
"detail": "string",
"detectedAt": "2019-08-24T14:15:22Z",
"context": {}
}unauthorized
This response has no body.
forbiddenResource
Same fields as List health scans for the tenant (paginated) (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/data-health/scans/{scanId}/checks/{checkKey}/records/{issueId}' \
--header 'Authorization: Bearer <token>'"passing", "failing", "error"flaggedCountnumberRequired when parent is presentField path: checks[].flaggedCountrecordsScannednumberRequired when parent is presentField path: checks[].recordsScannederrorMessagestringRequired when parent is presentField path: checks[].errorMessagepageCountnumberRequiredField path: records.meta.pageCounthasPreviousPagebooleanRequiredField path: records.meta.hasPreviousPagehasNextPagebooleanRequiredField path: records.meta.hasNextPage{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}