Skip to content
v3 API
/
Page Details Report
/
Download page links

V3 API

This section documents the V3 Reporting API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, and analyze web performance metrics from your ObservePoint scans.

Download OpenAPI description
REPORTING-API.openapi.json
REPORTING-API.openapi.yaml
Overview
URL

https://www.observepoint.com/contact-us

Languages
Servers
ObservePoint Production API

https://api.observepoint.com/

Audit Run Data

Retrieve audit run data including pages, cookies, geo-locations, network requests, JS variables and failures for web audit runs

Operations

Page Details Report

Detailed information about specific pages including tags, cookies, request logs, and console logs

Operations

Get cookie origin

Request

POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies/origin

Get the origin story for a cookie

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
Bodyapplication/jsonrequired
namestring
domainstring
pathstring
curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/cookies/origin \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "domain": "string",
    "path": "string"
  }'

Responses

OK, return a list of story actions

Bodyapplication/json
changesArray of objectsrequired
changes[].​cookieChangeTypestringrequired
Enum"ADD""UPDATE""DELETE""NO_CHANGE""REPEAT_SET"
changes[].​cookieobjectrequired
changes[].​cookie.​namestringrequired
changes[].​cookie.​valuestringrequired
changes[].​cookie.​domainstringrequired
changes[].​cookie.​pathstringrequired
changes[].​cookie.​httpOnlybooleanrequired
changes[].​cookie.​securebooleanrequired
changes[].​cookie.​sameSitestringrequired
changes[].​cookie.​expiresstringrequired
changes[].​cookie.​partyTypestringrequired

Indicates how much cookie domain is different from its page domain

Enum"1st_party""owned_3rd_party""3rd_party"
changes[].​cookie.​cookieTTLinteger(int64)

difference (in minutes) between cookie expiration and cookie set time (page scan) cookieTTL

changes[].​actionobjectrequired
changes[].​action.​sequenceintegerrequired
changes[].​action.​labelstringrequired
changes[].​action.​actionSnapshotIdintegerrequired
changes[].​initiatorsArray of objectsrequired
changes[].​initiators[].​initiatorTypestringrequired

Type of event that created the cookie

Enum"HTTP""APP""OP_ACTION""UNKNOWN"
changes[].​initiators[].​tagIdinteger

Will include a tag ID when a specific tag signature has been matched to initiating requests

changes[].​initiators[].​requestUrlstring

For initiatorType:

  • HTTP - requestUrl will be the URL of the request that created the cookie
  • APP, OP_ACTION, UNKNOWN - This field will be undefined
changes[].​initiators[].​lineinteger

The line number in the JS file that created the cookie

changes[].​initiators[].​columninteger

The column number in the JS file that created the cookie

changes[].​cookieOriginTypestring or nullrequired
Enum"PRE_AUDIT_ACTION""PAGE_LOAD""ON_PAGE_ACTION"
Response
application/json
{
  "changes": [
    { … }
  ]
}

Return specific page information

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/info

Get page information from specified audit run on a given page

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
Query
withBlockedRequestSummaryboolean

Parameter to request inclusion of blockedRequestSummary in response

Default false
withLinkSummaryboolean

Parameter to request inclusion of links in response

Default false
withParentPageboolean

Parameter to request inclusion of parent in response

Default false
withScreenshotUrlboolean

Parameter to request inclusion of screenshot in response

Default false
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/info?withBlockedRequestSummary=false&withLinkSummary=false&withParentPage=false&withScreenshotUrl=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page Info by page Id

Bodyapplication/json
initialPageUrlstring

Initial page URL - before the first redirect. If there were no redirects, equal to finalPageUrl

loadTimenumber
initialStatusCodeinteger

Initial page status code - before the first redirect. If there were no redirects, equal to finalStatusCode

sizenumber
screenshotstring
parentobject
finalPageUrlstring<= 11264 characters

Final page URL - after all redirects. If there were no redirects, equal to initialPageUrl

Example: "https://example.com/some-path"
finalStatusCodeinteger

Final status code - after all redirects. If there were no redirects, equal to initialStatusCode

Example: 302
titleobject

Page title as displayed by browser

Example: "My Cards - ObservePoint"
browserErrorstring

error produced by browser upon opening the page

Example: "This site can’t be reached. example.com’s server IP address could not be found. ERR_NAME_NOT_RESOLVED"
visitStartTimestampinteger(int64)

