View

View information about one or more items

This action requires a request with one or more active accounts.

Tokens

This action requires the following tokens:

  • item-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
item Array of Hash   Only show the item with the given hash(es)
category Array of Hash   Only show the items in the given category
searchtitle String   Only show items containing the given string somewhere in the title
searchdescription String   Only show items containing the given string somewhere in the description
searchkeywords String   Only show items containing the given keyword; note that keywords cannot contains commas, and it is not allowed to include them in the search text
searchfulltext String    
title String   Only show items with this exact title
description String   Only show items with this exact description
externalid String   Only show items with this external ID
mindatecreated DateTime   Only show items created at or after the given date and time
maxdatecreated DateTime   Only show items created at or before the given date and time
mindatemodified DateTime   Only show items last modified at or after the given date and time
maxdatemodified DateTime   Only show items last modified at or before the given date and time
mindateaired DateTime   Only show items aired at or after the given date and time
maxdateaired DateTime   Only show items aired at or before the given date and time
archived Boolean false

Enable to only show items which have been archived; by default, only items which have not been archived will be shown. Unset (leave empty) to show both archived and non-archived files

This argument can be unset by providing an empty string

showfiles Boolean false Enable to also show the files of each item; by default, these will not be shown
livestream Hash   Only show the items of the given live stream
user Hash   Only show the items of the given user
itemtype Label   Only show the items of the given item type
showmetadata Boolean false Also return the metadata belonging to the item(s)
metadata Array of String   Only show the items with the given metadata. Syntax of this argument is MetadataKey=value
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String created

Defines the field to order the results by; can be any of the following:

  • title – Order lexicographically by title
  • created – Order by the date when the item was created
  • modified – Order by the date when the item was last modified
  • aired – Order by the date when the item was aired
  • duration – Order by the duration of the items
  • views – Order by the number of views of the item
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash Item ID
title String Title of the item
description String Description of the item
type Label The type of this item; for available item types, refer to the documentation of the Item command
account

The account that created this item

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
datecreated DateTime When this item was created; for recordings of live-events, this is the date when the item finished recording
duration Duration Duration of this item
originalfilename String Original, human-readable name of the item
author String Author of the item
keywords

Keywords associated with this item, as an array

The value of this field is an array containing zero or more elements, each one being one String

copyright String Copyright notice of the item
externallink String A link to an external page, such as a page containing more information about this item, or the page where this item is embedded
externalid String An external ID which can be used by clients
protected Boolean True if signed links must be used to view this item, otherwise false
archived Boolean True if this item has been archived
securityprofile

Security profile

The value of this field is an object containing the following fields:

Name Type Description
id Hash Security profile ID
name String The name of this security profile
datemodified DateTime When this item was last modified
dateaired DateTime When this item was aired, e.g. on television
user

The user that created this item

The value of this field is an object containing the following fields:

Name Type Description
id Hash User ID
username String User name
views Integer The total number of views recorded for this item; this is equal to the number of plays as reported by the Statistics command
videoaspect Float The aspect ratio of the video in this item, if applicable; the value is a float such as 1.333333 for an aspect ratio of 4:3
thumbnails

Links to the thumbnails for this item. See Posters for details on the format

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
index Integer Index of the thumbnail
url String URL to this thumbnail
selectedthumbnail Integer Which thumbnail is the selected one
selectedthumbnailurl String URL of the currently selected thumbnail
moviestripsurl String URL of the moviestrips file
medialink

The URLs at which this item is available for streaming

The value of this field is an object containing the following fields:

Name Type Description
progressive String The URL at which this item can be streamed using progressive streaming
hls String The URL at which this item can be streamed using HTTP Live Streaming
dash String The URL at which this item can be streamed using MPEG-DASH
smooth String The URL at which this item can be streamed using Smooth Streaming
hds String The URL at which this item can be streamed using HTTP Dynamic Streaming
transcodestatus String The current status of transcodes for this item
transcodefailures String The current status of transcode failures for this item
isplayable Boolean Whether or not this item is playable through a standard embedframe at this moment
isbeingreplaced Boolean Whether or not this item is being replaced with a new source file at this moment
vrtype Label If this item is a virtual reality video, the type of virtual reality rendering to apply
livestream

Live stream from which this item originates

The value of this field is an object containing the following fields:

Name Type Description
id Hash Livestream ID
title String Title of the live stream
description String Description of the live stream
type Label The type of this livestream; for available livestream types, refer to the documentation of the Livestream command
replacementitemfile

File used for replacing original files

The value of this field is an object containing the following fields:

Name Type Description
id Hash ID of this item file
type String Type of this item file
originalfilename String Original, human-readable name of this file
extension String Extension of this file
size Integer File size in bytes
datecreated DateTime When this file was created
datemodified DateTime When this file was last modified
origin String Origin of this file
archived Boolean True if this item has been archived
deleted Boolean True if the item has been deleted
profile

