リアルタイム視聴者数の照会

Prev Next

Classic/VPC環境で利用できます。

プレイヤーで測定されるリアルタイム視聴者数を1分単位で1時間のデータをチャート形式で照会します。現時刻から60分(1時間)のデータが基準となります。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /v1/charts/currentViewers

リクエストヘッダ

Video Player Enhancement APIで共通して使用されるヘッダの詳細は、Video Player Enhancementのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
device String Optional プレイヤー再生環境
  • PC,Mobile (デフォルト)| PC | Mobile
videoType String Optional 再生ソース区分
  • VOD,LIVE (デフォルト) | VOD | LIVE
    • VOD,LIVE: VODビデオ、LIVEストリーム
    • VOD: VODビデオ
    • LIVE: LIVEストリーム

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ma-dashboard-api.vpe.naverncp.com/v1/charts/currentViewers?device=PC,Mobile&videoType=VOD,LIVE' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project id}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.currentViewerCnt Integer - リアルタイム視聴者数
result.logDate Date - 日時

レスポンスステータスコード

Video Player Enhancement APIで共通して使用されるレスポンスステータスコードの詳細は、Video Player Enhancementのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
	"code": 200,
	"message": "currentViewers (1m)",
	"result": [
		{
			"currentViewerCnt": 0,
			"logDate": "2025-10-09 16:23:00"
		},
		{
			"currentViewerCnt": 0,
			"logDate": "2025-10-09 16:22:00"
		},
		{
			"currentViewerCnt": 0,
			"logDate": "2025-10-09 16:21:00"
		},
        ...
		{
			"currentViewerCnt": 0,
			"logDate": "2025-10-09 15:25:00"
		},
		{
			"currentViewerCnt": 0,
			"logDate": "2025-10-09 15:24:00"
		},
		{
			"currentViewerCnt": 0,
			"logDate": "2025-10-09 15:23:00"
		}
	]
}