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

API docs by Redocly

Brightcove Social API (1.0.0)

Download OpenAPI specification:Download

API for Brightcove Social

For additional in-depth guides to features of the API, see the Overview.

Base URL: https://edge.social.api.brightcove.com/v1

Status

Operations for getting the status of all or a specific video.

List the current status for every video on the account

Gets the current status of every video Social has ever attempted to distribute to a social platform. Note that this endpoint has pagination.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

ID of the account to query video statuses for

query Parameters
platform
string
Enum: "YOUTUBE" "FACEBOOK" "TWITTER"

Limit the list of videos to a single social platform. Valid values for this property are

  • YOUTUBE
  • FACEBOOK
  • TWITTER

Note that this may conflict with destination_id, below.

destination_id
string <uuid>

Limit the list of videos to a single Social destination, by it's ID. Note that this may conflict with platform, above. (e.g., Specifying platform=YOUTUBE and passing the ID of a Twitter destination will result in no statuses.) Generally if you are passing a destination_id you probably don't want to be passing a platform as well, as destinations imply a platform.

status
string

Limit the list of videos to those with a specific status. Valid values for this property are

  • DELETED
  • ERROR
  • HIDDEN
  • PROCESSING
  • PUBLISHED
  • SCHEDULED
  • SYNCED
  • ABANDONED
before
string <date-time>

Limit the list of videos to those whose last status change occurred before the specified date time. Can accept either a full timestamp, or just a datestamp. If passed just a datestamp, assumes 00:00:00 for the time, and the filter will be exclusive of the date specified.

since
string <date-time>

Limit the list of videos to those whose last status change occurred since the specified date time. Can accept either a full timestamp, or just a datestamp. If passed just a datestamp, assumes 00:00:00 for the time, and the filter will be inclusive of the date specified.

page_key
string

Fetch the next page of data. If the previous call to this endpoint returned a page_key, a subsequent call can be made with the same parameters and including the page_key to retrieve the next page.

page_size
integer <int32> [ 1 .. 100 ]

The number of entries to fetch in the next page of data. Must be a number between 1 and 100, inclusive. Defaults to 20.

pretty_print
boolean

Whether or not to pretty-print the JSON response. Defaults to false.

Responses

Response samples

Content type
application/json
{
  • "total_hits": 117,
  • "page_key": "1506960062695:5382545592001_-T6xvfm_ebE",
  • "videos": [
    ]
}

List the current status for the video.

Gets the current status of the requested video for every Social Destination is has ever been distributed to. Note that this endpoint has pagination.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

ID of the account to query video statuses for

video_id
required
string

ID of the video to query video statuses for

query Parameters
platform
string
Enum: "YOUTUBE" "FACEBOOK" "TWITTER"

Limit the list of videos to a single social platform. Valid values for this property are

  • YOUTUBE
  • FACEBOOK
  • TWITTER

Note that this may conflict with destination_id, below.

destination_id
string <uuid>

Limit the list of videos to a single Social destination, by it's ID. Note that this may conflict with platform, above. (e.g., Specifying platform=YOUTUBE and passing the ID of a Twitter destination will result in no statuses.) Generally if you are passing a destination_id you probably don't want to be passing a platform as well, as destinations imply a platform.

status
string

Limit the list of videos to those with a specific status. Valid values for this property are

  • DELETED
  • ERROR
  • HIDDEN
  • PROCESSING
  • PUBLISHED
  • SCHEDULED
  • SYNCED
  • ABANDONED
before
string <date-time>

Limit the list of videos to those whose last status change occurred before the specified date time. Can accept either a full timestamp, or just a datestamp. If passed just a datestamp, assumes 00:00:00 for the time, and the filter will be exclusive of the date specified.

since
string <date-time>

Limit the list of videos to those whose last status change occurred since the specified date time. Can accept either a full timestamp, or just a datestamp. If passed just a datestamp, assumes 00:00:00 for the time, and the filter will be inclusive of the date specified.

page_key
string

Fetch the next page of data. If the previous call to this endpoint returned a page_key, a subsequent call can be made with the same parameters and including the page_key to retrieve the next page.

page_size
integer <int32> [ 1 .. 100 ]

The number of entries to fetch in the next page of data. Must be a number between 1 and 100, inclusive. Defaults to 20.

pretty_print
boolean

Whether or not to pretty-print the JSON response. Defaults to false.

Responses

Response samples

Content type
application/json
{
  • "total_hits": 117,
  • "page_key": "1506960062695:5382545592001_-T6xvfm_ebE",
  • "videos": [
    ]
}

