Skip to Content
veriom

Build period report

Build one compliance report over every audit completed in a month or range. The report is a draft revision like any other: build, draft, approve and export it in the report studio. Each audit keeps its own report.

POST
/v1/workspaces/{workspace_id}/reports/periods

Build one compliance report over every audit completed in a month or range.

The report is a draft revision like any other: build, draft, approve and export it in the report studio. Each audit keeps its own report.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Request Body

application/json
  1. body
end*End

Last day of the period, inclusive.

Formatdate
start*Start

First day of the period.

Formatdate

Response Body

Successful Response

application/json
  1. response
approved_at*|null
approved_by*|null
audit_id*Audit Id
Formatuuid
compliance_control_count?Compliance Control Count
Range0 <= value
Default0
confirmed_findings?Confirmed Findings

Findings confirmed as architecturally relevant.

Range0 <= value
Default0
created_at*Created At
Formatdate-time
diagnostic_count?Diagnostic Count
Range0 <= value
Default0
finding_dispositions?
history_change_count?History Change Count
Range0 <= value
Default0
id*Id
Formatuuid
impact_review_status?Impact Review Status

Whether every observation has an architectural conclusion.

Default"complete"
Value in"complete""incomplete""not_started"
kind?Kind

period covers every audit completed in a date range; audit_id is then the latest of them. audit is one audit's report.

Default"audit"
Value in"audit""period"
needs_investigation?Needs Investigation

Scanner observations with no evidence-backed architectural conclusion yet: reviewed without a conclusion, not reached by the review, or awaiting it.

Range0 <= value
Default0
period?|null
published_at?|

When the report was published in the app, automatically as its audit completed. Approval (approved_at) stays a person's attestation.

revision*Revision
status*Status
taxonomy_snapshot_id*|null
workspace_id*Workspace Id
Formatuuid
Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/reports/periods' \  -H 'Content-Type: application/json' \  -d '{  "end": "2019-08-24",  "start": "2019-08-24"}'
Example Response
{  "approved_at": "2019-08-24T14:15:22Z",  "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",  "audit_id": "78c04fa6-cfb4-46a0-9aa5-3681ba4f3897",  "compliance_control_count": 0,  "confirmed_findings": 0,  "created_at": "2019-08-24T14:15:22Z",  "diagnostic_count": 0,  "finding_dispositions": {    "property1": 0,    "property2": 0  },  "history_change_count": 0,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "impact_review_status": "complete",  "kind": "audit",  "needs_investigation": 0,  "period": {    "audit_count": 0,    "end": "2019-08-24",    "label": "string",    "source_count": 0,    "start": "2019-08-24"  },  "published_at": "2019-08-24T14:15:22Z",  "revision": 0,  "status": "string",  "taxonomy_snapshot_id": "487bda72-1129-4a41-8441-bc24f9e8006b",  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"}