Contents

AuditSummaryResponse

The response envelope returned by the Query Change History endpoint, wrapping an array of audit summary rows with pagination metadata.

Declaration

object AuditSummaryResponse

Properties

NameTypeDescription
result[AuditSummary]

The array of AuditSummary rows matching the query. Each row represents one transaction grouping. Read-only.

paginationPagination

Pagination state for the response. See Pagination. Contains offset, pageSize, and totalCount. totalCount is 0 when you set needTotals to "false" in the request options, which avoids a costly COUNT query. Read-only.

errorErrorMessage

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

Discussion

The AuditSummaryResponse object is the response envelope returned by POST /v1/change-history/query (Query Change History). The result array contains one AuditSummary row per unique (userType, modifiedBy, transactionId, eventType, entityType) combination matching the query filters.

Use pagination to navigate large result sets.

Example

{
  "dataType": "AuditSummary",
  "result": [
    {
      "transactionId": "txn_abc123def456",
      "eventType": "UPDATE",
      "eventTime": "2025-03-15T14:30:00.000Z",
      "entityType": "Campaign",
      "count": 2,
      "metas": [],
      "userType": "CUSTOMER_API",
      "modifiedBy": "555666777"
    },
    {
      "transactionId": "txn_def789ghi012",
      "eventType": "CREATE",
      "eventTime": "2025-03-10T09:15:00.000Z",
      "entityType": "AdGroup",
      "count": 1,
      "metas": [],
      "userType": "CUSTOMER",
      "modifiedBy": "123456789"
    }
  ],
  "pagination": {
    "offset": 0,
    "pageSize": 50,
    "totalCount": 2
  }
}

See Also