Changelogs

Query tenant change history.

Retrieving logs

get

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

Retrieves a paginated list of changes for the tenant. Results are ordered by occurrence time.

Filter results with the standard q query parameter. Supported fields:

• entity — Entity type, for example order, customer, company, product, segment, group, group-assignment, coupon, or a custom entity created with the Schema Service.
• entityId — Document identifier. Requires entity.
• type — Change type. Possible values: create, update, delete.
• actor — Actor display name. Supports exact match, glob patterns such as John*, and regex such as actor:~^sys. Special values: system, unknown.
• occurredAt — Time range, for example occurredAt:(>"2026-06-01T00:00:00.000Z" AND <"2026-06-30T23:59:59.999Z").
• related.entity / related.entityId — Related-entity filters. Alternatively use related:elemMatch(entity:<type> entityId:<id>).
• compoundLogicalQuery — Nested OR / AND expressions.

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

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. An occurredAt only inside an OR arm does not disable the default window.

Required scopes

This endpoint requires the following scopes:

• : Needed to retrieve changelog history.
• : Needed to manage changelog resources. Also grants read access.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Query parameters

qstringOptional

Standard query parameter used to filter changed entries.

Supported fields:

• entity — Entity type, for example q=entity:order.
• entityId — Document identifier. Requires entity, for example q=entity:order entityId:6a2bce93592855a33518fc2f.
• type — Change type (create, update, or delete), for example q=type:update.
• actor — Actor display name. Exact match: q=actor:system. Glob: q=actor:John*. Regex: q=actor:~^sys.
• occurredAt — Time range, for example q=occurredAt:(>"2026-06-01T00:00:00.000Z" AND <"2026-06-30T23:59:59.999Z").
• related.entity / related.entityId — Related-entity filters, for example q=related.entity:group related.entityId:1gr5e52e-6e27-4ac5-9471-2467d3fb7501.
• related:elemMatch(...) — ElemMatch syntax, for example q=related:elemMatch(entity:group entityId:1gr5e52e-6e27-4ac5-9471-2467d3fb7501).
• compoundLogicalQuery — Nested OR / AND expressions, for example q=compoundLogicalQuery:((entity:group type:update) OR (related:elemMatch(entity:group))).

See also Query Parameter.

Example: entity:order entityId:6a2bce93592855a33518fc2f

pageinteger · min: 1Optional

Page number to be retrieved. The number of the first page is 1.

Default: 1

sizeinteger · min: 1 · max: 100Optional

Number of changed entries to be retrieved per page. Maximum value is 100.

Default: 20

Responses

200

The request was successful. A paginated list of changed entries has been returned.

application/json

Paginated tenant changelog history.

pageintegerRequired

Current page number. The number of the first page is 1.

sizeintegerRequired

Number of items requested per page.

totalElementsinteger · int64Required

Total number of changed entries matching the query.

totalPagesintegerRequired

Total number of pages for the matching result set.

400

Bad Request. The page, size, or q parameter is invalid.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

500

Internal Server Error.

application/json

get/changelog/{tenant}/changelogs

GET /changelog/{tenant}/changelogs HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "items": [
    {
      "at": "2026-06-01T13:01:29.123Z",
      "type": "update",
      "entity": "order",
      "entityId": "6a2bce93592855a33518fc2f",
      "paths": {
        "status": {
          "before": "CREATED",
          "after": "CONFIRMED"
        }
      },
      "schemaVersion": "v2",
      "actor": "John Doe"
    }
  ],
  "page": 1,
  "size": 20,
  "totalElements": 1,
  "totalPages": 1
}