Activity and monitoring API

On this page

Read the audit trail, AI costs, background tasks, and notifications. See Audit logs.

Paths are relative to https://<your-atlas-host>/api/v1. For the API key and headers every request needs, see Authentication.

Scroll horizontally to see the full table.

Endpoint	What it does
GET /audit/	List audit log entries for your organization
GET /audit/{audit_log_id}	Get a single audit log entry by id
GET /costs/summary	Headline cost totals (LLM/warehouse split, MoM delta) for the window
GET /costs/events	Raw cost events for the window (for export / drill-down)
GET /task-executions/	List background task executions
GET /task-executions/{execution_id}	Get a background task execution, with its status and result
GET /notifications/	List notifications for the authenticated user
GET /notifications/unread-count	Get unread notification count for the authenticated user
POST /notifications/{notification_id}/read	Mark a notification as read
POST /notifications/read-all	Mark all notifications as read for the authenticated user
GET /notifications/preferences	Get notification channel preferences
PATCH /notifications/preferences	Update a notification channel preference

List audit logs

GET /audit/

List audit log entries for your organization.

Parameters

Scroll horizontally to see the full table.

Name	In	Type
`event_type`	query	string
`actor_type`	query	string
`status`	query	string
`actor_id`	query	UUID
`resource_type`	query	string
`resource_id`	query	UUID
`time_from`	query	datetime
`time_to`	query	datetime
`limit`	query	integer
`offset`	query	integer

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`event_type`	string
`actor_type`	string
`actor_id`	UUID
`resource_type`	string
`resource_id`	UUID
`resource_name`	string
`details`	object
`ip_address`	string
`user_agent`	string
`request_id`	string
`created_at`	datetime

Get audit log

GET /audit/{audit_log_id}

Get a single audit log entry by id.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`audit_log_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`event_type`	string
`actor_type`	string
`actor_id`	UUID
`resource_type`	string
`resource_id`	UUID
`resource_name`	string
`details`	object
`ip_address`	string
`user_agent`	string
`request_id`	string
`created_at`	datetime

Cost summary

GET /costs/summary

Headline cost totals (LLM/warehouse split, MoM delta) for the window.

Parameters

Scroll horizontally to see the full table.

Name	In	Type
`since`	query	datetime
`until`	query	datetime

Response

Scroll horizontally to see the full table.

Field	Type
`total_usd`	string
`llm_usd`	string
`dwh_usd`	string
`prev_total_usd`	string
`mom_delta_pct`	number
`event_count`	integer
`unknown_count`	integer
`pricing_version`	string

Cost events

GET /costs/events

Raw cost events for the window (for export / drill-down).

Parameters

Scroll horizontally to see the full table.

Name	In	Type
`since`	query	datetime
`until`	query	datetime
`limit`	query	integer
`offset`	query	integer

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`created_at`	datetime
`kind`	string
`cost_usd`	string
`units`	string
`unit_type`	string
`label`	string
`actor_label`	string
`workspace_id`	UUID
`source_type`	string
`source_id`	UUID
`attributes`	object

List task executions

GET /task-executions/

List background task executions.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Description
`task_type`	query	string	Kind of job, exact match, such as `datasource.sync` or `automation.run`.
`status`	query	string	`pending`, `running`, `waiting`, `completed`, `failed`, `timed_out`, `cancelled`, or `dlq` (retries used up).
`workspace_id`	query	UUID
`limit`	query	integer
`offset`	query	integer

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`task_type`	string
`idempotency_key`	string
`workspace_id`	UUID
`status`	string
`attempt`	integer
`max_attempts`	integer
`next_retry_at`	datetime
`started_at`	datetime
`completed_at`	datetime
`timeout_seconds`	integer
`pending_timeout_seconds`	integer
`progress_total`	integer
`progress_completed`	integer
`error_message`	string
`error_type`	string
`metadata`	object
`created_at`	datetime
`updated_at`	datetime

Get task execution

GET /task-executions/{execution_id}

Get a background task execution, with its status and result.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`execution_id`	path	UUID	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`task_type`	string
`idempotency_key`	string
`workspace_id`	UUID
`status`	string
`attempt`	integer
`max_attempts`	integer
`next_retry_at`	datetime
`started_at`	datetime
`completed_at`	datetime
`timeout_seconds`	integer
`pending_timeout_seconds`	integer
`progress_total`	integer
`progress_completed`	integer
`error_message`	string
`error_type`	string
`metadata`	object
`created_at`	datetime
`updated_at`	datetime

List notifications

GET /notifications/

List notifications for the authenticated user.

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`notification_type`	string
`title`	string
`body`	string
`data`	object
`link`	string
`read`	boolean
`read_at`	datetime
`created_at`	datetime

Get the unread notification count

GET /notifications/unread-count

Get unread notification count for the authenticated user.

Response

The raw file content.

Mark a notification read

POST /notifications/{notification_id}/read

Mark a notification as read.

Parameters

Scroll horizontally to see the full table.

Name	In	Type	Required
`notification_id`	path	UUID	Yes

Response

The raw file content.

Mark all notifications read

POST /notifications/read-all

Mark all notifications as read for the authenticated user.

Response

The raw file content.

Get notification preferences

GET /notifications/preferences

Get notification channel preferences.

Response A list of objects:

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`notification_type`	string
`channel`	string
`enabled`	boolean

Update a notification preference

PATCH /notifications/preferences

Update a notification channel preference.

Request body

Scroll horizontally to see the full table.

Field	Type	Required
`notification_type`	string	Yes
`channel`	string	Yes
`enabled`	boolean	Yes

Response

Scroll horizontally to see the full table.

Field	Type
`id`	UUID
`notification_type`	string
`channel`	string
`enabled`	boolean

What’s next?

API overview: authentication, worked examples, and error handling
Webhooks: get events pushed to your systems instead of polling
Service accounts: create the key an integration uses