API de Métricas

O TRD disponibiliza uma API com métricas relacionadas ao processo de transcrição.

API de métricas

Requisição

GET /v1/metrics

Query

• interval (opcional): Intervalo das metricas em horas, valor padrão 1 hora.

Header

• Authorization

Response

• 200 - Resposta das metricas

• 422 - Erro de validação

curl -X 'GET' \
  'http://localhost:8080/v1/metrics/?interval=1' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <token>'

Resultado da API no formato JSON:

{
  "job": {
    "requests": {
      "count": 10,
      "audio_duration": {
        "min": 2.296,
        "max": 2.296,
        "mean": 2.296,
        "std": 0,
        "unit": "minute"
      },
      "size": {
        "min": 36740,
        "max": 36740,
        "mean": 36740,
        "std": 0,
        "unit": "byte"
      },
      "request_rate": {
        "value": 0.16666666666666666,
        "unit": "requests/minute"
      },
      "speed": {
        "value": 0,
        "unit": "minutes/hour"
      }
    },
    "responses": {
      "count": 10,
      "audio_duration": {
        "min": 2.296,
        "max": 2.296,
        "mean": 2.296,
        "std": 0,
        "unit": "minute"
      },
      "speech_duration": {
        "min": 1.091,
        "max": 1.091,
        "mean": 1.0909999999999997,
        "std": 2.340555645717801e-16,
        "unit": "minute"
      },
      "size": {
        "min": 36784,
        "max": 36784,
        "mean": 36784,
        "std": 0,
        "unit": "byte"
      },
      "request_rate": {
        "value": 0.16666666666666666,
        "unit": "requests/minute"
      },
      "speed": {
        "value": 0,
        "unit": "minutes/hour"
      }
    },
    "errors": {
      "value": 0,
      "unit": "jobs"
    },
    "actives": {
      "value": 0,
      "unit": "jobs"
    },
    "processing_time": {
      "value": 0,
      "unit": "minute"
    },
    "transcription_rate": {
      "value": 1.53,
      "unit": "minutes/hour"
    },
    "audio": {
      "audio_total": {
        "value": 22.96,
        "unit": "minute"
      },
      "speech_total": {
        "value": 10.91,
        "unit": "minute"
      }
    },
    "status": {
      "queued": 0,
      "in_progress": 0,
      "failed": 0,
      "stopped": 1,
      "completed": 14
    }
  }
}

API de Licença

Requisição

GET /v1/license/status/

Header

• Authorization

Response

• 200 - Resposta das metricas

curl -X 'GET' \
  'http://localhost:8080/v1/license/status' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <token>'

Resultado da API no formato JSON:

{
  "consumed": {
    "minutes": {
      "value": 22.959999999999997,
      "unit": "minute"
    },
    "requests": {
      "value": 10,
      "unit": "request"
    }
  },
  "remain": {
    "minutes": {
      "value": 49977.04,
      "unit": "minute"
    },
    "requests": {
      "value": 49990,
      "unit": "request"
    }
  },
  "license_id": "T1TRD-..."
}