social_platform
dimension. The social_platform
dimension provides analytics for social platforms such as Twitter, Facebook, and YouTube, if you distributed your videos to those platforms using the Video Cloud Radius module.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.
social_lifetime_seconds_viewed
- the alltime seconds viewed on the social platformsocial_lifetime_views
- alltime video views on the social platformsocial_platform
- the name of the social platformsocial_seconds_viewed
- seconds of video viewed on the platform in the designated time periodsocial_views
- video views on the platform in the designated time period
Filter values
Used as a filter, a dimension allows you to narrow the results.
Filter values: facebook, twitter, youtube
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=social_platform
Filter request
https://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=account&where=social_platform==twitter
Response
Response will appear here when you test a request