GET Video Analytics API
ParOne allows you to pull statistics about your videos. Use the following REST API to retrieve that information.
Retrieve video analytics for your organization
This GET request retrieves the video analytics. Your organization key will be provided by ParOne.
GET https://reports.parone.app/prod/get_video_reports
Parameters
| Parameter | Value | Comments |
|---|---|---|
| content_key | The content key for the video | Optional. If not provided video statistics for all your videos will be provided. |
| organization_key | The organization key | This key is provided by ParOne. |
| start_date | The start date. Must be in the format YYYY-MM-DD. This is inclusive of this day. | Video statistics are stored by UTC day. A video that runs at 10PM EST on 1-Jan will be counted on 2-Jan. |
| end_date | The end date. Must be in the format YYY-MM-DD. This is inclusive. | Video statistics are stored by UTC day. A video that is viewed at 10PM EST on 1-Jan will be counted on 2-Jan. |
Return Value
This call will return a JSON object that has a list of videos for your organization.
{ "data": [ { "content_key": "2d91Ee68EA84Eb8bED31", "country": "USA", "date": "2022-09-15T23:59:59.000Z", "played_15s": 0, "played_25percent": 0, "played_30s": 0, "played_3s": 0, "played_50percent": 0, "played_75percent": 0, "thumbnail_view": 0, "video_autoplay": 0, "video_caption_enabled": 0, "video_device_type": "none", "video_ended": 0, "video_impression": 2, "video_muted": 0, "video_pause": 0, "video_played": 0, "video_played_muted": 0, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 }, { "content_key": "b4A486fde6dDf7Cb6C7c", "country": "USA", "date": "2022-09-13T23:59:59.000Z", "played_15s": 1, "played_25percent": 1, "played_30s": 1, "played_3s": 1, "played_50percent": 1, "played_75percent": 1, "thumbnail_view": 0, "video_autoplay": 0, "video_caption_enabled": 0, "video_device_type": "none", "video_ended": 1, "video_impression": 0, "video_muted": 0, "video_pause": 0, "video_played": 1, "video_played_muted": 0, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 }, { "content_key": "b4A486fde6dDf7Cb6C7c", "country": "USA", "date": "2022-09-14T23:59:59.000Z", "played_15s": 2, "played_25percent": 1, "played_30s": 1, "played_3s": 2, "played_50percent": 1, "played_75percent": 1, "thumbnail_view": 0, "video_autoplay": 0, "video_caption_enabled": 0, "video_device_type": "none", "video_ended": 1, "video_impression": 6, "video_muted": 0, "video_pause": 0, "video_played": 3, "video_played_muted": 0, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 }, { "content_key": "b4A486fde6dDf7Cb6C7c", "country": "USA", "date": "2022-09-15T23:59:59.000Z", "played_15s": 0, "played_25percent": 0, "played_30s": 0, "played_3s": 0, "played_50percent": 0, "played_75percent": 0, "thumbnail_view": 0, "video_autoplay": 0, "video_caption_enabled": 0, "video_device_type": "none", "video_ended": 0, "video_impression": 7, "video_muted": 0, "video_pause": 0, "video_played": 0, "video_played_muted": 0, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 }, { "content_key": "b4A486fde6dDf7Cb6C7c", "country": "USA", "date": "2022-09-16T23:59:59.000Z", "played_15s": 0, "played_25percent": 0, "played_30s": 0, "played_3s": 1, "played_50percent": 0, "played_75percent": 0, "thumbnail_view": 0, "video_autoplay": 0, "video_caption_enabled": 0, "video_device_type": "none", "video_ended": 0, "video_impression": 1, "video_muted": 0, "video_pause": 0, "video_played": 1, "video_played_muted": 0, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 }, { "content_key": "b4A486fde6dDf7Cb6C7c", "country": "USA", "date": "2022-09-27T23:59:59.000Z", "played_15s": 1, "played_25percent": 1, "played_30s": 1, "played_3s": 1, "played_50percent": 1, "played_75percent": 2, "thumbnail_view": 0, "video_autoplay": 1, "video_caption_enabled": 1, "video_device_type": "Desktop", "video_ended": 1, "video_impression": 1, "video_muted": 1, "video_pause": 0, "video_played": 1, "video_played_muted": 1, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 }, { "content_key": "b4A486fde6dDf7Cb6C7c", "country": "USA", "date": "2022-09-28T23:59:59.000Z", "played_15s": 7, "played_25percent": 4, "played_30s": 6, "played_3s": 8, "played_50percent": 3, "played_75percent": 1, "thumbnail_view": 0, "video_autoplay": 11, "video_caption_enabled": 9, "video_device_type": "Desktop", "video_ended": 1, "video_impression": 11, "video_muted": 11, "video_pause": 0, "video_played": 11, "video_played_muted": 11, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 } ], "message": "ok", "status": "ok"}Structure of the Returned Results
The video statistics object contains the following fields
| Field | Value | Comments |
|---|---|---|
| date | The date of the results. | An ISO 8601 Date. As mentioned above, this is the day for which the statistics are gathered in UTC. Statistics for a day start at 12:00:00:000 and end at 23:59:59:999 |
| thumbnail_view | number | The number of times the thumbnail was seen. For wordpress sites using the ParOne plugin only |
| video_impression | number | The number of times the video was seen |
| video_played | number | the number of times a video was played |
| played_1s | number | The number of times the video was played for 1 second. This is most often used to define views. |
| played_3s | number | The number of times the video was played for 3 seconds |
| played_15s | number | The number of times the video was played for 15 seconds |
| played_30s | number | The number of times the video was played for 30 seconds |
| played_25percent | number | The number of times the video was played to 25% of its length |
| played_50percent | number | The number of times the video was played to 50% of its length |
| played_75percent | number | The number of times the video was played to 75% of its length |
| video_ended | number | The number of times the video was played to the end |
| content_key | string | Identifies the video |
| video_autoplay | number | The number of times the video was autoplayed |
| country | string | The country played. This is a three-letter country code |
| video_device_type | String | What kind of device played the video. One of: Mobile, Desktop, Tablet, TV, or Other |
| video_muted | number | The number of times the video was muted |
| video_unmuted | number | The number of times the video was unmuted |
| video_player_id | String | The player ID of the video. This allows you to identify the page/location of a video player. Will be “none” if not set |
| video_played_muted | number | The number of times the video was played muted |
| video_played_unmuted | number | The number of times the video was played unmuted |
| video_caption_enabled | number | The number of times captions were enabled for the video (if captions are present) |
| video_pause | number | The number of times the video was paused |
| video_resume | number | The number of times the video was resumed |
| video_docked | number | The number of times the video was docked |
| video_undocked | number | The number of times the video was undocked |
| video_entered_fullscreen | number | The number of times the video entered fullscreen |
| video_exited_fulscreen | number | The number of times the video was exited fullscreen |
Retrieve videos and analytics simultaneously
:mega: Special thanks to the team at Ignitio for this one!
This GET request retrieves the videos and its corresponding analytics. Your organization key will be provided by ParOne.
GET https://reports.parone.app/prod/get_video_reports_combined
| Parameter | Value | Comments |
|---|---|---|
| organization_key | The organization key | This key is provided by ParOne. |
| start_date | The start date. Must be in the format YYYY-MM-DD. This is inclusive of this day. | Video statistics are stored by UTC day. A video that runs at 10PM EST on 1-Jan will be counted on 2-Jan. |
| end_date | The end date. Must be in the format YYY-MM-DD. This is inclusive. | Video statistics are stored by UTC day. A video that is viewed at 10PM EST on 1-Jan will be counted on 2-Jan. |
| content_key | The content key for the video | Optional. If not provided video statistics for all your videos will be provided. |
| sort_field | The field by which to sort. | Sorting will always be from highest to lowest |
| column_list | A list of fields to retrieve | Note that sort_field needs to be in this list |
| result_limit | The number of rows to return. | Optional. |
List of fields
Here is the current list of fields that can be used in the column_list and sort_field parameters:
thumbnail_viewvideo_impressionvideo_playedplayed_1splayed_3splayed_15splayed_30splayed_25percentplayed_50percentplayed_75percentvideo_endedvideo_mutedvideo_unmutedvideo_played_mutedvideo_played_unmutedvideo_caption_enabledvideo_autoplayvideo_pausevideo_resumevideo_dockedvideo_entered_fullscreenvideo_exited_fullscreenvideo_undockedvideo_device_typevideo_player_idReturn Value
See GET Videos for additional information on returned values.
Example Query
curl 'https://reports.parone.app/demo/get_video_reports_combined?organization_key=KEY&start_date=2023-05-01&end_date=2023-06-28&column_list=played_1s,played_15s&sort_field=played_1s&result_limit=1'Example Output
{ "status": "ok", "message" : "ok", "data" : [ {"video": "VIDEO_DATA", "stats": [VIDEO_STATS_DATA]}, {"video": "VIDEO_DATA", "stats": [VIDEO_STATS_DATA]} ]}[ { "stats": [ { "content_key": "EdSGJ6kC", "country": "USA", "date": "2022-09-27T23:59:59.000Z", "played_15s": 1, "played_25percent": 1, "played_30s": 1, "played_3s": 1, "played_50percent": 1, "played_75percent": 2, "thumbnail_view": 0, "video_autoplay": 1, "video_caption_enabled": 1, "video_device_type": "Desktop", "video_ended": 1, "video_impression": 1, "video_muted": 1, "video_pause": 0, "video_played": 1, "video_played_muted": 1, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 }, { "content_key": "EdSGJ6kC", "country": "USA", "date": "2022-09-28T23:59:59.000Z", "played_15s": 7, "played_25percent": 4, "played_30s": 6, "played_3s": 8, "played_50percent": 3, "played_75percent": 1, "thumbnail_view": 0, "video_autoplay": 11, "video_caption_enabled": 9, "video_device_type": "Desktop", "video_ended": 1, "video_impression": 11, "video_muted": 11, "video_pause": 0, "video_played": 11, "video_played_muted": 11, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 } ], "video": { "content_key": "EdSGJ6kC", "created_date": "2022-08-22T19:54:50.122Z", "description": "The Callaway Golf Rogue ST irons are meant to serve as a successor to the Mavrik line, but borrow some inspiration from last year\u2019s Apex 21 irons. At the heart of this year\u2019s update is the all-new 450 A.I. Face Cup, a piece of performance-boosting tech Callaway is introducing to the golf industry with the Rogue ST line. We put the new Rogue ST Pro irons up against vs the Apex irons during GOLF Magazine's 2022 ClubTest... \n\nGOLF.com ClubTest Reviews: https://golf.com/gear/\nFully Equipped Podcast: https://golf.social/37YxrvA", "duration": 36, "parone_categories": [], "privateCategory": [], "privateTag": [], "removed": false, "syndications": [ { "geos": [], "name": "setting name", "start_date": "2022-08-22T19:54:50.122Z", "stop_date": "2022-08-22T19:54:50.122Z" } ], "thumbnail": "https://thumbnails.parone.io/EdSGJ6kC.jpg", "title": "Can the new Callaway Rogue ST Pro irons outperform Apex irons? | Proving Ground ClubTest 2022", "translations": [] } }, { "stats": [ { "content_key": "SeNBH62r", "country": "USA", "date": "2022-09-28T23:59:59.000Z", "played_15s": 7, "played_25percent": 4, "played_30s": 6, "played_3s": 8, "played_50percent": 3, "played_75percent": 1, "thumbnail_view": 0, "video_autoplay": 11, "video_caption_enabled": 9, "video_device_type": "Desktop", "video_ended": 1, "video_impression": 11, "video_muted": 11, "video_pause": 0, "video_played": 11, "video_played_muted": 11, "video_played_unmuted": 0, "video_player_id": "none", "video_resume": 0, "video_unmuted": 0 } ], "video": { "content_key": "SeNBH62r", "created_date": "2022-08-22T19:54:50.122Z", "description": "private video 1080p", "duration": 36, "parone_categories": [], "privateCategory": [], "privateTag": [], "removed": false, "syndications": [ { "geos": [], "name": "setting name", "start_date": "2022-08-22T19:54:50.122Z", "stop_date": "2022-08-22T19:54:50.122Z" } ], "thumbnail": "https://thumbnails.parone.io/SeNBH62r.jpg", "title": "private 1080", "translations": [] } }]