Skip to content
v3 API/
/
Get audit configuration i...

Get audit configuration info for specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/info
Security
API_Key
Path
auditIdinteger, (int64)required

Unique identification number for web audit

Example:107239
runIdinteger, (int64)required

Unique identification number for web audit or journey run

Example:33010
Query
includeFiltersboolean

Include filters in the response

Default:false
GET
/v3/web-audits/{auditId}/runs/{runId}/info
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/info?includeFilters=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Audit run configuration info

Bodyapplication/json
blockThirdPartyCookiesbooleanrequired

When true the browser blocks all third-party cookies

browserNamestringrequired

Browser name

browserVersionstringrequired

Browser version

customProxystringrequired

The custom proxy used for the audit

discoverSitemapsbooleanrequired

When true, the audit discovers sitemaps on any domains for starting URLs and uses those to find URLs to scan

sitemapDataobject

Data about sitemaps that were discovered and visited by the audit

filtersobjectrequired

Filters used for the audit to include and exclude urls to be scanned

gpcEnabledbooleanrequired

GPC enabled or not

heightintegerrequired

Browser height in pixels

loginActionsbooleanrequired

Pre-Audit Actions present in configuration or not

locationIdintegerrequired

Location (Proxy) ID, this maps to a location in the location table

locationNamestringrequired

Location human readable name. This field maps to the db location.label

Example:"England, London"
onPageActionsbooleanrequired

On Page Actions present in configuration or not

privacyConsentActionsbooleanrequired

Privacy Consent Actions present in configuration or not

runDurationintegerrequired

Run duration in seconds

scanSpeedintegerrequired

Scan speed is the number of engines the customer requests to run the audit with Currently a value between 1-50 is supported, but not guaranteed.

startingUrlCountnumberrequired
urlsScannedintegerrequired

Number of URLs scanned

userAgentstringrequired

User agent

vpnEnabledbooleanrequired

VPN enabled or not for the run configuration

widthintegerrequired

Browser width in pixels

technologyBlockingEnabledbooleanrequired

Tag ID/Tag Category ID blocking enabled or not

fileSubstitutionConfiguredbooleanrequired

File Substitution configured or not

customHeadersAppliedbooleanrequired

Custom HTTP headers applied or not

auditStoppedByUserIdinteger or null, (int64)

ID of the user who stopped the audit run early, if applicable

Response
{
  "blockThirdPartyCookies": true,
  "browserName": "string",
  "browserVersion": "string",
  "customProxy": "string",
  "discoverSitemaps": true,
  "sitemapData": {
    "sitemapsScannedCount": 0,
    "sitemapsScanned": [ … ],
    "sitemapsBrokenCount": 0,
    "sitemapsBrokenUrls": [ … ]
  },
  "filters": {
    "includeFilters": [ … ],
    "excludeFilters": [ … ]
  },
  "gpcEnabled": true,
  "height": 0,
  "loginActions": true,
  "locationId": 0,
  "locationName": "England, London",
  "onPageActions": true,
  "privacyConsentActions": true,
  "runDuration": 0,
  "scanSpeed": 0,
  "startingUrlCount": 0,
  "urlsScanned": 0,
  "userAgent": "string",
  "vpnEnabled": true,
  "width": 0,
  "technologyBlockingEnabled": true,
  "fileSubstitutionConfigured": true,
  "customHeadersApplied": true,
  "auditStoppedByUserId": 0
}