Skip to main content
Developer Compliance Exports1.0.0-beta.1

Prepare and download a Compliance export

Generates a report from saved records in the token Space and returns the downloadable file. Questionnaire responses require approval. Approved Trust request downloads require approval for the current resource. Internal review copies are distinct from approved disclosures. The response omits storage URLs and the API never fetches user-supplied external sources. The request is limited to 512 KiB and the file to 2 MB. Table reports contain only the selected columns and at most 2,000 rows.

POST/api/v1/compliance/exports

Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.

Required token scope is compliance:exports:create. Scopes are independent.

This operation uses 12 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute. The compliance bulk group shares 15 requests per token and 40 per Space each UTC hour.

Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.

Examples write successful response bytes to standard output. Redirect the output to a private file and verify the HTTP status before using it.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Path parameters

None documented.

Query parameters

None documented.

Header parameters

None documented.

Request body

application/json · Required

Select one saved report. For a table, supply the exact saved record IDs in the desired order. auditScope is accepted only for the Audit Preparation table.

type = "statement"
Object shape 2
type = "trust-security-package"
Object shape 4
type = "table"
type = "risks"

Responses

Headers on every response

X-Request-Idstring (uuid)Optional

Server-generated ID to include in a support request.

200

The audited report in its native format. Save the response body to a file.

Response headers

RateLimit-LimitintegerOptional

Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.

RateLimit-RemainingintegerOptional

Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.

RateLimit-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

Content-DispositionstringOptional

An attachment disposition with a safe filename.

application/json, text/csv, text/plain, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/octet-stream

valuearray of object | objectOptional

No field description supplied.

400

Invalid export selector, malformed JSON or unexpected query parameter.

application/json

statusCodeintegerRequired

Minimum: 400. Maximum: 599.

statusMessagestringOptional

A safe explanation suitable for display.

dataobjectRequired

No field description supplied.

401

A valid developer token is required.

Response headers

WWW-AuthenticatestringOptional

Bearer authentication challenge. A rejected token can include the invalid_token error.

application/json

Uses the same response body schema as HTTP 400.

402

An active Compliance entitlement is required.

application/json

Uses the same response body schema as HTTP 400.

403

The token lacks compliance:exports:create or its Space access has changed.

application/json

Uses the same response body schema as HTTP 400.

404

The saved record, selected revision or operation is unavailable.

application/json

Uses the same response body schema as HTTP 400.

408

The request body did not arrive within the time limit.

application/json

Uses the same response body schema as HTTP 400.

409

The selected records changed or the disclosure requires current approval.

application/json

Uses the same response body schema as HTTP 400.

413

The request or generated file exceeds the size or row limits.

application/json

Uses the same response body schema as HTTP 400.

415

The request must use application/json.

application/json

Uses the same response body schema as HTTP 400.

429

The token or Space request budget is exhausted. Edge traffic limits can also return 429.

Response headers

RateLimit-LimitintegerOptional

Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.

RateLimit-RemainingintegerOptional

Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.

RateLimit-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

Retry-AfterintegerOptional

Seconds to wait before retrying, when the limiting policy supplies a retry time. Minimum: 1.

application/json

Uses the same response body schema as HTTP 400.

503

The report or mandatory audit could not be confirmed. No file was released.

application/json

Uses the same response body schema as HTTP 400.

Was this helpful?