サポート問い合わせ先| システムステータス

Audience API Reference (1.0.0)

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

Leads

Get leads for a Video Cloud account.

Get Leads

Get leads for an account

Authorizations:
BC_OAuth2
path Parameters
account_id
required
number

a Video Cloud account ID

query Parameters
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 - for descending order)

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 video_id, video_name, tracking_id, external_id, player_id, page_url, watched, time_watched, created_at, updated_at, is_synced

string or integer

'Start time for the period covered by the report — epoch time in milliseconds or a date in the format yyyy-mm-dd (such as 2013-09-26) or a relative date in d (days), h (hours), m (minutes), s (seconds) (such as -2d or -6h)'

string or integer

End time for the period covered by the report — epoch time in milliseconds or a date in the format yyyy-mm-dd (such as 2013-09-26) or a relative date in d (days), h (hours), m (minutes), s (seconds) (such as -2d or -6h)

header Parameters
Content-Type
required
string

Content-Type: application/json

Authorization
required
string

Authorization: Bearer access_token (see Getting Access Tokens)

Responses

Response samples

Content type
application/json
{}

View Events

Get view events for a Video Cloud account

Get View Events

Get view events for an account - note that only view events that have been processed will appear in the response

Authorizations:
BC_OAuth2
path Parameters
account_id
required
number

a Video Cloud account ID

query Parameters
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 - for descending order)

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 video_id, video_name, tracking_id, external_id, player_id, page_url, watched, time_watched, created_at, updated_at, is_synced

string or integer

'Start time for the period covered by the report — epoch time in milliseconds or a date in the format yyyy-mm-dd (such as 2013-09-26) or a relative date in d (days), h (hours), m (minutes), s (seconds) (such as -2d or -6h)'

string or integer

End time for the period covered by the report — epoch time in milliseconds or a date in the format yyyy-mm-dd (such as 2013-09-26) or a relative date in d (days), h (hours), m (minutes), s (seconds) (such as -2d or -6h)

header Parameters
Content-Type
required
string

Content-Type: application/json

Authorization
required
string

Authorization: Bearer access_token (see Getting Access Tokens)

Responses

Response samples

Content type
application/json
{}

ページの最終更新日22 Sep 2021