지원 고객 지원 문의 | 시스템 상태 시스템 상태
페이지 내용

    개요: 치수, 필드 및 매개변수

    측정 기준은 다음에 대한 주요 데이터 카테고리입니다. Analytics API데이터 보고서. 이 항목에서는 차원 및 차원에 대해 반환할 수 있는 필드에 대한 대화형 가이드를 제공합니다. 또한 보고서에서 결합할 수 있는 측정기준과 다양한 조합에 사용할 수 있는 필드도 표시됩니다.

    차원 및 필드

    차원은 분석을위한 기본 데이터 버킷입니다. 개별 치수에 대한 전체 가이드를 보려면 아래 목록에서 치수 이름을 클릭하십시오.

     
     

    반환 할 수있는 필드를 보려면 아래에서 차원을 선택하십시오. 클릭 할 수도 있습니다. 요청을하다버튼을 눌러 샘플 요청을하고 결과를 확인합니다. 호환되지 않는 치수를 여러 개 선택하면 해당 효과에 대한 메시지가 표시됩니다.

    입력

    보고 할 측정 기준 선택 :

     
     

    반환 할 필드 :

     
     

    (샘플 Brightcove 계정 사용)

    산출

    초기from이 차원 조합의 날짜 :  

     

    샘플 API 요청 :

    응답 데이터

      Response will appear here...

    참고

    1. 기본적으로, video_view반환되는 유일한 필드입니다. 다른 필드는 값에 지정된 경우에만 반환됩니다. fields매개 변수.
    2. 차원 또는 차원 조합에 지원되지 않는 반환 할 필드를 지정하면UNSUPPORTED_FIELD_COMBINATION_ERROR오류가 반환됩니다.
    3. 그만큼bytes_delivered필드에는 비디오 데이터, 이미지, 텍스트 트랙 및 기타 자산은 물론 플레이어 코드 자체를 포함하여 Video Cloud가 클라이언트에 제공하는 모든 데이터가 포함됩니다. 이 데이터 중 일부는 CDN에서 얻었으며 최대 3 일 동안 사용하지 못할 수도 있습니다.
    4. 에 대해 표시된 필드 외에도video차원, 당신은 또한 반환 할 수 있습니다video.custom_fields.{field_name}

    예제 요청

    여러 차원에 대한 보고서를 얻기위한 일반적인 사용 사례 : 데스크톱과 모바일 장치 간의 비디오보기를 분석하고 iOS와 Android 장치에 대한 모바일 장치보기의 수와 데스크톱의 수를 알고 싶어합니다. 보기는 Mac과 Windows 시스템에서 이루어졌습니다. 현재이 정보를 제공하는 Studio Analytics Module에는 표준 보고서가 없지만 다음을 통해 얻을 수 있습니다. Analytics API요구:

      https://analytics.api.brightcove.com/v1/data?accounts=57838016001&dimensions=video,device_type,device_os&from=2014-01-01&to=2014-04-01&fields=video_view

    (이 경우 2014 년 1 월 1 일부터 4 월 1 일까지의 기간 동안 동영상 조회를 요청합니다.)

    cURL을 사용한 예

    API를 사용해보고 싶다면곱슬 곱슬하다 , 다음은 몇 가지 참고 사항입니다.

    샘플

    다음은 샘플 cURL 명령입니다.

      curl -s --header "Authorization: Bearer $ACCESS_TOKEN" \
      "https://analytics.api.brightcove.com/v1/data?accounts=$ACCOUNT_ID&dimensions=video&from=2017-04-04&limit=100"

    교체하는 경우$ACCESS_TOKEN유효한 액세스 토큰으로$ACCOUNT_ID계정 ID를 사용하면이 요청이 작동합니다. 사용할 수 있습니다. 이 샘플 앱액세스 토큰을 생성합니다.

    지원되는 차원 조합

    빠른 참조를 위해 아래 표에는 지원되는 치수 조합이 나와 있습니다. 두 개 이상의 차원을 사용할 수있는 몇 가지 경우가 있습니다. 다음을 사용하여이를 알아낼 수 있습니다. 차원 및 필드위의 도구.

    지원되는 치수 조합
      계정 브라우저 _ 유형 시티 국가 데이트 date_hour destination_domain destination_path device_os device_manufacturer 기기 종류 live_stream 플레이어 referrer_domain 부위 검색어 social_platform 소스 _ 유형 비디오
    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 예     예 예 예 예   예   예   예 예     예 예 해당 없음

    매개변수

    다음은에서 사용 가능한 매개 변수를 요약 한 표입니다. Analytics API . 매개 변수 사용에 대해서는 다음 섹션에서 자세히 설명합니다.

    매개 변수 필수 설명 기본값

    계정

    보고 할 Video Cloud 계정은 다음을 사용하여 지정됩니다. accounts매개 변수. 예:

      https://analytics.api.brightcove.com/v1/data?accounts={account1_id,account2_id}

    어디에 필터

    필터의 일반 구문은 다음과 같습니다.

    where=dimension1==value1;dimension2==value2

    예:

    https://analytics.api.brightcove.com/v1?accounts=account_id(s)&dimensions=device_type&where=video==video_id;device_type==tablet

    쉼표는 논리 OR로 처리되고 세미콜론은 논리 AND로 처리됩니다. 예를 들면where=video==1234,5678;player==9876 "여기서 video = 1234 또는 5678 플레이어 = 9876 "

    공백 및 특수 문자

    문자열 값은 URI로 인코딩되어야합니다. ""를 사용하여 특수 문자를 이스케이프 할 수도 있습니다.

    where=search_terms==boston,%20ma

    모든 측정 기준을 필터로 사용할 수 있습니다. 그러나해당 차원이dimensions당신은 요청하고 있습니다.

    비디오 속성으로 필터링

    스페셜 사용where=video.q=={property}:{value}필터를 사용하면 다음과 같은 다양한 속성을 기반으로 특정 동영상 집합으로 보고서를 제한 할 수 있습니다.

    • 태그
    • 참조 ID
    • custom_fields [1]
    • {a_specific_custom_field}
    • 생성한_AT

    참고

    [1]기본 구문은 다음과 같습니다. where=video.q==custom_fields:value (사용자 정의 필드의 값과 일치) 또는where=video.q==myfield:value (특정 사용자 정의 필드의 값과 일치myfield ). 특정 사용자 정의 필드를 검색하는 경우에는내부 이름 , 표시 이름이 아닙니다.

    내부 이름 대 표시 이름
    내부 이름 대 표시 이름

    올바른 이름을 사용하고 있는지 한 가지 빠른 확인 : 내부 이름은모두 소문자이고 공백을 포함하지 않습니다. .

    다음은 몇 가지 예입니다. where태그 및 사용자 정의 필드 검색을위한 필터 :

    단일 태그
    where=video.q==tags:foo
    여러 태그 :
    where=video.q==tags:foo,bar
    사용자 정의 필드
    where=video.q==custom_fields:foo
    태그 및 사용자 정의 필드
    where=video.q==tags:foo,bar+custom_fields:fish

    이 쿼리 구문에 대한 전체 설명은 다음을 참조하십시오. CMS API 사용 : 비디오 검색 .

    필터 및 허용 값 요약

    다음 표는 필터로 사용되는 각 측정 기준에 허용되는 값을 보여줍니다.

    차원 필터 허용 가능한 값

    기간

    날짜 범위, 지정fromto모든 유형의 보고서에 대한 매개 변수는 다른 형식으로 표시 될 수 있습니다.

    • 텍스트 값 :
      • to=now (사용 가능하며 모든 요청에 대한 기본값)
    • 밀리초 단위의 에포크 시간 값 (예: 1377047323000
    • ISO 8601 표준 국제 날짜 형식으로 표현 된 날짜 : YYYY-MM-DD형식 (예 : 2013-09-12 . 이 형식으로 표현된 날짜의 경우:
      • 지정된 모든 날짜 범위가 해석됩니다. 계정에 설정된 시간대
      • 날짜 제공 시간은 자정 ( 00:00:00 ) 지정된 날짜계정에 설정된 시간대
    • 상대 날짜 : 다음 중 하나를 표현할 수 있습니다. tofrom d (일) 또는 h (시간)의 다른 값에 상대적인 값. 예:
      • from=2015-01-01&to=31d
      • from=-48h&to=now
      • from=-2d&to=now ( 이전 예제와 동일한 결과를 제공합니다)
      • from=-365d&to=2014-12-31

      음수 (-2d)는 "이전"(다른 값)으로 해석되고 양수 (48h)는 "시작"(다른 값)으로 처리됩니다.

    하루 동안 '동영상'과 같은 일부 측정 기준에 대한 보고서를 생성하려면 to 및 from 값을 해당 날짜로 설정합니다.

    ...&dimensions=video&from=2013-11-01&to=2013-11-01

    제한 및 오프셋

    그만큼limit반환 할 항목 수입니다 (기본값 : 10). 모든 항목을 반환하려면limit=all . offset건너 뛸 항목 수입니다 (기본값 : 0). limit및 를offset함께 사용하여 결과를 페이지하는 앱을 만들 수 있습니다.

    조정 된 데이터

    그만큼reconciled매개 변수는 부울입니다. 설정된 경우true , 결과는 조정 된 데이터로 제한됩니다. 만약false , 결과는 실시간 (매시간 미 조정) 데이터로 제한됩니다.

    지리적 보고서

    지리적 분석을위한 차원

    • country -ISO-3611-1 국가 코드. 예 : '우리'
    • region -ISO-3611-2 지역 코드. 예 : 'US-WA'
    • city - 도시 이름. 예 : 시애틀

    참고: 알 수없는 국가 또는 지역의 경우 API는 코드로 "ZZ"를 반환합니다 (ISO-3611-alpha2에 따라).

    필드 및 정렬

    사용fields반환 할 필드를 지정하는 매개 변수입니다. 기본적으로, video_view반환되고보고하는 측정 기준에 해당하는 필드 (예 : destination_domain )이 반환됩니다. 보다차원 및 필드상세 사항은.

    사용sort반환 된 항목을 정렬하는 데 사용되는 메트릭 필드를 지정하는 매개 변수입니다. 예를 들면 : sort=video_view . 정렬 필드를 부정하여 정렬 순서를 반대로 할 수 있습니다. sort= -video_view

    계산 된 필드

    다음 구문을 사용하여 API 요청에 계산 된 필드를 추가 할 수 있습니다.

    fields=calulated_field_name:expression

    계산 된 필드를 사용하여 기존 메트릭에서 고유 한 사용자 지정 필드를 만들거나 기존 필드의 이름을 바꿀 수 있습니다.

    계산 된 필드의 이름은 URI 호환 문자열 일 수 있습니다. 표현식에는 일반 필드 이름과 다음 산술 연산자가 포함될 수 있습니다.

    • + (부가)
    • - (빼기)
    • * (곱셈)
    • / (분할)
    • ^ (멱지수)
    • () (괄호)

    fields=avg_seconds_viewed:video_seconds_viewed/video_view,video.name
    fields=avg_incomplete_ads:(ad_mode_begin-ad_mode_complete)/video_view,video.name
    fields=Video%20Views:video_view,video.name

    샘플 요청

    샘플 응답 (위 요청에 대한)

    {
      "item_count": 110,
      "items": [
        {
          "avg_seconds_viewed": 2152.2519913106444,
          "video.name": "Flamingos",
          "video_seconds_viewed": 2972260,
          "video": "4825279519001",
          "video_view": 1381
        },
        {
          "avg_seconds_viewed": 14.016225448334756,
          "video.name": "Tiger",
          "video_seconds_viewed": 16413,
          "video": "4093643993001",
          "video_view": 1171
        },
        {
          "avg_seconds_viewed": 12.06,
          "video.name": "Zebra",
          "video_seconds_viewed": 9045,
          "video": "3851389913001",
          "video_view": 750
        },
        {
          "avg_seconds_viewed": 23.343065693430656,
          "video.name": "Sea-SeaTurtle",
          "video_seconds_viewed": 15990,
          "video": "1754276205001",
          "video_view": 685
        }
      ],
      "summary": {
        "avg_seconds_viewed": 274.27374399301004,
        "video_seconds_viewed": 3139063,
        "video_view": 11445
      }
    }