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

# Metriche di arricchimento eventi API

> Con Didit leggi i contatori di ingestione e arricchimento IP: tasso di cache hit, rapporto IP unici e ricerche nuove ogni mille eventi.

Prompt API per ottenere le metriche di arricchimento degli eventi
Copia il prompt negli appunti

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

Incolla in

La Business Console mostra gli stessi numeri sopra l'elenco degli eventi. Consulta [arricchimento IP](https://docs.didit.me/it/transaction-monitoring/events.md#arricchimento-ip) nella guida all'ingestione degli eventi per capire perché la telemetria a basso valore viene arricchita solo quando un altro evento ha già risolto l'indirizzo, e [arricchimento IP](https://docs.didit.me/it/transaction-monitoring/ip-enrichment.md) per i campi di un indirizzo arricchito.


## OpenAPI

````yaml it/openapi-25.json GET /v3/events/enrichment-metrics/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API di verifica dell'identità. Autenticati con l'intestazione x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/events/enrichment-metrics/:
    get:
      tags:
        - Monitoring Events
      summary: Recupera metriche di arricchimento eventi
      description: >-
        Restituisce i contatori di acquisizione degli eventi e di arricchimento
        IP della tua applicazione per un determinato periodo, sommati su ogni
        canale (server, batch e dispositivo), consentendoti di monitorare il
        volume degli eventi e confermare che l'arricchimento venga eseguito una
        sola volta per indirizzo univoco anziché per ogni evento. Il periodo
        include la data odierna più i `days` giorni precedenti, calcolati in
        base alla data di calendario UTC. I tre rapporti sono null quando il
        relativo denominatore è zero. Una chiave API con ambito limitato
        richiede `transactions: read`. Consulta [arricchimento
        IP](https://docs.didit.me/it/transaction-monitoring/events#arricchimento-ip).
      operationId: get_monitoring_event_enrichment_metrics
      parameters:
        - name: days
          in: query
          required: false
          description: >-
            Durata del periodo in giorni. Il valore predefinito è 30; i valori
            sono limitati all'intervallo compreso tra 1 e 365, e un valore non
            intero torna a 30. Il valore applicato viene restituito come
            `period_days`.
          schema:
            type: integer
            default: 30
            minimum: 1
            maximum: 365
          example: 30
      responses:
        '200':
          description: Contatori e rapporti per il periodo.
          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: >-
                      Nuovi eventi memorizzati. I replay idempotenti non vengono
                      conteggiati.
                  events_rejected:
                    type: integer
                    description: >-
                      Elementi rifiutati all'interno di richieste in batch (lato
                      server e lato dispositivo). Una richiesta per evento
                      singolo rifiutata non viene conteggiata.
                  enrichment_lookups:
                    type: integer
                    description: >-
                      Eventi il cui indirizzo IP pubblico è stato risolto, dalla
                      cache o ex novo.
                  enrichment_cache_hits:
                    type: integer
                    description: Ricerche risposte dalla cache.
                  enrichment_provider_calls:
                    type: integer
                    description: >-
                      Ricerche che hanno richiesto una nuova risoluzione
                      dell'indirizzo.
                  enrichment_skipped_low_value:
                    type: integer
                    description: >-
                      Eventi di telemetria di basso valore il cui indirizzo non
                      era già noto. Non attivano mai una nuova risoluzione
                      autonoma.
                  unique_ips_seen:
                    type: integer
                    description: Indirizzi che richiedevano una nuova risoluzione.
                  period_days:
                    type: integer
                    description: Il valore `days` applicato dopo l'applicazione dei limiti.
                  cache_hit_rate:
                    type: number
                    nullable: true
                    description: >-
                      `enrichment_cache_hits / enrichment_lookups`, arrotondato
                      a 4 decimali. Null quando non ci sono state ricerche.
                  unique_ip_ratio:
                    type: number
                    nullable: true
                    description: >-
                      `unique_ips_seen / events_ingested`, arrotondato a 4
                      decimali. Null quando non è stato acquisito alcun evento.
                  provider_calls_per_1k_events:
                    type: number
                    nullable: true
                    description: >-
                      Risoluzioni recenti per 1000 eventi acquisiti, arrotondate
                      a 2 decimali. Null se non è stato acquisito alcun evento.
              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 chiave API con ambito è scaduta. Solo una chiave scaduta riceve
            `401`; una chiave mancante o non valida riceve `403`.
          content:
            application/json:
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Intestazione `x-api-key` mancante (una chiave errata, revocata o
            scaduta restituisce `401`), una chiave con ambito priva di
            `transactions: read`, una chiave limitata ad alcuni workflow o a
            sessioni approvate (tale chiave non accede mai ai dati di
            monitoraggio delle transazioni), oppure una richiesta proveniente
            dall'esterno dell'allowlist IP della chiave.
          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: >-
            Limite di frequenza superato: le richieste `GET` condividono un
            budget di 600 richieste al minuto per chiave API. Attendi
            `Retry-After` secondi, quindi riprova.
          headers:
            Retry-After:
              description: Secondi da attendere prima di effettuare un nuovo tentativo.
              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 chiave API della tua applicazione, da Developers -> API keys nella
        Business Console. La chiave primaria ha accesso completo. Una chiave con
        nome può avere un ambito definito: nessuno, lettura o scrittura per
        risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco
        di indirizzi IP e a una data di scadenza. 401 indica che la chiave è
        errata, revocata o scaduta; 403 indica che non è stata inviata alcuna
        chiave, che la chiave non ha accesso a questa risorsa o azione, oppure
        che la richiesta proviene da un indirizzo non incluso nel suo elenco IP;
        404 su una route di sessione indica che la sessione non rientra nei
        workflow o negli stati previsti dalla chiave. Una chiave senza accesso
        ai media riceve gli URL di immagini, video e PDF come null, e una chiave
        senza permessi di scrittura sulle sessioni riceve link e token di
        sessione come null. Consulta https://docs.didit.me/console/api-keys.

````

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