Channel history

The channel history endpoint provides information about the most recent exports of a channel.

Creating and deleting channel history records is not supported.

Get

Use a GET request to retrieve the export history for a channel.

curl https://platform-api.productsup.io/platform/v2/sites/123/channels/321/history

{
    "success": true,
    "Channels": [
        {
            "id": "321",
            "site_id": "123",
            "channel_id": "1",
            "name": "Google Merchant Center DE",
            "export_name": "Google Merchant Center",
            "links": [...],
            "history": [
                {
                    "id": "333",
                    "site_id": "123",
                    "site_channel_id": "444",
                    "export_time": "2015-09-30 10:18:56",
                    "export_start": "2015-09-30 10:18:54",
                    "product_count": "18697",
                    "pid": "560b96899e334",
                    "product_count_new": "0",
                    "product_count_modified": "0",
                    "product_count_deleted": "0",
                    "product_count_unchanged": "0",
                    "uploaded": "0"
                },
                ...
            ]
        }
    ]
}

HTTP request

GET https://platform-api.productsup.io/platform/v2/sites/<siteId>/channels/<channelId>/history

Field	Type	Description
`siteId`	integer	Site the channel belongs to
`channelId`	integer	Channel to retrieve history for; use the site channel relation ID

Response fields

Field	Type	Description
`success`	boolean	Indicates request status
`Channels`	array	List of channels

Channel fields

Field	Type	Description
`id`	integer	ID of the site channel relation
`site_id`	integer	ID of the referenced site
`channel_id`	integer	ID of the channel
`name`	string	Name of the export as configured on the channel
`export_name`	string	Generic name of the export in the Productsup system
`links`	array	See link fields
`history`	array	See history fields

Links fields and values

Name	Description
`self`	Link to channel detail
`site`	Link to site

History fields

Field	Type	Description
`id`	integer	Internal identifier
`site_id`	integer	Identifier of the referenced site
`site_channel_id`	string	Internal ID for the combination of an export and site
`export_time`	dateTime	Time when the process finished
`export_start`	dateTime	Time when the process started
`product_count`	integer	Number of products exported
`pid`	string	Internal identifier for the process
`product_count_new`	integer	Number of new products (delta exports only)
`product_count_modified`	integer	Number of updated products (delta exports only)
`product_count_deleted`	integer	Number of deleted products (delta exports only)
`product_count_unchanged`	integer	Number of unchanged products (delta exports only)
`uploaded`	integer	Indicates whether the export was uploaded to its destination