> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# API de mètriques d'enriquiment d'esdeveniments

> Consulta a Didit la taxa d'encert de la caché, la proporció d'IP úniques i les consultes noves per cada mil esdeveniments d'un període.

Prompt de l'API per obtenir les mètriques d'enriquiment d'esdeveniments
Copia el prompt al porta-retalls

<pre>
  \`Read the event ingestion and IP-enrichment counters of my Didit application for a period.

  Endpoint:
  GET [https://verification.didit.me/v3/events/enrichment-metrics/?days=30](https://verification.didit.me/v3/events/enrichment-metrics/?days=30)

  Authentication:
  Use the x-api-key header with my Didit API key. A scoped key needs transactions: read.

  Goal:

  * Monitor event volume and confirm that IP enrichment is resolved once per unique address rather than once per event, for a usage dashboard or an alert.

  Behavior:

  * days defaults to 30 and is clamped to 1-365; a non-integer value falls back to 30.
  * The period covers today plus the previous days days, by UTC calendar day.
  * Counters are summed over every lane (server, batch and device).
  * The three ratios are null when their denominator is zero.

  Example call:
  curl -X GET "[https://verification.didit.me/v3/events/enrichment-metrics/?days=30](https://verification.didit.me/v3/events/enrichment-metrics/?days=30)" \
  -H "x-api-key: YOUR\_API\_KEY"

  What to read from the response:

  * events\_ingested - new events stored (replays are not counted).
  * events\_rejected - items rejected inside batch requests (a rejected single-event request is not counted).
  * enrichment\_lookups - events whose public IP address was resolved; enrichment\_cache\_hits - answered from the cache; enrichment\_provider\_calls - needed a fresh resolution.
  * enrichment\_skipped\_low\_value - low-value telemetry whose address was not cached; it never triggers a lookup of its own.
  * unique\_ips\_seen - distinct addresses that needed a fresh resolution.
  * cache\_hit\_rate, unique\_ip\_ratio, provider\_calls\_per\_1k\_events - the ratios.
  * period\_days - the period actually applied.

  Failure modes:

  * 401 - the API key has expired.
  * 403 - missing API key (a wrong, revoked or expired key gets 401), or a scoped key without transactions: read.

  Side effects: none. This is a pure read.

  For the full integration shape, see /integration/integration-prompt.\`
</pre>

Enganxa a

La Business Console mostra les mateixes xifres per sobre de la llista d'esdeveniments. Consulta [enriquiment d'IP](https://docs.didit.me/ca/transaction-monitoring/events.md#enriquiment-d’ip) a la guia d'ingestió d'esdeveniments per saber per què la telemetria de baix valor només llegeix l'enriquiment quan un altre esdeveniment ja ha resolt l'adreça, i [enriquiment d'IP](https://docs.didit.me/ca/transaction-monitoring/ip-enrichment.md) per als camps que conté una adreça enriquida.


## OpenAPI

````yaml ca/openapi-25.json GET /v3/events/enrichment-metrics/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/events/enrichment-metrics/:
    get:
      tags:
        - Monitoring Events
      summary: Obtenir les mètriques d'enriquiment d'esdeveniments
      description: >-
        Retorna els comptadors d'ingesta d'esdeveniments i d'enriquiment d'IP de
        la teva aplicació per a un període, sumats a través de totes les vies
        (servidor, lot i dispositiu), perquè puguis supervisar el volum
        d'esdeveniments i confirmar que l'enriquiment es resol un cop per adreça
        única en comptes d'un cop per esdeveniment. El període cobreix el dia
        d'avui més els `days` dies anteriors, comptats per data de calendari
        UTC. Les tres ràtios són nul·les quan el seu denominador és zero. Una
        clau d'API amb àmbit necessita `transactions: read`. Consulta
        [Enriquiment
        d'IP](https://docs.didit.me/ca/transaction-monitoring/events#enriquiment-d’ip).
      operationId: get_monitoring_event_enrichment_metrics
      parameters:
        - name: days
          in: query
          required: false
          description: >-
            Durada del període en dies. El valor per defecte és 30; els valors
            s'ajusten entre 1 i 365, i un valor no enter torna a 30. El valor
            aplicat es retorna com a `period_days`.
          schema:
            type: integer
            default: 30
            minimum: 1
            maximum: 365
          example: 30
      responses:
        '200':
          description: Comptadors i ràtios per al període.
          content:
            application/json:
              schema:
                type: object
                required:
                  - events_ingested
                  - events_rejected
                  - enrichment_lookups
                  - enrichment_cache_hits
                  - enrichment_provider_calls
                  - enrichment_skipped_low_value
                  - unique_ips_seen
                  - period_days
                  - cache_hit_rate
                  - unique_ip_ratio
                  - provider_calls_per_1k_events
                properties:
                  events_ingested:
                    type: integer
                    description: >-
                      Nous esdeveniments emmagatzemats. Les repeticions
                      idempotents no es comptabilitzen.
                  events_rejected:
                    type: integer
                    description: >-
                      Elements rebutjats dins de sol·licituds per lots (carrils
                      de servidor i de dispositiu). No es compta una sol·licitud
                      d'un sol esdeveniment rebutjada.
                  enrichment_lookups:
                    type: integer
                    description: >-
                      Esdeveniments l'adreça IP pública dels quals s'ha resolt,
                      des de la memòria cau o directament.
                  enrichment_cache_hits:
                    type: integer
                    description: Consultes resoltes des de la memòria cau.
                  enrichment_provider_calls:
                    type: integer
                    description: Consultes que han requerit una nova resolució de l'adreça.
                  enrichment_skipped_low_value:
                    type: integer
                    description: >-
                      Esdeveniments de telemetria de baix valor l'adreça dels
                      quals no es coneixia prèviament. Mai desencadenen una nova
                      resolució per si mateixos.
                  unique_ips_seen:
                    type: integer
                    description: Adreces que requerien una nova resolució.
                  period_days:
                    type: integer
                    description: El valor `days` aplicat després de l'ajust als límits.
                  cache_hit_rate:
                    type: number
                    nullable: true
                    description: >-
                      `enrichment_cache_hits / enrichment_lookups`, arrodonit a
                      4 decimals. Null quan no hi ha hagut consultes.
                  unique_ip_ratio:
                    type: number
                    nullable: true
                    description: >-
                      `unique_ips_seen / events_ingested`, arrodonit a 4
                      decimals. Nul quan no s'ha ingerit cap esdeveniment.
                  provider_calls_per_1k_events:
                    type: number
                    nullable: true
                    description: >-
                      Resolucions recents per cada 1000 esdeveniments ingerits,
                      arrodonit a 2 decimals. Null si no s'ha ingerit cap
                      esdeveniment.
              examples:
                Last 30 days:
                  value:
                    events_ingested: 128450
                    events_rejected: 214
                    enrichment_lookups: 41230
                    enrichment_cache_hits: 40118
                    enrichment_provider_calls: 1112
                    enrichment_skipped_low_value: 74320
                    unique_ips_seen: 1112
                    period_days: 30
                    cache_hit_rate: 0.973
                    unique_ip_ratio: 0.0087
                    provider_calls_per_1k_events: 8.66
                No events yet:
                  value:
                    events_ingested: 0
                    events_rejected: 0
                    enrichment_lookups: 0
                    enrichment_cache_hits: 0
                    enrichment_provider_calls: 0
                    enrichment_skipped_low_value: 0
                    unique_ips_seen: 0
                    period_days: 30
                    cache_hit_rate: null
                    unique_ip_ratio: null
                    provider_calls_per_1k_events: null
        '401':
          description: >-
            La clau d'API amb abast ha caducat. Només una clau caducada rep
            `401`; una clau absent o no vàlida rep `403`.
          content:
            application/json:
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Falta la capçalera `x-api-key` (una clau incorrecta, revocada o
            caducada rep un `401`), una clau amb àmbit sense `transactions:
            read`, una clau limitada a determinats fluxos de treball o a
            sessions aprovades (aquesta clau mai no accedeix a dades de
            monitoratge de transaccions), o una sol·licitud des de fora de la
            llista d'adreces IP permeses de la clau.
          content:
            application/json:
              examples:
                Missing or invalid API key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without access:
                  value:
                    detail: This API key has no read access to transactions.
                Key limited to workflows or approved sessions:
                  value:
                    detail: >-
                      This API key only reaches sessions inside its workflow or
                      status limits, so it can't use this endpoint.
                IP not allowed:
                  value:
                    detail: This API key can't be used from this IP address.
        '429':
          description: >-
            S'ha superat el límit de freqüència: les sol·licituds `GET`
            comparteixen un pressupost de 600 sol·licituds per minut per clau
            d'API. Espera els segons indicats a `Retry-After` i reintenta-ho.
          headers:
            Retry-After:
              description: Segons que cal esperar abans de reintentar.
              schema:
                type: integer
                minimum: 1
                example: 30
          content:
            application/json:
              examples:
                Throttled:
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/events/enrichment-metrics/?days=30'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.monitoring_events.retrieve_enrichment_metrics()
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.monitoringEvents.retrieveEnrichmentMetrics();

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.RetrieveEnrichmentMetrics(ctx, didit.MonitoringEventsRetrieveEnrichmentMetricsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.monitoringEvents().retrieveEnrichmentMetrics();
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->monitoringEvents->retrieveEnrichmentMetrics();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.monitoring_events.retrieve_enrichment_metrics
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.MonitoringEvents.RetrieveEnrichmentMetricsAsync();

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.