Audit log#

Query audit log entries to track changes made across your organization.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/audit-log#

List audit log entries with structured filtering. Use entityType to filter by category (e.g. "creator", "campaign", "activity") and action to filter by what happened (e.g. "created", "deleted", "updated", "linked"). This is the preferred action for questions like "show creator entries" or "show deletions".

bash
GET /v1/audit-log?page_index=0&page_size=25&organization_id=org_123
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
pageIndexintegerRequiredZero-based page index for pagination.
pageSizeintegerRequiredNumber of items per page (1-100).
organizationIdstring (UUID)RequiredOrganization identifier.
searchTermstringFree-text search term to filter results (max 200 characters).
sortBystringColumn name to sort by.
sortDirection'asc' | 'desc'Sort direction: ascending or descending.
entityType'activity' | 'campaign' | 'creator' | 'conversion' | 'conversion_source' | 'campaign_activity' | 'activity_creator' | 'cost' | 'note' | 'organization' | 'user'Filter by entity type.
entityIdstring (UUID)Filter by specific entity identifier.
action'created' | 'updated' | 'deleted' | 'linked' | 'unlinked' | 'refreshed' | 'attributed' | 'restored'Filter by action type.
relatedActivityIdstring (UUID)Filter by related activity.
relatedCampaignIdstring (UUID)Filter by related campaign.
relatedCreatorIdstring (UUID)Filter by related creator.
startDatestring (ISO 8601) | nullStart of the date range filter.
endDatestring (ISO 8601) | nullEnd of the date range filter.

Response#

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.auditLog.list(params)

GET /v1/audit-log/search#

Search audit log entry content using full-text matching across names, titles, and descriptions inside changes and metadata. Use this when looking for specific text in the data values, e.g. a creator name or activity title. Do NOT use this to filter by entity type or action — use list-audit-log with entityType/action filters instead.

bash
GET /v1/audit-log/search?organization_id=org_123&query=...&page_index=0&page_size=25
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
querystringRequiredFull-text search query (1-500 characters).
pageIndexintegerRequiredZero-based page index.
pageSizeintegerRequiredNumber of items per page (1-100).
startDatestring (ISO 8601) | nullStart of the date range filter.
endDatestring (ISO 8601) | nullEnd of the date range filter.

Response#

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.auditLog.search(params)

GET /v1/audit-log/:id#

Retrieve a single audit log entry by ID.

bash
GET /v1/audit-log/:id
Authorization: Bearer {token}

Parameters#

NameTypeRequiredDescription
idstring (UUID)RequiredAudit log entry identifier.

Response#

Returns { data } with the result.

Underlying SDK method: bw.auditLog({ id })