Changelogs

A changelog represents a creation, update, or deletion of a model such as Flow, Entity, or Field. Every change made will log the exact difference between the previous revision and the current one, as well as what user was logged in and what account the change was made on. Contained within the changelog is the full revision of the model changed at the state after the change was applied, as well as the differences between the previous revision and current revision.

Changelog

id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of this Change Log

action
required
string

Action performed: create, update, delete

Enum: "create" "update" "delete"
required
Array of objects (Change)

An object representing the normalization of the delta object

required
object
required
object

An object representing the difference between the previous revision and the latest revision of the model

type
required
string

The type of resource that was changed.

Enum: "flow" "entity" "field" "report"
object (User)

User information. This will only be present if the user was signed in when the changes were made

created_at
required
string <date-time>

Read-only time the Change Log was created

{
  • "id": "string",
  • "action": "create",
  • "changes": [
    • {
      • "action": "create",
      • "target": "string",
      • "delta_path": "string",
      • "previous": {
        • "value": "string"
        }
      }
    ],
  • "current_revision": { },
  • "delta_from_last_revision": { },
  • "type": "flow",
  • "user": {
    • "id": "string",
    • "api_key": "2f1d5f29915b866c7a2fa5de29613104",
    • "first_name": "string",
    • "last_name": "string",
    • "email": "string"
    },
  • "created_at": "2020-11-23T11:41:52Z"
}

List all changelogs

Get the list of all changelogs.

SecurityAPIKey
Responses
200

OK

get/changelogs
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "action": "create",
    • "changes": [
      • {
        • "action": "create",
        • "target": "string",
        • "delta_path": "string",
        • "previous": {
          • "value": "string"
          }
        }
      ],
    • "current_revision": { },
    • "delta_from_last_revision": { },
    • "type": "flow",
    • "user": {
      • "id": "string",
      • "api_key": "2f1d5f29915b866c7a2fa5de29613104",
      • "first_name": "string",
      • "last_name": "string",
      • "email": "string"
      },
    • "created_at": "2020-11-23T11:41:52Z"
    }
]
Get a changelog
Returns the changelog matching the specified ID


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the changelog to get


 
Responses 
200
OK


get/changelog/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "action": "create",
  • "changes": [
    • {
      • "action": "create",
      • "target": "string",
      • "delta_path": "string",
      • "previous": {
        • "value": "string"
        }
      }
    ],
  • "current_revision": { },
  • "delta_from_last_revision": { },
  • "type": "flow",
  • "user": {
    • "id": "string",
    • "api_key": "2f1d5f29915b866c7a2fa5de29613104",
    • "first_name": "string",
    • "last_name": "string",
    • "email": "string"
    },
  • "created_at": "2020-11-23T11:41:52Z"
}
List changes to a Flow
Lists all the changes made to a flow


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the flow


 
Responses 
200
OK


get/flows/{id}/changelogs
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "action": "create",
    • "changes": [
      • {
        • "action": "create",
        • "target": "string",
        • "delta_path": "string",
        • "previous": {
          • "value": "string"
          }
        }
      ],
    • "current_revision": { },
    • "delta_from_last_revision": { },
    • "type": "flow",
    • "user": {
      • "id": "string",
      • "api_key": "2f1d5f29915b866c7a2fa5de29613104",
      • "first_name": "string",
      • "last_name": "string",
      • "email": "string"
      },
    • "created_at": "2020-11-23T11:41:52Z"
    }
]