timestamp - GMT in milliseconds

Example: 1637944293
visitEndTimestampinteger(int64)

timestamp - GMT in milliseconds

Example: 1637944293
redirectsArray of objects<= 100 items

NULL if page had no redirects. Does not include final page

linksobject
onPageActionResultsArray of objectsnon-empty

(Optional) Present if failure/s is/are present in On-Page Actions execution

blockedRequestSummaryobject

(Optional) Present if withBlockedRequestSummary query parameter is true.

webVitalsSummaryobject

Google's Web Vitals metrics for a given page

accessibilityChecksSummaryobject
urlstringDeprecated

Deprecated - use initialPageUrl instead

statusCodeintegerDeprecated

Deprecated - use initialStatusCode instead

Example: 200
Response
application/json
{
  "url": "string",
  "initialPageUrl": "string",
  "loadTime": 0,
  "statusCode": 200,
  "initialStatusCode": 0,
  "size": 0,
  "screenshot": "string",
  "parent": {
    "pageId": "string",
    "pageUrl": "string"
  },
  "finalPageUrl": "https://example.com/some-path",
  "finalStatusCode": 302,
  "title": "My Cards - ObservePoint",
  "browserError": "This site can’t be reached. example.com’s server IP address could not be found. ERR_NAME_NOT_RESOLVED",
  "visitStartTimestamp": 1637944293,
  "visitEndTimestamp": 1637944293,
  "redirects": [
    { … }
  ],
  "links": {
    "linkToInitialUrlCount": 32,
    "linkToFinalUrlCount": 12,
    "linksFromThisPageV2": { … }
  },
  "onPageActionResults": [
    { … }
  ],
  "blockedRequestSummary": {
    "blockedRequests": true
  },
  "webVitalsSummary": {
    "largestContentfulPaint": { … },
    "cumulativeLayoutShift": { … },
    "firstContentfulPaint": { … },
    "timeToFirstByte": { … }
  },
  "accessibilityChecksSummary": {
    "configurationTags": [ … ],
    "scores": { … },
    "issues": [ … ],
    "inconclusive": [ … ]
  }
}

Get page links

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}

Get up to 1000 page links with specified direction (from/to this page), use downloadPageLinks to get all items

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
linkDirectionstringrequired
Enum"to_this_page""from_this_page"
Query
optionsArray of strings[ 1 .. 3 ] items

Applicable to links from this page

Items Enum"to_internal_pages""to_external_pages""to_urls_not_audited"
thisUrlTypestring

Applicable to links to this page.

  • missing - links pointing to either initial or final url
  • initial - links pointing to initial url,
  • final - links pointing to final url, if there was no redirect, final url will be the the same as initial
Enum"initial""final"
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/links/{linkDirection}?options=to_internal_pages&thisUrlType=initial' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page links

Bodyapplication/json
linksArray of objects<= 1000 itemsrequired
links[].​initial_page_urlstringrequired

URL initially opened by engine

links[].​initial_page_status_codeintegerrequired

Initial status code observed by engine

links[].​final_page_urlstringrequired

Final URL after all redirects. If no redirects, equal to initial_page_url

links[].​final_page_status_codeintegerrequired

Final status code observed by engine after all redirects. If no redirects, equal to initial_page_status_code

links[].​page_linked_from_urlstringrequired

URL of another page that has link to this page

links[].​outer_htmlstring<= 500 charactersrequired
Example: "<a href='https://www.iana.org/domains/example'>More information...</a>"
Response
application/json
{
  "links": [
    { … }
  ]
}

Download page links

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/links/{linkDirection}/download

Download page links with specified direction (from/to this page)

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
linkDirectionstringrequired
Enum"to_this_page""from_this_page"
Query
optionsArray of strings[ 1 .. 3 ] items

Applicable to links from this page

Items Enum"to_internal_pages""to_external_pages""to_urls_not_audited"
thisUrlTypestring

Applicable to links to this page.

  • missing - links pointing to either initial or final url
  • initial - links pointing to initial url,
  • final - links pointing to final url, if there was no redirect, final url will be the the same as initial
Enum"initial""final"
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/links/{linkDirection}/download?options=to_internal_pages&thisUrlType=initial' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page links

Headers
content-dispositionstring

Controls the name of the downloaded file (in case of text/csv content)

