List an Asset

Fetch a list of Einstein Content Selection assets. Various filters may be applied to limit the result set.

Method and Endpoint

GET "/ecs/ecs/external/api/v1/asset"

Request Body Parameters

Name Type Description
uuids array Provides a list by specific UUIDS.
type string Provides a list of assets in to a specific asset class by name.
asset_class_id string Provides a list of assets in specific asset class by uuid.
selectable boolean Provides a list of assets which are or aren't specified as acceptable depending on the availability and their start and end times. String values: t, f, y, n
archived boolean By default, archived assets are not listed. Set to true to list assets which are specified as acceptable. String values: t, f, y, n
availability boolean Provides a list of assets which have the specified availability. String values: t, f, y, n
fallback boolean Provides a list of assets which are or aren't specified as fallback. String values: t, f, y, n
start_date_from datetime Provides a list of assets that start on or after the provided date and time.
start_date_to datetime Provides a list of assets that start on or before the provided date and time.
end_date_from datetime Provides a list of assets that end on or after the provided date and time.
end_date_to datetime Provides a list of assets that end on or before the provided date and time.

Example Request

GET "/ecs/ecs/external/api/v1/asset?type=Other-Icons&start_date_from=2021-07-01

Example Response

{
    "assets": [
        {
            "key": "Einstein Content",
            "uuid": "cf868607-9eec-4e2b-ae87-3d2ca7ed7911",
            "type": "Other-Icons",
            "url": "https://www.example.com/einstein-content",
            "image_url": null,
            "custom": {
                "locale": "SE"
            },
            "created_at": "2021-08-02T22:20:52.861Z",
            "updated_at": "2021-08-02T22:38:28.804Z",
            "availability": "N",
            "fallback": "N",
            "file_ext": "png",
            "status": "ready",
            "image_updated_at": "2021-08-02T22:38:28.755Z",
            "image_processing_completed_at": "2021-08-02T22:38:28.802Z",
            "image_checksum": "16afe520c3489cc77f668cb2dcfa571c-1",
            "asset_class_id": "f0bc4b14-c19c-49a5-a72f-1736a2afa8f9",
            "content_builder_id": null,
            "archived": false,
            "ect_tags": null,
            "start_datetime": "2021-07-23T00:00:00.000Z",
            "end_datetime": null,
            "display_time_zone": "Helsinki",
            "image_link": "https://ecs-asset-images-qa.s3.us-west-2.amazonaws.com/3612/21575198/f/cf868607-9eec-4e2b-ae87-3d2ca7ed7911.png?v=16afe520c3489cc77f668cb2dcfa571c-1",
            "display_time_zone_name": "Europe/Helsinki",
            "display_start_datetime": "2021-07-23T03:00:00+03:00",
            "display_end_datetime": null
        }
    ]
}