GET /assets

1 min

GET

https://api.cmp.optimizely.com/v3/assets

Get the list of assets. Assets are sorted by modified_at in descending order. To get assets that are not inside any folder, pass include_subfolder_assets=false in the query param.

Query Parameters

typestring[]
Examples
Filter by a single type:
[ "image" ]
Filter by multiple types:
[ "article", "image", "video" ]
Description
Asset type to filter by. Example: type=image&type=video
Default
article,image,video,raw_file,structured_content,compose_content
labelobject[]
Examples
Filter by a single label:
[ "{\"group\": \"ee63e3ee43925bb5cc8cd17b817d93ee\", \"values\": [\"6706efc7828cd6aaedbc0434139cd3e1\", \"1f32651216cf2aefcaa08be1ea7dedf1\"]}" ]
Filter by multiple labels:
[ "{\"group\": \"ee63e3ee43925bb5cc8cd17b817d93ee\", \"values\": [\"6706efc7828cd6aaedbc0434139cd3e1\", \"1f32651216cf2aefcaa08be1ea7dedf1\"]}", "{\"group\": \"126123b543912bb5cc12d17b817d9312\", \"values\": [\"aa63e3ee43925bb5cc8cd17b817d93aa\", \"df697bd824a944bf7d4fb6e350d9c5bd\"]}" ]
Description
Label to filter by. Must be passed as urlencoded string. Labels that do not exist are ignored. If none of the provided labels exist, filtering is not applied. Example – label=%7B%22group%22%3A%22ee63e3ee43925bb5cc8cd17b817d93ee%22%2C%22values%22%3A%5B%226706efc7828cd6aaedbc0434139cd3e1%22%2C%221f32651216cf2aefcaa08be1ea7dedf1%22%5D%7D
- groupstringrequired
  Example
  2467e583a60e23fda2b89db81a453cd2
  Description
  Identifier of the label group
- valuesstring[]required
  Description
  List of identifiers of the label values
fieldsobject[]
Examples
Filter by a single field:
[ "[{\"id\": \"ee63e3ee43925bb5cc8cd17b817d93ee\", \"values\": [\"6706efc7828cd6aaedbc0434139cd3e1\", \"1f32651216cf2aefcaa08be1ea7dedf1\"]}]" ]
Filter by multiple fields:
[ "[{\"id\": \"ee63e3ee43925bb5cc8cd17b817d93ee\", \"values\": [\"6706efc7828cd6aaedbc0434139cd3e1\", \"1f32651216cf2aefcaa08be1ea7dedf1\"]}, {\"id\": \"126123b543912bb5cc12d17b817d9312\", \"values\": [\"aa63e3ee43925bb5cc8cd17b817d93aa\", \"df697bd824a944bf7d4fb6e350d9c5bd\"]}]" ]
Description
List of fields to filter by. Must be passed as base64 encoded string. Fields that do not exist are ignored. If none of the provided fields exist, filtering is not applied. Example – fields=Wwp7CiJpZCI6ICI2N2E4NDZhMWM3NzU1YTFwNThpNjh5MzVhIiwKInZhbHVlcyI6IFsiNjdhODQ2YTFjNzc1YWU1YWExYTE0YTA1Il0KfQpd=
- idstringrequired
  Example
  2467e583a60e23fda2b89db81a453cd2
  Description
  Identifier of the field
- valuesstring[]required
  Description
  List of identifiers of the field values
created_at__fromstring<date-time>
Example
2018-11-30T13:32:44Z
Description
Date and time as the lower limit to filter assets by created_at, in ISO 8601 UTC format
Format
date-time
created_at__tostring<date-time>
Example
2018-11-30T13:32:44Z
Description
Date and time as the upper limit to filter assets by created_at, in ISO 8601 UTC format
Format
date-time
modified_at__fromstring<date-time>
Example
2018-11-30T13:32:44Z
Description
Date and time as the lower limit to filter assets by modified_at, in ISO 8601 UTC format
Format
date-time
modified_at__tostring<date-time>
Example
2018-11-30T13:32:44Z
Description
Date and time as the upper limit to filter assets by modified_at, in ISO 8601 UTC format
Format
date-time
folder_idstring
Example
6bb8db20a5b611ebae319b7c541b1a7f
Description
ID of the library folder to include assets from
include_subfolder_assetsboolean
Example
false
Description
Indicates whether assets from subfolders need to be included
Default
true
search_textstring
Example
Cute Cat
Description
Search assets by title or content description
campaign_idstring
Example
673218bee23887779e9e9a6f
Description
ID of the campaign to include assets from
offsetinteger
Example
5
Description
Starting index of results (zero indexed)
Default
0
Minimum
0
page_sizeinteger
Example
15
Description
Number of results to return per page
Default
10
Minimum
1
Maximum
100

