> ## 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.

# Детализация использования API

> Получить разбивку запросов API и израсходованных кредитов за указанный диапазон дат, сгруппированную как по отдельным ключам API (`by_key`), так и по эндпоинтам (`by_endpoint`). Полезно для выявления ключей с наибольшим трафиком и наиболее ресурсоёмких по кредитам эндпоинтов в рабочей области.



## OpenAPI

````yaml ru-openapi POST /api_keys/usage/breakdown
openapi: 3.0.0
info:
  description: >-
    API Pubrio предоставляет данные об экспансии на рынки — сигналы в реальном
    времени, отмечающие выход компании на новый рынок, — вместе с лежащими в их
    основе данными о компаниях и людях. Выполняйте поиск, просмотр и обогащение
    данных об аккаунтах и контактах, а также подписывайтесь на типизированные
    сигналы движения с указанием даты по более чем 200 рынкам.
  version: 1.0.0
  title: Pubrio OpenAPI
  termsOfService: https://pubrio.com/ru/terms-of-service
  contact:
    email: king.lai@pubrio.com
    name: King Lai
    url: https://pubrio.com/ru/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: Информация о профиле рабочей области и статистика использования
  - name: Enrichment
    description: Обогащение записей о людях и компаниях подробными B2B-данными
  - name: Lookalike
    description: Поиск компаний, похожих на заданную компанию
  - name: Search
    description: >-
      Поиск людей, компаний, вакансий, новостей и рекламы с использованием
      фильтров
  - name: Lookup
    description: >-
      Просмотр подробной информации о конкретных людях, компаниях, вакансиях,
      новостях, рекламе и технологиях
  - name: LinkedIn
    description: Просмотр данных о людях и компаниях по URL профиля LinkedIn
  - name: Redeem
    description: >-
      Погашение кредитов для получения контактных данных людей (по одному и
      пакетно)
  - name: Channels
    description: >-
      Управление шаблонами каналов для рассылок (создание, обновление, удаление,
      список)
  - name: Monitor
    description: >-
      Создание мониторов данных и управление ими с вебхуками, статистикой и
      обработкой
  - name: Filters
    description: >-
      Получение доступных значений фильтров для параметров поиска (технологии,
      местоположения, отрасли и т. д.)
  - name: API Keys
    description: >-
      Просмотр списка и анализ журналов запросов API и статистики использования
      ключей API
  - name: Insights
    description: Агрегированные данные по сигналам компаний (вакансии, новости, реклама).
  - name: Export
    description: Массовый экспорт данных (расходует кредиты).
  - name: Expansion
    description: 'Данные об экспансии компаний на рынки: сигналы, стадии, рынки и экспорт.'
externalDocs:
  description: >-
    API Pubrio используется для поиска, предварительного просмотра и обогащения
    контактов и аккаунтов. База данных Pubrio предоставляет обширные
    B2B-контакты и данные для анализа продаж.
  url: https://docs.pubrio.com
