Get File Changes files for specified audit run

v3 API/

Get File Changes files for specified audit run

Request

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

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

pageinteger, >= 0

Page number, starts with 0

Default:0

sizeinteger, [ 50 .. 200 ]

Default:50

sortBystring

Enum:"largest_size_diff""page_count""tag""filename""change_type""domain""party_type""largest_date_diff"

sortDescboolean

Controls sorting order

Default:false

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/files?page=0&size=50&sortBy=largest_size_diff&sortDesc=false' \
  -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

metadataobjectrequired

Common metadata for iterable

filesArray of objectsrequired

Response

{
  "metadata": {
    "pagination": { … }
  },
  "files": [
    { … }
  ]
}