Contents

ChangeDetailsResponse

The response envelope returned by the Get Change History Detail endpoint, wrapping an array of change detail records with pagination metadata.

Declaration

object ChangeDetailsResponse

Properties

NameTypeDescription
result[ChangeDetails]

An array of ChangeDetails records. Each record contains the full field-level change history for one API entity within the transaction. Read-only.

paginationPagination

Pagination state for the response. See Pagination. Contains offset, pageSize, and totalCount. Read-only.

errorErrorMessage

Present when the request failed. See ErrorMessage. Contains error details. Read-only.

Discussion

The ChangeDetailsResponse object is the response envelope returned by the change history detail endpoints. Use pagination to navigate large transaction responses.

Example

{
  "dataType": "ChangeDetail",
  "result": [
    {
      "transactionId": "txn_abc123def456",
      "detailId": "Campaign.444555666.txn_abc123def456",
      "eventType": "UPDATE",
      "entityType": "Campaign",
      "entityId": "444555666",
      "eventTime": "2025-03-15T14:30:00.000Z",
      "userType": "CUSTOMER_API",
      "modifiedBy": "555666777",
      "entityMetaData": {
        "name": "AwayFinder - Summer App Promo"
      },
      "details": [
        {
          "transactionId": "txn_abc123def456",
          "changes": [
            {
              "field": "status",
              "oldValues": [
                "PAUSED"
              ],
              "newValues": [
                "ENABLED"
              ]
            },
            {
              "field": "dailyBudget",
              "oldValues": [
                "50.00"
              ],
              "newValues": [
                "100.00"
              ]
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "offset": 0,
    "pageSize": 50,
    "totalCount": 1
  }
}

See Also