Skip to main content
GET
Extrato da chave
Consumo da chave e lista do que ela consultou. Serve para conferir gasto antes de bater no teto e para reconciliar cobrança do seu lado.

Não gera cobrança

Lê só o histórico.
O extrato é da chave, não da organização: uma chave de integração não enxerga o que a equipe consultou pela tela do app, o que é deliberado. O bloco uso conta apenas consultas cobradas. Consulta servida do histórico não entra na conta, porque também não custou nada. Resposta:

Authorizations

Authorization
string
header
required

Chave de API criada em Configurações, Integrações, Chaves de API. Começa com sk_live_ e aparece uma vez só. O cabeçalho X-API-Key também é aceito, com o mesmo valor.

Query Parameters

limite
integer
default:30

Quantas consultas trazer. O máximo é 100.

Required range: x <= 100
produto
string

Filtra por id de produto.

documento
string

Filtra por documento. Pontuação é ignorada.

Response

Consumo e histórico da chave.

uso
object

Consultas cobradas por janela. Consulta servida do histórico não entra na conta, porque também não custou nada.

consultas
object[]