Video reports API offers a wide range of analytics to help your users track their video and understand viewers within your app.
This API provides two types of reports:
Reports for a video
This report offers basic details of the video such as the number of plays, watch rate, and video engagement.
URL
GET https://www.hippovideo.io/api/v1/me/video/reports/{video_id}
Params
email - email of the user
authentication_token - auth token of the user (Get your auth token here)
video_id - id of the video
Response
{
"status": 200,
"id": 988,
"total_plays": 13,
"total_page_loads": 15,
"unique_users": 10,
"avg_watch_rate": 85,
"actions": {
"no_of_actions": 111,
"annotations": 4,
"call_to_actions": 19,
"forms": 6,
"end_screens": 3,
"questions": 5,
"comments": 8,
"reactions": 63,
"replies": 3
},
"watch_rate": {
"0": 0,
"25": 3,
"50": 2,
"75": 1,
"100": 5
},
"popular_region": "Houston, Texas",
"plays_in_popular_region": "1 plays from Houston, Texas"
}id - Video ID
total_page_loads - Number of times the shared link is opened.
total_plays - Number of times the video has been played out of total page loads.
unique_users - Number of unique users that have played the video.
avg_watch_rate - The overall percentage (total duration watched / total plays * video duration)
actions - (annotation, CTA, lead generation forms, etc.)
no_of_actions - Total number of actions.
annotations - Number of clicks on annotations.
call_to_actions - Number of clicks on CTA.
forms - Number of clicks on lead generation forms.
end_screens - Number of clicks on playlist.
questions - Number of clicks on custom poll.
comments - Total number of comments on the video.
reactions - Total number of reactions on the video.
replies - Number of replies to the comments.
Viewer profile reports
Under viewer profile reports, you can get the following reports:
Based on Video
This report offers all the details of a video such as the number of views, watch rate, viewer location, and the viewers engagement on a particular video. To get the reports, you must call the link below.
URL
GET https://www.hippovideo.io/api/v1/me/video/viewer_profile
Params
email - email of the user
authentication_token - auth token of the user (Get your auth token here)
user_email (optional) - mail id of the lead
video_id (optional) - id of the video
Note: You can either provide user_email or video_id. They are mutually exclusive. If you'd like to know how a particular video is performing, then enter video_id.
Response
{
"status": 200,
"viewer_profile": [
{
"video_id": "988",
"email": 'michael.clark@icc.com',
"viewer_name": 'Michael Clark',
"ip": "188.XXX.29.XXX",
"last_viewed_time": "31/12/2018 02:23 AM",
"location": "Sydney, Australia",
"device": "DESKTOP",
"os": Macintosh,
"browser": Chrome,
"referer_url": "https://www.google.co.in/",
"precentage_played": 95,
"views": 2
}
],
"load_more": false,
"page": 1,
"next_page": 2
}Based on Lead’s Email
This report offers all the details for a particular lead’s email address such as the number of videos watched, watch rate, lead's location, and their engagement on the videos.
This API is same as the report based on video, except ‘user_email’ param should be passed instead of ‘video_id.’
Response
{
"status": 200,
"viewer_profile": [
{
"video_id": "999",
"email": "joebrown@google.com",
"viewer_name": "Joe Brown",
"ip": "188.XXX.29.XXX",
"last_viewed_time": "09/01/2019 12:27PM",
"location": " NA ",
"device": "DESKTOP",
"os": "Macintosh",
"browser": "Chrome",
"referer_url": "https://mail.google.com/mail/u/#sent/16831654c41cc10a",
"precentage_played": 36,
"views": 1
},
{
"video_id": "937",
"email": "joebrown@google.com",
"viewer_name": "Joe Brown",
"ip": "188.XXX.29.XXX",
"last_viewed_time": "19/10/2018 12:25PM",
"location": "Naples, ITALY",
"device": "DESKTOP",
"os": "Macintosh",
"browser": "Chrome",
"referer_url": " NA ",
"precentage_played": 100,
"views": 1
}
],
"load_more": false,
"page": 1,
"next_page": 2
}video_id - ID of the video.
email - Email address of the lead.
viewer_name - Name of the lead.
ip - Masked IP of the lead.
last_viewed_time - Time at which the lead has watched the video.
location - Geographical location of the lead.
device - Device used by the lead to watch the video.
os - Operating system of the device in which the lead has watched the video.
browser - The browser in which the lead has watched the video.
referer_url - The address of the webpage where a person clicked a link that sent them to your video.
percentage_played - Percentage of video watched.
load_more - By default the number of videos in an API call is 10. P.S: load_more is true, if it has more results left.
page - The current page number.
next_page - The number of the next page.
The above responses are success cases. In case, any errors occur you’ll see an error response.
To check out other articles related to this topic.
