지원 지원 문의 | 시스템 상태 시스템 상태

개요 : Analytics API v1

이 항목에서는 Analytics API.

소개

그리고, Analytics API 당신의 분석 데이터를 얻을 수 있습니다. Video Cloud 직접 계정. 웹 로그 분석 모듈에서 기본 제공 분석 보고서를 볼 수도 있습니다. Video Cloud 사진관. 프로그래밍 방식으로 데이터에 액세스하면 유연성이 추가됩니다.

또한 API 참조.

일반적인 용도

다음은 API의 일반적인 용도입니다.

  • 맞춤 차트 및 디스플레이 만들기
  • 여러 API를 함께 사용하여 작업합니다 (예 : CMS API 지난 주 동안 조회수가 가장 많은 동영상의 경우
  • 비디오 분석 데이터를 다른 사이트 분석 데이터와 결합
  • 일부 샘플 솔루션의 경우

기본 URL

의 기본 URL Analytics API 입니다

  https://analytics.api.brightcove.com/v1

헤더

인증 필요)

그리고, Analytics API Brightcove를 사용합니다 OAuth 서비스 호출을 인증합니다.

먼저 클라이언트 자격 증명 (a client_idclient_secret). 이 작업은 일회성 작업으로 OAuth 자격증 명 UI. 다음을 사용하여 Brightcove OAuth 서비스에서 직접 클라이언트 자격 증명을 얻을 수 있습니다. , 우편 집배원잠 잘 수 없음.

클라이언트 자격 증명에 대해 Analytics 읽기 및 비디오 읽기 권한이 필요합니다.

에 대한 권한 Analytics API 신임장
에 대한 권한 Analytics API 신임장

직접 통해 자격 증명을 만드는 경우 OAuth API, 필요한 사용 권한은 다음과 같습니다.

  [
    "video-cloud/analytics/read"
    "video-cloud/video/read"
  ]

또한 access_token, client_idclient_secret 귀하의 API 요청과 함께 Authorization 헤더가 전달되었습니다.

  Authorization: Bearer {access_token}

그리고, access_token 5 분 후에 만료되므로 각 요청에 대해 하나를 얻거나 토큰이 유효한지 확인해야합니다. 만나다 액세스 토큰 얻기 코드 샘플을 포함하여 토큰에 액세스하는 방법에 대한 자세한 설명은

수락 - 인코딩 : gzip (선택 사항)

이 헤더를 전달하면 압축 된 형식으로 응답이 반환됩니다. 이렇게하면 큰 보고서의 성능이 향상 될 수 있습니다.

캐싱

성능상의 이유로 API 응답은 약 5 분 동안 캐시되지만 정확한 시간은 여러 요소에 따라 달라질 수 있습니다. 어떠한 것도 Analytics API 쿼리를 사용하면 응답 헤더에서 캐시에 대한 정보를 얻을 수 있습니다.

캐시 제어 헤더
캐시 제어 헤더

그리고, Cache-Control 결과가 초 단위로 캐시 될 최대 시간 (위의 예제에서 24 초)을 알려줍니다. 그만큼 Last-ModifiedExpires 헤더는 현재 캐시가 작성된시기와 만기시기를 알려줍니다.

대부분의 경우 이것은 문제가되지 않지만 분석 데이터의 최신 성이 매우 중요한 경우 쿼리를 실행하는 시간이 길어질수록 캐시 시간이 길어지고 실시간 (비 매시간) 데이터 만 가져 오는 보고서가 있어야한다는 것을 알아야합니다. 는 조정 된 데이터를 가져 오는 캐시만큼 캐시되지 않습니다 (실시간 데이터 외에 또는 캐시 된 데이터). 을 찾다 실시간 및 조정 된 데이터에 대한 전체 설명 당신이 원한다면; 짧은 버전은 Analytics API 두 가지 데이터 버킷을 사용합니다.

  • 실시간으로 또는 매시간 미 조정 된 데이터는 즉시 사용 가능하며 32 일 동안 저장됩니다.
  • 영구적으로 저장된 조정 된 데이터. 실시간 데이터는 정확도를 높이기 위해 조정되며 24 시간마다 조정 된 데이터 저장소에 저장됩니다.

해당 결과를 조정 된 또는 실시간 데이터로 제한 할 수 있습니다. 화해 매개 변수입니다.

캐싱을 최소화하려면 다음을 수행하십시오.

  • 사용 reconciled=false 결과를 실시간 데이터로 제한하는 매개 변수
  • 작은 것을 사용하십시오. 날짜 범위, 전체 범위가 지난 32 일 내에 있는지 확인하십시오.

타임 아웃

