page | number Default: 1 Which page of data are you requesting
Example: page=1 |
limit | number <= 50 Default: 20 How many items are your requesting
Example: limit=10 |
nextPage | string Example: nextPage=d2lraS9hcGkvdjIvcGFnZXM/bGltaXQ9MTAmY3Vyc29yPWV5SnBaQ0k2SWpJM05USTJPVGdpTENKamIyNTBSUGNtUmxjbFpoYkhWbElqb3lOelV5TmprNGZRPT0= |
q | string Filter data by searching for test names
Example: q=SSL enforced on company website |
checkResultStatus | string Filter monitors (control test instances) on a result status
Enum: "READY" "PASSED" "FAILED" "ERROR" "PREAUDIT" Example: checkResultStatus=ERROR |
checkResultStatuses | Array of strings Filter monitors (control test instances) on result statuses
Items Enum: "READY" "PASSED" "FAILED" "ERROR" "PREAUDIT" Example: checkResultStatuses=PASSED&checkResultStatuses=FAILED |
checkStatus | string Filter monitors (control test instances) on system status
Enum: "UNUSED" "UPCOMING" "ENABLED" "DISABLED" "TESTING" Example: checkStatus=ENABLED |
type | string Filter monitors by check type (associated monitor instances)
Enum: "POLICY" "IN_DRATA" "AGENT" "INFRASTRUCTURE" "VERSION_CONTROL" "IDENTITY" "TICKETING" "HRIS" "OBSERVABILITY" Example: type=INFRASTRUCTURE |
controlOwner | number Owner id to filter against
Example: controlOwner=1 |
getAll | boolean boolean for running through the full pagination
Example: getAll=true |
includeArchivedControls | boolean boolean for getting archived controls as well
Example: includeArchivedControls=true |
controlId | number Control id to filter against
Example: controlId=1 |
excludeControlId | number Control id to filter against
Example: excludeControlId=1 |
excludeTestIds | Array of numbers Exclude tests by array of id
Example: |
sortByName | boolean boolean for sorting results by name
Example: sortByName=true |
reportInterval | string The interval to group the data on
Enum: "WEEKLY" "MONTHLY" Example: reportInterval=MONTHLY |