{"id":17736595,"url":"https://github.com/toshimaru/brightcove-analytics-api-ruby","last_synced_at":"2025-03-31T19:17:01.824Z","repository":{"id":66162106,"uuid":"405794608","full_name":"toshimaru/brightcove-analytics-api-ruby","owner":"toshimaru","description":null,"archived":false,"fork":false,"pushed_at":"2021-09-13T05:11:18.000Z","size":56,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-14T18:22:22.529Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://apis.support.brightcove.com/analytics/references/reference.html","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toshimaru.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"toshimaru"}},"created_at":"2021-09-13T01:22:47.000Z","updated_at":"2024-04-14T18:22:22.529Z","dependencies_parsed_at":"2023-02-21T02:16:19.948Z","dependency_job_id":null,"html_url":"https://github.com/toshimaru/brightcove-analytics-api-ruby","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toshimaru%2Fbrightcove-analytics-api-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toshimaru%2Fbrightcove-analytics-api-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toshimaru%2Fbrightcove-analytics-api-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toshimaru%2Fbrightcove-analytics-api-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toshimaru","download_url":"https://codeload.github.com/toshimaru/brightcove-analytics-api-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246523847,"owners_count":20791444,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-26T00:23:36.080Z","updated_at":"2025-03-31T19:17:01.795Z","avatar_url":"https://github.com/toshimaru.png","language":"Ruby","funding_links":["https://github.com/sponsors/toshimaru"],"categories":[],"sub_categories":[],"readme":"# openapi_client\n\nOpenapiClient - the Ruby gem for the Brightcove Analytics API Reference\n\nReference for the Brightcove Analytics API, used to retrieve analytics data for your accounts. To test API requests, you can use our \u003ca href=\\\"/getting-started/concepts-testing-tools-brightcove-apis.html\\\" target=\\\"_blank\\\"\u003eAPI Testing Tools\u003c/a\u003e.\n\nFor additional in-depth guides to features of the API, see the **[general documentation](/analytics/index.html)**.\n\n **Base URL**: https://analytics.api.brightcove.com\n\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.RubyClientCodegen\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build openapi_client.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./openapi_client-1.0.0.gem\n```\n\n(for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'openapi_client', '~\u003e 1.0.0'\n\n### Install from Git\n\nIf the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:\n\n    gem 'openapi_client', :git =\u003e 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n\n```ruby\n# Load the gem\nrequire 'openapi_client'\n\n# Setup authorization\nOpenapiClient.configure do |config|\n  # Configure OAuth2 access token for authorization: BC_OAuth2\n  config.access_token = 'YOUR ACCESS TOKEN'\nend\n\napi_instance = OpenapiClient::AnalyticsReportApi.new\ncontent_type = 'content_type_example' # String | Content-Type: application/json\nauthorization = 'authorization_example' # String | Authorization: Bearer access_token (see Getting Access Tokens)\naccept_encoding = 'accept_encoding_example' # String | Accept-Encoding: gzip (optional)\naccounts = 'accounts_example' # String | One or more account ids, separated by commas\ndimensions = OpenapiClient::Dimensions::ACCOUNT # Dimensions | One or more dimensions to report on; see [Multiple Dimensions](/analytics/getting-started/analytics-api-overview-dimensions-fields-and-parameters.html) or which combined dimensions are supported  Dimensions:   - account   - browser_type   - city   - country   - date   - date_hour   - destination_domain   - destination_path   - device_os   - device_manufacturer   - device_type   - live_stream   - player   - referrer_domain   - region   - search_terms   - social_platform   - source_type   - video\nwhere = OpenapiClient::LiveWhere::COUNTRY # LiveWhere | one or more 'dimension==value' pairs to filter the results; for live, the only available filters are `country`, `device-type`, and `video`\nopts = {\n  limit: 10, # Integer | Number of items to return\n  offset: 10, # Integer | Number of items to skip\n  sort: 'video_view', # String | Field to sort results by (prefix with `-` for descending order)\n  fields: 'video_view, video_impression, video.name', # String | Fields to return - available fields varies according to the dimensions - see the [Overview: Analytics API](/analytics/getting-started/analytics-api-overview-dimensions-fields-and-parameters.html) for more details\n  from: TODO, # OneOfstringinteger | 'Start time for the period covered by the report — epoch time in milliseconds (`1535654206775`) or a date in the format `yyyy-mm-dd` (such as `2013-09-26`)'\n  to: TODO, # OneOfstringinteger | End time for the period covered by the report — `now` or epoch time in milliseconds (`1535654206775`) or a date in the format `yyyy-mm-dd` (such as `2013-09-26`)\n  format: OpenapiClient::Format::CSV, # Format | format to return the results in\n  reconciled: true # Boolean | if true, only reconciled data is returned; if false, only realtime data is returned; if not present, both reconciled and realtime data are returned\n}\n\nbegin\n  #Get Analytics Report\n  result = api_instance.get_analytics_report(content_type, authorization, accept_encoding, accounts, dimensions, where, opts)\n  p result\nrescue OpenapiClient::ApiError =\u003e e\n  puts \"Exception when calling AnalyticsReportApi-\u003eget_analytics_report: #{e}\"\nend\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://analytics.api.brightcove.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*OpenapiClient::AnalyticsReportApi* | [**get_analytics_report**](docs/AnalyticsReportApi.md#get_analytics_report) | **GET** /v1/data | Get Analytics Report\n*OpenapiClient::AnalyticsReportApi* | [**get_available_date_range**](docs/AnalyticsReportApi.md#get_available_date_range) | **GET** /v1/data/status | Get Available Date Range\n*OpenapiClient::EngagementReportApi* | [**get_account_engagement**](docs/EngagementReportApi.md#get_account_engagement) | **GET** /v1/engagement/accounts/{account_id} | Get Account Engagement\n*OpenapiClient::EngagementReportApi* | [**get_player_engagement**](docs/EngagementReportApi.md#get_player_engagement) | **GET** /v1/engagement/accounts/{account_id}/players/{player_id} | Get Player Engagement\n*OpenapiClient::EngagementReportApi* | [**get_video_engagement**](docs/EngagementReportApi.md#get_video_engagement) | **GET** /v1/engagement/accounts/{account_id}/videos/{video_id} | Get Video Engagement\n*OpenapiClient::LiveAnalyticsApi* | [**get_live_events**](docs/LiveAnalyticsApi.md#get_live_events) | **GET** /v1/events/accounts/{account-id} | Get Live Analytics event\n*OpenapiClient::LiveAnalyticsApi* | [**get_live_time_series**](docs/LiveAnalyticsApi.md#get_live_time_series) | **GET** /v1/timeseries/accounts/{account_id} | Get Live Analytics time-series\n*OpenapiClient::VideoDataApi* | [**get_alltime_video_views**](docs/VideoDataApi.md#get_alltime_video_views) | **GET** /v1/alltime/accounts/{account_id}/videos/{video_id} | Get Alltime Video Views\n\n\n## Documentation for Models\n\n - [OpenapiClient::Account](docs/Account.md)\n - [OpenapiClient::Dimensions](docs/Dimensions.md)\n - [OpenapiClient::Format](docs/Format.md)\n - [OpenapiClient::GetAlltimeVideoViewsResponse](docs/GetAlltimeVideoViewsResponse.md)\n - [OpenapiClient::GetAnalyticsReportResponse](docs/GetAnalyticsReportResponse.md)\n - [OpenapiClient::GetAvailableDateRangeResponse](docs/GetAvailableDateRangeResponse.md)\n - [OpenapiClient::GetEventsResponse](docs/GetEventsResponse.md)\n - [OpenapiClient::GetEventsResponseData](docs/GetEventsResponseData.md)\n - [OpenapiClient::GetTimeSeriesResponse](docs/GetTimeSeriesResponse.md)\n - [OpenapiClient::GetVideoEngagementResponse](docs/GetVideoEngagementResponse.md)\n - [OpenapiClient::Items](docs/Items.md)\n - [OpenapiClient::LiveDimensions](docs/LiveDimensions.md)\n - [OpenapiClient::LiveWhere](docs/LiveWhere.md)\n - [OpenapiClient::Summary](docs/Summary.md)\n - [OpenapiClient::Timeline](docs/Timeline.md)\n - [OpenapiClient::Where](docs/Where.md)\n\n\n## Documentation for Authorization\n\n\n### BC_OAuth2\n\n\n- **Type**: OAuth\n- **Flow**: application\n- **Authorization URL**: \n- **Scopes**: \n  - video-cloud/analytics/read: Read analytics data\n  - video-cloud/video/read: Read video data\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoshimaru%2Fbrightcove-analytics-api-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoshimaru%2Fbrightcove-analytics-api-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoshimaru%2Fbrightcove-analytics-api-ruby/lists"}