Skip to content
v3 API/
/
Get Browser Logs summary...

Get Browser Logs summary for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs
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
Bodyapplication/json

Filters applicable to Browser Logs report

pageUrlobject
finalPageUrlobject
pageTitleobject
initialPageStatusCodeobject
finalPageStatusCodeobject
combinedPageStatusCodestring
  • broken - initial or final URL are broken,
  • good - initial URL is good or redirect and final URL is good
Enum:"broken""good"
pageLoadTimeobject

Page load time in milliseconds. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

pageSizeobject

Page size in bytes. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

redirectCountobject

Number of redirects for a page. Should have min and/or max properties defined. min is inclusive and max is exclusive. min should be less than max.

tagIdinteger

Tag ID

tagCategoryIdinteger

Tag category ID

tagVendorIdinteger

Tag vendor ID

levelstring
Enum:"error""warn""info""debug""other"
messageTextobject
anyRelatedTagboolean

Show all messages with any related tag

pageStatusCodestringdeprecated

good - 2xx, redirects - 3xx, broken - all others

Enum:"good""redirects""broken"
POST
/v3/web-audits/{auditId}/runs/{runId}/reports/browser-logs
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/browser-logs \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageUrl": {
      "filterType": "contains",
      "filterValue": "string",
      "negated": false
    },
    "finalPageUrl": {
      "filterType": "contains",
      "filterValue": "string",
      "negated": false
    },
    "pageTitle": {
      "filterType": "contains",
      "filterValue": "ObserveP"
    },
    "initialPageStatusCode": {
      "filterType": "specific",
      "negated": true,
      "filterValue": 0
    },
    "finalPageStatusCode": {
      "filterType": "specific",
      "negated": true,
      "filterValue": 0
    },
    "combinedPageStatusCode": "broken",
    "pageLoadTime": {
      "min": 0,
      "max": 0
    },
    "pageSize": {
      "min": 0,
      "max": 0
    },
    "redirectCount": {
      "min": 0,
      "max": 0
    },
    "hasBrokenLinks": true,
    "pageStatusCode": "good",
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0,
    "level": "error",
    "messageText": {
      "filterType": "contains",
      "filterValue": "string"
    },
    "anyRelatedTag": true
  }'

Responses

Browser Logs summary data

Bodyapplication/json
errorLogCountintegerrequired

Number of error level messages

warnLogCountintegerrequired

Number of warn level messages

infoLogCountintegerrequired

Number of info level messages

debugLogCountintegerrequired

Number of debug level messages

otherLogCountintegerrequired

Number of other level messages

totalPageCountintegerrequired

Total number of pages audited

filteredPageCountintegerrequired

Number of pages passing all applied filters

Response
{
  "errorLogCount": 0,
  "warnLogCount": 0,
  "infoLogCount": 0,
  "debugLogCount": 0,
  "otherLogCount": 0,
  "totalPageCount": 0,
  "filteredPageCount": 0
}