CloudKit Web Services Reference: Fetching Zone Changes (zones/changes)

Fetching Zone Changes (zones/changes)

Returns the zones that changed since a specified sync token.

POST [path]/database/[version]/[container]/[environment]/[database]/zones/changes

path: The URL to the CloudKit web service, which is https://api.apple-cloudkit.com.
version: The protocol version—currently, 1.
container: A unique identifier for the app’s container. The container ID begins with iCloud..
environment: The version of the app’s container. Pass development to use the environment that is not accessible by apps available on the store. Pass production to use the environment that is accessible by development apps and apps available on the store.
database: The database to store the data within the container. Pass public to use the database that is accessible to all users of the app. Pass private to use the database that is visible only to the currently signed-in user.

The POST request is a JSON dictionary containing the following keys:


Key	Description
`metaSyncToken`	Identifies a point in the zone’s change history.
`resultsLimit`	The maximum number of records to fetch. The default is the maximum number of records allowed in a request, described in Data Size Limits.

Dictionary containing the results of the operation with the following keys:


Key	Description
`zones`	An array containing a result dictionary for each zone in the specified database. If successful, the result dictionary contains the keys described in Zone Dictionary. If unsuccessful, the result dictionary contains the keys described in Zone Fetch Error Dictionary.
`metaSyncToken`	Identifies a point in the zone’s change history.
`moreComing`	Boolean value that indicates whether there are more changes to request. If `moreComing` is `true`, request more changes using the value of the included `syncToken` key. If `moreComing` is `false`, there are no more changes.

Alternatively, you can get record changes for all the zones, as described in Fetching Record Changes (records/changes).