{ "opencollection": "1.0.0", "info": { "name": "Brightcove Analytics API Reference Access Tokens Folders API", "version": "1.0.0" }, "items": [ { "info": { "name": "Folders", "type": "folder" }, "items": [ { "info": { "name": "Get Folders", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.api.brightcove.com/v1/accounts/:{account_id}/folders", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Video Cloud account ID." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://oauth.brightcove.com/v4/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets list of folders for the account " }, { "info": { "name": "Create Folder", "type": "http" }, "http": { "method": "POST", "url": "https://analytics.api.brightcove.com/v1/accounts/:{account_id}/folders", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Video Cloud account ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://oauth.brightcove.com/v4/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new folder for the account - **note** that there is a limit of 1000 folders per account" }, { "info": { "name": "Get Folder Information", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.api.brightcove.com/v1/accounts/:{account_id}/folders/:{folder_id}", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Video Cloud account ID." }, { "name": "folder_id", "value": "", "type": "path", "description": "Folder ID." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://oauth.brightcove.com/v4/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets information about a folder " }, { "info": { "name": "Update Folder Name", "type": "http" }, "http": { "method": "PATCH", "url": "https://analytics.api.brightcove.com/v1/accounts/:{account_id}/folders/:{folder_id}", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Video Cloud account ID." }, { "name": "folder_id", "value": "", "type": "path", "description": "the folder ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://oauth.brightcove.com/v4/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the folder name " }, { "info": { "name": "Delete Folder", "type": "http" }, "http": { "method": "DELETE", "url": "https://analytics.api.brightcove.com/v1/accounts/:{account_id}/folders/:{folder_id}", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Video Cloud account ID." }, { "name": "folder_id", "value": "", "type": "path", "description": "the folder ID" }, { "name": "name", "value": "", "type": "query", "description": "name of the folder (must be unique in the account)" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://oauth.brightcove.com/v4/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a folder " }, { "info": { "name": "Get Videos in Folder", "type": "http" }, "http": { "method": "GET", "url": "https://analytics.api.brightcove.com/v1/accounts/:{account_id}/folders/:{folder_id}/videos", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Video Cloud account ID." }, { "name": "folder_id", "value": "", "type": "path", "description": "the folder ID." }, { "name": "limit", "value": "", "type": "query", "description": "Number of items to return - see [Paging Search Results](/cms/searching/using-cms-api-page-search-results.html) for more information" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip - see [Paging Search Results](/cms/searching/using-cms-api-page-search-results.html) for more information" }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort results by - if absent and there is a search string, results are sorted by relevance or if there is no search string, results are sorted by `-updated_at`. \nNotes: \n - to sort in descending order, preface the field name with a minus (`-`) sign\n - this parameter can be used to sort results both for a get videos request and for a get videos in folder request" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://oauth.brightcove.com/v4/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets list of video objects in a folder " }, { "info": { "name": "Add Video to Folder", "type": "http" }, "http": { "method": "PUT", "url": "https://analytics.api.brightcove.com/v1/accounts/:{account_id}/folders/:{folder_id}/videos/:{video_id}", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Video Cloud account ID." }, { "name": "folder_id", "value": "", "type": "path", "description": "Folder ID." }, { "name": "video_id", "value": "", "type": "path", "description": "Video ID (specified as `{video_id}}`)." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://oauth.brightcove.com/v4/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add a video to a folder " }, { "info": { "name": "Remove Video from Folder", "type": "http" }, "http": { "method": "DELETE", "url": "https://analytics.api.brightcove.com/v1/accounts/:{account_id}/folders/:{folder_id}/videos/:{video_id}", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "path", "description": "Video Cloud account ID." }, { "name": "folder_id", "value": "", "type": "path", "description": "the folder ID" }, { "name": "video_id", "value": "", "type": "path", "description": "the video ID" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://oauth.brightcove.com/v4/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove a video from a folder " } ] } ], "bundled": true }