Find monitor by search terms and filters

List Monitors given the provided search terms and filters

Securitybearer
Request
query Parameters
page
number >= 1
Default: 1

Which page of data are you requesting

limit
number [ 1 .. 50 ]
Default: 20

How many items are you requesting

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" "NEW" "ENABLED" "DISABLED" "TESTING"
Example: checkStatus=ENABLED
source
string

Filter monitors by test source type (control test instances)

Enum: "DRATA" "CUSTOM" "EXTERNAL" "ACORN"
Example: source=DRATA
type
string

Filter monitors by check type (associated monitor instances)

Enum: "POLICY" "IN_DRATA" "AGENT" "INFRASTRUCTURE" "VERSION_CONTROL" "IDENTITY" "TICKETING" "HRIS" "OBSERVABILITY" "CUSTOM"
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
drafts
boolean

boolean for returning drafts instead of published

Example: drafts=true
Responses
200
400

Malformed data and/or validation errors

401

Invalid Authorization

403

You are not allowed to perform this action

500

Internal server error

default

Response Code: 412

You must accept the Drata terms and conditions to use the API

get/monitors
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": 1,
      • "name": "A Version Control System is being Used",
      • "description": "Inspected Drata's version control system...",
      • "checkResultStatus": "PASSED",
      • "lastCheck": "2020-07-06 12:00:00.000000",
      • "checkStatus": "ENABLED",
      • "disabledMessage": "Disabled since it is not applicable to the company",
      • "priority": "NORMAL",
      • "autoEnabledAt": "2020-07-06 12:00:00.000000",
      • "testId": "42",
      • "createdAt": "2020-07-06 12:00:00.000000",
      • "updatedAt": "2020-07-06 12:00:00.000000",
      • "monitorInstances": "MonitorInstanceResponseDto[]",
      • "disablingUser": {
        • "id": 1,
        • "email": "[email protected]",
        • "firstName": "Sally",
        • "lastName": "Smith",
        • "jobTitle": "CEO",
        • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
        • "drataTermsAgreedAt": "2020-07-06 12:00:00.000000",
        • "createdAt": "2020-07-06 12:00:00.000000",
        • "updatedAt": "2020-07-06 12:00:00.000000",
        • "roles": [
          • "ROLE",
          • "ANOTHER_ROLE"
          ],
        • "backgroundChecks": [
          • {
            • "id": 1,
            • "userId": 1,
            • "status": "OK",
            • "caseId": "abc123",
            • "caseInvitationId": "abc123",
            • "url": "https://app-stage.karmacheck.com/background_check/aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
            • "manualCheckDate": "2020-07-06",
            • "manuallyCheckUrl": "url.com",
            • "type": "CERTN",
            • "source": "DRATA",
            • "reportData": "string",
            • "user": { },
            • "outOfScopeReason": "abc123",
            • "outOfScopeAt": "2020-07-06 12:00:00.000000",
            • "invitationEmail": "[email protected]",
            • "linkedAt": "2020-07-06 12:00:00.000000",
            • "createdAt": "2020-07-06 12:00:00.000000",
            • "updatedAt": "2020-07-06 12:00:00.000000"
            }
          ],
        • "identities": [
          • {
            • "id": 1,
            • "identityId": "1a2b3c",
            • "username": "Username",
            • "connectedAt": "2020-07-06 12:00:00.000000",
            • "disconnectedAt": "2020-07-06 12:00:00.000000",
            • "hasMfa": true,
            • "user": { },
            • "connection": {
              • "id": "1",
              • "clientType": "GOOGLE",
              • "state": "ACTIVE",
              • "connected": false,
              • "connectedAt": "2020-07-06 12:00:00.000000",
              • "failedAt": "2020-07-06 12:00:00.000000",
              • "companyId": "12341234",
              • "assignmentId": "FLk12AsS",
              • "user": { },
              • "accountId": "string",
              • "clientId": "drata.com",
              • "clientAlias": "My-connection-alias-1",
              • "manuallyUpdatedAt": "2020-07-06 12:00:00.000000",
              • "aliasUpdatedAt": "2020-07-06 12:00:00.000000",
              • "deletedAt": "2020-07-06 12:00:00.000000",
              • "requestorId": "328d3016-71f3-4485-af20-06ce8044da18",
              • "product": "",
              • "writeAccessEnabled": false,
              • "sourcePreference": "LABEL",
              • "securityLabel": "Jira Security Label",
              • "jqlQuery": "project = IT AND type = \"Offboarding\"",
              • "authorized": true,
              • "workspaces": [],
              • "providerTypes": [
                • 5
                ],
              • "code": 10010,
              • "groupLabel": "Everyone"
              },
            • "hasIdp": true
            }
          ]
        },
      • "controls": "ControlMonitorResponseDto[]",
      • "monitorInstanceExclusions": "ExclusionDto[]",
      • "graph": "ControlTestInstanceHistoryType",
      • "eventTypes": "EventType[]"
      }
    ],
  • "page": 1,
  • "limit": 10,
  • "total": 100
}