Skip to main content

Company Consume

Endpoint que retorna el consumo del servicio por una compañia, en un rango de tiempo dado. Para indicar la compañia se debe ingresar su identificador en la variable de ruta company_id. La respuesta que recibe el usuario está comprendida por el identificador de la compañía, el rango de fechas, los gigabytes totales de los archivos que se han subido y los gigabytes que han sido descargados.

Endpoint#

Headers

KeyValueDescription
Content-Typeapplication/json
AuthorizationBearer {{access_token}}access_token obtained in Atenea
Method: Get
URL: https://api.trust.lat/chronos/v1/metrics/companies/:company_id?from_date=&until_date=&deleted=

Query Params:

KeyValue ExampleDescription
from_date2021-09-15Fecha de inicio de búsqueda. Obligatorio
until_date2021-11-16Fecha límite de búsqueda. Obligatorio
deletedfalseIndica si la búsqueda debe incluir archivos eliminados. Opcional

Path Variables:

KeyValue ExampleDescription
company_id1Identificador de la compañia por la empresa Trust. Obligatorio
caution

Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea

Como obtener un access token

Code Examples#

curl --location --request GET 'https://api.trust.lat/chronos/v1/metrics/companies/:company_id?from_date=2021-09-14&until_date=2021-11-18&deleted=false' \
--header 'Authorization: Bearer {{access_token}}'

Responses#

HTTP Code: 200 OK#

Company Consume, without considering the deleted files#

{
"code": 200,
"resource": "Metrics",
"data": {
"company_id": "1",
"from_date": "2021-09-14",
"until_date": "2021-11-18",
"gigabytes_uploaded": 0.007,
"gigabytes_downloaded": 0.001
},
"message": "Found"
}

Company consume, considering deleted files#

{
"code": 200,
"resource": "Metrics",
"data": {
"company_id": "1",
"from_date": "2021-09-14",
"until_date": "2021-11-18",
"gigabytes_uploaded": 0.009,
"gigabytes_downloaded": 0.003
},
"message": "Found"
}

HTTP Code: 404 Not Found#

Company not registed in Chronos Service#

{
"code": 404,
"resource": "Company Config",
"message": "Not found"
}
Last updated on by Claudio-Franco