Help Center> Live> API Reference> API Overview

API Overview

The following tables list the Live APIs. Before calling a Live API, you need to obtain a user token. The obtained token can then be used to authenticate the calling of other APIs. For details about how to call a Live API, see Getting Started.

Transcoding Template APIs

Table 1 Transcoding template APIs

API

Description

POST /v1/{project_id}/template/transcodings

Creating a Transcoding Template

PUT /v1/{project_id}/template/transcodings

Modifying a Transcoding Template

DELETE /v1/{project_id}/template/transcodings

Deleting a Transcoding Template

GET /v1/{project_id}/template/transcodings

Querying Transcoding Templates

Streams Management APIs

Table 2 Streams management APIs

API

Description

POST /v1/{project_id}/stream/blocks

Disabling a Push Stream

PUT /v1/{project_id}/stream/blocks

Modifying the Attribute of a Disabled Stream

DELETE /v1/{project_id}/stream/blocks

Resuming a Push Stream

GET /v1/{project_id}/stream/blocks

Querying Disabled Streams

GET /v1/{project_id}/stream/bandwidth

Querying Bandwidth Data

GET /v1/{project_id}/stream/traffic

Querying Traffic Data

GET /v1/{project_id}/stream/users

Querying the Number of Online Viewers

Recording APIs

Table 3 Recording APIs

API

Description

POST /v1/{project_id}/record/config

Creating a Recording Template

GET /v1/{project_id}/record/config

Querying Recording Templates

DELETE /v1/{project_id}/record/config

Deleting a Recording Template

Statistics Analysis APIs

Table 4 Statistics analysis APIs

API

Description

GET /v2/{project_id}/stats/bandwidth/detail

Querying Bandwidth Utilization

GET /v2/{project_id}/stats/traffic/detail

Querying Traffic Utilization

GET /v2/{project_id}/stats/bandwidth/peak

Querying Peak Bandwidth

GET /v2/{project_id}/stats/traffic/summary

Querying Total Traffic

GET /v2/{project_id}/stats/user

Querying the Number of Viewers

GET /v2/{project_id}/stats/httpcodes

Querying HTTP Status Codes for Pulling Live Streams

GET /v2/{project_id}/stats/transcode

Querying the Duration of Transcoded Outputs

GET /v2/{project_id}/stats/record

Querying Recording Channels

GET /v2/{project_id}/stats/snapshot

Querying the Number of Snapshots

GET /v2/{project_id}/stats/up-bandwidth/detail

Querying Upstream Bandwidth

GET /v2/{project_id}/stats/stream-count

Querying the Number of Stream Channels

GET /v2/{project_id}/stats/history/streams

Querying the Historical Stream List

Stream Analytics APIs

Table 5 Stream analytics APIs

API

Description

GET /v2/{project_id}/stats/stream/framerate

Querying the Stream Frame Rate

GET /v2/{project_id}/stats/stream/bitrate

Querying the Stream Bitrate