動画モニタリングタスクの詳細を取得

単一のモニタリングタスクについて、設定、現在のステータス、これまでに記録した全エンゲージメントスナップショットを時系列順で返します。

GET/api/v1/monitor/video/tasks/detail

クォータ消費: このエンドポイントへの成功したリクエスト 1 件あたり、プランのクォータが 1500 単位消費されます。

リクエストパラメータ

必須パラメータ

名前	位置	型	説明
`monitor_id`	query	string	Monitor ID

レスポンスフィールド

名前	型	説明
`success`	boolean	Success
`code`	integer	Code
`message`	string	Message
`data`	object	-
`data.monitor_id`	string	Monitor ID
`data.platform`	string	Platform
`data.video_id`	string	Video identifier
`data.video_title`	string	Video title
`data.author_id`	string	Author identifier
`data.author_name`	string	Author name
`data.monitor_status`	integer	Monitoring status: 0 = monitoring, 10 = completed, 20 = stopped, -1 = error
`data.monitor_start_date`	string	Monitoring start date
`data.monitor_end_date`	string	Monitoring end date
`data.last_snapshot_time`	string	Last collected at
`data.snapshot_count`	integer	Snapshots collected
`data.created_time`	string	Created at
`data.snapshots`	array<object>	Snapshot list

お試し実行

リクエストURL

https://openapi.scdata.cc/api/v1/monitor/video/tasks/detail

Authorization

ダッシュボードのAPIキーを選択

リクエストを送信する前にAPIキーを入力してください。ダッシュボードを開く

クエリパラメータ

monitor_id*

cURL の例

bash

curl -X GET "https://openapi.scdata.cc/api/v1/monitor/video/tasks/detail?monitor_id=example" \
  -H "Authorization: YOUR_API_KEY"

レスポンス例 (200 application/json)

json

{
  "success": true,
  "code": 200,
  "message": "Request successful",
  "data": {
    "monitor_id": "string",
    "platform": "string",
    "video_id": "string",
    "video_title": "string",
    "video_description": "string",
    "video_publish_at": "2019-08-24T14:15:22.123Z",
    "video_url": "string",
    "video_cover": "string",
    "video_type": "string",
    "author_id": "string",
    "author_name": "string",
    "monitor_status": 0,
    "monitor_start_date": "2019-08-24",
    "monitor_end_date": "2019-08-24",
    "last_snapshot_time": "2019-08-24T14:15:22.123Z",
    "snapshot_count": 0,
    "created_time": "2019-08-24T14:15:22.123Z",
    "snapshots": [
      {
        "id": 0,
        "snapshot_time": "2019-08-24T14:15:22.123Z",
        "snapshot_type": "string",
        "like_count": 0,
        "comment_count": 0,
        "play_count": 0,
        "share_count": 0,
        "collect_count": 0
      }
    ]
  }
}

ユースケース

エンゲージメント曲線 — 公開後の動画の再生数といいねが時間ごとにどう伸びたかをグラフ化します。
キャンペーン報告 — キャンペーン終了時に記録した時系列をクライアント向けレポートに出力します。