Ir al contenido

Minutos de salida

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

Minutos producidos por categoría, en total y por día UTC. Cada calidad cuenta una vez (aunque alimente MP4 y streaming), según su lado corto: SD por debajo de 720, HD de 720 a 1080, UHD por encima. Cada entregable de audio (un idioma del streaming, un MP3) cuenta como audio.

from
Uno o varios de:
string formato: 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)))$/

Desde este momento, en ISO 8601 (una fecha, o fecha y hora). Por defecto: el inicio del mes en curso (UTC).

to
Uno o varios de:
string formato: 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)))$/

Hasta este momento, en ISO 8601. Por defecto: ahora.

Los minutos.

Tipo de contenidoapplication/json

Minutos de salida en un periodo: en total y por día UTC.

object
object
obligatorio
string
Valor permitido: usage
from
obligatorio
string
to
obligatorio
string
minutes
obligatorio

Minutos de salida por categoría (SD < 720p, HD 720p–1080p, UHD por encima; entregables de audio).

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

Ejemplo

{
"object": "usage"
}

Campos inválidos: details lista cada problema con su ruta.

Tipo de contenidoapplication/json
object
error
obligatorio
object
code
obligatorio

Estable: decide con él.

string
Valores permitidos: 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
obligatorio

En inglés, para personas; puede cambiar.

string
details
obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

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

La API key falta, no es válida o está revocada.

Tipo de contenidoapplication/json
object
error
obligatorio
object
code
obligatorio

Estable: decide con él.

string
Valores permitidos: 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
obligatorio

En inglés, para personas; puede cambiar.

string
details
obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

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

Demasiadas peticiones: espera y reintenta. Lo responde la pasarela, así que el cuerpo puede ser distinto.

Tipo de contenidoapplication/json
object
error
obligatorio
object
code
obligatorio

Estable: decide con él.

string
Valores permitidos: 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
obligatorio

En inglés, para personas; puede cambiar.

string
details
obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

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

Nuestro: reintenta, y avísanos si persiste.

Tipo de contenidoapplication/json
object
error
obligatorio
object
code
obligatorio

Estable: decide con él.

string
Valores permitidos: 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
obligatorio

En inglés, para personas; puede cambiar.

string
details
obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

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

No disponible por un momento: reintenta en unos segundos.

Tipo de contenidoapplication/json
object
error
obligatorio
object
code
obligatorio

Estable: decide con él.

string
Valores permitidos: 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
obligatorio

En inglés, para personas; puede cambiar.

string
details
obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

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