Retrieve the history (audit log) events recorded for one specific entity instance.

get

https://api.bluestonepim.com/history/history/{entityType}/{id}

Returns a paginated list of history events for the entity identified by entityType and id, optionally narrowed with the query parameters below.
Use GET /history/{entityType} to list events for all entities of that type instead of one id, or GET /history/{entityType}/{id}/count to get just the number of matching events.
An entityType or id that doesn't exist isn't an error: the result is simply an empty list.
For restricted users, only entityType PRODUCT, CATEGORY, or RULES_ENGINE can be queried, and only for entities within the user's assigned policies; anything else fails with no access to the entity.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityType

string

required

length ≥ 1

The type of the entity to retrieve history for, e.g. PRODUCT, CATEGORY, or ORGANIZATION, as recorded by the service that produced the event.

string

required

length ≥ 1

The id of the specific entity instance to retrieve history for (the product, category, etc. whose changes are being looked up).

Query Params

page

int32

≥ 0

A number sequence representing a block of items to return as a result set.

pageSize

int32

1 to 1000

Size of a block of items to return. It corresponds with the page parameter.

eventType

string

Filters to events of this type, e.g. CREATE, UPDATE, DELETE, ASSOCIATE, or DISASSOCIATE depending on the service that produced the event; not validated against a fixed list.

field

string

Filters to events that changed this specific attribute/field of the entity, matching the field name shown in the event's metadata.

origin

string

Filters to events produced by this originating service, e.g. bluestone-pim, bluestone-tasks, or bluestone-labels.

userId

string

Filters to events performed by this user id.

fromTime

int64

Only includes events at or after this time, in epoch milliseconds.

toTime

int64

Only includes events at or before this time, in epoch milliseconds.

eventId

string

Accepted but currently has no effect on the results - do not rely on it to fetch a single event.

metadataEntityId

string

Filters to events whose metadata references this related entity id (e.g. a category or attribute referenced by a product change), distinct from the entity identified by the id path parameter.

context

string

Filters to events in this context, e.g. 'en'; matches the context field on the event.

Responses

200OK

400Bad Request This response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.