BoxCast Connector Reference

21 metrics46 dimensions

Fields

The BoxCast connector exposes 67 fields (21 metrics, 46 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.

BoxCast Fields

BoxCast broadcast fields

The broadcast report of the BoxCast connector includes 3 fields.

ID	Type	Name	Description
broadcast_description	TEXT	Broadcast Description	Additional information to display to viewers about the broadcast. This field might be slower to fetch when there are many rows.
broadcast_in_channel_ids	TEXT	Broadcast in Channel IDs	The IDs of any additional Channels the broadcast has been added to; comma-and-space-separated list. This field might be slower to fetch when there are many rows.
broadcast_static_playlist_url	TEXT	Broadcast Static Playlist URL	An M3U8 URL that can always be used to play this broadcast. This field might be slower to fetch when there are many rows. NOTE: This URL can be used for integration into certain third party app providers. It should never be distributed directly to viewers. Also be aware that the use of this URL for watching the broadcast will skew your analytics. If you would like to retain analytics, your app should be updated to use one of the supported BoxCast SDKs.

BoxCast broadcast_analytics fields

The broadcast_analytics report of the BoxCast connector includes 8 fields.

ID	Type	Name	Description
broadcast_live_buffer_seconds	NUMERIC	Broadcast Live Buffer Seconds	Amount of broadcast seconds buffered live
broadcast_live_view_count	NUMERIC	Broadcast Live View Count	Amount of views of the broadcast live
broadcast_live_view_seconds	NUMERIC	Broadcast Live View Seconds	Amount of time spent viewing the broadcast live
broadcast_recorded_buffer_seconds	NUMERIC	Broadcast Recorded Buffer Seconds	Amount of broadcast seconds buffered recorded
broadcast_recorded_view_count	NUMERIC	Broadcast Recorded View Count	Amount of views of the broadcast recorded
broadcast_recorded_view_seconds	NUMERIC	Broadcast Recorded View Seconds	Amount of time spent viewing the broadcast recorded
broadcast_unique_viewer_count	NUMERIC	Broadcast Unique Viewer Count	Amount of unique viewers of the broadcast
broadcast_viewed_broadcast_count	NUMERIC	Broadcast Viewed Count	Amount of full views of the broadcast

BoxCast broadcasts fields

The broadcasts report of the BoxCast connector includes 20 fields.

ID	Type	Name	Description
broadcast_audio_source	TEXT	Broadcast Audio Source	The audio source the BoxCaster will use when streaming: all: BoxCaster will mix all available audio sources; embedded: BoxCaster will use embedded audio. BoxCaster Pro only; hdmi: BoxCaster will use HDMI audio. BoxCaster only; analog: BoxCaster will use analog audio; nochange: The audio configuration can be managed on the device itself, or through device settings on the dashboard (i.e. do not automatically mute or unmute any channels). Spark only.
broadcast_boxcaster_id	TEXT	Broadcast Boxcaster ID	The id of the BoxCaster that streamed or will stream the broadcast. Empty if stream_source is not boxcaster.
broadcast_boxcaster_name	TEXT	Broadcast Boxcaster Name	The name of the BoxCaster that streamed or will stream the broadcast. Empty if stream_source is not boxcaster.
broadcast_channel_id	TEXT	Broadcast Channel ID	An automatically created channel which consists only of this broadcast (even if the broadcast is private).
broadcast_free_variant	TEXT	Broadcast Free Variant	A variant of the broadcast which may be viewed without purchasing a ticket: none: There is no free variant; the stream can only be viewed by purchasing a ticket; best: All variants are free; there is no need to purchase a ticket to view the stream; low: A lower quality (SD-only) variant of the stream is available for free viewing; audio: An audio-only variant of the stream is available for free listening; other variants may be added later.
broadcast_id	TEXT	Broadcast ID	The primary unique identifier of the broadcast.
broadcast_is_private	BOOLEAN	Broadcast is Private	A public broadcast may be listed and promoted by BoxCast so that a public viewer can find it easily. If a broadcast is private, however, then BoxCast will generate an obfuscated channel for the broadcast and will not promote it or list it in any channels (except for its own channel). This is useful, for example, when creating a test broadcast.
broadcast_is_ticketed	BOOLEAN	Broadcast is Ticketed	A ticketed broadcast requires a ticket purchase to view the full stream. Some ticketed broadcasts offer a variant stream which is viewable without a ticket purchase (so-called "flex" broadcasts).
broadcast_name	TEXT	Broadcast Name	A human-friendly name for quick identification and display in user interfaces.
broadcast_poster	IMAGE_URL	Broadcast Poster	A URL to a full-size poster image for the broadcast, if available.
broadcast_preview	IMAGE_URL	Broadcast Preview	A URL to a thumbnail image for the broadcast, if available.
broadcast_starts_at	TIMESTAMP	Broadcast Starts at	The scheduled start time for the broadcast.
broadcast_stops_at	TIMESTAMP	Broadcast Stops at	The scheduled stop time for the broadcast.
broadcast_stream_source	TEXT	Broadcast Stream Source	The source of the audio and video for the broadcast: boxcaster: Streamed from a BoxCaster; app: Streamed from the Broadcaster app for iOS; switcher: Streamed from Switcher Studio for iOS; rtmp: Streamed from an external RTMP source.
broadcast_ticket_price	NUMERIC	Broadcast Ticket Price	The purchase price in USD for a ticket to view the highest quality version of the broadcast. All values are rounded to two decimal places.
broadcast_timeframe	TEXT	Broadcast Timeframe	An indicator of the timeframe in which this broadcast is scheduled to stream: future: The broadcast is scheduled to stream at some time in the future; preroll: The broadcast is scheduled to start streaming very soon and is preparing now; current: The broadcast is currently scheduled to be streaming now; past: The broadcast was scheduled to stream at some time in the past.
broadcast_total_active_viewer_count	NUMERIC	Broadcast Total Active Viewer Count	The total number of currently active viewers of this broadcast.
broadcast_total_minutes_viewed	NUMERIC	Broadcast Total Minutes Viewed	The total duration in minutes that this broadcast was watched, across all views.
broadcast_total_view_count	NUMERIC	Broadcast Total View Count	The total number of times this broadcast was watched.
broadcast_viewer_url	TEXT	Broadcast Viewer URL	The URL at which BoxCast hosts a web page for viewers to watch the broadcast live or recorded.

BoxCast channel_analytics fields

The channel_analytics report of the BoxCast connector includes 8 fields.

ID	Type	Name	Description
channel_live_buffer_seconds	NUMERIC	Channel Live Buffer Seconds	Amount of channel seconds buffered live
channel_live_view_count	NUMERIC	Channel Live View Count	Amount of views of the channel live
channel_live_view_seconds	NUMERIC	Channel Live View Seconds	Amount of time spent viewing the channel live
channel_recorded_buffer_seconds	NUMERIC	Channel Recorded Buffer Seconds	Amount of channel seconds buffered recorded
channel_recorded_view_count	NUMERIC	Channel Recorded View Count	Amount of views of the channel recorded
channel_recorded_view_seconds	NUMERIC	Channel Recorded View Seconds	Amount of time spent viewing the channel recorded
channel_unique_viewer_count	NUMERIC	Channel Unique Viewer Count	Amount of unique viewers of the channel
channel_viewed_broadcast_count	NUMERIC	Channel Broadcast Viewed Count	Amount of full views of broadcasts of the channel

BoxCast channels fields

The channels report of the BoxCast connector includes 5 fields.

ID	Type	Name	Description
channel_free_variant	TEXT	Channel Free Variant	A variant of the channel which may be viewed without purchasing a ticket: none: There is no free variant; the stream can only be viewed by purchasing a ticket; best: All variants are free; there is no need to purchase a ticket to view the stream; low: A lower quality (SD-only) variant of the stream is available for free viewing; audio: An audio-only variant of the stream is available for free listening; other variants may be added later.
channel_id	TEXT	Channel ID	The primary unique identifier of the channel.
channel_is_ticketed	BOOLEAN	Channel is Ticketed	A ticketed channel requires a ticket purchase to view the full stream. Some ticketed channels offer a variant stream which is viewable without a ticket purchase (so-called "flex" channels).
channel_name	TEXT	Channel Name	A human-friendly name for quick identification and display in user interfaces.
channel_ticket_price	NUMERIC	Channel Ticket Price	The purchase price in USD for a ticket to view the highest quality version of the channel. All values are rounded to two decimal places.

BoxCast connector fields

The connector report of the BoxCast connector includes 3 fields.

ID	Type	Name	Description
account_id	TEXT	Account ID	Account ID of the connected account
account_name	TEXT	Account Name	Account name of the connected account
date	DATE	Date	The Date

BoxCast other fields

The BoxCast connector has 20 fields that do not belong to a named report, or belong to a report with only one or two fields.

ID	Type	Name	Description	Report
channel_description	TEXT	Channel Description	Additional information to display to viewers about the channel. This field might be slower to fetch when there are many rows.	channel
channel_static_playlist_url	TEXT	Channel Static Playlist URL	An M3U8 URL containing any currently-live, public broadcasts from this channel. This field might be slower to fetch when there are many rows. NOTE: This M3U8 URL will return a 404 if there is no currently-live, public content. NOTE: This URL can be used for integration into certain third party app providers. It should never be distributed directly to viewers. Also be aware that the use of this URL for watching the channel will skew your analytics. If you would like to retain analytics, your app should be updated to use one of the supported BoxCast SDKs.	channel
data_fetched_at	TIMESTAMP	Data fetched at	UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasource	TEXT	Data Source	The name of the Windsor connector returning the row
day_of_month	TEXT	Day of month	Day of the month
month	TEXT	Month	Number of the month
now	TIMESTAMP	Now	Current timestamp
source	TEXT	Source	The name of the Windsor connector returning the row
today	DATE	Today	Today's date
week	TEXT	Week	Week (Sun-Sat).
week_day	TEXT	Day of week and day number	Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_iso	TEXT	Day of week and day number, ISO	Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_iso	TEXT	Week ISO	Week, ISO format (Mon-Sun).
year	TEXT	Year	Year
year_month	TEXT	Yearmonth	Year and month, e.g. 2024\|3
year_month_name	TEXT	Year month name	Year and month with the month name written out, e.g. "Jan 2025".
year_of_week	TEXT	Year of week	The year that contains first day of the week (Sun-Sat).
year_of_week_iso	TEXT	Year of week, ISO	The year that contains first day of the ISO week (Mon-Sun).
year_week	TEXT	Year week	Year and week for US weeks (Sun-Sat), e.g. 2024\|15
year_week_iso	TEXT	Year week ISO	Year and week for ISO weeks (Mon-Sun), e.g. 2024\|20

API Connectors