Audit Logs (Changelog) Tutorial

The Audit Logs (Changelog) Service exposes a query API for tenant-wide change history of platform entities such as orders, customers, companies, products, segments, groups, coupons, and custom entities created with the Schema Service.

This functionality is in preview mode - some of the features may not be fully operational yet.

If you have any questions, contact the Emporix Support Team or post directly in the Community

Authentication

Request a service access token with one of these scopes:

• changelog.changelog_read
• changelog.changelog_manage

See Tokens and Scopes and the OAuth Service.

How to retrieve logs

Send a request to the Retrieving logs endpoint.

To test the endpoint, open the API reference or check the example of a curl request.

API Reference

curl -L \
  --request GET \
  --url 'https://api.emporix.io/changelog/{tenant}/changelogs?page=1&size=20' \
  --header 'Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}'

Pagination uses page (1-based, default 1) and size (default 20, maximum 100). Results are ordered by occurrence time.

When the query omits a conjunctive occurredAt from-bound, the API applies a default trailing window of 30 days. Pass an explicit top-level or AND occurredAt range to override it.

How to filter by entity and document ID

Scope history to a single document with entity and entityId in the q parameter. There is no path-based history endpoint.

curl -L \
  --request GET \
  --url 'https://api.emporix.io/changelog/{tenant}/changelogs?q=entity:order%20entityId:6a2bce93592855a33518fc2f&page=1&size=20' \
  --header 'Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}'

How to filter by change type, actor, and time

Supported q fields include:

Field	Example
type	type:update
actor	actor:system, actor:John*, actor:~^sys
occurredAt	occurredAt:(>"2026-06-01T00:00:00.000Z" AND <"2026-06-30T23:59:59.999Z")

curl -L \
  --request GET \
  --url 'https://api.emporix.io/changelog/{tenant}/changelogs?q=entity:order%20type:update%20actor:system&page=1&size=20' \
  --header 'Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}'

Possible type values are create, update, and delete.

How to query related entities

Find changed entries that reference another entity, for example group-assignment entries related to a group:

curl -L \
  --request GET \
  --url 'https://api.emporix.io/changelog/{tenant}/changelogs?q=related.entity:group%20related.entityId:1gr5e52e-6e27-4ac5-9471-2467d3fb7501&page=1&size=20' \
  --header 'Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}'

You can also use elemMatch syntax or compound logical queries:

curl -L \
  --request GET \
  --url 'https://api.emporix.io/changelog/{tenant}/changelogs?q=compoundLogicalQuery:((entity:group%20type:update)%20OR%20(related:elemMatch(entity:group)))&page=1&size=20' \
  --header 'Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}'

For general q syntax, see Query Parameter.