API Guide

Mindstamp Events

New View

Triggers when a video view takes place on Mindstamp.

Value Type Description Example
id Unique ID ID of the view 9bce33d1-120c-4bb5-8b5a-499896140f20
owner_id Unique ID ID of the video owner 75d57cda-332b-400a-887e-0bed5f6ced99
video_id Unique ID ID of the Video 0452e22e-5e15-4b51-bcc7-0be4c0df99b1
video_token String Unique Token of the video found in your video URL aVOfEGmGrZlG
video_title String Title of the video Interactive Video #9
started DateTime When the view started Sat, 1 Jan 2022 05:12:32 UTC +00:00
finished DateTime When the view finished Sat, 1 Jan 2022 05:15:24 UTC +00:00
elapsed Integer The difference between the started time and the finished time in seconds 172
percentage Integer Percentage watched 95
last_point Integer The second in which your viewer stopped watching your video. 35
furthest_point Integer The furthest second in the video the viewer watched. 55
viewer_id Unique ID ID of the viewer 8b5ce4b2-8bc6-4252-bdeb-a7304d7e028e
viewer_name String Viewer's name as received in the URL, info capture, or if they are Mindstamp user John Doe
viewer_email String Viewer's email as received in the URL, info capture, or if they are Mindstamp user [email protected]
viewer_phone String Viewer's phone number as received in the URL, info capture, or if they are Mindstamp user (321) 123-4567
viewer_custom_id String Viewer's custom ID number as received in the URL or info capture 123456
interaction_count Integer Number of interactions the viewer engaged with 25
city String City the viewer watched the video Flagami
region String Region (state) the viewer watched the video Florida
country String Country the viewer watched the video United States
flag String Emoji of the viewer's country 🇺🇸
url String URL of the video https://myinteractive.video/ w/aVOfEGmGrZlG
browser String Browser the viewer used Chrome 101
screen_width String Viewer's screen width 1792
screen_height String Viewer's screen height 980
participation Integer Number from 0-100 indicating the number of interactions the view engaged with divided by the total number of interactions in the video 98
correctness Integer Number from 0-100 indicating the number of questions answered correctly divided by the total number of questions with correctness 95
plink_id Unique ID ID of the personal link for the viewer to view the video 7b5ce3b4-1bc5-5373-bdeb-a9468d7e033e
tag1 String Value of the tag1 variable passed in through the URL of the video or collected in the video by other means myTag1
tag2 String Value of the tag2 variable passed in through the URL of the video or collected in the video by other means myTag2
tag3 String Value of the tag3 variable passed in through the URL of the video or collected in the video by other means myTag3
tag4 String Value of the tag4 variable passed in through the URL of the video or collected in the video by other means myTag4
tag5 String Value of the tag5 variable passed in through the URL of the video or collected in the video by other means myTag5
group_id Unique ID ID of the group in which the video belongs to ac864070-9501-4f32-a361-075c89a2c339
video_owner_id Unique ID User ID of the owner of the video 75d57cda-332b-400a-887e-0bed5f6ced99
export_count Integer The number of times the view has been exported via a webhook 1
variables JSON Object containing the variables used throughout the video {
  "name" : "John",
  "color" : "blue",
  "favorite_number" : 7
}
created_at DateTime When the view record was created in the Mindstamp database Sat, 1 Jan 2022 05:12:32 UTC +00:00
updated_at DateTime When the view record was last updated in the Mindstamp database Sat, 1 Jan 2022 05:15:24 UTC +00:00

New Interaction

Triggers when a viewer makes an interaction with one of your video

Value Type Description Example
id Unique ID ID of the interaction 9bce33d1-120c-4bb5-8b5a-499896140f20
video_title String Title of the video Interactive Video #9
type_of String Type of interaction click
value String Selected answer (questions) or label of interaction (button, hotspot, etc.) D. All of the Above
time Integer Second the interaction appears in the video 100
finish Integer Second the interaction disappears in the video 105
parent_id Unique ID ID of the parent of the interaction 9ers33y1-120t-4gs5-8g5s-499896140g20
parent_type String The parent type of the interaction (question, button, hotspot, etc.) question
parent_value String Question Prompt or label of interaction (button, hotspot, etc.) How can you get a good night's sleep?
click_action String The action assigned when a user engages with an interactions link
click_value String Parameter for the click action www.google.com
viewer_name String Viewer's name as received in the URL, info capture, or if they are Mindstamp user John Doe
viewer_email String Viewer's email as received in the URL, info capture, or if they are Mindstamp user [email protected]
viewer_phone String Viewer's phone number as received in the URL, info capture, or if they are Mindstamp user (321) 123-4567
viewer_custom_id String Viewer's custom ID number as received in the URL or info capture 123456
style String Type of question (free response, multiple choice, show poll, etc.) multiple
answers List Array of answers for a question interaction [
  "A. No coffee past 2pm",
  "B. Don't nap past 4pm",
  "C. Limit screen time",
  "D. All of the Above"
]
correct_answer String Correct answer to a question interaction D. All of the Above
correct Boolean True/False if the viewer answered the question correctly TRUE
view_id Unique ID ID of the view ds4yh2sd-5df5-4by1-bccd-0be4c0dfd9b1
video_id Unique ID ID of the Video 0452e22e-5e15-4b51-bcc7-0be4c0df99b1
url String URL of the video https://myinteractive.video/ w/aVOfEGmGrZlG
viewer_id Unique ID ID of the viewer 8b5ce4b2-8bc6-4252-bdeb-a7304d7e028e
created_at DateTime When the interaction record was created in the Mindstamp database Sat, 1 Jan 2022 05:12:32 UTC +00:00
updated_at DateTime When the interaction record was last updated in the Mindstamp database Sat, 1 Jan 2022 05:15:24 UTC +00:00
group_id Unique ID ID of the group in which the video belongs to ac864070-9501-4f32-a361-075c89a2c339
variables JSON Object containing the variables used throughout the video {
  "name" : "John",
  "color" : "blue",
  "favorite_number" : 7
}
export_count Integer The number of times the interaction has been exported via a webhook 1
video_owner_id Unique ID User ID of the owner of the video 75d57cda-332b-400a-887e-0bed5f6ced99

New Lead

Triggers when a viewer submits their name, email, phone, or custom ID in one of your videos.

Value Type Description Example
id Unique ID ID of the viewer 9bce33d1-120c-4bb5-8b5a-499896140f20
name String Viewer's name as received in the URL, info capture, or if they are Mindstamp user John Doe
email String Viewer's email as received in the URL, info capture, or if they are Mindstamp user [email protected]
phone String Viewer's phone number as received in the URL, info capture, or if they are Mindstamp user (321) 123-4567
owner_id Unique ID ID of the video owner 75d57cda-332b-400a-887e-0bed5f6ced99
user_id Unique ID ID of the viewer if they are a Mindstamp user 9bc34dd1-1sdc-4bb5-8b5a-4dg39614d320
custom_id String Viewer's custom ID number as received in the URL or info capture 123456
created_at DateTime When the view record was created in the Mindstamp database Sat, 1 Jan 2022 05:12:32 UTC +00:00
updated_at DateTime When the view record was last updated in the Mindstamp database Sat, 1 Jan 2022 05:15:24 UTC +00:00