ContentGroup
SchemaRepresents the Content Group object. For Instagram, YouTube types of platforms, it will media containers (album, playlist) created/published on that platforms.
Fields
· 21id string · uuid required Unique ID of the content group.
created_at string · date-time required Object creation time (UTC date and time in ISO 8601 format)
updated_at string · date-time required Object updation time (UTC date and time in ISO 8601 format)
user UserAttribute account AccountAttribute work_platform WorkPlatformAttribute engagement object Object having reputation information.
external_id string required Unique content group ID on the platform.
title string required Title of the content group.
format string · enum Media type of the content item.
values
VIDEOIMAGEAUDIOTEXTCOLLECTIONOTHER
type string · enum required Platform specific content type.
values
ALBUMPLAYLISTOTHER
url string · uri Platform content group URL. Ex - for YouTube, it will the playlist URL.
description string · nullable Description of the content group.
visibility string · enum Visibility of the content group.
values
PUBLICPRIVATE
thumbnail_url string · uri Thumbnail URL of the content group, which can be used to download the media thumbnail. This is usually a signed URL and may have certain expiry limits so we recommend using it for downloads as soon as possible (such as when a webhook is received), if you are looking to cache thumbnails with you.
published_at string · date-time required Publishing timestamp of the content group.
platform_profile_id string · nullable required Unique profile ID of the user on the work platform.
Ex - For YouTube it's the channel ID and for Instagram it's the Instagram page ID.
platform_profile_name string · nullable required User's profile name on the work platform. This is not unique, is displayed prominently on the profile, usually editable and is most commonly associated with that user's identity on the platform.
Ex - For YouTube, it's the channel name displayed on the channel page and for Instagram / Twitter / TikTok etc, it's the name displayed on the user's profile page.
item_count integer required Number of content items in this content group.
media_url string · nullable Direct media URL of the first content item in the content group, which can be used to download the media item. This is usually a signed URL and may have certain expiry limits so we recommend using it for downloads as soon as possible (such as when a webhook is received), if you are looking to cache media files with you.
media_urls array of string · nullable Direct media URL of all the content items in the content group, which can be used to download the media item. This is usually a signed URL and may have certain expiry limits so we recommend using it for downloads as soon as possible (such as when a webhook is received), if you are looking to cache media files with you.