Get asset change notifications.

v1.0.0

Asset Changes

Get notifications about new, updated or deleted assets for a specific channel.

Quickstart

You'll need an API key and an access token to use this resource.

Maximum batch size is 2200.

Change-sets must be confirmed before a new batch of notifications can be retrieved from this endpoint. Use the DELETE asset-changes/change-sets/{change-set-id} endpoint to confirm reciept of these notifications.

Values returned for asset_type include Image, Film, and null. Values returned for asset_lifecycle include New, Update, and Delete.

Delete notifications may be provided for asset ids that have not previously been received as New or Update notifications. Delete notifications may return null for the asset_type.

If there are no notifications in the channel an empty response body will be returned.

Notifications older than 60 days will be removed from partner channels.

Input

{
  "type": "object",
  "properties": {
    "batch_size": {
      "type": "integer",
      "format": "int32",
      "description": "Specifies the number of assets to return. The default is 2200; maximum is 2200."
    },
    "channel_id": {
      "type": "integer",
      "format": "int32",
      "description": "Specifies the id of the channel for the asset data. Valid channel ids can be found in the results of the Get Partner Channel query."
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "change_set_id": {
      "type": "string",
      "description": "Contains the identifier for the change-set resource. Passed into ConfirmAssetChanges requests to confirm receipt of the asset changes in the response."
    },
    "changed_assets": {
      "type": "array",
      "description": "Contains a list of ChangedAssetList results for the query.",
      "items": {
        "type": "object",
        "properties": {
          "asset_changed_utc_datetime": {
            "type": "string",
            "format": "date-time",
            "description": "Contains the date of the asset change."
          },
          "asset_lifecycle": {
            "type": "string",
            "description": "Contains the type of change this asset change is. (i.e. \"New,\" \"Updated\" or \"Deleted\")"
          },
          "asset_type": {
            "type": "string",
            "description": "Contains the type of asset this asset change is (i.e. \"Image\")."
          },
          "id": {
            "type": "string",
            "description": "Contains the Id for the asset change."
          },
          "uri": {
            "type": "string",
            "description": "Contains the asset download URL for assets with an AssetLifecycle of \"New.\""
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}