Skip to content
v2 API/
/
Get web audit

Get web audit

Request

GET /v2/web-audits/{webAuditId}
Security
API_Key
Path
webAuditIdinteger, (int32)required
Query
withRunsboolean
runsLimitstring
GET
/web-audits/{webAuditId}
curl -i -X GET \
  'https://api.observepoint.com/v2/web-audits/{webAuditId}?withRuns=true&runsLimit=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
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": {
    "exclude": [ … ],
    "include": [ … ]
  },
  "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": {
    "adobeAuditor": true,
    "blockThirdPartyCookies": true,
    "browserHeight": 0,
    "browserWidth": 0,
    "customHttpHeaders": [ … ],
    "customProxy": "string",
    "discoverSitemap": true,
    "fireTags": true,
    "gpcEnabled": true,
    "loadFlash": true,
    "location": "string",
    "remoteFileMapConfig": [ … ],
    "requestRate": 0,
    "sameUrlRunId": 0,
    "stripQueryString": true,
    "userAgent": "string",
    "vpnEnabled": true,
    "webHookUrl": "string"
  },
  "ownerId": 0,
  "queued": true,
  "recipients": [
    "string"
  ],
  "rules": [
    { … }
  ],
  "runs": [
    { … }
  ],
  "schedule": true,
  "screenshot": "string",
  "startingUrls": [
    "string"
  ],
  "taggingPlans": [
    0
  ],
  "webAuditRunning": 0
}