paths:
  /api_keys/usage/breakdown:
    post:
      tags:
        - API Keys
      summary: Получить разбивку использования API по ключам и эндпоинтам
      description: >-
        Получить разбивку запросов API и израсходованных кредитов за указанный
        диапазон дат, сгруппированную как по отдельным ключам API (`by_key`),
        так и по эндпоинтам (`by_endpoint`). Полезно для выявления ключей с
        наибольшим трафиком и наиболее ресурсоёмких по кредитам эндпоинтов в
        рабочей области.
      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: >-
                    Начало диапазона дат в формате `YYYY-MM-DD`
                    (интерпретируется в часовом поясе рабочей области).
                end_date:
                  type: string
                  example: '2026-05-14'
                  description: >-
                    Конец диапазона дат в формате `YYYY-MM-DD` (интерпретируется
                    в часовом поясе рабочей области).
                keys:
                  type: array
                  items:
                    type: string
                  description: >-
                    Необязательный список замаскированных идентификаторов ключей
                    API (например, `0••••••••••••••••f39`), чтобы ограничить
                    результаты конкретными ключами. Используйте замаскированные
                    значения, возвращаемые `/api_keys` или полем
                    `masked_authentication` записи журнала.
                log_type_slugs:
                  type: array
                  items:
                    type: string
                  description: >-
                    Необязательный список слагов типов журналов (например,
                    `people_search`, `company_search`, `people_redeem`), чтобы
                    ограничить результаты конкретными эндпоинтами.
      responses:
        '200':
          description: Успешный ответ с разбивкой использования API.
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    type: object
                    properties:
                      filters:
                        type: object
                        description: >-
                          Отражение фильтров запроса, использованных для
                          формирования этого ответа, с удалёнными пустыми
                          значениями.
                        additionalProperties: true
                  data:
                    type: object
                    properties:
                      by_key:
                        type: array
                        description: >-
                          Использование, сгруппированное по ключу API (топ-100,
                          упорядочено по кредитам, затем по количеству
                          запросов).
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              description: Замаскированный идентификатор ключа API.
                            requests:
                              type: integer
                              description: Количество запросов, выполненных с этим ключом.
                            credits:
                              type: number
                              description: Кредиты, израсходованные этим ключом.
                            last_used:
                              type: string
                              nullable: true
                              description: >-
                                Время последнего запроса с этим ключом, или
                                `null`, если он ни разу не использовался за этот
                                период.
                            percent_of_requests:
                              type: number
                              description: Доля от общего числа запросов, в процентах.
                            percent_of_credits:
                              type: number
                              description: Доля от общего числа кредитов, в процентах.
                      by_endpoint:
                        type: array
                        description: >-
                          Использование, сгруппированное по эндпоинту (топ-100,
                          упорядочено по кредитам, затем по количеству
                          запросов).
                        items:
                          type: object
                          properties:
                            slug:
                              type: string
                              nullable: true
                              description: >-
                                Слаг типа журнала. `null` для запросов, не
                                сопоставленных с тарифицируемым типом журнала.
                            name:
                              type: string
                              description: Понятное человеку название типа журнала.
                            requests:
                              type: integer
                            credits:
                              type: number
                            cost_per_call:
                              type: number
                              description: >-
                                Среднее количество кредитов на запрос для этого
                                эндпоинта.
                            percent_of_requests:
                              type: number
                              description: Доля от общего числа запросов, в процентах.
                            percent_of_credits:
                              type: number
                              description: Доля от общего числа кредитов, в процентах.
                      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: >-
        Некорректный запрос. Запрос был некорректно сформирован или содержал
        недопустимые параметры. Подробности см. в коде и сообщении об ошибке.
      content:
        application/json:
          schema:
            required:
              - code
              - message
              - details
            type: object
            properties:
              code:
                example: 40001
                type: integer
              message:
                example: >-
                  Errors and codes will vary depending on the scenario, please
                  see the documentation for information.
                type: string
              details:
                type: object
    rate_limit_error:
      description: >-
        Превышен лимит запросов. За заданный период времени было сделано слишком
        много запросов. Повторите попытку после сброса окна лимита запросов.
      content:
        application/json:
          schema:
            required:
              - error
            type: object
            properties:
              error:
                example: Request rate limit exceeded. Please wait and try again later.
                type: string
    server_error:
      description: >-
        Внутренняя ошибка сервера. На сервере произошла непредвиденная ошибка.
        Если ошибка повторяется, обратитесь в службу поддержки.
      content:
        application/json:
          schema:
            required:
              - error
            type: object
            properties:
              error:
                example: An unexpected error occurred on the server.
                type: string
  securitySchemes:
    pubrio_api_key:
      type: apiKey
      name: pubrio-api-key
      description: >-
        Уникальный токен API, представляющий действия, которые вы выполняете
        через API, и соответствующие права доступа и операции. Вы можете создать
        его в разделе [Settings](https://dashboard.pubrio.com/#/settings/).
      in: header

````