Recuperar estatísticas de Assemblies
Retorna contagens de Assemblies para uma região e um intervalo de tempo solicitados.
https://api2.transloadit.com/O exemplo inclui Assemblies com e sem Template na região e no intervalo de tempo solicitados.
Omitir template_id seleciona apenas as Assemblies criadas sem Template.
Exemplo de requisição
Execute esta requisição em um shell no servidor com curl e um bearer token adequado em TRANSLOADIT_TOKEN. Se você precisar de um token, expanda a configuração abaixo.
Este exemplo também usa jq para codificar valores dinâmicos como JSON.
Precisa de um bearer token?
Em um shell confiável no servidor com curl e jq, defina TRANSLOADIT_KEY e TRANSLOADIT_SECRET com sua Auth Key e seu Auth Secret. Mantenha as duas credenciais e o token resultante em segredo; nunca execute esta configuração em código de navegador.
Primeiro, crie um token com os escopos exigidos por este endpoint. Sua Auth Key já precisa conceder esses escopos.
if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
--request POST \
--url 'https://api2.transloadit.com/token' \
--user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'aud=api2' \
--data-urlencode 'scope=assemblies:read')"; then
printf '%s\n' "$TOKEN_RESPONSE" >&2
exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
jq -er '.access_token | strings | select(length > 0)')" || exit 1
Mantenha este shell aberto e execute a requisição abaixo. Reutilize o token enquanto ele continuar válido.
SINCE="$(date -u +%Y-%m-%dT00:00:00Z)"
PARAMS="$(jq -cn --arg since "${SINCE:?Set SINCE}" '{"region":"us-east-1","since":$since,"template_id":"all"}')"
curl --fail-with-body -sS --request GET --get \
--url "https://api2.transloadit.com/assembly_stats" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode "params=$PARAMS"
Autenticação
Este endpoint aceita params assinados ou um token bearer. Consulte Autenticação para instruções de configuração.
Escopo necessário para a Auth Key ou o token bearer: assemblies:read.
Requisições assinadas exigem tanto uma signature quanto um timestamp params.auth.expires no futuro. Tokens Bearer não exigem nenhum dos dois.
Parâmetros de consulta
params(string JSON), obrigatório. Um objeto codificado em JSON cujas chaves suportadas estão listadas abaixo.signature(string). Obrigatório para requisições assinadas. Omita este campo ao usar um bearer token.
Chaves compatíveis dentro do campo params
Os campos de autenticação desta lista se aplicam a requisições assinadas. Com um bearer token, você pode omitir params.auth e o campo signature separado. Compare os parâmetros de requisição específicos de autenticação abaixo.
Esquema JSON completo
params: Somente os campos listados para este objeto são aceitos.
| Campo | Tipo e descrição |
|---|---|
params.obrigatório para requisições assinadas; opcional com um bearer token | Contém a chave de API da Transloadit e os metadados de autenticação por assinatura para uma requisição de Assembly Stats.
|
params.obrigatório | stringTimestamp de expiração no formato ISO 8601 situado no futuro. Obrigatório quando uma requisição é assinada ou exige autenticação por assinatura; requisições autenticadas por bearer podem omiti-lo. |
params.obrigatório | stringChave de API da Transloadit usada para autenticar as requisições |
params. | string | integerValor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas. |
params. | string | integerValor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas. |
params.obrigatório | string (comprimento mínimo: 1)Região a incluir, ou |
params.obrigatório | string (comprimento mínimo: 1)Data e hora em que a janela de estatísticas começa, no máximo 91 dias atrás. Recomenda-se ISO 8601; a API2 também preserva strings de data aceitas pelo seu parser atual. Um período de consulta mais longo é rejeitado com o erro de horário inválido do endpoint. |
params. | null | stringTemplate ID a incluir, ou |
Parâmetros de requisição por método de autenticação
Com parâmetros assinados
Inclua sua Auth Key como params.auth.key. Ao assinar a requisição, inclua um timestamp futuro em params.auth.expires e envie a assinatura no campo separado signature. As definições de campos abaixo usam caminhos dentro de params.
Esquema JSON completo
params: Somente os campos listados para este objeto são aceitos.
Usa as definições de campo acima: params.auth, params.nonce, params.region, params.since, params.template_id
Com um token bearer
Envie o token bearer no cabeçalho Authorization. Você pode omitir params.auth e o campo signature separado. Os demais parâmetros obrigatórios continuam se aplicando. As definições de campos abaixo usam caminhos dentro de params.
Esquema JSON completo
params: Somente os campos listados para este objeto são aceitos.
Usa as definições de campo acima: params.nonce, params.region, params.since, params.template_id
| Campo | Tipo e descrição |
|---|---|
params. | Contém a chave de API da Transloadit e os metadados de autenticação por assinatura para uma requisição de Assembly Stats.
|
params. | stringTimestamp de expiração no formato ISO 8601 situado no futuro. Obrigatório quando uma requisição é assinada ou exige autenticação por assinatura; requisições autenticadas por bearer podem omiti-lo. |
params. | stringChave de API da Transloadit usada para autenticar as requisições |
params. | string | integerValor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas. |
Resposta
Veja um exemplo de corpo de resposta:
{
"errorStats": [
{
"data_from_ts": 1789200000,
"error": "FILE_IMPORT_FAILED",
"num_erroneous_assemblies": 1
}
],
"errorStatsGranularity": 60,
"errorStatsTotals": [
{
"error": "FILE_IMPORT_FAILED",
"num_erroneous_assemblies": 1
}
],
"granularity": 60,
"ok": "ASSEMBLY_STATS_FOUND",
"stats": [
{
"avg_execution_duration": 2,
"avg_input_file_sizes": 100000,
"avg_live_queue_duration": 0.5,
"avg_output_file_sizes": 90000,
"avg_processing_speed": 0.4,
"avg_upload_duration": 1,
"avg_upload_speed": 0.8,
"data_from_ts": 1789200000,
"num_assemblies": 10,
"num_bytes": 1000000,
"num_cancelled_assemblies": 0,
"num_erroneous_assemblies": 1,
"num_files": 10,
"num_request_aborted_assemblies": 0,
"num_successful_assemblies": 9,
"total_bytes_usage": 1000000,
"total_execution_duration": 20,
"total_live_queue_duration": 5,
"total_num_output_files": 9,
"total_num_uploaded_bytes": 1000000,
"total_output_file_sizes": 900000,
"total_upload_duration": 10
}
],
"totalAssemblies": 10,
"totalBytesProcessed": 1000000,
"totalBytesUploaded": 1000000,
"totalExecutionDuration": 20,
"totalFilesProcessed": 10,
"totalLiveQueueDuration": 5,
"totalOutputBytesProcessed": 900000,
"totalOutputFilesProcessed": 9,
"totalUploadDuration": 10,
"totalUsage": 1000000
}sucesso 2xx
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
A resposta contém apenas os campos listados para este objeto.
| Campo | Tipo e descrição | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorStatsobrigatório | Array<object>Esquema do item do array
| ||||||||||||||||||||||||||||||||||||||||||||||
errorStatsGranularityobrigatório | integer (mínimo exclusivo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
errorStatsTotalsobrigatório | Array<object>Esquema do item do array
| ||||||||||||||||||||||||||||||||||||||||||||||
granularityobrigatório | integer (mínimo exclusivo: 0)Duração de cada bucket de estatísticas em segundos. | ||||||||||||||||||||||||||||||||||||||||||||||
okobrigatório | string (sempre: "ASSEMBLY_STATS_FOUND") | ||||||||||||||||||||||||||||||||||||||||||||||
statsobrigatório | Array<object>Esquema do item do array
| ||||||||||||||||||||||||||||||||||||||||||||||
totalAssembliesobrigatório | integer (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalBytesProcessedobrigatório | integer (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalBytesUploadedobrigatório | integer (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalExecutionDurationobrigatório | number (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalFilesProcessedobrigatório | integer (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalLiveQueueDurationobrigatório | number (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalOutputBytesProcessedobrigatório | integer (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalOutputFilesProcessedobrigatório | integer (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalUploadDurationobrigatório | number (mínimo: 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalUsageobrigatório | integer (mínimo: 0) |
HTTP 400
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
Erros nomeados e o formato geral de erro
error: "ASSEMBLY_STATS_INVALID_TIME"
O horário since está ausente ou incorreto.
A resposta pode conter campos adicionais.
error: "ASSEMBLY_STATS_MISSING_REGION"
É necessário fornecer uma region específica ou "all".
A resposta pode conter campos adicionais.
Formato geral de erro
HTTP 500
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
Erros nomeados e o formato geral de erro
error: "ASSEMBLY_STATS_ERROR"
Não foi possível carregar as estatísticas da Assembly.
A resposta pode conter campos adicionais.
Formato geral de erro
Resposta de erro
Corpo da resposta JSON. application/json text/plain; charset=utf-8
Esquema do corpo da resposta
Esquema JSON completo
A resposta pode conter campos adicionais.
| Campo | Tipo e descrição |
|---|---|
assembly_id | string |
error | string (comprimento mínimo: 1) |
http_code | number | string
|
message | stringExplicação do erro legível por humanos. A redação pode variar; use o código |
reason | null | string | number | boolean | Array<qualquer valor> | objectQualquer um dos esquemas a seguir pode ser aplicado: nullnullstringstringnumbernumberbooleanbooleanArray<qualquer valor>Array<qualquer valor>Esquema do item do arrayqualquer valorobjectobjectEsquema de propriedade adicionalqualquer valor |