Skip to main content
POST
/
api
/
datasets
/
{dataset_id}
/
compliance-report
Generate Dataset Compliance Report
curl --request POST \
  --url https://api.example.com/api/datasets/{dataset_id}/compliance-report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  }
}
'
{
  "report_id": "<string>",
  "generated_at": "2023-11-07T05:31:56Z",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "bytes_estimate": 0,
  "download_url": "<string>",
  "preview": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

dataset_id
string
required

Cookies

antidote_session
string | null

Body

application/json
format
enum<string>
required
Available options:
json,
pdf,
csv
depth
enum<string>
required
Available options:
summary,
detailed,
exhaustive
compliance_standard
enum<string>
required
Available options:
soc2,
iso27001,
hipaa,
gdpr
time_range
ComplianceTimeRange · object
required

Response

Successful Response

report_id
string
required
format
enum<string>
required
Available options:
json,
pdf,
csv
depth
enum<string>
required
Available options:
summary,
detailed,
exhaustive
compliance_standard
enum<string>
required
Available options:
soc2,
iso27001,
hipaa,
gdpr
status
enum<string>
required
Available options:
queued,
ready
generated_at
string<date-time>
required
time_range
ComplianceTimeRange · object
required
dataset_id
string | null
dataset_name
string | null
bytes_estimate
integer
default:0
download_url
string | null
preview
Preview · object