Lumiere Video URL Anatomy
To understand how to integrate a Lumiere video into your 3rd party platform, we'll first need to understand the format of a Lumiere Video URL.
VideoID
Each video that is created in Lumiere comes with a unique videoID. This videoID is automatically generated by Lumiere and is used to keep your content organized. The videoID part of the video URL points your viewers to the right video.
EID (External ID)
EID, which stands for External ID, is a variable that Lumiere uses to take in the unique ID of viewers that are coming from an external source. External sources with unique view IDs are typically online sample sources like Cint Marketplace, Appinio, and NewtonX (to name a few) or survey hosting platforms like Qualtrics, Decipher, FuelCycle, and others.
If your viewers are coming from an external source, such as a sample provider or being redirected from a survey hosting platform, we advise piping in each respondent's unique ID into our EID field to match data across platforms.
If you do not pipe in each respondent's UniqueID into the EID field of your Lumiere URL, you will not be able to match viewer data collected in Lumiere to the same respondent's data in your native platform.
Custom Data (cd_)
Custom data can be added to your link. Each variable you add can have a unique value for each viewer, allowing you to filter on audience segments and demographics on your video's insights dashboard. Check out our article on custom data here.
3rd Party Integration
Within your survey hosting platform is likely an area where you can redirect respondents to a 3rd party site, like Lumiere, then back to their native surveying environment. Within that area of your survey platform, add your Lumiere video's URL, the unique ID of your survey respondent (optional), and a redirect destination for when their Lumiere Video experience ends.
https://lumiere.is/v/videoIDexample?eid=[viewerID_From_Your_Platform]&returnUrl=[ReturnLink]
OPTION 1: Redirect respondents to Lumiere WITHOUT returning them to your site when they're done viewing
Construct a redirect action in your platform that points to a Lumiere video and includes the uniqueID value (without the brackets):
https://lumiere.is/v/vmXBfZdkBgcS?eid=[UniqueID]
OPTION 2: Send respondents to Lumiere AND return them to your site when they're done viewing
Construct a redirect action in the platform that points to a Lumiere video and includes the respondent's unique ID value as well as a 'returnUrl' (where the respondent should be sent back to after Lumiere).
As an example, if the respondent's native survey URL is:
http://survey.example.com/s3/12345/example-survey?UniqueID=user112
Their full Lumiere redirect link would be:
https://lumiere.is/v/vmXBfZdkBgcS?eid=[user112]&returnUrl=[http%3A%2F%2Fsurvey.example.com%2Fs3%2F12345%2Fexample-survey%3FuniqueID%3Duser112]
If you need help integrating Lumiere into your survey hosting or online sample platform, reach out to our Lumiere Support Team for assistance!
Remember, custom data can also be added to your video URL. These custom data allow you to filter a video's insights dashboard. See more here.