Skip to Content
veriom

Preview period report

What a period report over these dates would cover, before building it.

GET
/v1/workspaces/{workspace_id}/reports/periods/preview

What a period report over these dates would cover, before building it.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Query Parameters

start*Start
Formatdate
end*End
Formatdate

Response Body

Successful Response

application/json
  1. response
audit_count*Audit Count

Completed audits in the period with a report.

Range0 <= value
available*Available

Whether the workspace's plan includes period compliance reports.

end*End
Formatdate
label*Label
latest_report_id?|

The newest period report already built for these dates.

source_count*Source Count
Range0 <= value
start*Start
Formatdate
unreadable_count*Unreadable Count

Audit reports in the period that could not be read and are left out.

Range0 <= value
Example Request
curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/reports/periods/preview?start=2019-08-24&end=2019-08-24'
Example Response
{  "audit_count": 0,  "available": true,  "end": "2019-08-24",  "label": "string",  "latest_report_id": "339520bd-e44d-4259-a4ba-1d278b054521",  "source_count": 0,  "start": "2019-08-24",  "unreadable_count": 0}