Example: "attachment; filename=\"page-summary-links-to-this-page-My_Audit-2022-03-22_15-16-17.csv\""
Bodytext/csv
string(csv)

See AuditRun_PageInfo_LinkItem for single row schema

Response
No content

Return remote file mapping results

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/file-mapping

Get remote file mapping results from specified audit run on a given page

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/file-mapping \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page Info by page Id

Bodyapplication/jsonArray [
remoteFileMappingIdinteger
matchstring
matchTypeinteger

1 - success, 2 - failure

Enum12
fileUrlstring
mappedRequestsArray of strings
]
Response
application/json
[
  {
    "remoteFileMappingId": 0,
    "match": "string",
    "matchType": 1,
    "fileUrl": "string",
    "mappedRequests": [ … ]
  }
]

Return page tag information

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/tags

Get tags from specified audit run on a given page, getting summary insight is optional

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
Query
getInsightsboolean
Example: getInsights=true
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/tags?getInsights=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Tag Info by page Id, pageTagInsights object is optional

Bodyapplication/json
pageTagInsightsobject
pageTagsArray of objects
Response
application/json
{
  "pageTagInsights": {
    "noOfTagRequests": 0,
    "noOfUniqueTags": 0,
    "noOfBrokenTags": 0
  },
  "pageTags": [
    { … }
  ]
}

Return page cookie information

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/cookies

Get cookies from specified audit run on a given page, getting summary insight is optional

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
Query
getInsightsboolean
Example: getInsights=true
getOriginsboolean

If true then origin story will be returned for each cookie

Example: getOrigins=true
hidePreAuditActionOnlyCookiesboolean

If true then cookies which were only changed during pre-audit actions will be hidden

Default false
Example: hidePreAuditActionOnlyCookies=true
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/cookies?getInsights=true&getOrigins=true&hidePreAuditActionOnlyCookies=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK, return cookies found on a page

Bodyapplication/json
insightsobjectrequired
insights.​noOfUniqueCookiesintegerrequired
insights.​noOfUniqueDomainsintegerrequired
insights.​noOf3rdPartyCookiesintegerrequired
cookiesArray of objectsrequired
cookies[].​namestring
cookies[].​valuestring
cookies[].​domainstring
cookies[].​pathstring
cookies[].​httpOnlyboolean
cookies[].​secureboolean
cookies[].​samesitestring
cookies[].​expiresstring
cookies[].​partyTypestring

Indicates how much cookie domain is different from its page domain

Enum"1st_party""owned_3rd_party""3rd_party"
cookies[].​originobject
cookies[].​initiatorsArray of objects
cookies[].​partitionKeystring
cookies[].​ttlInMinutesinteger(int64)
cookies[].​uniqueInitiatorCountinteger
cookies[].​changesArray of objects
Response
application/json
{
  "insights": {
    "noOfUniqueCookies": 0,
    "noOfUniqueDomains": 0,
    "noOf3rdPartyCookies": 0
  },
  "cookies": [
    { … }
  ]
}

Return network requests fired on a given page

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/request-log

Get request logs from specified audit run on a given page

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
Query
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sizeinteger[ 50 .. 1000 ]
Default 50
sortBystring
Enum"request_start_time""request_url""tag_name""mime_type""response_size""load_time""status_code""geo""date_difference""size_difference"
sortDescboolean

Controls sorting order

Default false
searchstring

Filters results by a search string

showPreAuditActionRequestsboolean

Filters results by cookie origin type

Default false
showFileChangesboolean

For privacy customers, when file changes are requested, we show the changes of the files between previous run and current run.

Default false
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/request-log?page=0&size=50&sortBy=request_start_time&sortDesc=false&search=string&showPreAuditActionRequests=false&showFileChanges=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK, return a list of network requests send

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

requestsArray of objectsrequired
requests[].​resourceTypestring

The type of resource that was requested. e.g. 'xhr', 'script', 'image', 'stylesheet', 'font', 'document', 'other'. Available since WORK-24937

requests[].​methodstring

The HTTP method used for the request

requests[].​serverIPAddressstring(ipAddress)

The IP address of the server that responded to the request

requests[].​httpVersionstring

The HTTP version used for the request (e.g. 'HTTP/1.1')

requests[].​requestUrlstringrequired
requests[].​statusCodeintegerrequired

HTTP status code of network request

requests[].​loadTimenumberrequired

Time took for network request to execute, in milliseconds

requests[].​geoLocationInfoobject
requests[].​tagobject