The profile used to encode this file

The value of this field is an object containing the following fields:

Name Type Description
id Hash Unique identifier for the profile
name String Name of the profile
width Integer Width of the file in pixels (for video files)
height Integer Height of the file in pixels (for video files)
format String File format/container
audiocodec String Audio codec used in this file (for audio files)
audiocodecname String Name of the audio codec used in this file (for audio files)
audiocodecdescription String Description of the audio codec used in this file (for audio files)
audiochannels Integer Number of audio channels (for audio files)
audiobitrate Integer Audio bitrate in bits per second (for audio files)
audiosamplerate Integer Audio sampel rate in Hz (for audio files)
audiobitdepth Integer Number of bits per audio sample (for audio files)
videocodec String Video codec used in this file (for video files)
videocodecname String Name of the video codec used in this file (for video files)
videocodecdescription String Description of the video codec used in this file (for video files)
videocodecprofile Label Video codec profile used in this file (for video files)
videocodecprofilename String Name of the video codec profile used in this file (for video files)
videocodecprofilelevel Float Video codec profile used in this file (for video files)
videobitrate Integer Video bitrate in bits per second (for video files)
videoaspect Float Video aspect ratio (for video files)
videoframerate Float Video frame rate in frames per second (for video files)
videogoprate Integer Video group-of-frame rate: the number of frames between 2 consecutive keyframes (for video files)
videoisvbr Boolean True if the video has a variable bit rate, false if it has a constant bit rate (for video files)
videoisinterlaced Boolean True if the video is interlaced, false if it is progressive (for video files)
corrupted Boolean True if and only if this file is corrupted
rotation Integer Rotation of this video file (for video files)
medialink

The URLs at which this item file is available for streaming

The value of this field is an object containing the following fields:

Name Type Description
progressive String The URL at which this item file can be streamed using progressive streaming
hls String The URL at which this item file can be streamed using HTTP Live Streaming
dash String The URL at which this item file can be streamed using MPEG-DASH
smooth String The URL at which this item file can be streamed using Smooth Streaming
hds String The URL at which this item file can be streamed using HTTP Dynamic Streaming
categories

Categories this item belongs to

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash Category ID
name String The name of this category
files

The files present in the item. Only available if showfiles is true

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash ID of this item file
type String Type of this item file
originalfilename String Original, human-readable name of this file
extension String Extension of this file
size Integer File size in bytes
datecreated DateTime When this file was created
datemodified DateTime When this file was last modified
origin String Origin of this file
archived Boolean True if this item has been archived
deleted Boolean True if the item has been deleted
profile

The profile used to encode this file

The value of this field is an object containing the following fields:

Name Type Description
id Hash Unique identifier for the profile
name String Name of the profile
width Integer Width of the file in pixels (for video files)
height Integer Height of the file in pixels (for video files)
format String File format/container
audiocodec String Audio codec used in this file (for audio files)
audiocodecname String Name of the audio codec used in this file (for audio files)
audiocodecdescription String Description of the audio codec used in this file (for audio files)
audiochannels Integer Number of audio channels (for audio files)
audiobitrate Integer Audio bitrate in bits per second (for audio files)
audiosamplerate Integer Audio sampel rate in Hz (for audio files)
audiobitdepth Integer Number of bits per audio sample (for audio files)
videocodec String Video codec used in this file (for video files)
videocodecname String Name of the video codec used in this file (for video files)
videocodecdescription String Description of the video codec used in this file (for video files)
videocodecprofile Label Video codec profile used in this file (for video files)
videocodecprofilename String Name of the video codec profile used in this file (for video files)
videocodecprofilelevel Float Video codec profile used in this file (for video files)
videobitrate Integer Video bitrate in bits per second (for video files)
videoaspect Float Video aspect ratio (for video files)
videoframerate Float Video frame rate in frames per second (for video files)
videogoprate Integer Video group-of-frame rate: the number of frames between 2 consecutive keyframes (for video files)
videoisvbr Boolean True if the video has a variable bit rate, false if it has a constant bit rate (for video files)
videoisinterlaced Boolean True if the video is interlaced, false if it is progressive (for video files)
corrupted Boolean True if and only if this file is corrupted
rotation Integer Rotation of this video file (for video files)
medialink

The URLs at which this item file is available for streaming

The value of this field is an object containing the following fields:

Name Type Description
progressive String The URL at which this item file can be streamed using progressive streaming
hls String The URL at which this item file can be streamed using HTTP Live Streaming
dash String The URL at which this item file can be streamed using MPEG-DASH
smooth String The URL at which this item file can be streamed using Smooth Streaming
hds String The URL at which this item file can be streamed using HTTP Dynamic Streaming
metadata

The metadata belonging to the item

The value of this field is an array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
key String The key
value String The value

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_CATEGORY_NOT_FOUND (210)