Get Request Metrics

This section allows you to get the metrics of a request

Get Video Request Metrics

get

Get metrics for the request

Response body

Property	Type	Description
minutesInState	Object	Minutes spent in various processing states
minutesInState.pendingSourceUpload	Number	-
minutesInState.initializing	Number	-
minutesInState.preprocessing	Number	-
minutesInState.processing	Number	-
minutesInState.postprocessing	Number	-
minutesToEnhance	Number	Time to complete enhancement after source upload
inputFrames	Integer	Number of input frames
outputFrames	Integer	Number of output frames
inputSize	String	Size of input video
outputSize	String	Size of output video
chunks	Array	Refer to VideoChunkMetrics below

---

VideoChunkMetrics

Property	Type	Description
chunkIndex	Integer	Index of the chunk
tasks	Array	List of processing tasks for the chunk
tasks.*.minutesProcessing	Number	Duration of processing in minutes
tasks.*.inputFrames	Integer	Number of input frames
tasks.*.outputFrames	Integer	Number of output frames
tasks.*.inputSize	String	Size of the input file
tasks.*.outputSize	String	Size of the output file

Authorizations

apiKey

X-API-KeystringRequired

Path parameters

requestIdstring · uuidRequiredExample: c1f96dc2-c448-00e6-82ed-14ecb6403c62

Responses

200

Successful response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Enhancement request with the provided ID not found

application/json

500

Internal server error

application/json

get

/video/{requestId}/metrics

HTTPcURLJavaScriptPython

GET /video/{requestId}/metrics HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "minutesInState": {
    "pendingSourceUpload": 1.23,
    "initializing": 1.23,
    "preprocessing": 1.23,
    "processing": 3.21,
    "postprocessing": 3.21
  },
  "minutesToEnhance": 12.34,
  "inputFrames": 3000,
  "outputFrames": 3000,
  "inputSize": "300 MB",
  "outputSize": "400 MB",
  "chunks": [
    {
      "chunkIndex": 0,
      "tasks": [
        {
          "minutesProcessing": 12.3,
          "inputFrames": 320,
          "outputFrames": 320,
          "inputSize": "100 MB",
          "outputSize": "200 MB"
        }
      ]
    },
    {
      "chunkIndex": 1,
      "tasks": [
        {
          "minutesProcessing": 12.2,
          "inputFrames": 319,
          "outputFrames": 319,
          "inputSize": "99 MB",
          "outputSize": "199 MB"
        }
      ]
    }
  ]
}