* Stats API
❗️ ANIMAKER PLEASE CHECK
A) PLEASE DELETE TOPIC IF NOT RELEVANT
B) check the following links for GET statement:
- Account statistics
- Video statistics
C) please check if the information for account and video statistics are as what I wrote
📘 RESPONSE FROM SHOW
they will give the dev docs for this topic at a later stage so disabling this page for now
OVERVIEW
You can use our STATS API to get information about your historical statistics like how many viewers watched your video, how many watched it till the end, etc.
ACCOUNT STATISTICS
If you want to get information about your SHOW account information, like how many videos have been played, etc. You need to issue a GET request to the following URL to get the information about your account.
GET https://api.getshow.io/stats/account.json
The typical response would include the following information:
| FIELD | DESCRIPTION |
|---|---|
| load\_count | This will give the total number of times all the videos in your SHOW account have been loaded. |
| play\_count | This will tell you how many times the viewers have clicked the Play Button, or how many times all the videos in your SHOW account have been played. |
| hours\_watched | This will tell you the total amount of hours your viewers spent to watch all of the videos in your SHOW account. |
| number\_of\_videos | This will give the total number of videos in your SHOW account. |
VIDEO STATISTICS
You can get statistics of a specific video in your SHOW account. For this, you need to send a GET request to the following URL where the Video ID is the one you can see in the particular video's URL.
GET https://api.getshow.io/stats/[video-id].json
You will get a response with the following information:
| FIELD | DESCRIPTION |
|---|---|
| load\_count | This will tell you the total number of times this video has been loaded. |
| play\_count | This will tell you how many times this video was played. |
| play\_rate | This will give you a percentage of viewers who played the video (between 0 and 1). |
| hours\_watched | This will tell you the total number of hours your video was watched. |
| engagement | This will give you an average percentage of the viewed video(between 0 and 1). |
| visitors | This will give you the number of unique visitors who loaded this video. |
| actions | This will give you the statistics for the different actions like forms, call-to-action, etc. |
ENGAGEMENT STATISTICS
Here, you can get detailed information about your video's engagement that will help in plotting your engagement graphs. The GET request for this option is,
GET https://api.getshow.io/stats/[video-id]/engagement.json
You can get the following information in your response.
| FIELD | DESCRIPTION |
|---|---|
| engagement | This will give you a percentage of how many visitors had viewed this video, averaged across all viewing sessions. |
| engagement\_data | This will give you the necessary data source to help create engagement graphs. |
| rewatch\_data | This will give the data for the rewatch block on the engagement graph. |
VISITOR STATISTICS
For All Visitors\ You can get the data for all the visitors that have engaged with your SHOW videos. The request statement is,
GET https://api.wistia.com/v1/stats/visitors.json
GET https://api.getshow.io/stats/visitors.json
You can set the following parameters to get the required response.
| PARAMETER | DESCRIPTION |
|---|---|
| page | The number of pages of results depending on the per\_page parameter. |
| per\_page | The maximum number of results on a page. The max. limit is 100. |
| filter | This optional parameter can take any of the values: 1. **has\_name**: For visitors with a name or 2. **has\_email**: For visitors with an email address 3. **identified\_by\_email\_gate**: For visitors who entered email address in video email gate |
| search | This will give the visitor name or email address that fits the given value exactly. |
| FIELD | DESCRIPTION |
|---|---|
| visitor\_key | The visitor's unique id. |
| created\_at | The time the viewer loaded a video from your SHOW account for the first time |
| last\_active\_at | The time the viewer played a video from your SHOW account for the last time |
| last\_event\_key | The event key that will tell you what happened the last time they played a video |
| load\_count | This will give the total number of videos loaded by this visitor, including ones played and not played. |
| play\_count | This will give the total number of videos played by this visitor. |
| identifying\_event\_key | This will give the key to the event that will identify the viewer. |
| visitor\_identity | This will give information about the visitor, like the name, email, and organization. |
| user\_agent\_details | The Tech information about the viewer, the browser, browser version, platform/operating system, and whether the user was using a mobile device. |
For A Specific Visitor\ You can get all the information of a specific visitor's activity by sending a GET request to the following URL.
GET https://api.getshow.io/stats/visitors/[visitor-key].json
This will give the following information in the response and no parameters can be defined since the visitor's ID is provided.
| visitor\_key | Unique ID of this specific viewer |
| created\_at | The time this visitor loaded a video for the first time |
| last\_active\_at | The time this viewer played a video from your SHOW account for the last time. |
| last\_event\_key | This will tell you what happened the last time this visitor played a video. |
| load\_count | This will give the total number of videos loaded by this specific viewer. |
| play\_count | This will give the total number of videos played by this specific viewer. |
| visitor\_identity | More information about this specific viewer, like the name, email, and organization. |
| user\_agent\_details | The Tech information about the viewer, the browser, browser version, platform/operating system, and whether the user was using a mobile device. |
EVENT STATISTICS
List of All Events\ You can get the list of all the events that have occurred in your SHOW account as per the following parameters.
| PARAMETER | DESCRIPTION |
|---|---|
| video\_id | Specifies a particular video (optional) |
| visitor\_key | Specifies a specific visitor (optional) |
| per\_page | Specifies the maximum number of events to retrieve per page |
| page | Specifies the page of events as per the per\_page parameter |
| start\_date | Specifies the start date of the date range for the events retrieval. |
| end\_date | Specifies the end date of the date range for the retrieval of the events. |
You can send the following request,
GET https://api.getshow.io/stats/events.json
And, you can get the following information in the response.
| FIELD | DESCRIPTION |
|---|---|
| received\_at | The time and date of the event |
| event\_key | The unique ID of the event |
| visitor\_key | A visitor's unique ID |
| embed\_url | URL of the video that was watched |
| percent\_viewed | Percentage of how much the video was watched |
| ip | Viewer's IP address |
| org | Name of the viewer's company/organization, based on the IP address |
| country | Viewer's country based on the IP address |
| region | Viewer's region based on the IP address |
| city | Viewer's city based on the IP address |
| lat | Viewer's latitude based on the IP address |
| lon | Viewer's longitude based on the IP address |
| Viewer's email address | |
| media\_id | SHOW video's unique ID |
| media\_url | SHOW video's URL |
| media\_name | SHOW video's name |
For Single Event\ You can use this for information for a single event. You can give the following request.
GET https://api.getshow.io/stats/events/[event-key].json
The information received is similar to the one received for all events. You don't have to set the parameters since this is for a single event.