Skip to main content
GET
/
api
/
compliance
/
activity-timeline
/
detail
Get Compliance Activity Timeline Detail
curl --request GET \
  --url https://api.example.com/api/compliance/activity-timeline/detail \
  --header 'Authorization: Bearer <token>'
{
  "generated_at": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "bucket_start": "2023-11-07T05:31:56Z",
  "bucket_end": "2023-11-07T05:31:56Z",
  "highest_severity": "none",
  "critical_count": 0,
  "high_count": 0,
  "total_count": 0,
  "affected_dataset_count": 0,
  "datasets": [
    {
      "dataset_id": "<string>",
      "dataset_name": "<string>",
      "highest_severity": "none",
      "total_count": 0,
      "critical_count": 0,
      "high_count": 0,
      "events": [
        {
          "id": "<string>",
          "event_type": "<string>",
          "summary": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "category": "activity",
          "actor": "<string>",
          "dataset_id": "<string>",
          "dataset_name": "<string>",
          "scan_id": "<string>",
          "scan_type": "<string>",
          "scan_status": "<string>",
          "severity": "low",
          "critical": false,
          "details": {}
        }
      ]
    }
  ]
}

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

Query Parameters

bucket_start
string<date-time>
required

ISO timestamp marking the bucket start.

bucket_end
string<date-time>
required

ISO timestamp marking the bucket end.

dataset_ids
string[] | null

Optional dataset UUIDs to scope the detail to a subset of datasets.

timezone
string | null
default:UTC

IANA timezone name used for labeling the selected bucket.

Cookies

antidote_session
string | null

Response

Successful Response

generated_at
string<date-time>
required
timezone
string
required
bucket_start
string<date-time>
required
bucket_end
string<date-time>
required
highest_severity
enum<string>
default:none
Available options:
critical,
high,
medium,
low,
none
critical_count
integer
default:0
high_count
integer
default:0
total_count
integer
default:0
affected_dataset_count
integer
default:0
datasets
ComplianceActivityTimelineDatasetGroup · object[]