A API de Estatísticas de Uso retorna informações sobre a utilização do serviço (e os limites configurados para essa utilização) por parte do usuário que está realizando a consulta, dentro do período especificado pelo mesmo. As consultas são contabilizadas dinamicamente, então uma requisição realizada agora, e outra realizada daqui a cinco minutos podem, potencialmente, trazer resultados diferentes. A verificação em períodos (ranges de data) muito longos pode impactar o tempo de resposta da requisição.
Essa API retorna informações sobre a quantidade total de requisições realizadas contra o serviço, a quantidade de requisições que retornaram com sucesso e com erro, o tempo médio de resposta para as requisições, e uma estimativa do valor que será cobrado do cliente pelas requisições realizadas (esse valor pode sofrer alterações devido ao volume de consultas realizadas). Além dos números gerais, também são enviadas as estatísticas detalhadas para cada Dataset disponível para o cliente, permitindo uma análise detalhada do comportamento do serviço.
Finalmente, o retorno da API contém também o limite mensal de consultas configurado para a conta do usuário, e permite que seja feito um acompanhamento de se o volume de consultas já atingiu esse limite ou não.
Funcionamento
Caso não passe algum parâmetro no Body, serão contabilizadas todas as chamadas realizadas pelo
mesmo no mês corrente. Alternativamente, as chamadas na API de Estatísticas de Uso podem receber uma data inicial (InitialReferenceDate)
e uma data final (FinalReferenceDate), que serão utilizadas para compor o período no qual as requisições realizadas
serão contadas. Além disso, pode receber também um parâmetro de formato da data (DateFormat), que indica em qual formato
as datas fornecidas na entrada foram preenchidas.
Quando estamos compondo o período, são consideradas as 0:00 horas de cada data informada, ou seja, uma requisição que recebe como data inicial 1o de Janeiro e como data final 31 de Dezembro só irá contar as requisições feitas das 0:00hs do dia 1 de Janeiro até as 0:00hs do dia 31 de dezembro, e as chamadas realizadas ao longo do próprio dia 31 serão ignoradas. Para contabilizar um ano inteiro, deve ser passado o dia 1o de Janeiro do ano que se deseja consultar como data inicial, e o dia 1o de Janeiro do ano seguinte como data final.
Exemplos
Como recuperar as estatísticas de uso referentes ao mês corrente:
POST https://dataplatform.bigdatacorp.com.br/uso
Body:
{}
Como recuperar as estatísticas de uso referentes ao mês de Julho de 2019:
POST https://dataplatform.bigdatacorp.com.br/uso
Body:
{
"InitialReferenceDate": "2019-07-01",
"FinalReferenceDate": "2019-08-01",
"DateFormat": "yyyy-MM-dd"
}
Como recuperar as estatísticas de uso referentes ao ano de 2018:
POST https://dataplatform.bigdatacorp.com.br/uso
Body:
{
"InitialReferenceDate": "2018-01-01",
"FinalReferenceDate": "2019-01-01",
"DateFormat": "yyyy-MM-dd"
}