Get change history for a specific experience

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/change-history

Retrieves a historical log of all changes made to a specific experience. This includes modifications to its settings, variations, audiences, goals, status, etc. Provides an audit trail for the lifecycle of an experience, filterable by date and user. The Knowledge Base article "Track User Changes with Change History" details this.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to which save/retrieved data is connected

experience_id

integer

required

ID of the Experience

Body Params

Filters for retrieving the change history of a specific experience. Allows specifying date ranges, users, types of experience components changed (e.g., 'variation', 'goal', 'audience_linkage'), and methods of change.

Filter Single Experience history list.

onlyCount

boolean

If set to true in a list request, the response will only contain the total count of matching items (extra.pagination.items_count) and will not include the actual item data. Useful for quickly getting totals without fetching full datasets.

methods

array of objects | null

methods

objects

array of objects | null

objects

sort_by

string | null

enum

Defaults to timestamp

A value to sort history list by specific field(s)

Defaults to timestamp if not provided

Allowed:

variations

array of numbers | null

List of variations ids

variations

changes

array of numbers | null

List of changes ids

changes

author_id

string | null

The id of the author who made changes

expand

array of objects | null

Specifies linked objects to expand in the response, e.g., 'project'. Refer to the Expanding Fields section.

expand

results_per_page

integer | null

0 to 50

Defaults to 30

Specifies the maximum number of items to return in a single page of results. Used for pagination. Default is 30, maximum is 50.

sort_direction

string | null

enum

Defaults to desc

The direction for sorting the list results, based on the sort_by field.

asc: Ascending order (e.g., A-Z, 1-10, oldest to newest).
desc: Descending order (e.g., Z-A, 10-1, newest to oldest). Defaults to desc (newest/highest first) if not specified.

Allowed:

page

integer

≥ 1

The page number for paginated results. For example, if results_per_page is 30, page: 2 will retrieve items 31-60. Defaults to 1 if not specified.

Responses

200A log of changes made within an account or project. Each entry details the event (e.g., 'create', 'update', 'delete'), the object changed (e.g., 'experience', 'goal'), object_id, user who made the change, timestamp, and changes (old and new values).

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.