Common tag info

requests[].​mimeTypestring
requests[].​fileInfoobject
requests[].​fileChangeobject

Available only for JavaScript files for now. Provided only for customers that have Privacy features available.

requests[].​responseSizeBytesinteger
requests[].​originstring or null
Enum"PRE_AUDIT_ACTION""ON_PAGE"
requests[].​relatedCookiesArray of objects
requests[].​blockingResultsobject

(Optional) Present if the request was blocked. TagId and Tag Category Id not included here since RequestLog's tag will have that information.

requests[].​startedAtstring(date-time)

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
requests[].​startedAtRelativeToPageNavigationinteger(int64)
requests[].​geoLocationstringDeprecated

Use geoLocationInfo property instead. It will be renamed to geoLocation soon

requests[].​tagIdintegerDeprecated

Use tag property instead

Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "requests": [
    { … }
  ]
}

Return console logs summary on a given page

Request

POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log-summary

Get browser console logs summary for specified audit run page

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
Bodyapplication/json
includedLevelsArray of strings
Items Enum"error""warn""info""debug""other"
searchstring

Filters logs by message and source with 'contains' predicate

curl -i -X POST \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/console-log-summary \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "includedLevels": [
      "error"
    ],
    "search": "string"
  }'

Responses

OK

Bodyapplication/json
errorLogCountintegerrequired
warnLogCountintegerrequired
debugLogCountintegerrequired
infoLogCountintegerrequired
Example: 4
otherLogCountintegerrequired
Response
application/json
{
  "errorLogCount": 0,
  "warnLogCount": 0,
  "debugLogCount": 0,
  "infoLogCount": 4,
  "otherLogCount": 0
}

Return console logs generated on a given page

Request

POST /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/console-log

Get browser console logs for specified audit run page

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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
Query
pageinteger>= 0

Number of results page of an endpoint with paginated results

Default 0
sizeinteger[ 50 .. 200 ]
Default 50
sortBystring
Enum"message""timestamp""level""source""count""related_tag"
sortDescboolean

Controls sorting order

Default false
Bodyapplication/json
includedLevelsArray of strings
Items Enum"error""warn""info""debug""other"
searchstring

Filters logs by message and source with 'contains' predicate

curl -i -X POST \
  'https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/console-log?page=0&size=50&sortBy=message&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "includedLevels": [
      "error"
    ],
    "search": "string"
  }'

Responses

OK, return a list of console logs generated

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

metadata.​paginationobjectrequired
metadata.​pagination.​totalCountintegerrequired

Total number of items available from all result pages combined

metadata.​pagination.​totalPageCountintegerrequired

Total number of pages available

metadata.​pagination.​pageSizeintegerrequired

Page size - number of items per result page configured by size query parameter or default page size

metadata.​pagination.​currentPageSizeintegerrequired

Number of items in current result page

metadata.​pagination.​currentPageNumberintegerrequired

Current page number/ordinal

consoleLogsArray of objectsrequired
consoleLogs[].​timestampinteger(int64)required
Example: 1612568767911
consoleLogs[].​messagestringrequired
Example: "loadscript added to queue: /path/to/example.js"
consoleLogs[].​levelstringrequired
Enum"error""warn""info""debug""other"
consoleLogs[].​sourcestring
consoleLogs[].​countintegerrequired
Example: 4
consoleLogs[].​relatedTagobject

Common tag info

Response
application/json
{
  "metadata": {
    "pagination": { … }
  },
  "consoleLogs": [
    { … }
  ]
}

Return insights on a given page for all runs in the given days

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/sparklines
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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/sparklines \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page Insights by page Id

Bodyapplication/jsonArray [
runIdnumber
runCompletionDatestring(date-time)
pageInsightsobject
]
Response
application/json
[
  {
    "runId": 0,
    "runCompletionDate": "2019-08-24T14:15:22Z",
    "pageInsights": { … }
  }
]

Get Page Details Web Vitals trends relative to specified audit run

Request

GET /v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/trends/web-vitals
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
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
curl -i -X GET \
  https://api.observepoint.com/v3/web-audits/107239/runs/33010/pages/f9d32cc7cc2046d6decb145a80289287f5226323/trends/web-vitals \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page Details Web Vitals trends data

Bodyapplication/json
runsArray of objectsrequired
runs[].​runIdinteger(int64)required
Example: 33010
runs[].​completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
runs[].​largestContentfulPaintnumber(double)

