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

APIs for managing audits

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

This API exposes 11 operations across 9 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0.

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

11 operations 9 paths 31 schemas 6 GET2 PATCH2 POST1 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 Management 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 11

Across 9 paths, the API surfaces 11 operations — 6 GET, 2 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

audits-management 11

APIs for managing audits

GET
/v3/web-audits
Get list of web audits
getWebAudits → 200401403
GET
/v3/web-audits/latest-runsdeprecated
Get latest runs for web audits
getWebAuditLatestRuns 1 param → 200400401403
PATCH
/v3/web-audits/undelete
Undelete a web audit
undeleteWebAudit body → 200400401403
GET
/v3/web-audits/{auditId}
Get audit notes by ID
getWebAuditNotes 1 param → 200401403404
PUT
/v3/web-audits/{auditId}
Update audit notes
updateWebAuditNotes 1 param body → 200400401403404
POST
/v3/web-audits/{auditId}/runs
run audit now
runAuditNow 1 param body → 201400401403
GET
/v3/web-audits/{auditId}/runs/{runId}/info
Get audit configuration info for specified audit run
getAuditRunInfo 3 params → 200400401403404
GET
/v3/web-audits/{auditId}/consent-categories
Get all the consent categories assigned to an audit
getAuditConsentCategories 1 param → 200401403404
PATCH
/v3/web-audits/{auditId}/consent-categories
Update the consent categories assigned to an audit
patchAuditConsentCategories 1 param body → 200401403404
GET
/v3/web-audits/{auditId}/runs/{runId}/consent-categories
Retrieve all consent categories snapshots that are applied to a specific audit run.
getAuditRunConsentCategories 2 params → 200401403404
POST
/v3/web-audits/{auditId}/runs/{runId}/consent-categories/reprocess
Reprocess consent-category for the selected auditId and runIds
reprocessConsentCategories 2 params → 200401403

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are AuditRun_ConfigurationInfoResponseDTO (25 properties), ConsentCategoryDTO (8 properties), WebAuditDTO (7 properties), AuditRun_RunNowRequestDTO (7 properties). Each schema is shown below with its type and property counts.

AuditRun_SitemapData
object
Data about sitemaps that were discovered and visited by the audit
4 properties
LatestRunItemDTO
object
Latest run information for an audit
5 properties 4 required
AuditId
integer
UndeleteWebAuditResponse
object
6 properties 2 required
AttachmentPatchDocument_ItemDTO
object
A JSONPatch document for modifying consent preference attachments
3 properties
AuditRun_RunNowRequestDTO
object
7 properties 3 required
WebAuditDTO
object
Web audit information
7 properties 4 required
Label
object
DTO for Labels
2 properties 2 required
WebAudit_ConsentCategorySnapshots_ResponseDTO
object
NOTE: For individual consent category snapshot, Field consentCategoryId is omitted when the consent category is deleted
1 property
ConsentCategory_TypeEnum
string
LabelId
integer
Label identifier
ConsentCategorySnapshotDTO
object
A consent category snapshot dto
6 properties 5 required
WebAudit_ConsentCategories_ResponseDTO
object
1 property 1 required
ConsentCategory_Cmp_Data
object
6 properties 4 required
UndeleteFailureCode
string
AttachmentPatchDocument_RequestDTO
array
RunInfoDTO
object
Run execution information
3 properties 1 required
ConsentCategoryDTO
object
8 properties
DomainInfoDTO
object
Domain information
2 properties 2 required
AuditRun_ConfigurationInfoResponseDTO
object
25 properties 23 required
GhAppNameEnum
string
Allowed GitHub App names for installation
ConsentCategory_VendorTypeEnum
string
UndeleteStatus
string
RunId
integer
ConsentCategoryId
integer
ID of consent category
AuditRun_SitemapDataItem
object
2 properties 2 required
ErrorModel
object
4 properties
ConsentCategorySnapshotId
integer
Use in filtering purposes is DEPRECATED in favour of ConsentCategoryId! Snapshot Id of consent category attached to this run
ConsentCategory_updatedType
string
AuditNotesDTO
object
Audit notes information
2 properties
UndeleteWebAuditRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-audits-management-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 Management 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.