Security, Privacy, AI and CSR information for all Piano products now lives in one place. Explore our Compliance Center.
Audience
English French
English French

/persisted/history

Read what each change to a persisted request changed. Every create, update and delete of a persisted request adds one entry, and each entry lists the fields that differ from the previous version. The format follows /segment/history. See API authentication for more information about persisted requests.

Request

The request object has the following fields:

Name

Type

Required

Description

id

String

Yes

Identifier for the persisted request.

orderBy

String

No

Order of the entries by time: asc (oldest first, the default) or desc.

Response

The response object has the following fields:

Name

Type

Description

changes

Array of Object

The entries, one for each recorded save.

Each entry has the following fields:

Name

Type

Description

time

String

The time of the change, as an ISO-8601 UTC timestamp.

username

String

User name of the user who made the change.

changes

Array of Object

The changes made by this save.

Each change has the following fields:

Name

Type

Description

type

String

Type of change: PATH, REQUEST, MUTABLE, DESCRIPTION, USER, NO_CHANGES or DELETED_BY.

oldValue

String

The value before the change, or null if the field had no value.

newValue

String

The value after the change, or null if the field has no value anymore.

  • REQUEST and MUTABLE hold the JSON as text. They are compared as JSON, so a different key order is not a change.

  • USER is the owner.

  • NO_CHANGES is the only change of a save that did not change any field. Its values are null.

  • DELETED_BY is the only change of the last entry of a deleted persisted request. newValue is the user who deleted it.

  • The first entry of a persisted request that was created before the history was introduced is left out, because there is no earlier version to compare it with. Its next change is shown as usual.

Examples

Bash
$ python cx.py /persisted/history '{"id":"58e5154490191e5ca6b941ee56f6e7349b9d2fe1"}'
{
 "changes": [
 {
 "time": "2026-10-01T09:12:00.000Z",
 "username": "user@example.com",
 "changes": [
 {"type": "PATH", "oldValue": null, "newValue": "/site"},
 {"type": "REQUEST", "oldValue": null, "newValue": "{\"siteId\":\"9222300742735526873\"}"},
 {"type": "DESCRIPTION", "oldValue": null, "newValue": "Example persisted"},
 {"type": "USER", "oldValue": null, "newValue": "user@example.com"}
 ]
 },
 {
 "time": "2026-10-12T14:30:00.000Z",
 "username": "admin@example.com",
 "changes": [
 {"type": "DESCRIPTION", "oldValue": "Example persisted", "newValue": "Changed description"}
 ]
 },
 {
 "time": "2026-10-13T10:00:00.000Z",
 "username": "admin@example.com",
 "changes": [
 {"type": "DELETED_BY", "oldValue": null, "newValue": "admin@example.com"}
 ]
 }
 ]
}

Last updated: