GET Project

URL

GET https://api.smartzer.com/embedding/api/v1/project/{project_id}

Parameters

Field	Type \ Value(s)	Required	Description
loop	boolean	false	If true, the project will loop when it reaches the end
autoplay	boolean	false	If true, the project will autoplay
addToCart	boolean	false	If true, and you are using an API to import your products, products will have variants and extra buttons if applicable
region	string	false	The region of the user (used for the region plugin)
lang	string	false	The language of the user (used for the language plugin)
distribution	string	false	Any distribution flag you would like passed through to the player for analytics purposes
pictureInPicture	boolean	false	If true, the project will collapse into a picture in picture mode when the user clicks a CTA that would open a new tab
inlineAwaitConfirmation	boolean	false	If true, the project will show a loader when a cta_inline is clicked, and requires a response to be sent back to the player. Please see SDK Events for more information
lightboxTriggerTextSource	splashscreen | project	false	see lightbox
utm_*	string	false	All utm_ prefixed variables are passed through to the player, and then added to the end of every cta that has a url

Response

{
  id: number, // The project Id
  projectType: "VIDEO" | "LIVESTREAM" | "SHORTFORM" | "LIVESTREAM_RECORDING", // The type of the project
  url: string, // The url to play the video (this should be used to embed the video - it can play in an iframe, a webview or directly in the browser)
  project: {
    projectName: string, // The name of the project
    duration: number, // The duration of the project in seconds (if known)
    countdown: number, // The go-live time of the livestream project in milliseconds (if known)
  },
  config: {
    thumbnail: string, // A url that can be used to display a thumbnail for the project
    title: string[], // An array of strings that can be used to display the title of the project
  }
}