Table of Contents
Application Programming Interface (API)
Video Player Public API
Summary
The following public API’s/routes are available for use by other users and services, without authentication.
API List
Purpose | HTTP Method(s) | Route | Response (Success/Fail) |
|
| HTML/HTML | |
|
| JavaScript/HTML | |
|
| JSON/JSON | |
|
| JSON/JSON |
URL Construction
The root address is:
https://player.pitchhub.com/en
An example, using the thumbnail API is, in generalized form:
https://player.pitchhub.com/en/public/player/thumbnails/{id}
An example, using the thumbnail API with a specific ID:
https://player.pitchhub.com/en/public/player/thumbnails/70c030c726183558ce09d52945083df3
API details
Video Player IFRAME
Video player designed to be used inside of an IFRAME, so there are no context controls.
Request
Relative Route
/public/player/iframe/{id}Route Parameters
ID | Required | Description |
| Yes | Video Menu token or Video token, also referred to as "id" in the PitchHub Video Export screen. |
Example URL:
https://player.pitchhub.com/en/public/player/70c030c726183558ce09d52945083df3
Example Response:
Valid (200)
Example:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
…
</head>
<body>
<div id="menu"></div>
<script src="https://player-dev.pitchhub.com/en/public/player/embed/8ee2afe9a240a968191d0ca0b37a4f02"></script>
</body>
</html>
Not Found (404)
Example:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
…
</head>
<body>
…
</body>
</html>
Video Player Embedded
Video player designed to be imported in a <script> tag, as JavaScript code.
Request
Relative Route
/public/player/embed/{id}Route Parameters
ID | Required | Description |
| Yes | Video Menu token or Video token, also referred to as "id" in the PitchHub Video Export screen. |
Response
Example URL:
https://player.pitchhub.com/en/public/player/embed/70c030c726183558ce09d52945083df3
Example Response:
Valid (200)
var defaultScriptElement = document.currentScript;
var constants = {
Asset_Type_Javascript: 'js',
Asset_type_CSS: 'css',
…
Not Found (404)
Example:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
…
</head>
<body>
…
</body>
</html>
Video Player Thumbnails
Return a JSON object with an array of available thumbnails.
The number of thumbnails in the array will vary depending upon the full size dimensions. The pixel width and height of each thumbnail is listed, along with the full URL to the thumbnail.
In the future:
- Thumbnails can originate from other services (AWS S3/CloudFront, Mux.com, etc.)
- Thumbnails might have signed URL’s that represent an extremely long amount of time until expiration.
Request
Relative Route
/public/player/thumbnails/{id}Route Parameters
ID | Required | Description |
| Yes | Video Menu token or Video token, also referred to as "id" in the PitchHub Video Export screen. |
Response
Valid (200)
Example URL:
https://player.pitchhub.com/en/public/player/thumbnails/70c030c726183558ce09d52945083df3
Example Response:
[
{
"width": 100,
"height": 75,
"url": "https://image.mux.com/E6Z6YXCnzLAN4Z1xtW2ULO6AQdrSj01bw/thumbnail.png?height=75&width=100&time=2.04271&fit_mode=preserve"
},
{
"width": 200,
"height": 150,
"url": "https://image.mux.com/E6Z6YXCnzLAN4Z1xtW2ULO6AQdrSj01bw/thumbnail.png?height=150&width=200&time=2.04271&fit_mode=preserve"
},
{
"width": 295,
"height": 166,
"url": "https://image.mux.com/E6Z6YXCnzLAN4Z1xtW2ULO6AQdrSj01bw/thumbnail.png?height=166&width=295&time=2.04271&fit_mode=preserve"
},
{
"width": 640,
"height": 360,
"url": "https://image.mux.com/E6Z6YXCnzLAN4Z1xtW2ULO6AQdrSj01bw/thumbnail.png?height=360&width=640&time=2.04271&fit_mode=preserve"
},
{
"width": 940,
"height": 540,
"url": "https://image.mux.com/E6Z6YXCnzLAN4Z1xtW2ULO6AQdrSj01bw/thumbnail.png?height=540&width=940&time=2.04271&fit_mode=preserve"
},
{
"width": 1280,
"height": 720,
"url": "https://image.mux.com/E6Z6YXCnzLAN4Z1xtW2ULO6AQdrSj01bw/thumbnail.png?height=720&width=1280&time=2.04271&fit_mode=preserve"
},
{
"width": 1920,
"height": 1080,
"url": "https://image.mux.com/E6Z6YXCnzLAN4Z1xtW2ULO6AQdrSj01bw/thumbnail.png?height=1080&width=1920&time=2.04271&fit_mode=preserve"
}
]
Not Found (404)
Example:
{
"error_code": "general.record_not_found",
"error": "Record not found"
}Video Player Basic Metrics
Return a JSON object with the basic metrics for a video. The metrics are created only for views which take place outside of the PitchHub web app (e.g. HTML "iframe", or "Video Hosted Page")
Request
Relative Route
/public/player/basic-metrics/{id}Route Parameters
ID | Required | Description |
| Yes | Video Menu token or Video token, also referred to as "id" in the PitchHub Video Export screen. (note as of June 10, 2021: currently only "Video" entries are supported, not "Video Menus") |
Response
Valid (200)
Example URL:
https://player.pitchhub.com/en/public/player/basic-metrics/70c030c726183558ce09d52945083df3
Example Response:
{
"play_count": 2
}Not Found (404)
Example:
{
"error_code": "general.record_not_found",
"error": "Record not found"
}