Analytics API 완료하지 않은 경우 8 분 후에 시간 종료를 요청합니다. 8 분 미만의 시간 초과가 표시되면 클라이언트 측 제한이 원인입니다.

반환 할 수있는 최대 항목

반환 될 수있는 항목의 최대 수는 백만입니다. 대부분의 경우 한도에 도달 할 가능성은 낮지 만, date 예를 들어, 시간의 큰 범위에 걸쳐 차원이 가능합니다. 백만 항목 제한에 도달하면 반환 된 항목 수를 줄이기 위해 요청을 수정해야합니다. 일반적으로이 작업을 수행하는 가장 간단한 방법은 데이터 범위를 줄이는 것입니다 ( fromto 매개 변수들).

동시 요청

단일 계정은 한 번에 하나의 요청으로 제한됩니다. 여러 개의 동시 요청이 연속적으로 실행됩니다.

예 :

  1. API 요청 "A"를 시작하십시오.
  2. 동일한 계정에 대한 API 요청 "B"를 시작하십시오.
  3. 요청 "B"는 "A"가 완료 될 때까지 완료되지 않습니다.
  4. 요청 "A"가 너무 오래 걸리는 경우 요청 "A"에 "요청이 대기 중입니다. 다시 시도하십시오"라는 오류 메시지가 표시됩니다.
  5. 요청 "A"가 너무 오래 걸리는 경우 요청 "B"에 동일한 오류가 발생할 수 있습니다. 요청 "B"는 A + B를 완료하는 시간이 우리의 시간 초과 값보다 큰 경우 오류를 발생시킵니다.

여러 개의 동시 요청을하는 경우 수신 된 순서대로 한 번에 하나씩 처리됩니다.

"보류 오류"와 함께 반환되는 요청은 결국 완료되어 캐시에 저장됩니다. 즉, 동일한 데이터에 대한 이후 요청은 거의 즉시 반환되지만 요청이 5 분 캐시가 만료되기 전에 이루어진 경우에만 해당됩니다.

시스템은 2-4 분을 대기하고 동일한 요청을 다시 수행하여 보류중인 오류를 처리해야합니다.

모범 사례

요청 유형

그리고, Analytics API 세 가지 요청 유형을 허용합니다.

데이터 (보고서라고도 함)
하나 이상의 보고서 치수. 보고서 요청의 끝점은 다음과 같습니다.
  https://analytics.api.brightcove.com/v1/data?accounts={account_id(s)}&dimensions={dimensions}
Engage멘트 보고서
지난 32 일 동안 이용 가능한 상세한 참여 데이터. 만나다 결합 부 자세한 내용은.
비디오 정보 종점
분석 데이터의 특정 부분은 최소한의 대기 시간으로 제공됩니다. 만나다 비디오 데이터 종점 문의주시기 바랍니다.

필터 위치기간 보고서에 적용 할 수 있습니다. 보고서 요청에 추가 매개 변수가 있음 이 문서.

치수 및 필드

크기 및 필드에 대한 자세한 정보는 이제 별도의 문서에 있습니다. 치수, 필드 및 매개 변수 개요.

매개 변수

매개 변수에 대한 자세한 정보는 별도의 문서에 있습니다. 치수, 필드 및 매개 변수 개요.

Engage멘트 보고서

동영상의 각 100 번째 부분에 대한 조회수 (또는 계정에 대한 모든 동영상의 평균 또는 player)은 지난 32 일 동안 사용할 수 있습니다. 지난 32 일 이외의 기간에 대한 요청은 오류를 반환합니다.

계정 참여

시청 한 동영상의 평균 참여 가치를 얻으려면 다음과 같이 엔드 포인트를 사용하십시오.

  
      https://analytics.api.brightcove.com/v1/engagement/accounts/:account_id
  

Player 약혼

에서 본 모든 동영상의 평균값을 얻으려면 player엔드 포인트를 사용하십시오.

  
      https://analytics.api.brightcove.com/v1/engagement/accounts/:account_id/players/:player_id
  

동영상 참여도

특정 비디오에 대한 참여 데이터를 얻으려면 엔드 포인트를 사용하십시오.

  
      https://analytics.api.brightcove.com/v1/engagement/accounts/:account_id/videos/:video_id
  

Live 통계 분석 (Analytics)

그리고, Analytics API Brightcove에 대한 분석을 검색하기위한 두 개의 엔드 포인트 제공 Live 스트림을 시계열 또는 이벤트별로 표시합니다. 자세한 내용은 Analytics API 참고 자세한 내용은.


12 년 2020 월 XNUMX 일에 마지막으로 업데이트 된 페이지