Data definition

A description of each of the data values and structure of results from the Content API

This section of the documentation covers all of the data fields that can be returned by the API.

A typical API response has the following data structure:

{
  "data": {
    "content": {
      "total": 10,
      "items": [
        "array of item objects"
      ]
    }
  }
}

Inside the "items" array is where you will find the JSON structure of an "item".

Content data structure

• content_id (the unique ID of the asset)
• title (the title of the asset)
• reference_id (the shared unique ID of the asset)
• description (the description of the asset)
• content_type (the type of asset - either video or photo)
• creation_date (the date the content was created)
• modified_date (the date the content was last modified)
• tags (comma separated string of keywords/phrases, returned as an array)
• products (an array of product objects)
  • product_id (the unique ID of the product)
  • reference_id (the shared unique ID of the product)
  • title (the title of the product)
  • link (the link to the product page on your ecommerce site)
  • image (the thumbnail image of the product)
  • price (the price of the product)
  • sale_price (the sale price of the product, if provided)
• attributes(codes:["custom_attribute_code1", "custom_attribute_code2"])  
  • code (the code of the custom attribute)
  • value (the stored value)
• creator
  • creator_id (the unique ID of the creator)
  • first_name (the first name of the creator)
  • last_name (the last name of the creator)
  • full_name (the full name of the creator)
  • thumbnail (the profile image of the creator)
  • uri_stem (the path the creator's storefront if it exists)
• asset
  • asset_type (video, photo or youtube)
  • photo (if asset_type is "photo", this object will be populated)
    • sources (array of differently sized photo assets)
      • height (the height of the asset)
      • width (the width of the asset)
      • url (the CDN URL to the asset)
  • video (if asset_type is "video", this object will be populated)
    • sources (array of differently sizes video assets)
      • hls (URL of the HLS manifest file)
      • dash (URL of the DASH manifest file)
      • mp4 (an array of MP4 videos with different resolutions)
        • height (the height of the asset)
        • width (the width of the asset)
        • url (the CDN URL to the asset)
    • thumbnails (array of differently sized thumbnails for the video asset)
      • height (the height of the thumbnail image)
      • width (the width of the thumbnail image)
      • url (the CDN URL to the thumbnail image)
    • cc (an array of accessibility objects to support ADA compliance)
      • label (a readable label for the object)
      • lang (a 2 character code representing the language)
      • url (the CDN URL to the accessibility object)
      • default (true/false - whether or not this is the default accessibility object to be used)
    • transcript (a text representation of all of the spoken words in the video asset)
  • youtube (if asset_type is "youtube", this object will be populated)
    • youtube_id (the id of the asset from YouTube)
    • height (the height of the asset)
    • width (the width of the asset)
    • duration (the length of the video in seconds)
    • thumbnail (the URL of the thumbnail image for the asset)
    • youtube_url (the URL to the asset on YouTube)

Here is an example of a query that will return a "kitchen sink" (all of the data) response from the Content API. You can copy/paste this directly into the API playground in the dashboard.

{
 content {
   items {
     content_id
     title
     reference_id
     modified_date
     creation_date
     page_url
     uri_stem
     products {
       product_id
       title
       link
     }
     attributes(codes: ["hide_from_grid"]) {
       code
       value
     }
     asset {
       asset_type
       photo {
         sources {
           height
           width
           url
         }
       }
       video {
         sources {
           hls
           dash
             mp4 {
               height
               width
               url
             }
           }
         thumbnails {
           height
           width
           url
         }
         cc {
           label
           lang
           url
           default
         }
         transcript
       }
       youtube {
         youtube_id
         height
         width
         duration
         thumbnail
         youtube_url
       }
     }
   }
 }
}