Skip to content
Docs

Output minutes

GET
/v1/usage
curl --request GET \
  --url https://api.iomza.com/v1/usage \
  --header 'Authorization: Bearer <token>'

Minutes produced per category, in total and per UTC day. Each quality counts once (even if it feeds both MP4 and streaming), by its short side: SD below 720, HD 720–1080, UHD above. Each audio deliverable (a streaming language, an MP3) counts as audio.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

From this moment, ISO 8601 (a date or a date and time). Default: the start of the current month (UTC).

to
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

Up to this moment, ISO 8601. Default: now.

Responses

Section titled “Responses”

200

Section titled “200”

The minutes.

Media typeapplication/json

Output minutes over a period: in total and per UTC day.

object
object
required
string
Allowed value: usage
from
required
string
to
required
string
minutes
required

Output minutes per category (SD < 720p, HD 720p–1080p, UHD above; audio deliverables).

object
audio
required
number
sd
required
number
hd
required
number
uhd
required
number
daily
required
Array<object>
object
day
required
string
minutes
required
object
audio
required
number
sd
required
number
hd
required
number
uhd
required
number

Example 

{
  "object": "usage"
}

400

Section titled “400”

Invalid fields: details lists each problem with its path.

Media typeapplication/json
object
error
required
object
code
required

Stable: branch on it.

string
Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable
message
required

English, for people; may change.

string
details
required

Each problem, as path: message (validation errors).

Array<string>

Example 

{
  "error": {
    "code": "validation_error"
  }
}

401

Section titled “401”

The API key is missing, invalid or revoked.

Media typeapplication/json
object
error
required
object
code
required

Stable: branch on it.

string
Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable
message
required

English, for people; may change.

string
details
required

Each problem, as path: message (validation errors).

Array<string>

Example 

{
  "error": {
    "code": "validation_error"
  }
}

429

Section titled “429”

Too many requests: wait and retry. Answered by the gateway, so the body may differ.

Media typeapplication/json
object
error
required
object
code
required

Stable: branch on it.

string
Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable
message
required

English, for people; may change.

string
details
required

Each problem, as path: message (validation errors).

Array<string>

Example 

{
  "error": {
    "code": "validation_error"
  }
}

500

Section titled “500”

Ours: retry, and tell us if it persists.

Media typeapplication/json
object
error
required
object
code
required

Stable: branch on it.

string
Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable
message
required

English, for people; may change.

string
details
required

Each problem, as path: message (validation errors).

Array<string>

Example 

{
  "error": {
    "code": "validation_error"
  }
}

503

Section titled “503”

Momentarily unavailable: retry in a few seconds.

Media typeapplication/json
object
error
required
object
code
required

Stable: branch on it.

string
Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable
message
required

English, for people; may change.

string
details
required

Each problem, as path: message (validation errors).

Array<string>

Example 

{
  "error": {
    "code": "validation_error"
  }
}