> ## Documentation Index > Fetch the complete documentation index at: https://docs.pubrio.com/llms.txt > Use this file to discover all available pages before exploring further. # Detalhamento de Uso da API > Recupera um detalhamento das requisições da API e dos créditos consumidos dentro de um intervalo de datas, agrupado tanto por chave de API individual (`by_key`) quanto por endpoint (`by_endpoint`). Útil para identificar as chaves com maior tráfego e os endpoints que mais consomem créditos em todo o workspace. ## OpenAPI ````yaml pt-openapi POST /api_keys/usage/breakdown openapi: 3.0.0 info: description: >- A API Pubrio entrega inteligência de expansão de mercado — sinais em tempo real que indicam quando uma empresa entra em um novo mercado — além dos dados de empresas e pessoas por trás desses sinais. Pesquise, consulte e enriqueça contas e contatos, e assine sinais de movimentação tipados e datados em mais de 200 mercados. version: 1.0.0 title: Pubrio OpenAPI termsOfService: https://pubrio.com/pt-BR/terms-of-service contact: email: king.lai@pubrio.com name: King Lai url: https://pubrio.com/pt-BR/get-in-touch license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.pubrio.com security: - pubrio_api_key: [] tags: - name: Profile description: Informações do perfil da equipe e estatísticas de uso - name: Enrichment description: Enriqueça registros de pessoas e empresas com dados B2B detalhados - name: Lookalike description: Encontre empresas semelhantes a uma empresa específica - name: Search description: Pesquise pessoas, empresas, vagas, notícias e anúncios com filtros - name: Lookup description: >- Consulte informações detalhadas de pessoas, empresas, vagas, notícias, anúncios e tecnologias específicas - name: LinkedIn description: >- Consulte dados de pessoas e empresas por meio de URLs de perfil do LinkedIn - name: Redeem description: >- Resgate créditos para desbloquear detalhes de contato de pessoas (individual e em lote) - name: Channels description: >- Gerencie templates de canais de outreach (criar, atualizar, excluir, listar) - name: Monitor description: >- Crie e gerencie monitores de dados com webhooks, estatísticas e processamento - name: Filters description: >- Obtenha os valores de filtro disponíveis para os parâmetros de busca (tecnologias, localizações, verticais etc.) - name: API Keys description: >- Liste e inspecione logs de requisições da API e análises de uso das chaves de API - name: Insights description: Insights agregados de sinais para empresas (vagas, notícias, anúncios). - name: Export description: Exportações de dados em massa (consomem créditos). - name: Expansion description: >- Inteligência de expansão de mercado de empresas: sinais, estágios, mercados e exportações. externalDocs: description: >- A API Pubrio é usada para pesquisar, pré-visualizar e enriquecer contatos e contas. O banco de dados Pubrio oferece dados extensos de contatos B2B e inteligência de vendas. url: https://docs.pubrio.com paths: /api_keys/usage/breakdown: post: tags: - API Keys summary: Obter detalhamento de uso da API por chave e endpoint description: >- Recupera um detalhamento das requisições da API e dos créditos consumidos dentro de um intervalo de datas, agrupado tanto por chave de API individual (`by_key`) quanto por endpoint (`by_endpoint`). Útil para identificar as chaves com maior tráfego e os endpoints que mais consomem créditos em todo o workspace. operationId: api_keys_get_usage_breakdown requestBody: required: true content: application/json: schema: type: object required: - start_date - end_date properties: start_date: type: string example: '2026-05-01' description: >- Início do intervalo de datas no formato `YYYY-MM-DD` (interpretado no fuso horário do workspace). end_date: type: string example: '2026-05-14' description: >- Fim do intervalo de datas no formato `YYYY-MM-DD` (interpretado no fuso horário do workspace). keys: type: array items: type: string description: >- Lista opcional de identificadores mascarados de chave de API (ex.: `0••••••••••••••••f39`) para restringir os resultados a chaves específicas. Use os valores mascarados retornados por `/api_keys` ou pelo campo `masked_authentication` de uma entrada de log. log_type_slugs: type: array items: type: string description: >- Lista opcional de slugs de tipo de log (ex.: `people_search`, `company_search`, `people_redeem`) para restringir os resultados a endpoints específicos. responses: '200': description: Resposta bem-sucedida contendo o detalhamento de uso da API. content: application/json: schema: type: object properties: metadata: type: object properties: filters: type: object description: >- Eco dos filtros de requisição usados para gerar esta resposta, com os valores vazios removidos. additionalProperties: true data: type: object properties: by_key: type: array description: >- Uso agrupado por chave de API (top 100, ordenado por créditos e, em seguida, por requisições). items: type: object properties: name: type: string description: Identificador mascarado da chave de API. requests: type: integer description: Número de requisições feitas com esta chave. credits: type: number description: Créditos consumidos por esta chave. last_used: type: string nullable: true description: >- Carimbo de data/hora da requisição mais recente feita com esta chave, ou `null` se nunca usada no intervalo. percent_of_requests: type: number description: >- Participação no total de requisições, em porcentagem. percent_of_credits: type: number description: >- Participação no total de créditos, em porcentagem. by_endpoint: type: array description: >- Uso agrupado por endpoint (top 100, ordenado por créditos e, em seguida, por requisições). items: type: object properties: slug: type: string nullable: true description: >- Slug do tipo de log. `null` para requisições não mapeadas para um tipo de log faturável. name: type: string description: Nome legível do tipo de log. requests: type: integer credits: type: number cost_per_call: type: number description: >- Média de créditos por requisição para este endpoint. percent_of_requests: type: number description: >- Participação no total de requisições, em porcentagem. percent_of_credits: type: number description: >- Participação no total de créditos, em porcentagem. totals: type: object properties: credits: type: number requests: type: integer example: metadata: filters: start_date: '2026-04-01' end_date: '2026-05-14' data: by_key: - name: 2••••••••••••••••a37 requests: 929 credits: 42766 last_used: '2026-05-05 11:09:42.508' percent_of_requests: 17.892 percent_of_credits: 99.425 - name: 0••••••••••••••••f39 requests: 175 credits: 187 last_used: '2026-05-14 12:04:21.651' percent_of_requests: 3.37 percent_of_credits: 0.434 by_endpoint: - slug: people_redeem name: Redeem People requests: 4088 credits: 41215 cost_per_call: 10.08 percent_of_requests: 78.73 percent_of_credits: 95.82 - slug: people_search name: People Search requests: 368 credits: 1101 cost_per_call: 2.99 percent_of_requests: 7.08 percent_of_credits: 2.55 totals: credits: 43013 requests: 5192 '400': $ref: '#/components/responses/general_error' '429': $ref: '#/components/responses/rate_limit_error' '500': $ref: '#/components/responses/server_error' components: responses: general_error: description: >- Requisição inválida. A requisição estava malformada ou continha parâmetros inválidos. Verifique o código de erro e a mensagem para mais detalhes. content: application/json: schema: required: - code - message - details type: object properties: code: example: 40001 type: integer message: example: >- Os erros e códigos variam de acordo com o cenário; consulte a documentação para mais informações. type: string details: type: object rate_limit_error: description: >- Limite de requisições excedido. Foram feitas requisições em excesso em um determinado período de tempo. Tente novamente após a janela do limite de requisições ser reiniciada. content: application/json: schema: required: - error type: object properties: error: example: >- Limite de requisições excedido. Aguarde e tente novamente mais tarde. type: string server_error: description: >- Erro interno do servidor. Ocorreu um erro inesperado no servidor. Entre em contato com o suporte caso o erro persista. content: application/json: schema: required: - error type: object properties: error: example: Ocorreu um erro inesperado no servidor. type: string securitySchemes: pubrio_api_key: type: apiKey name: pubrio-api-key description: >- Um token de API exclusivo que representa as ações que você realiza por meio da API e as permissões e operações correspondentes. Você pode criá-lo na seção [Configurações](https://dashboard.pubrio.com/#/settings/). in: header ````