Dimension: `referrer_domain`

In this topic, you will learn about the Analytics API referrer_domain dimension. The referrer_domain dimension is the top private domain of the referrer URL (the URL for the page the viewer was on just before coming to the page where the video was viewed) on a page where events are collected for analytics.

URL parameters

Analytics API reports support the following URL parameters.

URL Parameters
Parameter	Description	Required	Values	Default
`account`	The accounts you want to report on	yes	one or more account ids as a comma-delimited list	none
`dimensions`	The dimension(s) to report on	yes	one or more dimensions as a comma-delimited list (some combinations are not valid)	none
`where`	Used to specify filters for reports	no	{dimension}=={value} - one or more as a semi-colon-delimited list	none
`limit`	Number of items to return	no	positive integer	10
`offset`	Number of items to skip	no	positive integer	0
`sort`	Field to sort items on	no	a valid field for the request	video_view
`fields`	Fields to return	no	varies according to the dimension you are reporting on	video_view
`format`	Format to return results in	no	json \| csv \| xlxs	json
`reconciled`	If included, will limit results to either historical or realtime data	no	true \| false	true
`from`	The beginning of the date range for the request	no	An ISO 8601 date (YYYY-MM-DD), epoch time in milliseconds, the string alltime, or relative date (-1m); only dates within the past 32 days are allowed for engagement endpoints or if reconciled=false.	30 days prior to now
`to`	The end of the date range for the request	no	An ISO 8601 date (YYYY-MM-DD), epoch time in milliseconds, the string now, or relative data (+7d); only dates within the past 32 days are allowed for engagement endpoints or if reconciled=false.	now

Fields available

The following fields can be returned for the dimension.

ad_mode_begin - the number of times the player entered ad mode
ad_mode_complete - the number of times the player completed ad mode
engagement_score - the average engagement score for a videos played in a player
play_request - total number of times video playback was requested
play_rate - the average play rate (video views divided by impressions) for a video
player_load - the number of times a player was loaded
referrer_domain - the domain the viewer left to reach the page where the player was hosted
video_impression - the total number of videos loaded into the player
video_percent_viewed - the sum of percent viewed of videos in the player
video_seconds_viewed - total seconds of videos viewed in the player
video_view - total times video playback started in the player

Filter values

Used as a filter, a dimension allows you to narrow the results.

Filter values: A comma-delimited list of domains; e.g. brightcove.com,docs.brightcove.com

Combining dimensions

To see what dimensions this on can be combined with, and what fields are available for the combination, see Dimension and Fields.

Request Examples

Dimension request

  https://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=referrer_domain

Filter request

  https://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=video&where=referrer_domain==brightcove.com,docs.brightcove.com

Response

  Response will appear here when you test a request

Dimension: referrer_domain