Skip to content
/Audits

Audits

Endpoints for managing audits including creation, configuration, execution, and retrieving audit results and runs

Operations

Get list of all web audits

Request

GET /v2/web-audits
Security
API_Key
Query
withRunsboolean
runsLimitstring
GET
/web-audits
curl -i -X GET \
  'https://api.observepoint.com/v2/web-audits?withRuns=true&runsLimit=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
Array [
createdstring, (date-time)required
domainIdinteger, (int32)required
filtersobject
folderIdinteger, (int32)required
frequencystring
idinteger, (int32)required
labelsArray of objectsrequired
lastRunstring, (date-time)
lastUpdatedstring, (date-time)required
limitinteger, (int32)required
namestringrequired
nextRunstring, (date-time)
optionsobject
ownerIdinteger, (int32)required
queuedbooleanrequired
recipientsArray of stringsrequired
rulesArray of objects
runsArray of objectsrequired
scheduleboolean
screenshotstring
startingUrlsArray of stringsrequired
taggingPlansArray of numbers
webAuditRunningnumber
]
Response
[
  {
    "created": "2019-08-24T14:15:22Z",
    "domainId": 0,
    "filters": { … },
    "folderId": 0,
    "frequency": "string",
    "id": 0,
    "labels": [ … ],
    "lastRun": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "limit": 0,
    "name": "string",
    "nextRun": "2019-08-24T14:15:22Z",
    "options": { … },
    "ownerId": 0,
    "queued": true,
    "recipients": [ … ],
    "rules": [ … ],
    "runs": [ … ],
    "schedule": true,
    "screenshot": "string",
    "startingUrls": [ … ],
    "taggingPlans": [ … ],
    "webAuditRunning": 0
  }
]