History

Operations for getting the history of all or a specific video.

List the lifetime social history for every video on the account.

Gets the lifetime history of every video Social has ever attempted to distribute to a social platform. Note that this endpoint has pagination.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

ID of the account to query video statuses for

query Parameters
platform
string
Enum: "YOUTUBE" "FACEBOOK" "TWITTER"

Limit the list of videos to a single social platform. Valid values for this property are

  • YOUTUBE
  • FACEBOOK
  • TWITTER

Note that this may conflict with destination_id, below.

destination_id
string <uuid>

Limit the list of videos to a single Social destination, by it's ID. Note that this may conflict with platform, above. (e.g., Specifying platform=YOUTUBE and passing the ID of a Twitter destination will result in no statuses.) Generally if you are passing a destination_id you probably don't want to be passing a platform as well, as destinations imply a platform.

status
string

Limit the list of videos to those with a specific status. Valid values for this property are

  • DELETED
  • ERROR
  • HIDDEN
  • PROCESSING
  • PUBLISHED
  • SCHEDULED
  • SYNCED
  • ABANDONED
before
string <date-time>

Limit the list of videos to those whose last status change occurred before the specified date time. Can accept either a full timestamp, or just a datestamp. If passed just a datestamp, assumes 00:00:00 for the time, and the filter will be exclusive of the date specified.

since
string <date-time>

Limit the list of videos to those whose last status change occurred since the specified date time. Can accept either a full timestamp, or just a datestamp. If passed just a datestamp, assumes 00:00:00 for the time, and the filter will be inclusive of the date specified.

page_key
string

Fetch the next page of data. If the previous call to this endpoint returned a page_key, a subsequent call can be made with the same parameters and including the page_key to retrieve the next page.

page_size
integer <int32> [ 1 .. 100 ]

The number of entries to fetch in the next page of data. Must be a number between 1 and 100, inclusive. Defaults to 20.

pretty_print
boolean

Whether or not to pretty-print the JSON response. Defaults to false.

Responses

Response samples

Content type
application/json
{
  • "total_hits": 117,
  • "page_key": "1506960062695:5382545592001_-T6xvfm_ebE",
  • "videos": [
    ]
}

List the lifetime social history the video.

Gets the lifetime history of the requested video for every Social Destination is has ever been distributed to. Note that this endpoint has pagination.

Authorizations:
BC_OAuth2
path Parameters
account_id
required
string

ID of the account to query video statuses for

video_id
required
string

ID of the video to query video statuses for

query Parameters
platform
string
Enum: "YOUTUBE" "FACEBOOK" "TWITTER"

Limit the list of videos to a single social platform. Valid values for this property are

  • YOUTUBE
  • FACEBOOK
  • TWITTER

Note that this may conflict with destination_id, below.

destination_id
string <uuid>

Limit the list of videos to a single Social destination, by it's ID. Note that this may conflict with platform, above. (e.g., Specifying platform=YOUTUBE and passing the ID of a Twitter destination will result in no statuses.) Generally if you are passing a destination_id you probably don't want to be passing a platform as well, as destinations imply a platform.

status
string

Limit the list of videos to those with a specific status. Valid values for this property are

  • DELETED
  • ERROR
  • HIDDEN
  • PROCESSING
  • PUBLISHED
  • SCHEDULED
  • SYNCED
  • ABANDONED
before
string <date-time>

Limit the list of videos to those whose last status change occurred before the specified date time. Can accept either a full timestamp, or just a datestamp. If passed just a datestamp, assumes 00:00:00 for the time, and the filter will be exclusive of the date specified.

since
string <date-time>

Limit the list of videos to those whose last status change occurred since the specified date time. Can accept either a full timestamp, or just a datestamp. If passed just a datestamp, assumes 00:00:00 for the time, and the filter will be inclusive of the date specified.

page_key
string

Fetch the next page of data. If the previous call to this endpoint returned a page_key, a subsequent call can be made with the same parameters and including the page_key to retrieve the next page.

page_size
integer <int32> [ 1 .. 100 ]

The number of entries to fetch in the next page of data. Must be a number between 1 and 100, inclusive. Defaults to 20.

pretty_print
boolean

Whether or not to pretty-print the JSON response. Defaults to false.

Responses

Response samples

Content type
application/json
{
  • "total_hits": 117,
  • "page_key": "1506960062695:5382545592001_-T6xvfm_ebE",
  • "videos": [
    ]
}
ページの最終更新日22 Sep 2021
×