How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ObservePoint Web Audits API

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

ObservePoint Web Audits API is one of 65 APIs that ObservePoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include web-audits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 8 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.observepoint.com.

8 operations 8 paths 33 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.observepoint.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ObservePoint Web Audits API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (API_Key).

  • API_Key — Use the Authorization header in your requests with ObservePoint API key as header value. Example: Authorization: abc123...def456

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

web-audits 8

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

GET
/v3/web-audits/{auditId}/runs/{runId}/scores
Get scores for specified audit run
getAuditRunScores 2 params → 200400401404
GET
/v3/web-audits/{auditId}/runs/{runId}/pages
Return pages found in the run
getAuditRunPages 6 params → 200400401404
GET
/v3/web-audits/{auditId}/runs/{runId}/cookies
Return a list of unique cookies
getCookies 2 params → 200400401404
GET
/v3/web-audits/{auditId}/runs/{runId}/geo-locations
Return a list of unique geo-locations
getGeoLocation 2 params → 200400401404
GET
/v3/web-audits/{auditId}/runs/{runId}/request-domains
Return a list of unique request-domains
getRequestDomain 2 params → 200400401404
GET
/v3/web-audits/{auditId}/runs/{runId}/javascript-variables
Return a list of pages with JS variables
getJavaScriptVariables 4 params → 200400401404
GET
/v3/web-audits/{auditId}/runs/{runId}/reports/failures
Get run failures summary
getAuditFailureResults 2 params → 200400401404
GET
/v3/web-audits/{auditId}/runs/{runId}/pages/{pageId}/screenshot
Get audit run page screenshot URL
generateAuditRunPageScreenshot 3 params → 302400401404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are AuditRun_AuditSummary_ScoresDTO (6 properties), PaginationMetadata (5 properties), PageWithJsVariables (5 properties), AuditPage (5 properties). Each schema is shown below with its type and property counts.

AuditId
integer
GeoLocationDTO
object
3 properties
PageId
string
PageStatusCode
integer
Page HTTP status code
RequestDomainParsingResult
RequestDomainDTO-parsed1
object
3 properties
AuditPage
object
5 properties
JsVariable
object
2 properties 2 required
PreAuditActionResults
object
2 properties 1 required
AuditRun_Pages_DTO
object
DTO returning pages of a particular run in paged way.
2 properties 2 required
S3IterableResponseMetadata
object
Metadata for iterable results from S3
1 property 1 required
AuditRun_PagesSort
string
possible ways to sort pages in a given run
AuditActionSnapshotId
integer
An ID assigned to actions of all types on an audit - unique in the context of an individual run
OnPagesActionResultItem
object
2 properties 2 required
RequestDomainDTO-parsed2
object
3 properties
PaginationMetadata
object
5 properties 5 required
RequestDomainDTO-failedToParse
object
2 properties
PageUrl
string
PagesWithJsVariablesDTO
object
2 properties 2 required
AuditRun_AuditSummary_Score
object
2 properties 2 required
AuditActionResult
object
2 properties 2 required
StartingUrlResults
object
Provide information for the following use cases: One and Out - All starting URLs failed to launch One and Out - All links found were excluded by filters
3 properties 1 required
StartingUrlFailureItem
object
3 properties 2 required
CookieDTO
object
Cookie name and domain
2 properties
RunId
integer
RequestDomainDTO
array
S3PaginationMetadata
object
Represents pagination metadata for results from S3, where each result page contains multiple pageIds. It's not possible to efficiently get total count of files…
3 properties 3 required
ErrorModel
object
4 properties
CommonIterableResponseMetadata
object
Common metadata for iterable
1 property 1 required
OnPagesActionResults
object
(Optional) Present if failure/s is/are present for any Page's On-Page Actions execution
3 properties 3 required
AuditFailureResults
object
3 properties 1 required
PageWithJsVariables
object
5 properties 5 required
AuditRun_AuditSummary_ScoresDTO
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-web-audits-api-openapi.yml Raw ↑

Other APIs ObservePoint publishes across the network.

ObservePoint Account API
ObservePoint Account Triggered Alerts API
ObservePoint Account Usage Alerts API
ObservePoint Account Usage Export API
ObservePoint Account Usage V2 API
ObservePoint Action Set Action Rules API
ObservePoint Action Set Actions API
ObservePoint Action Sets API
ObservePoint Alert Export API
ObservePoint Alert Summary Report API
ObservePoint Alerts API
ObservePoint Audit Actions API
Where this information came from

This is an independent, third-party profile of ObservePoint Web Audits API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.