PV4 Documentation

BIGSCREEN

The BIGSCREEN data integration connects to the Bigscreen stats API, using separate development and production endpoints. Setup fields below are configured per Show in the PV4 Portal (Show → Data Integrations); field descriptions are transcribed from the Portal setup screen. Required fields are marked.

Fields

Field

Required

Type

Default

Description

Stats Enabled


Boolean

None

Is the stats provider enabled for the Orchestrator.

Poll Time (Ms)


Number

None

How long between data pulls. Default is 5000ms.

Dev Source Url

Required

String

None

The base URL for the Bigscreen development API.

Dev Request Headers

Required

String

None

Headers required to access the Bigscreen development API.

Source Url

Required

String

None

The base URL for the Bigscreen production API.

Request Headers

Required

String

None

Headers required to access the Bigscreen production API.

Top Player Stats


String

None

A comma-separated array of stats to get, e.g. tries,conversions.

Top Player Stats Timeframe


String

None

The timeframe for top player stats. Options are allTime, tournament, series, or country. All-time stats are only available for tries, points, and conversions; all other all-time stats are only available from 2018–2019 onwards.

Default Mens Event Code


String

None

Default code for the men's event.

Default Womens Event Code


String

None

Default code for the women's event.