API Integration - Troubleshooting and Q&A

API Integration - Troubleshooting and Q&A

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


Q&A

Q: Bad request with the incomprehensible error message?

A: Check club options first, then check if the payload schema matches, and if the values have correct format.

Q: 401 Unauthorized error?

A: Can be caused by a few reasons:
  1. The need to refresh a token. No need to do it all the time, as the token is valid for 10 hours.
  2. Incorrect request composition. "Authorization" header should be used for sending token data, and the value should not include the "Bearer " prefix.

Q: How to pull the game highlights, aka “condensed game”?

A: Highlights can be be received using the ClipNotification webhook type - see the "What do you get when you subscribe?" section from https://docs.pixellot.tv/portal/en/kb/articles/api-webhook-subscriptions-28-12-2022#37__ClipNotification. The "automaticProductionHighlight" is the same entity as "Highlight"/"Highlight HQ" in CMS. In case there is a need to have raw files, try using https://app.swaggerhub.com/apis/Pixellot/partner_api/1.28.1#/default/getHighlightsArchiveV2 API - it will provide a link to download a .zip with highlights.

Q: Time options are incorrect?

A: The recommended time for event setup is 10 minutes, as described in the "Best Practices" section from https://docs.pixellot.tv/portal/en/kb/articles/pixellot-api-integration-onboarding-and-best-practices-15-2-2023-1#20_Best_practices. The minimum time offset you can schedule an event with is the next minute. Assuming that the current time is 2023-04-13 13:13:13.000 UTC, the closest possible start$date will be “2023-04-13T13:14:00.000+00:00” - otherwise the request will be rejected.

Q: I am receiving a "Venue doesn't belong to any club or doesn't exist" error during event creation?

A: Check the list of venues assigned to a club you are creating the events on. For example, the following payload can be used to create an event only for the club on the left:
  1. {
    "eventName": "PXLT Test",
    "start$date": "{{start_date}}",
    "end$date": "{{end_date}}",
    "venue": {
        "_id": "5cb711860b461f3c102ef58b"
    },
    "scoreboardData": {
        "homeTeam": "Home", "awayTeam": "Guest", "enable": true
    },
    "permission": "club",
    "productionType": "soccer"
}
Good config:

Will return an error:

Q: Where to find user ID to add/remove from a club?

A: IDs of users are the same as in CMS, and can be also obtained from GET /clubs/:id API - https://app.swaggerhub.com/apis/Pixellot/partner_api/1.28.1#/default/getClub . Note that the user behind API credentials used for requests does not have a specified ID, and is not a part of club or tenant data.

Q: How to upload club logos via API?

A: The logos are already part of the clubs’ configurations, that’s why no additional configuration is needed from API side. Club graphics will be inherited by events.

Q: “Live Pano” setting has different value than I provided?

A: In club-level event scheduling it is possible to provide the value explicitly - https://app.swaggerhub.com/apis/Pixellot/partner_api/1.28.1#/default/addEventForClub , or inherit from club or tenant. Using POST /events can yield unexpected results here.

Q: How to specify event’s visibility to specific users only?

A: “permission” field should be used. Accepts one of the values:
- all - visible to all users
- club - visible to club members
- admin - visible to club admins, and account admins of the tenant

Q: What game types can be created via API?

A: Currently, we allow “game” events to be created with 2 teams. Also, “practice” and “other” can be scheduled via API (events with 1 and 0 teams respectively). Use the “gameType” field to specify the selected game type.

    • Related Articles

    • 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, ...

    • API Integration - Pixellot Marketplace

      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 - 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 - 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, ...