Responses

200List of fetched assets

object
- dataAssetResponse[]required
  Description
  List of assets
  - idstringrequired
    Example
    5d7f910551b00a722e0418830cee6631
    Description
    Unique identifier for the asset
  - titlestringrequired
    Example
    sample_image.png
    Description
    Title of the asset
  - typestring<article | image | video | raw_file | structured_content | compose_content>required
    Example
    image
    Description
    Type of the asset
    Allowed
    articleimagevideoraw_filestructured_contentcompose_content
  - mime_typestringrequired
    Example
    image/png
    Description
    MIME type of the asset
  - file_extensionstringrequired
    Example
    png
    Description
    File extension of the asset
  - created_atstring<date-time>required
    Example
    2019-10-06T13:15:30Z
    Description
    Date and time on which the asset was created, in ISO 8601 UTC format (2020-02-10T10:40
    )
    Format
    date-time
  - modified_atstring<date-time>required
    Example
    2019-10-07T13:15:30Z
    Description
    Date and time of the most recent modification of the asset, in ISO 8601 UTC format (2020-02-10T10:40
    )
    Format
    date-time
  - folder_idstringrequired
    Example
    6bb8db20a5b611ebae319b7c541b1a5a
    Description
    ID of the folder containing the asset in the library
  - file_locationstringrequired
    Example
    /all assets/important assets
    Description
    Location of the folder containing the asset in the library
  - is_archivedbooleanrequired
    Description
    Whether the asset is archived or not
  - contentAssetContentrequired
    Description
    Content of the asset
    - typestring<url | api_url | html_body>required
      Example
      url
      Description
      Type of the content.
      
      article – html_body
      
      image, raw_file, video – url
      
      structured_content – api_url
      
      compose_content – api_url
      Allowed
      urlapi_urlhtml_body
    - valuestringrequired
      Example
      http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S
      Description
      Content of the asset. - article – the html body - image, raw_file, video – the download URL - structured_content – api url - compose_content – api url
  - labelsResourceLabelResponse[]required
    Description
    Labels associated with the asset
    - groupobjectrequired
      Description
      Label group
      - idstringrequired
        Example
        2467e583a60e23fda2b89db81a453cd2
        Description
        Identifier of the label group
      - namestringrequired
        Example
        Content Format
        Description
        Name of the label group
    - valuesobject[]required
      Description
      List of values of the label
      - idstringrequired
        Example
        71c378f3fee3d822759d1bdc2aab628c
        Description
        Identifier of the label value
      - namestringrequired
        Example
        Photos
        Description
        Name of the label value
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/images/5d7f910551bw0a722e0418830cee6631
      Description
      URL of the asset (only GET is supported)
  - owner_organization_idstringrequired
    Example
    5108c3a9becac35915111191
    Description
    ID of the asset's owner organization
  - thumbnail_urlstringrequired
    Example
    https://images1.cmp.optimizely.com/Pz1kYmI9Z2FkYTJtZWI5VGI1WZq4MTZkNTdmGHjM5OGRmYq==
    Description
    URL of the asset's thumbnail
- paginationobjectrequired
  - Pagination
    - nextstringrequired
      Example
      https://api.cmp.optimizely.com/<some-path-to-next-page>?offset=10&page_size=10
      Description
      URL to the next page
    - previousstringrequired
      Description
      URL to the previous page
  - object
    - nextstring
      Example
      https://api.cmp.optimizely.com/v3/assets?offset=10&page_size=10
