Consultar Consumo da API Pro

Descrição

Retorna o consumo da API Pro no mês vigente, permitindo acompanhar programaticamente a quantidade de requisições (hits) realizadas e seus respectivos custos.

O consumo é apresentado separadamente entre os períodos diurno e noturno, além dos valores totais acumulados no período. A resposta também informa a moeda utilizada e o limite financeiro de consumo (costLimit) configurado para o escopo da chave utilizada na requisição.

A consulta respeita o escopo da chave de acesso:

Chave de ADM Geral: retorna o consumo pertencente ao escopo do ADM Geral.

Chave de filial: retorna somente o consumo pertencente ao escopo da respectiva filial.

🚧 Observações
O consumo retornado corresponde ao mês vigente.
O consumo da API Pro é contabilizado considerando os custos aplicáveis aos hits diurnos e noturnos.
O limite financeiro é independente entre os diferentes escopos. O consumo realizado por chaves cadastradas no ADM Geral é contabilizado no escopo do ADM Geral, enquanto o consumo de uma chave de filial é contabilizado no escopo da respectiva filial.
O campo costLimit representa o limite financeiro configurado para o escopo consultado.
O limite financeiro é opcional. Quando configurado, ele é utilizado para controlar o valor máximo de consumo da API Pro no período.
Quando o custo acumulado atingir o limite configurado, as chaves vinculadas ao respectivo escopo serão bloqueadas para novos consumos da API Pro.
Após o limite ser atingido e a chave ser bloqueada, este endpoint também não poderá mais ser consultado com a chave bloqueada. As requisições retornarão HTTP 401 com o código API_COST_LIMIT_REACHED.
O consumo e o bloqueio são reiniciados na virada do mês, mantendo o limite configurado para o novo período.

📤 Estrutura da Resposta

A resposta apresenta o período considerado, a moeda, o consumo da API Pro separado entre períodos diurno e noturno, o consumo total e o limite financeiro configurado.

Campo	Tipo	Descrição
`period`	object	Objeto contendo o período considerado para o cálculo do consumo. Ver mais abaixo.
`currency`	string	Moeda utilizada para os valores de consumo e limite financeiro.
`usage`	object	Objeto contendo a quantidade de hits e os custos acumulados no período. Ver mais abaixo.
`costLimit`	number	Limite financeiro de consumo da API Pro configurado para o escopo da chave utilizada.

🧩 Estrutura do Objeto `period`

Campo	Tipo	Descrição
`start`	date-time	Data e hora inicial do período considerado para o cálculo do consumo no mês vigente.
`end`	date-time	Data e hora final do período considerado para o cálculo do consumo.

🧩 Estrutura do Objeto `usage`

Campo	Tipo	Descrição
`daytime`	object	Consumo acumulado durante o período diurno.
`nighttime`	object	Consumo acumulado durante o período noturno.
`total`	object	Consumo total acumulado, considerando os períodos diurno e noturno.

🧩 Estrutura dos Objetos `daytime`, `nighttime` e `total`

Campo	Tipo	Descrição
`hits`	int32	Quantidade de requisições (hits) contabilizadas no respectivo período. No objeto `total`, representa a soma dos hits diurnos e noturnos.
`cost`	number	Custo acumulado das requisições no respectivo período. No objeto `total`, representa o custo total acumulado.

💰 Moeda

A moeda utilizada para apresentar o consumo e o limite financeiro varia de acordo com o mercado do cliente:

Mercado	`currency`
Brasil	`BRL`
LATAM aplicável	`USD`

⚠️ Limite de Consumo Atingido

Quando o custo acumulado atingir 100% do costLimit configurado, as chaves vinculadas ao respectivo escopo serão bloqueadas.

A partir desse momento, novas requisições realizadas com a chave bloqueada, inclusive para este endpoint, retornarão:

HTTP 401

{
  "error": {
    "code": "API_COST_LIMIT_REACHED",
    "message": "The configured API usage cost limit has been reached."
  }
}

OBS. Enquanto a chave estiver ativa, este endpoint pode ser utilizado para acompanhar o consumo e comparar o campo usage.total.cost com o costLimit configurado.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Respostas

🟢200

application/json

Success

Body

Exemplo

{
    "period": {
        "start": "2019-08-24T14:15:22.123Z",
        "end": "2019-08-24T14:15:22.123Z"
    },
    "currency": "string",
    "usage": {
        "daytime": {
            "hits": 0,
            "cost": 0
        },
        "nighttime": {
            "hits": 0,
            "cost": 0
        },
        "total": {
            "hits": 0,
            "cost": 0
        }
    },
    "costLimit": 0
}

🟠400

Get API Pro usage of the current month (hits and costs by period) and the configured cost limit

Consultar Consumo da API Pro

Descrição

📤 Estrutura da Resposta

🧩 Estrutura do Objeto `period`

🧩 Estrutura do Objeto `usage`

🧩 Estrutura dos Objetos `daytime`, `nighttime` e `total`

💰 Moeda

⚠️ Limite de Consumo Atingido

Requisição

Exemplos de Requisição

Respostas

Get API Pro usage of the current month (hits and costs by period) and the configured cost limit

Consultar Consumo da API Pro#

Descrição#

📤 Estrutura da Resposta#

🧩 Estrutura do Objeto period#

🧩 Estrutura do Objeto usage#

🧩 Estrutura dos Objetos daytime, nighttime e total#

💰 Moeda#

⚠️ Limite de Consumo Atingido#

Requisição

Exemplos de Requisição

Respostas

Consultar Consumo da API Pro

Descrição

📤 Estrutura da Resposta

🧩 Estrutura do Objeto `period`

🧩 Estrutura do Objeto `usage`

🧩 Estrutura dos Objetos `daytime`, `nighttime` e `total`

💰 Moeda

⚠️ Limite de Consumo Atingido