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

# Répartition de l'utilisation de l'API

> Récupérez une répartition des requêtes API et des crédits consommés sur une plage de dates, regroupée à la fois par clé API individuelle (`by_key`) et par point de terminaison (`by_endpoint`). Utile pour identifier les clés à plus fort trafic et les points de terminaison les plus consommateurs de crédits au sein de l'espace de travail.



## OpenAPI

````yaml fr-openapi POST /api_keys/usage/breakdown
openapi: 3.0.0
info:
  description: >-
    L'API Pubrio fournit une intelligence d'expansion de marché — des signaux en
    temps réel qui indiquent quand une entreprise entre sur un nouveau marché —
    ainsi que les données d'entreprises et de personnes qui les sous-tendent.
    Recherchez, consultez et enrichissez des comptes et des contacts, et
    abonnez-vous à des signaux de mouvement typés et datés sur plus de 200
    marchés.
  version: 1.0.0
  title: Pubrio OpenAPI
  termsOfService: https://pubrio.com/fr/terms-of-service
  contact:
    email: king.lai@pubrio.com
    name: King Lai
    url: https://pubrio.com/fr/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: >-
      Informations de profil de l'espace de travail et statistiques
      d'utilisation
  - name: Enrichment
    description: >-
      Enrichissez les fiches de personnes et d'entreprises avec des données B2B
      détaillées
  - name: Lookalike
    description: Trouvez des entreprises similaires à une entreprise donnée
  - name: Search
    description: >-
      Recherchez des personnes, des entreprises, des offres d'emploi, des
      actualités et des publicités à l'aide de filtres
  - name: Lookup
    description: >-
      Consultez des informations détaillées sur des personnes, entreprises,
      offres d'emploi, actualités, publicités et technologies spécifiques
  - name: LinkedIn
    description: >-
      Consultez les données de personnes et d'entreprises via des URL de profil
      LinkedIn
  - name: Redeem
    description: >-
      Utilisez des crédits pour débloquer les coordonnées de personnes (unitaire
      et par lot)
  - name: Channels
    description: >-
      Gérez les modèles de canaux de prospection (création, mise à jour,
      suppression, liste)
  - name: Monitor
    description: >-
      Créez et gérez des moniteurs de données avec webhooks, statistiques et
      traitement
  - name: Filters
    description: >-
      Récupérez les valeurs de filtre disponibles pour les paramètres de
      recherche (technologies, localisations, secteurs verticaux, etc.)
  - name: API Keys
    description: >-
      Listez et inspectez les journaux de requêtes API et les statistiques
      d'utilisation des clés API
  - name: Insights
    description: >-
      Informations agrégées sur les signaux des entreprises (offres d'emploi,
      actualités, publicités).
  - name: Export
    description: Exports de données en masse (soumis à des crédits).
  - name: Expansion
    description: >-
      Intelligence d'expansion de marché des entreprises : signaux, étapes,
      marchés et exports.
externalDocs:
  description: >-
    L'API Pubrio permet de rechercher, prévisualiser et enrichir des contacts et
    des comptes. La base de données Pubrio fournit des données étendues de
    contacts B2B et de veille commerciale.
  url: https://docs.pubrio.com
paths:
  /api_keys/usage/breakdown:
    post:
      tags:
        - API Keys
      summary: >-
        Obtenir la répartition de l'utilisation de l'API par clé et par point de
        terminaison
      description: >-
        Récupérez une répartition des requêtes API et des crédits consommés sur
        une plage de dates, regroupée à la fois par clé API individuelle
        (`by_key`) et par point de terminaison (`by_endpoint`). Utile pour
        identifier les clés à plus fort trafic et les points de terminaison les
        plus consommateurs de crédits au sein de l'espace de travail.
      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: >-
                    Début de la plage de dates au format `YYYY-MM-DD`
                    (interprété dans le fuseau horaire de l'espace de travail).
                end_date:
                  type: string
                  example: '2026-05-14'
                  description: >-
                    Fin de la plage de dates au format `YYYY-MM-DD` (interprétée
                    dans le fuseau horaire de l'espace de travail).
                keys:
                  type: array
                  items:
                    type: string
                  description: >-
                    Liste facultative d'identifiants de clé API masqués (par
                    exemple `0••••••••••••••••f39`) pour restreindre les
                    résultats à des clés spécifiques. Utilisez les valeurs
                    masquées renvoyées par `/api_keys` ou par le champ
                    `masked_authentication` d'une entrée de journal.
                log_type_slugs:
                  type: array
                  items:
                    type: string
                  description: >-
                    Liste facultative de slugs de type de journal (par exemple
                    `people_search`, `company_search`, `people_redeem`) pour
                    restreindre les résultats à des points de terminaison
                    spécifiques.
      responses:
        '200':
          description: Réponse réussie contenant la répartition de l'utilisation de l'API.
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    type: object
                    properties:
                      filters:
                        type: object
                        description: >-
                          Reprise des filtres de requête utilisés pour produire
                          cette réponse, les valeurs vides étant supprimées.
                        additionalProperties: true
                  data:
                    type: object
                    properties:
                      by_key:
                        type: array
                        description: >-
                          Utilisation regroupée par clé API (top 100, triée par
                          crédits puis par requêtes).
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              description: Identifiant de clé API masqué.
                            requests:
                              type: integer
                              description: Nombre de requêtes effectuées avec cette clé.
                            credits:
                              type: number
                              description: Crédits consommés par cette clé.
                            last_used:
                              type: string
                              nullable: true
                              description: >-
                                Horodatage de la requête la plus récente
                                effectuée avec cette clé, ou `null` si elle n'a
                                jamais été utilisée sur la période.
                            percent_of_requests:
                              type: number
                              description: Part du total des requêtes, en pourcentage.
                            percent_of_credits:
                              type: number
                              description: Part du total des crédits, en pourcentage.
                      by_endpoint:
                        type: array
                        description: >-
                          Utilisation regroupée par point de terminaison (top
                          100, triée par crédits puis par requêtes).
                        items:
                          type: object
                          properties:
                            slug:
                              type: string
                              nullable: true
                              description: >-
                                Slug du type de journal. `null` pour les
                                requêtes non associées à un type de journal
                                facturable.
                            name:
                              type: string
                              description: Nom lisible du type de journal.
                            requests:
                              type: integer
                            credits:
                              type: number
                            cost_per_call:
                              type: number
                              description: >-
                                Moyenne de crédits par requête pour ce point de
                                terminaison.
                            percent_of_requests:
                              type: number
                              description: Part du total des requêtes, en pourcentage.
                            percent_of_credits:
                              type: number
                              description: Part du total des crédits, en pourcentage.
                      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: >-
        Requête invalide. La requête était mal formée ou contenait des
        paramètres invalides. Consultez le code d'erreur et le message pour plus
        de détails.
      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: >-
        Limite de débit dépassée. Trop de requêtes ont été effectuées au cours
        d'une période donnée. Réessayez après la réinitialisation de la fenêtre
        de limitation de débit.
      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: >-
        Erreur interne du serveur. Une erreur inattendue s'est produite sur le
        serveur. Contactez le support si l'erreur persiste.
      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: >-
        Un jeton API unique qui représente les actions que vous effectuez via
        l'API ainsi que les autorisations et opérations correspondantes. Vous
        pouvez le créer dans la section
        [Settings](https://dashboard.pubrio.com/#/settings/).
      in: header

````