분석 API: 라이브 지표

서문

브라이트코브 라이브서비스에서 제공하는 라이브 스트림의 재생 지표는 Analytics API를 통해 실시간으로 사용할 수있습니다. 이 데이터는라이브스트림용으로만 캡처되며 VOD 재생은 포함되지 않습니다.

API는 2 개의 엔드 포인트를 통해 라이브 스트림 메트릭을 제공합니다.

/v1/timeseries
/v1/events

둘 다 동일한 데이터 세트를 쿼리하지만 결과를 다르게 집계합니다. 이 문서는 각각의 사용법과 구문을 설명합니다.

메트릭

라이브 엔드 포인트를 통해 사용할 수있는 메트릭입니다. 쿼리는 여러 메트릭을 요청할 수 있습니다.

미터법	설명
`alive_ss_ad_start`	서버 측 광고 노출
`ccu`	고유세션 수 , 고유 세션 수 ( 핑거프린트+세션 )
`fingerprint_count`	고유기기 , 고유지문 개수 (아래 참조)
`video_impression`	동영상이 플레이어에로드 된 횟수
`video_seconds_viewed`	모든 시청자가 본 총 시간
`video_view`	스트림 시작 (고유하지 않음)

을 위한고유한추적, 우리는지문 ( Remote IP + User-Agent + Player ). 우리는 장치 자체의 실제 하드웨어 ID를 사용하지 않습니다. 이것은 정확도를 떨어 뜨리지 만 우리가 개인 정보를 준수하도록합니다.

해상도 및 비트레이트

다음 조합은 다음과 같이 지원됩니다. dimensions그리고where필터 키:

video
video, country
video, device_type

쿼리 매개 변수

두 라이브 엔드 포인트는 쿼리의 범위와 그룹화를 제어하는 몇 가지 공통 매개 변수를 공유합니다.

매개 변수	구문	필수	기본값	설명
치수	`<dim1>,<dim2>,...`	예	-	쿼리 차원 (GROUP BY)
메트릭	`<metric1>,<metric2>,...`	예	-	보고 할 하나 이상의 메트릭
여기서	`<dim1>==<value1>;...`	예	-	하나 이상의 쿼리 필터. 동영상을 1 개 이상 포함해야합니다.
...에서	`<epoch>`	아니요	지금부터 32일	시간 범위 시작
변경 후:	`<epoch>`	아니요	지금	시간 범위 종료

시계열

/v1/timeseries엔드포인트는 각 시점의 요청된 지표 값과 함께 타임라인을 따라 포인트 목록을 반환합니다. 포인트는 기본적으로 1분버킷이지만 파라미터를 통해 변경할 수 있습니다.

이 맥락에서 고유 메트릭( ccu , fingerprint_count ) 표시최대값각 버킷 중 언제든지. 따라서 쿼리가 있는 쿼리는 매일 최대 동시성을bucket_duration=1d반환하고, 를 사용한bucket_limit=1쿼리는 스트림의 어느 시점에서든 최대 동시성을 반환합니다.

우리

/v1/timeseries/accounts/{account_id}

추가 매개변수

매개 변수	구문	필수	기본값	설명
bucket_duration	`<n>m` (분) `<n>h` (시간) `<n>d` (일)	아니요	1 분	기간은 각 포인트로 표시됩니다. `1d`달력일이 아니라 24시간입니다.
bucket_limit	`<n>`	아니요	-	반환 할 포인트 수입니다. 둘 중 하나`bucket_duration`또는 둘 다`bucket_limit`사용하되 둘 다 함께 사용하지는 마십시오.

대응

{
"<metric1>": {
"data": [
  {
    "dimensions": {
        "account": "<account>",
        "<dim1>": "<key1>",
        ...
        "<dimN>": "<keyN>"
      },
    "points": [
      {
        "timestamp": <bucket1>,
        "value": <value1>
      },
      ...,
      {
        "timestamp": <bucketN>,
        "value": <valueN>
      },
    ]
  }
]
},
"<metric2>": {
...
},
...
}

사내 행사 및 이벤트 소식을 비디오로 제공하십시오.

/v1/events엔드포인트는 라이브 비디오 스트림의 전체 또는 일부에 대한 지표 합계를 반환합니다.

이 컨텍스트에서 고유 지표 ( ccu , fingerprint_count ) 는 쿼리 범위의총 값을나타냅니다. 예를 들어from / to매개 변수가 없는 쿼리는 전체 스트림에 대한고유세션 (ccu) 및/또는 장치 (fingerprint_count) 의 총 수를 반환합니다.

우리

/v1/events/accounts/{account_id}

추가 매개변수

없음

대응

{
"data": [
{
  "dimensions": {
    "account": "<account>",
    "<dim1>": "<key1>",
    ...
    "<dimN>": "<keyN>"
  },
  "totals": {
    "<metric1>": <value1>,
    ...
    "<metricN>": <valueN>
  }
}
]
}

내보내기

이벤트 엔드 포인트는 다운로드 가능한 보고서도 제공합니다.

/v1/events/accounts/{account_id}/videos/{video_id}/export?format=xlsx

응답은 4개의 시트에 실시간 지표가 있는 XLSX파일입니다.

요약
동시 사용자
장치 유형별보기
지역별 조회수

사용 예

이 모든 예시에서는계정 1234 , 동영상 55555를 사용하며 현재 시간을 2020년 2월 15일 오후 12시 00:00 (UTC) 로 가정하겠습니다 .

라이브 스트림 또는 채널에 대한 현재 뷰어 수 (CCU) 가져 오기

세트 ~에서최소 2분 전(오전 11:58)까지, 마지막가리키다응답에서.

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581767880000

지난 24 시간 동안 라이브 스트림에 대한 CCU 그래프 포인트 얻기

확대 (1 분 포인트)

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1m

축소 (1 시간 포인트)

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1h

지난 7 일 동안 라이브 채널에 대한 일일 최대 CCU 받기

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581206400000&bucket_duration=7d

라이브 스트림 중 언제든지 최대 CCU를 받으세요

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&bucket_limit=1

여러 라이브 스트림에 대해 총 고유 시청자 수 및 조회 시간 (초) 얻기

비디오 5555가 완료되었습니다. 숫자는 최종입니다. 비디오 5556은 여전히 활성 상태입니다. 숫자는 누계입니다.

/v1/events/accounts/1234?dimensions=video&metrics=fingerprint_count,video_seconds_viewed&where=video==5555,5556

라이브 채널에서 한 시간 동안 진행되는 프로그램의 시청률 및 광고 합계 가져오기 <

프로그램은 오전 10시부터 오전 11시 (UTC) 까지 방영되었습니다.

/v1/events/accounts/1234?dimensions=video&metrics=alive_ss_ad_start,video_view,fingerprint_count&where=video==5555&from=1581760800000&to=1581764399999

라이브 스트림 기간 동안 국가 별 시청률 얻기

/v1/events/accounts/1234?dimensions=video,country&metrics=video_view,fingerprint_count&where=video==5555