Get Video Monitoring Task Details

5 endpoints • Base: https://openapi.scdata.cc

Returns a single monitoring task with its configuration, current status and every engagement snapshot recorded so far, ordered by time.

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

Quota usage: Each successful request to this endpoint deducts 1500 quota units from your plan.

Request Parameters

Required Parameters

NameInTypeDescription
monitor_idquerystringMonitor ID

Response Fields

NameTypeDescription
successbooleanSuccess
codeintegerCode
messagestringMessage
dataobject-
data.monitor_idstringMonitor ID
data.platformstringPlatform
data.video_idstringVideo identifier
data.video_titlestringVideo title
data.author_idstringAuthor identifier
data.author_namestringAuthor name
data.monitor_statusintegerMonitoring status: 0 = monitoring, 10 = completed, 20 = stopped, -1 = error
data.monitor_start_datestringMonitoring start date
data.monitor_end_datestringMonitoring end date
data.last_snapshot_timestringLast collected at
data.snapshot_countintegerSnapshots collected
data.created_timestringCreated at
data.snapshotsarray<object>Snapshot list

Try It

https://openapi.scdata.cc/api/v1/monitor/video/tasks/detail
Select an API key from Dashboard
Add an API key before sending a request.Go to Dashboard

Query Params

monitor_id*

cURL Example

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

Response Example (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
}
]
}
}

Use Cases

  • Engagement curvesChart how a video's views and likes grew hour by hour after publication.
  • Campaign reportingExport the recorded series into a client report at the end of a campaign.

Related Endpoints