GET Ecommerce Analytics API
Requires ParOne Enterprise PlayerRequires Ecommerce Addon
ParOne allows you to pull statistics about the ecommerce activities that run on your videos. Use the following REST API to retrieve that information.
Retrieve ecommerce analytics for your organization
This GET request retrieves the ecommerce analytics. Your organization key will be provided by ParOne.
GET https://reports.parone.app/prod/get_ecommerce_reports
Parameters
| Parameter | Value | Comments |
|---|---|---|
| content_key | the content key for the video | optional. If not provided ecommerce statistics for all your videos will be provided. |
| organization_key | The organization key. Provided by ParOne. | |
| start_date | The start date. Must be in the format YYYY-MM-DD. This is inclusive of this day. | ecommerce statistics are stored by UTC day. An event that occurs 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. | ecommerce statistics are stored by UTC day. An event that occurs at 10PM EST on 1-Jan will be counted on 2-Jan. |
| include_video_data | 0 / 1 | Optional. 0 → no video data (default). 1 → include video data |
| include_ecommerce_data | 0 / 1 | Optional. 0 → no ecommerce data (default). 1 → include ecommerce data |
Return Value
This call will return a JSON object that has a list of videos for your organization.
{
"data": {
"ecommerce_info": [
{
"ecommerce_key": "vyP4NsKz",
"ecommerce_link": "https://www.cnn.com",
"ecommerce_name": "Testing"
},
{
"ecommerce_key": "zikKYoMQ",
"ecommerce_link": "https://www.google.com",
"ecommerce_name": "Testing2"
}
],
"ecommerce_stats": [
{
"content_key": "2d91Ee68EA84Eb8bED31",
"date": "2022-10-19T23:59:59.000Z",
"device_type": "Desktop",
"ecommerce_bar_hidden": 0,
"ecommerce_bar_shown": 0,
"ecommerce_clicked": "0",
"ecommerce_hidden": 1,
"ecommerce_key": "vyP4NsKz",
"ecommerce_viewed": 1
},
{
"content_key": "2d91Ee68EA84Eb8bED31",
"date": "2022-10-19T23:59:59.000Z",
"device_type": "Desktop",
"ecommerce_bar_hidden": 0,
"ecommerce_bar_shown": 0,
"ecommerce_clicked": "0",
"ecommerce_hidden": 1,
"ecommerce_key": "zikKYoMQ",
"ecommerce_viewed": 1
},
{
"content_key": "2d91Ee68EA84Eb8bED31",
"date": "2022-10-14T23:59:59.000Z",
"device_type": "Desktop",
"ecommerce_bar_hidden": 0,
"ecommerce_bar_shown": 0,
"ecommerce_clicked": "1",
"ecommerce_hidden": 2,
"ecommerce_key": "vyP4NsKz",
"ecommerce_viewed": 5
},
{
"content_key": "2d91Ee68EA84Eb8bED31",
"date": "2022-10-14T23:59:59.000Z",
"device_type": "Desktop",
"ecommerce_bar_hidden": 3,
"ecommerce_bar_shown": 2,
"ecommerce_clicked": "0",
"ecommerce_hidden": 0,
"ecommerce_key": "none",
"ecommerce_viewed": 0
},
{
"content_key": "2d91Ee68EA84Eb8bED31",
"date": "2022-10-14T23:59:59.000Z",
"device_type": "Desktop",
"ecommerce_bar_hidden": 0,
"ecommerce_bar_shown": 0,
"ecommerce_clicked": "1",
"ecommerce_hidden": 1,
"ecommerce_key": "zikKYoMQ",
"ecommerce_viewed": 5
},
{
"content_key": "2d91Ee68EA84Eb8bED31",
"date": "2022-10-14T23:59:59.000Z",
"device_type": "Desktop",
"ecommerce_bar_hidden": 0,
"ecommerce_bar_shown": 0,
"ecommerce_clicked": "0",
"ecommerce_hidden": 0,
"ecommerce_key": "zikKYoMQ",
"ecommerce_viewed": 1
},
{
"content_key": "2d91Ee68EA84Eb8bED31",
"date": "2022-10-14T23:59:59.000Z",
"device_type": "Desktop",
"ecommerce_bar_hidden": 0,
"ecommerce_bar_shown": 0,
"ecommerce_clicked": "0",
"ecommerce_hidden": 0,
"ecommerce_key": "vyP4NsKz",
"ecommerce_viewed": 1
},
{
"content_key": "2d91Ee68EA84Eb8bED31",
"date": "2022-10-14T23:59:59.000Z",
"device_type": "Desktop",
"ecommerce_bar_hidden": 1,
"ecommerce_bar_shown": 1,
"ecommerce_clicked": "0",
"ecommerce_hidden": 0,
"ecommerce_key": "none",
"ecommerce_viewed": 0
},
{
"content_key": "b4A486fde6dDf7Cb6C7c",
"date": "2022-10-15T23:59:59.000Z",
"device_type": "Mobile",
"ecommerce_bar_hidden": 0,
"ecommerce_bar_shown": 0,
"ecommerce_clicked": "0",
"ecommerce_hidden": 0,
"ecommerce_key": "none",
"ecommerce_viewed": 0
}
],
"video_info": [
{
"content_key": "2d91Ee68EA84Eb8bED31",
"description": "Watch highlights from the final round of the 2022 Trust Golf Women\u2019s Scottish Open",
"duration": null,
"parone_categories": [
"News & Tour News",
"LPGA Tour"
],
"privateCategories": [],
"privateTags": [],
"removed": 0,
"syndications": [
{
"end_date": "2999-12-31T00:00:00.000Z",
"geos": [
"USA"
],
"start_date": "2022-08-02T00:00:00.000Z"
}
],
"thumbnail": "https://thumbnails.parone.io/2d91Ee68EA84Eb8bED31.jpg",
"title": "Final Round Highlights | 2022 Trust Golf Women\u2019s Scottish Open",
"translations": []
},
{
"content_key": "b4A486fde6dDf7Cb6C7c",
"description": "Watch highlights from Hyo-Joo Kim\u2019s final round 66 at the 2022 Trust Golf Women\u2019s Scottish Open",
"duration": "281.000000000000000000000000000000",
"parone_categories": [
"News & Tour News",
"LPGA Tour"
],
"privateCategories": [],
"privateTags": [],
"removed": 0,
"syndications": [
{
"end_date": "2999-12-31T00:00:00.000Z",
"geos": [
"USA"
],
"start_date": "2022-08-02T00:00:00.000Z"
}
],
"thumbnail": "https://thumbnails.parone.io/b4A486fde6dDf7Cb6C7c.jpg",
"title": "Hyo Joo Kim Final Round Highlights | 2022 Trust Golf Women's Scottish Open",
"translations": []
}
]
},
"message": "ok",
"status": "ok"
}Structure of the Returned Results
The ecommerce 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 |
| content_key | String | The content key of the video. This is the video that the eCommerce key is associated with. |
| ecommerce_key | String | The eCommerce key for the video. This is a key pointing to the name/url/icon of the eCommerce icon. |
| ecommerce_clicked | number | The number of times a user clicked on the icon |
| ecommerce_hidden | number | The number of times the icon was hidden |
| ecommerce_visible | number | The number of times the icon was viewed |
| device_type | String | What kind of device played the ecommerce. One of: Mobile, Desktop, Tablet, TV, Other |
| ecommerce_bar_hidden | number | The number of times the bar was hidden by viewers of the video |
| ecommerce_bar_shown | number | The number of times the bar was shown by viewers of the video |