country dimension. The country dimension provides information about the country that videos were viewed in.URL parameters
Analytics API reports support the following 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 modead_mode_complete- the number of times the player completed ad modecountry- the two-letter code for the countrycountry_name- the DMA zone - applies only to the US, and the value will be0unless the region and/or city dimensions are includeddma- the name of the countryengagement_score- the average engagement score for a videos played in a playerplay_request- total number of times video playback was requestedplay_rate- the average play rate (video views divided by impressions) for a videoplayer_load- the number of times a player was loadedvideo_impression- the total number of videos loaded into the playervideo_percent_viewed- the sum of percent viewed of videos in the playervideo_seconds_viewed- total seconds of videos viewed in the playervideo_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: comma-delimited list of ISO-3166-1 country codes - e.g.: KO,US
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=country
Filter request
https://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=city&where=country==US,GB,JA,KO&fields=country_name
Sample Response
{
"item_count": 128,
"items": [
{
"country": "SC",
"video_view": 1
},
{
"country": "GM",
"video_view": 1
},
{
"country": "SS",
"video_view": 1
},
{
"country": "BW",
"video_view": 1
},
{
"country": "ZM",
"video_view": 1
},
{
"country": "JM",
"video_view": 1
},
{
"country": "VE",
"video_view": 1
},
{
"country": "CY",
"video_view": 1
},
{
"country": "IQ",
"video_view": 1
},
{
"country": "XK",
"video_view": 1
}
],
"summary": {
"video_view": 45117
}
}