Récupérer les statistiques des Assemblies
Renvoie les décomptes d’Assemblies pour la région et la plage temporelle demandées.
https://api2.transloadit.com/L’exemple inclut des Assemblies avec et sans Template dans la région et la plage de temps demandées.
Omettre template_id sélectionne uniquement les Assemblies créées sans Template.
Exemple de requête
Exécutez cette requête dans un shell côté serveur avec curl et un jeton porteur approprié dans TRANSLOADIT_TOKEN. Si vous avez besoin d’un jeton, développez la section de configuration ci-dessous.
Cet exemple utilise également jq pour encoder les valeurs dynamiques au format JSON.
Besoin d’un jeton porteur ?
Dans un shell de confiance côté serveur disposant de curl et de jq, définissez TRANSLOADIT_KEY et TRANSLOADIT_SECRET avec votre Auth Key et votre Auth Secret. Gardez secrets ces deux éléments d’authentification et le jeton obtenu ; n’exécutez jamais cette configuration dans du code côté navigateur.
Commencez par créer un jeton avec les portées requises par ce point de terminaison. Votre Auth Key doit déjà accorder ces portées.
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
Gardez ce shell ouvert et exécutez la requête ci-dessous. Réutilisez le jeton tant qu’il reste valide.
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"
Authentification
Ce point de terminaison accepte des params signés ou un jeton porteur. Consultez la section Authentification pour les instructions de configuration.
Portée requise pour l’Auth Key ou le jeton porteur : assemblies:read.
Les requêtes signées nécessitent à la fois une signature et un horodatage params.auth.expires situé dans le futur. Les jetons porteurs ne nécessitent ni l’un ni l’autre.
Paramètres de requête
params(Chaîne JSON), obligatoire. Un objet encodé en JSON dont les clés prises en charge sont répertoriées ci-dessous.signature(chaîne de caractères). Obligatoire pour les requêtes signées. Omettez ce champ lorsque vous utilisez un jeton porteur.
Clés prises en charge dans le champ params
Les champs d’authentification de cette liste s’appliquent aux requêtes signées. Avec un jeton porteur, vous pouvez omettre params.auth et le champ distinct signature. Comparez les paramètres de requête spécifiques à l’authentification ci-dessous.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
| Champ | Type et description |
|---|---|
params.obligatoire pour les requêtes signées ; facultatif avec un jeton porteur | Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête de statistiques d’Assembly.
|
params.obligatoire | stringHorodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre. |
params.obligatoire | stringClé API Transloadit utilisée pour authentifier les requêtes |
params. | string | integerValeur unique et aléatoire incluse dans les paramètres de la requête signée pour rendre chaque signature unique et empêcher la réutilisation accidentelle d’une signature. |
params.obligatoire | string (longueur minimale : 1)Région à inclure, ou |
params.obligatoire | string (longueur minimale : 1)Date et heure auxquelles commence la fenêtre de statistiques, au plus tôt il y a 91 jours. Le format ISO 8601 est recommandé ; API2 préserve également les chaînes de date acceptées par son analyseur existant. Une période rétrospective plus longue est rejetée avec l’erreur invalid-time du point de terminaison. |
params. | null | stringID du Template à inclure, ou |
Paramètres de requête par méthode d’authentification
Avec des paramètres signés
Incluez votre Auth Key dans params.auth.key. Lors de la signature de la requête, incluez un horodatage futur dans params.auth.expires et envoyez la signature dans le champ distinct signature. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.auth, params.nonce, params.region, params.since, params.template_id
Avec un jeton porteur
Envoyez le jeton porteur dans l’en-tête Authorization. Vous pouvez omettre params.auth et le champ distinct signature. Les autres paramètres obligatoires restent requis. Les définitions des champs ci-dessous utilisent des chemins à l’intérieur de params.
Schéma JSON complet
params: Seuls les champs répertoriés pour cet objet sont acceptés.
Utilise les définitions des champs ci-dessus : params.nonce, params.region, params.since, params.template_id
| Champ | Type et description |
|---|---|
params. | Contient la clé API Transloadit et les métadonnées de Signature Authentication pour une requête de statistiques d’Assembly.
|
params. | stringHorodatage d’expiration au format ISO 8601 situé dans le futur. Obligatoire lorsqu’une requête est signée ou nécessite Signature Authentication ; les requêtes authentifiées par jeton porteur peuvent l’omettre. |
params. | stringClé API Transloadit utilisée pour authentifier les requêtes |
Réponse
Voici un exemple de corps de réponse :
{
"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
}Succès 2xx
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
La réponse contient uniquement les champs répertoriés pour cet objet.
| Champ | Type et description | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errorStatsobligatoire | Array<object>Schéma d’un élément de tableau
| ||||||||||||||||||||||||||||||||||||||||||||||
errorStatsGranularityobligatoire | integer (minimum exclusif : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
errorStatsTotalsobligatoire | Array<object>Schéma d’un élément de tableau
| ||||||||||||||||||||||||||||||||||||||||||||||
granularityobligatoire | integer (minimum exclusif : 0)Durée de chaque intervalle de statistiques, en secondes. | ||||||||||||||||||||||||||||||||||||||||||||||
okobligatoire | string (toujours : "ASSEMBLY_STATS_FOUND") | ||||||||||||||||||||||||||||||||||||||||||||||
statsobligatoire | Array<object>Schéma d’un élément de tableau
| ||||||||||||||||||||||||||||||||||||||||||||||
totalAssembliesobligatoire | integer (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalBytesProcessedobligatoire | integer (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalBytesUploadedobligatoire | integer (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalExecutionDurationobligatoire | number (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalFilesProcessedobligatoire | integer (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalLiveQueueDurationobligatoire | number (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalOutputBytesProcessedobligatoire | integer (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalOutputFilesProcessedobligatoire | integer (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalUploadDurationobligatoire | number (minimum : 0) | ||||||||||||||||||||||||||||||||||||||||||||||
totalUsageobligatoire | integer (minimum : 0) |
HTTP 400
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
Erreurs nommées et format général des erreurs
error: "ASSEMBLY_STATS_INVALID_TIME"
L’heure since est manquante ou incorrecte.
La réponse peut contenir des champs supplémentaires.
error: "ASSEMBLY_STATS_MISSING_REGION"
Vous devez fournir une valeur spécifique pour region, ou « all ».
La réponse peut contenir des champs supplémentaires.
Format général des erreurs
HTTP 500
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
Erreurs nommées et format général des erreurs
error: "ASSEMBLY_STATS_ERROR"
Impossible de charger les statistiques des Assemblies.
La réponse peut contenir des champs supplémentaires.
Format général des erreurs
Réponse d’erreur
Corps de la réponse JSON. application/json text/plain; charset=utf-8
Schéma du corps de la réponse
Schéma JSON complet
La réponse peut contenir des champs supplémentaires.
| Champ | Type et description |
|---|---|
assembly_id | string |
error | string (longueur minimale : 1) |
http_code | number | string
|
message | stringExplication de l’erreur destinée à être lue par un humain. Sa formulation peut varier ; utilisez le code |
reason | null | string | number | boolean | Array<n’importe quelle valeur> | objectN’importe lequel des schémas suivants peut s’appliquer : nullstringnumberbooleanArray<n’importe quelle valeur>Array<n’importe quelle valeur>Schéma d’un élément de tableaun’importe quelle valeurobjectobjectSchéma de la propriété supplémentairen’importe quelle valeur |