Actions349
- General Actions
- List Channels
- Returns The Disk Usage (in Bytes) For The Given Channel.
- Returns The Media Poster.
- Replaces The Thumbnail & Poster For A Given Media
- Lists All Children Of The Channel's Root Folder.
- Moves One Or Many Medias/folders To Trash.
- Duplicates One Or Many Medias/folders To A Given Folder.
- Moves One Or Many Medias/folders To A Given Folder.
- Lists All Medias/folders In Trash.
- Deletes One Or Many Medias/folders From Trash, Permanently.
- Deletes A Media/folder From Trash, Permanently.
- Restores A Media/folder From Trash To Its Original Location.
- Returns The Tree Of The Folder With All Its Children, Recursively.
- Returns The Breadcrumb Of The Media/folder Up To Root Ancestor.
- Updates One Or Many Medias/folders.
- Lists All Children Of A Given Folder.
- Updates A Media/folder.
- Moves A Media/folder To Trash.
- Duplicates A Media/folder To A Given Folder.
- Moves A Media/folder To A Given Folder.
- Lists All Callback Logs.
- Deletes One Or Many Callback Logs.
- Returns A Callback Log.
- Deletes A Callback Log.
- Lists All Callbacks.
- Creates A New Callback.
- Updates One Or Many Callbacks.
- Deletes One Or Many Callbacks.
- Returns A Callback.
- Updates A Callback.
- Deletes A Callback.
- Lists All Event.
- Lists All Encodings.
- Creates A New Encoding.
- Deletes One Or Many Players.
- Returns An Encoding.
- Updates An Encoding.
- Deletes An Encoding.
- List Logos
- Create A Logo
- Deletes Logos
- Detach Logo
- Display Logo
- Updates Logo
- Delete Logo
- Sets A Logo Either For Media Or Folders
- List All Folders.
- Creates A New Folder In The Channel's Root Folder.
- Adds One Or Many Given Encodings To A Folder.
- Remove Encodings From Folder
- Appends An Encoding To A Folder.
- Removes An Encoding From A Folder.
- Add Logo To A Folder
- Returns The Channel's Root Folder.
- Returns A Folder.
- Creates A New Folder In The Parent Folder.
- Updates A Folder.
- Deletes A Folder With All Its Children, Recursively.
- Lists All Playlists Having A Given Folder Attached.
- Lists All FTP Users.
- Creates A New FTP User.
- Returns A FTP User.
- Updates A FTP User.
- Deletes A FTP User.
- Lists All Medias.
- Updates One Or Many Medias.
- Returns A Media.
- Updates A Media.
- Deletes A Media.
- Lists All Chapters Of A Given Media.
- Creates A New Chapter To A Given Media.
- Updates One Or Many Chapters.
- Deletes One Or Many Chapters.
- Returns A Chapter.
- Updates A Chapter.
- Deletes A Chapter.
- List Media Cuts
- Cut A Media
- Get New More Precise Waveform ( For Medias Older Than 2024, Async Job )
- Get New Thumbstrip Thumbnail ( For Medias Older Than 2024, Async Job )
- Lists All Players.
- Creates A New Player.
- Returns A Player.
- Updates A Player.
- Deletes A Player.
- Duplicates A Player.
- Lists All Ads.
- Creates A New Ad.
- Deletes One Or Many Ads.
- Returns A Ad.
- Updates A Ad.
- Deletes A Ad.
- Lists All Playlists.
- Creates A New Playlist.
- Deletes One Or Many Playlists.
- Returns A Playlist.
- Updates A Playlist.
- Deletes A Playlist.
- Lists All Children Of A Given Folder, With Attached To Playlist Flag.
- Lists All Shares.
- Creates A New Share To A Given Target
- Returns A Share.
- Updates A Share.
- Deletes A Share.
- Create A Token From A Share
- Get Average Time
- Get Channel Consumption
- Get Channel Consumption Per Encoding
- Get Channel Top Medias
- Get Media Consumption
- Get Media Consumption Per Encoding
- Get Media Top Clusters
- Get Media Top Countries
- Get Browser Shares Per Media
- Get Os Shares Per Media
- Get Playbacks Shares Per Media
- Get Players Shares Per Media
- Get Media Viewers
- Get Media Viewers Per Encoding Histogram
- Get Media Viewers Per Encoding Share
- Get Media Unique Viewers
- Get Media Viewing Time
- Get Viewing Time Per Encoding And Media
- Get Channel Browser Shares
- Get Channel Os Shares
- Get Channel Playbacks Shares
- Get Channel Players Shares
- Get Consumed Time Per IP
- Get Channel Viewers
- Get Channel Viewers Per Encoding Histogram
- Get Channel Viewers Per Encoding Share
- Get Channel Viewers Histogram
- Get Channel Unique Viewers
- Get Channel Viewing Time
- Get Channel Viewing Time Per Encoding
- List Uploads
- Create New Media
- Creates A New Subtitle To A Given Media.
- Creates A New Subtitle To A Given Media, From A Provided File.
- Set A Default Subtitle.
- Returns A Subtitle.
- Updates A Subtitle.
- Deletes A Subtitle.
- Attach Logo
- List Major Encoding Constraints That Should Be Respected
- List Encoding Profiles.
- Lists All Available Countries.
- Lists All Available Categories.
- Lists All Available Languages.
- Finds And Returns Anything Matching A Given Query.
- Lists All Playlists Having A Given Media Attached.
- Adds One Or Many Given Medias/folders To One Or Many Playlists.
- Removes One Or Many Given Medias/folders From One Or Many Playlists.
- Lists All Subtitles Of A Given Media.
- Updates One Or Many Subtitle.
- Deletes Many Subtitles.
- V2 > Browse Actions
- V2 > Channel Actions
- V2 > Playlist Actions
- Returns A Playlist In Its Given Extension
- Adds One Or Many Given Medias/folders To A Playlist.
- Removes One Or Many Given Medias/folders From A Playlist.
- Duplicates A Playlist.
- Returns A Playlist Image.
- Deletes A Playlist Image
- Lists All Medias Of A Playlist.
- Moves One Or Many Given Medias One Position Up.
- Moves One Or Many Given Medias One Position Down.
- Moves One Or Many Given Medias After A Given Media.
- Moves One Or Many Given Medias Before A Given Media.
- V2 > Subtitles Actions
- V2 > User Activity Actions
- V3 > Ad Actions
- V3 > Alert Actions
- V3 > Callback Actions
- V3 > Category Actions
- V3 > Channel Actions
- V3 > Chapter Actions
- V3 > Country Actions
- V3 > Encoding Actions
- V3 > Filesystem Actions
- V3 > Folder Actions
- Show Root Folder.
- List Folders.
- Create Folder.
- Show Folder Details.
- Update Folder Details.
- Delete A Folder.
- Synchronize Encodings For A Folder.
- Attach Encodings To A Folder.
- Detach Encodings From A Folder.
- Attach A Logo To A Folder.
- Detach A Logo From A Folder.
- Attach Labels To A Folder.
- Detach Labels From A Folder.
- Locks The Provided Folder.
- Unlocks The Provided Folder.
- V3 > Ftp Actions
- V3 > Journal Actions
- V3 > Label Actions
- V3 > Language Actions
- V3 > Linked Svc Actions
- V3 > Logo Actions
- V3 > Media Actions
- V3 > Metadata Actions
- V3 > Mixtape Actions
- V3 > Player Actions
- V3 > Playlist Actions
- V3 > Reflect Actions
- V3 > Resources Actions
- V3 > Share Actions
- V3 > Statistics Actions
- Get Top Media Statistics.
- Get Media Unique Viewers' Statistics.
- Get Media Viewers' Statistics.
- Get The Consumption.
- Get The View Time.
- Get The Viewers.
- Get The Unique Viewers.
- Get The Average View Time.
- Get Encoding Statistics.
- Get Browsers Statistics.
- Get Cities Statistics.
- Get Countries Statistics.
- Get Operating System Statistics.
- Get Playbacks Statistics.
- Get Players Statistics.
- Get Cluster Statistics.
- Get Viewers Per Encoding Statistics.
- Get Consumed Time Per IP Statistics.
- Get Consumed Time Per Encoding Statistics.
- V3 > Subtitle Actions
- V3 > Thumbnail Actions
- V3 > Upload Actions
General → Get Media Consumption
AI-generatedSummary
Retrieve media consumption details for a specified channel and media item, optionally filtered by a start date.
Inputs
- Authentication — Choose between OAuth2 or API Key for authenticating the request.
- Channel (required) — Specify the unique identifier of the channel to query media consumption for.
- Media (required) — Specify the unique identifier of the media item to retrieve consumption data for.
- Additional Query Parameters — Optionally provide a 'From' parameter, representing the begin date timestamp to filter consumption data starting from that date.
- Return Full Response — Choose whether to return the entire API response or just the extracted consumption data.
Output shape
a JSON object containing media consumption metrics for the specified channel and media item, optionally filtered by provided parameters
If 'Return Full Response' is true, the full raw API response is returned; otherwise, only the relevant consumption data extracted from the response is provided. Errors or failures are communicated via node error handling mechanisms.