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 Audits API

Endpoints for managing audits including creation, configuration, execution, and retrieving audit results and runs

ObservePoint 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 Audits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 21 operations across 12 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0.

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

21 operations 12 paths 42 schemas 3 DELETE11 GET3 POST4 PUT

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 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 21

Across 12 paths, the API surfaces 21 operations — 3 DELETE, 11 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Audits 21

Endpoints for managing audits including creation, configuration, execution, and retrieving audit results and runs

GET
/web-audits
Get list of all web audits
getAllWebAudits 2 params → 200401
POST
/web-audits
Create new web audit
createWebAudit body → 201401404
GET
/web-audits/frequencies
Get list of all frequencies
getWebAuditAvailableFrequencies → 200401
GET
/web-audits/locations
Get list of all available locations
getWebAuditAvailableLocations → 200401
GET
/web-audits/user-agents
Get list of all available user agents
getWebAuditAvailableUserAgents → 200401
GET
/web-audits/{auditId}/labels
Get audit labels
getAuditLabels 1 param body → 200401404
PUT
/web-audits/{auditId}/labels
Create audit labels
createAuditLabels 1 param body → 200401404
DELETE
/web-audits/{auditId}/labels
Delete web audit labels
deleteWebAuditLabels 1 param body → 200204404
GET
/web-audits/{webAuditId}
Get web audit
getWebAudit 3 params → 200401404
PUT
/web-audits/{webAuditId}
Update web audit
updateWebAudit 1 param body → 200401404422
DELETE
/web-audits/{webAuditId}
Delete web audit
deleteWebAudit 1 param → 204401404423
GET
/web-audits/{webAuditId}/filters
Get web audit filters
getWebAuditFilters 1 param → 200401404
PUT
/web-audits/{webAuditId}/filters
Update web audit filters
updateWebAuditFilters 1 param body → 200401404422
GET
/web-audits/{webAuditId}/rules
Get web audit rules
getWebAuditRules 1 param → 200401404
PUT
/web-audits/{webAuditId}/rules
Update web audit rules
updateWebAuditRules 1 param body → 200401404
GET
/web-audits/{webAuditId}/runs
Get all available audit runs
getRuns 1 param → 200401404
POST
/web-audits/{webAuditId}/runs
Request audit run creation
runAuditNow 1 param → 200202401404
POST
/web-audits/{webAuditId}/runs/current/finish
Stop and finish the currently running audit
finishActiveAuditRun 1 param → 204401403404409
GET
/web-audits/{webAuditId}/runs/{runId}
Get specified audit run
getRun 2 params → 200401404
DELETE
/web-audits/{webAuditId}/runs/{runId}
Stop and discard audit run
stopAuditRun 2 params → 204401
GET
/web-audits/{webAuditId}/runs/{runId}/pages/{pageId}/rule-results
Get rule results for page
getPageRuleResults 3 params → 200401404

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are UserContext (24 properties), Audit (23 properties), LocalDateTime (20 properties), AuditOptions (18 properties). Each schema is shown below with its type and property counts.

RuleDescription
object
8 properties 7 required
AuditOptions
object
18 properties 6 required
SnowflakeUsage
object
9 properties 9 required
AuditRunWithRuleFailurePresence
object
14 properties 12 required
AuditFilters
object
2 properties 2 required
WritableItemSchedule
object
5 properties 4 required
Value
object
UserContext
object
24 properties 22 required
IncludeFilter
object
2 properties 2 required
PageRuleResultsSummary
object
4 properties 4 required
NewAudit
object
10 properties 5 required
AuditRunSwaggerReference
object
12 properties 8 required
CheckTimesResult
object
2 properties 2 required
Label
object
2 properties 2 required
AccountCapabilities
object
3 properties 3 required
RuleResultTag
object
2 properties 2 required
DurationFieldType
object
1 property 1 required
PageRuleResult
object
6 properties 5 required
Function1RequestContextFutureRouteResult
object
TagVariableResult
object
9 properties 2 required
FeatureWhichCanBeSupportedByAuditRun
object
1 property 1 required
AuthToken
object
5 properties 5 required
Chronology
object
1 property 1 required
LocalDateTime
object
20 properties 20 required
DateTimeZone
object
2 properties 2 required
PageRuleResults
object
2 properties 2 required
TokenType
object
Location
object
4 properties 4 required
RemoteFileMapping
object
10 properties 2 required
UserAgent
object
2 properties 2 required
PageTagResult
object
3 properties 2 required
CustomHttpHeaderAssignment
object
2 properties 2 required
Audit
object
Web audit model
23 properties 13 required
PageRuleResultTag
object
5 properties 3 required
Permissions
object
2 properties 2 required
DurationField
object
5 properties 5 required
DateTimeFieldType
object
3 properties 3 required
PageFilterResult
object
4 properties 2 required
SeqObject
object
2 properties 2 required
AuditUpdate
object
12 properties 6 required
ItemIsRunningApiError
object
3 properties 3 required
DateTimeField
object
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-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 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.