Get Change History Detail

Retrieve field-level before and after values for a single entity change by its detail ID.

URL

GET https://api.ads.apple.com/v1/change-history/{detailId}

Path Parameters

Name	Type	Description
`detailId` Required	string	The composite identifier for the entity change to retrieve, in the form `EntityType.entityId.txnId` (for example, `Campaign.444555666.txn_abc123def456`). Path parameter.

Query Parameters

Name	Type	Description
`limit` Optional	integer	Maximum number of entries to return from the `changes` array. Defaults to `100`.
`offset` Optional	integer	Zero-based index of the first `changes` entry to return. Defaults to `0`.

Header Parameters

Name	Type	Description
`X-Ap-Context` Required	string

Response Codes

Status	Reason	Type	Description
200	OK Content-Type: application/json	`ChangeDetailsResponse`	Successful operation. Returns ChangeDetailsResponse (`result`: array of ChangeDetails).
400	Bad Request Content-Type: application/json	`Error`	Bad Request. Returns ErrorMessage.
401	Unauthorized Content-Type: application/json	`Error`	Unauthorized.
403	Forbidden Content-Type: application/json	`Error`	Forbidden.
404	Not Found Content-Type: application/json	`Error`	Not Found. Returns ErrorMessage.
429	Too Many Requests Content-Type: application/json	`Error`	Rate Limit Exceeded. Returns ErrorMessage.
500	Internal Server Error Content-Type: application/json	`Error`	Internal Server Error. Returns ErrorMessage.

Discussion

This endpoint returns the complete field-level change record for a single entity within a transaction. The response contains a details array of ActivityDetail objects, each holding a changes array of field change objects. Each change object captures the field name, oldValues, and newValues as string arrays. To page through a large changes array, use limit and offset.

What populates oldValues and newValues depends on the event type that produced the change.

Event Type	`oldValues`	`newValues`
`CREATE`	Empty array	Set to values at creation
`UPDATE`	Previous field value	Updated field value
`DELETE`	Last known value	Typically empty [], but may contain system-managed values (for example, deletion flag, status, transaction ID) set at delete time