- total_countnumberrequired
  Description
  Total number of assets found based on the request

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request GET \
     --url 'https://api.cmp.optimizely.com/v3/assets?type=article%2Cimage%2Cvideo%2Craw_file%2Cstructured_content%2Ccompose_content&label=[%22{%5C%22group%5C%22%3A%20%5C%22ee63e3ee43925bb5cc8cd17b817d93ee%5C%22%2C%20%5C%22values%5C%22%3A%20[%5C%226706efc7828cd6aaedbc0434139cd3e1%5C%22%2C%20%5C%221f32651216cf2aefcaa08be1ea7dedf1%5C%22]}%22]&fields=[%22[{%5C%22id%5C%22%3A%20%5C%22ee63e3ee43925bb5cc8cd17b817d93ee%5C%22%2C%20%5C%22values%5C%22%3A%20[%5C%226706efc7828cd6aaedbc0434139cd3e1%5C%22%2C%20%5C%221f32651216cf2aefcaa08be1ea7dedf1%5C%22]}]%22]&include_subfolder_assets=true&offset=5&page_size=10' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/assets?type=article,image,video,raw_file,structured_content,compose_content&label=[\"{\\\"group\\\": \\\"ee63e3ee43925bb5cc8cd17b817d93ee\\\", \\\"values\\\": [\\\"6706efc7828cd6aaedbc0434139cd3e1\\\", \\\"1f32651216cf2aefcaa08be1ea7dedf1\\\"]}\"]&fields=[\"[{\\\"id\\\": \\\"ee63e3ee43925bb5cc8cd17b817d93ee\\\", \\\"values\\\": [\\\"6706efc7828cd6aaedbc0434139cd3e1\\\", \\\"1f32651216cf2aefcaa08be1ea7dedf1\\\"]}]\"]&include_subfolder_assets=true&offset=5&page_size=10", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/assets?type=article,image,video,raw_file,structured_content,compose_content&label=[\"{\\"group\\": \\"ee63e3ee43925bb5cc8cd17b817d93ee\\", \\"values\\": [\\"6706efc7828cd6aaedbc0434139cd3e1\\", \\"1f32651216cf2aefcaa08be1ea7dedf1\\"]}\"]&fields=[\"[{\\"id\\": \\"ee63e3ee43925bb5cc8cd17b817d93ee\\", \\"values\\": [\\"6706efc7828cd6aaedbc0434139cd3e1\\", \\"1f32651216cf2aefcaa08be1ea7dedf1\\"]}]\"]&include_subfolder_assets=true&offset=5&page_size=10")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/assets?type=article,image,video,raw_file,structured_content,compose_content&label=[\"{\\\"group\\\": \\\"ee63e3ee43925bb5cc8cd17b817d93ee\\\", \\\"values\\\": [\\\"6706efc7828cd6aaedbc0434139cd3e1\\\", \\\"1f32651216cf2aefcaa08be1ea7dedf1\\\"]}\"]&fields=[\"[{\\\"id\\\": \\\"ee63e3ee43925bb5cc8cd17b817d93ee\\\", \\\"values\\\": [\\\"6706efc7828cd6aaedbc0434139cd3e1\\\", \\\"1f32651216cf2aefcaa08be1ea7dedf1\\\"]}]\"]&include_subfolder_assets=true&offset=5&page_size=10"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// List of fetched assets
{
  "data": [
    {
      "id": "5d7f910551b00a722e0418830cee6631",
      "title": "sample_image.png",
      "type": "image",
      "mime_type": "image/png",
      "file_extension": "png",
      "created_at": "2019-10-06T13:15:30Z",
      "modified_at": "2019-10-07T13:15:30Z",
      "folder_id": "6bb8db20a5b611ebae319b7c541b1a5a",
      "file_location": "/all assets/important assets",
      "is_archived": false,
      "content": {
        "type": "url",
        "value": "http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S"
      },
      "labels": [
        {
          "group": {
            "id": "2467e583a60e23fda2b89db81a453cd2",
            "name": "Content Format"
          },
          "values": [
            {
              "id": "71c378f3fee3d822759d1bdc2aab628c",
              "name": "Photos"
            }
          ]
        }
      ],
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/images/5d7f910551bw0a722e0418830cee6631"
      },
      "owner_organization_id": "5108c3a9becac35915111191",
      "thumbnail_url": "https://images1.cmp.optimizely.com/Pz1kYmI9Z2FkYTJtZWI5VGI1WZq4MTZkNTdmGHjM5OGRmYq=="
    }
  ],
  "pagination": {},
  "total_count": 0
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}