Get File Changes summary for specified audit run

v3 API/

Get File Changes summary for specified audit run

Request

POST /v3/web-audits/{auditId}/runs/{runId}/reports/file-changes

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 File Changes 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.

hasBrokenLinksboolean

primaryTagsOnlyboolean

if true then return only pages/tags with primary tags else return all pages/tags

tagIdinteger

Tag ID

tagCategoryIdinteger

Tag category ID

tagVendorIdinteger

Tag vendor ID

dateDifferenceobject

Filters absolute difference values, e.g. when min = 200 then -300 diff passes filter. Should have min and/or max properties defined. min is inclusive, max is exclusive.

sizeDifferenceobject

Filters absolute difference values, e.g. when min = 200 then -300 diff passes filter. Should have min and/or max properties defined. min is inclusive, max is exclusive.

filenamestring

Name of the file. Identified as the last non-empty part of URL path

Example:"main.js"

changeTypestring

Enum:"new_file""not_changed""changed_file""deleted_file""unknown"

anyRelatedTagboolean

Show all files with any related tag

pageStatusCodestringdeprecated

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

Enum:"good""redirects""broken"

curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/reports/file-changes \
  -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",
    "primaryTagsOnly": true,
    "tagId": 0,
    "tagCategoryId": 0,
    "tagVendorId": 0,
    "dateDifference": {
      "min": 1,
      "max": 1
    },
    "sizeDifference": {
      "min": 1,
      "max": 1
    },
    "filename": "main.js",
    "changeType": "new_file",
    "anyRelatedTag": true
  }'

Responses

File Changes summary data

Bodyapplication/json

totalPageCountintegerrequired

Total number of pages audited

filteredPageCountintegerrequired

Number of pages passing all applied filters

totalChangedFileCountintegerrequired

Total number of changed files discovered

filteredChangedFileCountintegerrequired

Number of changed files passing all applied filters

totalNewFileCountintegerrequired

Total number of new files discovered

filteredNewFileCountintegerrequired

Number of new files discovered that pass all applied filters

totalFileDateDifferenceCountintegerrequired

Total number of files with date change discovered

filteredFileDateDifferenceCountintegerrequired

Number of files with date change passing all applied filters

totalFileSizeDifferenceCountintegerrequired

Total number of files with size change discovered

filteredFileSizeDifferenceCountintegerrequired

Number of files with size change passing all applied filters

Response

{
  "totalPageCount": 0,
  "filteredPageCount": 0,
  "totalChangedFileCount": 0,
  "filteredChangedFileCount": 0,
  "totalNewFileCount": 0,
  "filteredNewFileCount": 0,
  "totalFileDateDifferenceCount": 0,
  "filteredFileDateDifferenceCount": 0,
  "totalFileSizeDifferenceCount": 0,
  "filteredFileSizeDifferenceCount": 0
}