GET /assets/{asset_id}/related-assets

1 min

GET

https://api.cmp.optimizely.com/v3/assets/{asset_id}/related-assets

Returns a paginated list of related assets for the specified asset. Only supported for asset types: article, image, video, raw_file, and structured_content.

Path Parameters

asset_idstringrequired
Example
5d7f910551b00a722e0418830cee6631
Description
Unique identifier of the asset

Query Parameters

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 related assets

RelatedAssetsListResponse
- dataRelatedAssetItem[]required
  Description
  List of related 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
  - contentobjectrequired
    - 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
      Description
      Content of the asset. - article – the html body - image, raw_file, video – the download URL - structured_content – api url - compose_content – api url
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/images/5d7f910551b00a722e0418830cee6631
      Description
      URL of the asset (only GET is supported)
- 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/5d7f910551b00a722e0418830cee6631/related-assets?offset=10&page_size=10

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

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
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/{asset_id}/related-assets?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/{asset_id}/related-assets?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/{asset_id}/related-assets?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/{asset_id}/related-assets?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 related assets
{
  "data": [
    {
      "id": "5d7f910551b00a722e0418830cee6631",
      "title": "sample_image.png",
      "type": "image",
      "mime_type": "image/png",
      "file_extension": "png",
      "content": {
        "type": "url",
        "value": ""
      },
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/images/5d7f910551b00a722e0418830cee6631"
      }
    }
  ],
  "pagination": {}
}

400

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

401

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

403

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

404

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