Returns the Spotlights and Presentations to which you have access
This call returns an array of Spotlights and Presentations that have been created in your workspace. The response includes all existing Spotlights and Presentations to which you have access; as an administrator, you have access to Spotlights and Presentations created by all users in your workspace.
To set the number and order of Spotlights and Presentations contained in the response, you can use path parameters like sortBy and sort. For example, the request below will return the ten most recently created Spotlights and Presentations in your workspace.
https://api.shift.io/v3/presentations?_page=1&_pageSize=10&_sortBy=created&_sort=desc
To show Spotlights and Presentations created by a specific user, use the ownerId path parameter. For example:
https://api.shift.io/v3/presentations?_ownerId=11111111-1111-1111-1111-111111111111
A 200 code is returned when one or more Spotlights or Presentations are found. Here is an overview of the properties returned for each one:
| id | The unique id of the Spotlight or Presentation |
| templateId | The unique id of a Spotlight or Presentation’s template. Multiple Spotlights and Presentations can use the same “parent template,” but this id corresponds to the unique instance of the child template, not the parent template. |
| templateName | The name of a Spotlight or Presentation’s template. Multiple Spotlights and Presentations can use the same “parent template,” but this name corresponds to the unique instance of the child template, not the parent template. |
| title | The name of the Spotlight or Presentation. When you open the Spotlight or Presentation in your browser, this name appears in the browser tab. The name also appears on the Spotlight home page in MediaSilo. |
| description | A description is optional when creating a Spotlight or Presentation. |
| type | This value is either “Spotlight” or “Presentation.” See the info box below for more information on the difference between the two. |
| expires | The Unix timestamp of the date and time when the Spotlight or Presentation expires. This date and time can be in the future or, in the case of expired Spotlights and Presentations, in the past. The value is null if the Spotlight or Presentation is set to never expire. |
| created | The Unix timestamp of the date and time when the Spotlight or Presentation was created |
| modified | The Unix timestamp of the date and time when the Spotlight or Presentation was last edited |
| thumbnail | This is an S3 link to the image used as the Spotlight or Presentation’s thumbnail. In MediaSilo, this thumbnail is visible in grid view on the Spotlight home page. |
| authorization | This object contains the type property, which indicates the Spotlight or Presentation’s access setting: “Public,” “Password_Protected,” or “Shift Email” (Workspace users). When the type is “Shift_Email,” the authorizedEmails property contains the emails of the workspace users who have been granted access to the Spotlight or Presentation. |
| owner | This object contains the name and user id of the user who created the Spotlight or Presentation. It also includes an AWS link to the user’s avatar/profile picture (if the user uploaded one) and any information the user has provided on their Profile page, including their title, company, website, and location. |
| playlists | This object contains the id of each playlist featured in the Spotlight or Presentation (playlistId) and the id of each media gallery that contains a playlist (elementId).
The boolean isPlaylistDownloadable indicates if downloading is enabled on the playlist level. The boolean canDownload indicates if downloading is enabled on the media-gallery level. For your audience to download files from a playlist, both booleans must be true. |
| live | This boolean corresponds to the “Live” toggle in list view in the MediaSilo UI. If the value is false, then the Spotlight or Presentation has been made inactive, and it will remain inaccessible until the value is changed to true.
A value of true does not guarantee that a Spotlight or Presentation is active. A Spotlight or Presentation that has expired can still be “live,” even though it is no longer accessible. You can only access a Spotlight or Presentation that is live and has not expired. |
What is the difference between “Spotlights” and “Presentations”?
The MediaSilo UI distinguishes “Spotlights” from “Presentations.” For example, the Insights page contains analytics for Spotlights in one tab and analytics for Presentations in a separate tab. However, both Spotlights and Presentations are used to share files, and they both use templates to determine their look and layout.
In the MediaSilo platform, the key difference between a Spotlight and a Presentation is how they are created. You can create a Spotlight from the Spotlight page by going to Create New > Spotlight. You can create a Presentation from the Projects section using the Share as Presentation option.
While both formats are versatile, a Presentation offers a fast way to select files in Projects and then share them using a branded, reusable template. A Spotlight is geared towards customizing a webpage or slide deck for a specific campaign or project. For example, you might create multiple Presentations over two months to share footage of a work in progress. Later, you can create a single Spotlight as a virtual screening room for the completed work, with separate pages for cast and crew information, behind-the-scenes videos, image galleries, and more. While Spotlights and Presentations can support different use cases, there is no difference in functionality between the two.