ObservePoint Page Details Report API is one of 65 APIs that ObservePoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include page-details-report. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
16 operations
across 16 paths,
and defines 115 schemas.
It is described by OpenAPI 3.2.0.
Requests are made against a single base URL, https://api.observepoint.com.
The identity and technical contract details declared by the specification.
CookieTrait
object
8 properties
8 required
GetCookiesByHarEntryIndices_RequestItem
object
2 properties
2 required
CookieOriginTypeEnum
stringnull
ItemRunTrendsItemTrait
object
2 properties
2 required
AuditPageCookieChangeItem
object
QueryByHarEntryIndices_RequestDto
object
1 property
1 required
HarEntryIndex
integer
The 0-based index of the HAR entry that this request corresponds to. Used to uniquely identify a request on a page.
CookiePartyType
string
Indicates if cookie domain is different from domain of a page it was set on. owned3rdparty is deprecated
CookieInitiator
object
2 properties
AuditRun_PageInfo_LinksDTO
object
1 property
1 required
AuditActionSnapshotId
integer
An ID assigned to actions of all types on an audit - unique in the context of an individual run
AccessibilityRuleResult
object
8 properties
8 required
PaginationMetadata
object
5 properties
5 required
BaseCookieChangeActionTrait
object
2 properties
2 required
CookieOriginRequestDTO
object
3 properties
AuditActionResult
object
2 properties
2 required
WebVitalDetails
object
Specific details for a given Web Vital
4 properties
3 required
AuditRun_PageDetails_WebVitalsTrends_Stats
object
Web Vitals trends statistics (min, max, average, median)
4 properties
4 required
AuditRun_PageInfo_ThisUrlTypeEnum
string
CommonIterableResponseMetadata
object
Common metadata for iterable
1 property
1 required
TagCategoryId
integer
Tag category ID
AuditRun_FileChanges_DateDifferenceInMinutes
integer
Number of minutes for date difference between 2 file versions, can be negative
AccessibilityChecksResults
object
4 properties
2 required
TagInsights
object
3 properties
AuditRun_PageInfo_LinkDownloadOptionEnum
string
TagVendorId
integer
Tag vendor ID
RequestOriginTypeEnum
stringnull
AccessibilityTestedElement
object
7 properties
1 required
CookieChangeSnapshot
object
GetRequestsByHarEntryIndices_ResponseDto
object
1 property
1 required
AuditRun_PageDetails_SpecificWebVitalsTrend_Response
object
2 properties
2 required
TagInstance
object
10 properties
AuditRun_PageDetails_WebVitalsTrends_Response
object
1 property
1 required
AuditRunPage_InitiatorsTree_ResponseDTO
object
2 properties
2 required
RequestLogItemGeoLocation
object
2 properties
2 required
BrowserLogMessageLevelEnum
string
AuditRun_PageInfo_LinkItem
object
6 properties
6 required
RequestLogTrait
object
15 properties
4 required
BaseResponseCookieChangeItemTrait
object
2 properties
2 required
AuditRun_FileChanges_SizeDifferenceInBytes
integer
File size change in number of bytes between 2 file versions, can be negative
AuditPageCookieItem
object
When getOrigins is true, will include changes array and uniqueInitiatorCount, but initiators array won't be included
RequestLogItemFileInfo
object
3 properties
2 required
ErrorModel
object
4 properties
AuditRunPage_InitiatorsSummary
object
8 properties
8 required
FullCookieTrait
object
12 properties
TagCategoryName
string
Name of a category of a tag
BaseCookieInitiator
object
3 properties
1 required
PageScoreValue
number
Page accessibility score in %, 1 digit after decimal point
AuditRun_PageInfo_RedirectChainElement
object
3 properties
3 required
AuditRun_PageInfo_LinkDirection
string
AuditRunPage_BrowserLogs_MessagesSortColumn
string
AuditRun_PageDetails_RequestLogSortColumn
string
FileMappingResultsDTO
object
5 properties
TagInfo
object
9 properties
BrowserConsoleLog
object
6 properties
4 required
RequestLogItemFileChange
object
Available only for JavaScript files for now. Provided only for customers that have Privacy features available.
3 properties
1 required
CookieChangeTypeEnum
string
AuditRun_PageInfo_LinkSummary
object
3 properties
2 required
TagInfoDTOWithInsights
object
2 properties
FileSubstitutionFailure
object
2 properties
1 required
SparkLinePageInsights
object
3 properties
FileSubstitutionFailureType
string
AuditRunPage_InitiatorsTree_RequestDTO
object
Request body with filters for Page Details Initiators tree, supporting filtering by request tags and cookies as well as request attributes
12 properties
SparkLineDTO
object
3 properties
WebVitalsSummary
object
Google's Web Vitals metrics for a given page
4 properties
4 required
BaseCookieInsights
object
3 properties
3 required
GetRequestsByHarEntryIndices_RequestItem
BrowserRedirectType
string
AuditRun_WebVitalsTrends_Enum
string
AccessibilitySuccessCriteria
object
2 properties
1 required
DateAndTime
string
Date-time in [RFC3339 profile ISO 8601 format](https://www.ietf.org/rfc/rfc3339.txt) with the following additional restrictions: 1. An uppercase T must separat…
AuditRunPage_ConsoleLogs_RequestDTO
object
2 properties
StringInclusionFilterTypeEnum
string
GetCookiesByHarEntryIndices_RequestCookieItem
CookieOriginDto
object
2 properties
FileMappingMatchTypeEnum
integer
1 - success, 2 - failure
AuditRun_PageDetails_WebVitalsTrendsItem
InitiatorsTreeVertex
object
Represents a node in the initiators tree. Each node/vertex is a network request. The root node is the page request. The root node does not have relationToParen…
6 properties
5 required
InitiatorParentChildRelationType
string
Default value is normal, may be omitted. The root node does not have relation.
AuditCookieInsights
object
PageAccessibilityScores
object
The accessibility scores for the page based on different WCAG versions and conformance levels
9 properties
9 required
CountryCode
string
ISO 3166-1 (Alpha-2) country code
ConsoleLogSummary
object
5 properties
5 required
AuditRun_FileChanges_FileChangeType
string
WebVitalsLargestContentfulPaint
number
LCP time in milliseconds
PageInfo
object
19 properties
AuditRun_PageDetails_TrendsEnum
string
AuditRunPage_ConsoleLogsDTO
object
2 properties
2 required
AuditRun_PageWebVitals
object
Web Vitals for a single page
4 properties
Variable
object
2 properties
AuditPageCookiesDTO
object
2 properties
2 required
GetCookiesByHarEntryIndices_ResponseDto
object
1 property
1 required
StatusCodeEnum
string
good - 2xx, redirects - 3xx, broken - all others
PageTrendDTO
object
4 properties
CookieInitiatorTypeEnum
string
Type of event that created the cookie
RequestFilename
string
Name of the file. Identified as the last non-empty part of URL path
StringInclusionFilter
object
2 properties
2 required
RequestDomain
string
Network request URL domain
FileSubstitution
object
3 properties
1 required
TagAccount
string
Tag account
TagInfoTrait
object
Common tag info
4 properties
4 required
AuditCookieChangeAction
object
RequestLogDTO
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ObservePoint publishes across the network.
