Download OpenAPI specification:Download
Reference for the Brightcove Audience API, used to retrieve audience data for your accounts. To test API requests, you can use our API Testing Tools.
For additional in-depth guides to features of the API, see the Overview.
Base URL: https://audience.api.brightcove.com/v1
Get leads for an account
account_id required | number a Video Cloud account ID |
limit | integer <int32> [ 1 .. 200 ] Default: 25 Example: limit=25 Number of items to return |
offset | integer <int32> Default: 0 Example: offset=0 Number of items to skip |
sort | string (sort for Leads) Default: "created_at" Enum: "video_id" "video_name" "player_id" "created_at" Example: sort=video_id Field to sort lead results by (prefix with |
fields | string (fields) Enum: "video_id" "video_name" "external_id" "first_name" "last_name" "email_address" "business_phone" "country" "company_name" "industry" "player_id" "page_url" "created_at" Example: fields=video_id Fields to return for leads Note: by default, all fields are returned. Use this parameter to return fewer fields. |
where | string One or more field==value pairs to filter the results; fields supported are |
string or integer 'Start time for the period covered by the report — epoch time in milliseconds or a date in the format | |
string or integer End time for the period covered by the report — epoch time in milliseconds or a date in the format |
Content-Type required | string Content-Type: application/json |
Authorization required | string Authorization: Bearer access_token (see Getting Access Tokens) |
{- "result": [
- {
- "email_address": "rcrooks@brightcove.com",
- "first_name": "Robert",
- "last_name": "Crooks",
- "business_phone": "",
- "company_name": "Brightcove",
- "player_id": "HyH9wwb4BZ",
- "video_id": "6038250741001",
- "video_name": "Creating a Smart Playlist",
- "created_at": "2019-07-19T20:26:33.535Z",
- "external_id": "cc8e546c-89e1-4de2-b83a-21fc8a7974f3"
}, - {
- "email_address": "aladron@brightcove.com",
- "first_name": "Alberto",
- "last_name": "Ladron",
- "business_phone": "",
- "company_name": "Brightcove",
- "player_id": "HyH9wwb4BZ",
- "video_id": "6038250741001",
- "video_name": "Creating a Smart Playlist",
- "created_at": "2019-07-19T20:26:28.229Z",
- "external_id": "2e3d9209-0018-4ade-82c7-83d9a15fb5b2"
}
], - "count": 14,
- "offset": 0,
- "limit": 4
}
Get view events for an account - note that only view events that have been processed will appear in the response
account_id required | number a Video Cloud account ID |
limit | integer <int32> [ 1 .. 200 ] Default: 25 Example: limit=25 Number of items to return |
offset | integer <int32> Default: 0 Example: offset=0 Number of items to skip |
sort | string (sort for view events) Default: "created_at" Enum: "video_id" "video_name" "tracking_id" "external_id" "player_id" "page_url" "watched" "time_watched" "created_at" "updated_at" "is_synced" "utm_source" "utm_medium" "utm_campaign" "utm_term" "utm_content" Example: sort=video_id Field to sort results by (prefix with |
fields | string (fields) Enum: "video_id" "video_name" "tracking_id" "external_id" "player_id" "page_url" "watched" "time_watched" "created_at" "updated_at" "is_synced" "utm_source" "utm_medium" "utm_campaign" "utm_term" "utm_content" Example: fields=video_id Fields to return for view events Note: by default, all fields are returned. Use this parameter to return fewer fields. |
where | string One or more field==value pairs to filter the results; fields supported are |
string or integer 'Start time for the period covered by the report — epoch time in milliseconds or a date in the format | |
string or integer End time for the period covered by the report — epoch time in milliseconds or a date in the format |
Content-Type required | string Content-Type: application/json |
Authorization required | string Authorization: Bearer access_token (see Getting Access Tokens) |
{- "count": 27,
- "limit": 25,
- "offset": 0,
- "result": [
- {
- "created_at": "2016-04-25T18:30:21.651Z",
- "player_id": "V1s6NOwRx",
- "time_watched": 2,
- "updated_at": "2016-04-25T18:30:21.651Z",
- "video_id": "4842718056001",
- "video_name": "Horses Heading to the Track",
- "watched": 19
}, - {
- "created_at": "2016-04-25T18:31:55.071Z",
- "player_id": "BkgFuzyhg",
- "time_watched": 15,
- "updated_at": "2016-04-25T18:32:00.879Z",
- "video_id": "4842718056001",
- "video_name": "Horses Heading to the Track",
- "watched": 99
}
]
}