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

Key	Value	Description
Content-Type	application/json
Authorization	Bearer {{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:

Key	Value Example	Description
from_date	2021-09-15	Fecha de inicio de búsqueda. Obligatorio
until_date	2021-11-16	Fecha límite de búsqueda. Obligatorio
deleted	false	Indica si la búsqueda debe incluir archivos eliminados. Opcional

Path Variables:

Key	Value Example	Description
company_id	1	Identificador 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

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}}`'

JavaScript

import requests

url = "https://api.trust.lat/chronos/v1/metrics/companies/:company_id?from_date=2021-09-14&until_date=2021-11-18&deleted=false"

payload={}
headers = {
  'Authorization': 'Bearer `{{access_token}}`'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Python

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.trust.lat/chronos/v1/metrics/companies/:company_id?from_date=2021-09-14&until_date=2021-11-18&deleted=false',
  headers: { 
    'Authorization': 'Bearer `{{access_token}}`'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

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"
}