API Integration - Venue Monitoring
About Pixellot
Pixellot offers automated sports production solutions that provide affordable alternatives to traditional video capture, production, and distribution systems for professional and semi-professional sports events. Founded in 2013, Pixellot’s AI technology solution streamlines production workflow by deploying an unmanned multicamera system in a fixed location, with additional angles as required, to cover the entire field, offering a stitched panoramic image. Advanced algorithms enable automatic coverage of the flow of play and generate highlights. Pixellot systems are deployed by broadcasters, production companies, clubs, federations, universities, high schools, sports portals, and coaching solution providers around the globe.
For more information visit: www.pixellot.tv
Legal Notice
This document contains proprietary and confidential material of Pixellot Ltd. Any unauthorized reproduction, use, or disclosure of this material, or any part thereof, is strictly prohibited. This document is solely for the use of Pixellot employees and authorized Pixellot customers.
The material furnished in this document is believed to be accurate and reliable. However, no responsibility is assumed by Pixellot Ltd. for the use of this document or any material included herein. Pixellot Ltd. reserves the right to make changes to this document or any material included herein at any time and without notice.
For more information visit: www.pixellot.tv
Copyright © 2024 Pixellot Ltd.
All Rights Reserved.
Pixellot API
Pixellot provides its partners with a dedicated Partner API for creating new entities, updating and retrieving them. In addition, a partner can subscribe to Pixellot webhooks to get notification about different significant occurrences.
The idea is that a partner can, for
instance, ask for a list of events on startup. When the partner
subscribes to the webhooks service, it will get notifications about
every significant change (including creation and deletion) and will
update its own database. This will omit the need to repeatedly ask for
the full list of events to get new events and updates to existing
events. The updates can, in this way, be done passively in a push method
instead of pull.
RestAPI documentation
Explore Partner API through our official documentation. This resource provides essential information for integrating our services seamlessly into your applications. Find detailed API endpoints, request methods, authentication guides, and error handling instructions.
For more information, visit our REST API documentation at https://app.swaggerhub.com/apis/Pixellot/partner_api/
Available environments:
[Base URL] = api.pixellot.tv/v1 (PROD) - production workloads
[Base URL] = api.stage.pixellot.tv/v1 (STAGE) - tests and integration
Authorization
All
API requests, except for login, require the “Authorization” header to
be present. Authorization is based on the JWT method. JSON Web Token
(JWT) is a compact, URL-safe means of representing claims to be
transferred between two parties.
Typical authenticated request would be having the following look:
curl https://api.stage.pixellot.tv/v1/venues -H "Authorization: eyJ0eX..."
Venue monitoring
Example response:
{"venueId": "5778a5ee3e87e87f115be78f","systemRole": "vpu","status": "Live","values": {"cpu": {"severity": "Ok"},"gpu": {"severity": "Ok"},"camera": {"severity": "Ok"},"health": {"severity": "Ok"},"status": {"severity": "Ok", "description": "Live"},"darkCourt": {"severity": "Error"},"connection": {"severity": "Ok"},"hdBandwidth": {"severity": "Ok"},"hdAudioVolume": {"severity": "Ok"},"panoBandwidth": {"severity": "Error"},"cpuTemperature": {"severity": "Error"},"scoreboardData": {"severity": "Ok"},"audioIndication": {"severity": "Warning"},"panoAudioVolume": {"severity": "Ok"},"hardDriveAvailableMB": {"severity": "Ok"},"scoreboardConnection": {"severity": "Ok"}},"name": "Custom VPU Name"}
This data is being updated once a few minutes.
If you need any additional fields to be present in response, for example, Panorama bandwidth, please raise a request to your account manager.
Related Articles
API Integration - Events Monitoring and Hooks
About Pixellot Pixellot offers automated sports production solutions that provide affordable alternatives to traditional video capture, production, and distribution systems for professional and semi-professional sports events. Founded in 2013, ...API Integration - Events and Clubs
About Pixellot Pixellot offers automated sports production solutions that provide affordable alternatives to traditional video capture, production, and distribution systems for professional and semi-professional sports events. Founded in 2013, ...API Integration - Onboarding and Best practices
About Pixellot Pixellot offers automated sports production solutions that provide affordable alternatives to traditional video capture, production, and distribution systems for professional and semi-professional sports events. Founded in 2013, ...API Integration - Advanced Breakdown
About Pixellot Pixellot offers automated sports production solutions that provide affordable alternatives to traditional video capture, production, and distribution systems for professional and semi-professional sports events. Founded in 2013, ...API Integration - Categories and Teams
About Pixellot Pixellot offers automated sports production solutions that provide affordable alternatives to traditional video capture, production, and distribution systems for professional and semi-professional sports events. Founded in 2013, ...