LCP time in milliseconds

runs[].​firstContentfulPaintnumber(double)

FCP time in milliseconds

runs[].​timeToFirstBytenumber(double)

TTFB time in milliseconds

runs[].​cumulativeLayoutShiftnumber(double)

unitless measurement of CLS

Response
application/json
{
  "runs": [
    { … }
  ]
}

Return specific insight trend on a given page for all runs in the given duration (days)

Request

GET /v3/web-audits/{auditId}/pages/{pageId}/insight-trends/{trendName}
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
trendNamestringrequired

name of the insight trend type

Enum"pageSize""pageLoadTime"
Example: pageSize
Query
dayinteger[ 1 .. 390 ]required

how many days of run records should be included

Example: day=120
curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/pages/f9d32cc7cc2046d6decb145a80289287f5226323/insight-trends/pageSize?day=120' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A array of page insights

Bodyapplication/jsonArray [
runIdinteger(int64)
runCompletionDatestring(date-time)
trendNamestring
trendValueinteger(int64)
]
Response
application/json
[
  {
    "runId": 0,
    "runCompletionDate": "2019-08-24T14:15:22Z",
    "trendName": "string",
    "trendValue": 0
  }
]

Get Page Details Web Vitals specific trend values relative to current day

Request

GET /v3/web-audits/{auditId}/pages/{pageId}/trends/web-vitals/{trendName}
Security
API_Key
Path
auditIdinteger(int64)required

Unique identification number for web audit

Example: 107239
pageIdstringrequired

Unique identification number for web audit run-page, it is different from dcUUID

Example: f9d32cc7cc2046d6decb145a80289287f5226323
trendNamestringrequired
Enum"largest_contentful_paint""first_contentful_paint""time_to_first_byte""cumulative_layout_shift"
Query
daysinteger[ 1 .. 390 ]required

Number of days to get trend values for, relative to current time

curl -i -X GET \
  'https://api.observepoint.com/v3/web-audits/107239/pages/f9d32cc7cc2046d6decb145a80289287f5226323/trends/web-vitals/{trendName}?days=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Page Details Web Vitals specific trend values

Bodyapplication/json
statsobjectrequired

Web Vitals trends statistics (min, max, average, median)

stats.​minnumber(double)required
stats.​maxnumber(double)required
stats.​averagenumber(double)required
stats.​mediannumber(double)required
runsArray of objectsrequired
runs[].​runIdinteger(int64)required
Example: 33010
runs[].​completedAtstring(date-time)required

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example: "2016-08-18T17:33:00Z"
runs[].​trendValuenumber(double)required
Response
application/json
{
  "stats": {
    "min": 0.1,
    "max": 0.1,
    "average": 0.1,
    "median": 0.1
  },
  "runs": [
    { … }
  ]
}

Page Summary Report

Page Summary report endpoints

Operations

Audit Summary Report

Audit Summary report endpoints

Operations

Alert Summary Report

Alert Summary report endpoints

Operations

Rule Summary Report

Rule Summary report endpoints

Operations

Tag Inventory Report

Tag Inventory report endpoints

Operations

Tag Health Report

Tag Health report endpoints

Operations

Tag Duplicates and Multiples Report

Tag Duplicates and Multiples report endpoints

Operations

Variable Inventory Report

Variable Inventory report endpoints

Operations

Browser Logs Report

Browser Logs report endpoints

Operations

File Changes Report

File changes report endpoints

Operations

Tag Privacy Report

Tag privacy report endpoints

Operations

Request Privacy Report

Request Privacy report endpoints

Operations

Exports Center

Access requested exports status/information

Operations

Scheduled Exports

Manage scheduled grid report data exports

Operations

Audit Run Export

Export audit run data

Operations

Web Journey Run Export

Export web journey run data

Operations

Manual Journey Run Export

Export manual journey run data

Operations

Alerts

Alert management and configuration

Operations

Account's Triggered Alerts

Account-level triggered alerts

Operations

Alert Export

Export alert data

Operations

Account Usage

Account usage data

Operations

Account Usage Alerts

Alerts related to account usage

Operations

Account Usage Export

Export account usage data

Operations

Notification Center

Find and manage email subscriptions

Operations

Email Inbox Messages

Get Email Inbox message details

Operations

Email Inbox Message Alerts

Email inbox message alerts

Operations