> ## 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étricas de enriquecimiento de eventos

> Lee en Didit la ingesta de eventos y el enriquecimiento de IP por periodo: aciertos de caché, ratio de IP únicas y consultas nuevas por mil eventos.

Prompt para la API de obtención de métricas de enriquecimiento de eventos
Copiar el prompt al portapapeles

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

Pegar en

La Business Console muestra las mismas cifras encima de la lista de eventos. Consulta [Enriquecimiento de IP](https://docs.didit.me/es/transaction-monitoring/events.md#enriquecimiento-de-ip) en la guía de ingesta de eventos para saber por qué la telemetría de bajo valor solo consulta el enriquecimiento cuando otro evento ya ha resuelto la dirección, y [Enriquecimiento de IP](https://docs.didit.me/es/transaction-monitoring/ip-enrichment.md) para ver los campos que incluye una dirección enriquecida.


## OpenAPI

````yaml es/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ón de identidad. Autentícate con el encabezado x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/events/enrichment-metrics/:
    get:
      tags:
        - Monitoring Events
      summary: Obtener las métricas de enriquecimiento de eventos
      description: >-
        Devuelve los contadores de ingesta de eventos y de enriquecimiento de IP
        de tu aplicación para un periodo, sumados en todos los canales
        (servidor, lote y dispositivo), para que puedas vigilar el volumen de
        eventos y confirmar que el enriquecimiento se resuelve una vez por
        dirección única y no una vez por evento. El periodo abarca el día de hoy
        más los `days` días anteriores, contados por fecha natural en UTC. Las
        tres ratios son null cuando su denominador es cero. Una clave de API con
        alcance limitado necesita `transactions: read`. Consulta
        [Enriquecimiento de
        IP](https://docs.didit.me/es/transaction-monitoring/events#enriquecimiento-de-ip).
      operationId: get_monitoring_event_enrichment_metrics
      parameters:
        - name: days
          in: query
          required: false
          description: >-
            Duración del periodo en días. El valor predeterminado es 30; los
            valores se limitan al rango de 1 a 365 y un valor no entero se
            sustituye por 30. El valor aplicado se devuelve como `period_days`.
          schema:
            type: integer
            default: 30
            minimum: 1
            maximum: 365
          example: 30
      responses:
        '200':
          description: Contadores y ratios del período.
          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: >-
                      Nuevos eventos almacenados. Las repeticiones idempotentes
                      no se cuentan.
                  events_rejected:
                    type: integer
                    description: >-
                      Elementos rechazados dentro de solicitudes por lotes
                      (canales de servidor y de dispositivo). Una solicitud de
                      un solo evento rechazada no se cuenta.
                  enrichment_lookups:
                    type: integer
                    description: >-
                      Eventos cuya dirección IP pública se resolvió, desde la
                      caché o con una consulta nueva.
                  enrichment_cache_hits:
                    type: integer
                    description: Consultas respondidas desde la caché.
                  enrichment_provider_calls:
                    type: integer
                    description: >-
                      Consultas que requirieron una nueva resolución de la
                      dirección.
                  enrichment_skipped_low_value:
                    type: integer
                    description: >-
                      Eventos de telemetría de poco valor cuya dirección aún no
                      se conocía. Nunca provocan por sí mismos una nueva
                      resolución.
                  unique_ips_seen:
                    type: integer
                    description: Direcciones que necesitaron una nueva resolución.
                  period_days:
                    type: integer
                    description: >-
                      El valor de `days` aplicado después de limitarlo al rango
                      permitido.
                  cache_hit_rate:
                    type: number
                    nullable: true
                    description: >-
                      `enrichment_cache_hits / enrichment_lookups`, redondeado a
                      4 decimales. Null cuando no hubo consultas.
                  unique_ip_ratio:
                    type: number
                    nullable: true
                    description: >-
                      `unique_ips_seen / events_ingested`, redondeado a 4
                      decimales. Null cuando no se ingirió ningún evento.
                  provider_calls_per_1k_events:
                    type: number
                    nullable: true
                    description: >-
                      Resoluciones nuevas por cada 1000 eventos ingeridos,
                      redondeadas a 2 decimales. Null cuando no se ingirió
                      ningún 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 clave de API con alcance limitado ha expirado. Solo una clave
            expirada recibe `401`; una clave ausente o no válida recibe `403`.
          content:
            application/json:
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Falta `x-api-key` (una clave incorrecta, revocada o expirada recibe
            `401`), una clave con permisos limitados sin `transactions: read`,
            una clave limitada a algunos flujos o a sesiones aprobadas (una
            clave así nunca accede a los datos de monitorización de
            transacciones), o una solicitud desde fuera de la lista de IP
            permitidas de la clave.
          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: >-
            Límite de solicitudes superado: las solicitudes `GET` comparten un
            cupo de 600 solicitudes por minuto por clave de API. Espera
            `Retry-After` segundos y vuelve a intentarlo.
          headers:
            Retry-After:
              description: Segundos que hay que esperar antes 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 clave de API de tu aplicación, que encontrarás en Developers -> API
        keys en la Business Console. La clave principal tiene acceso completo.
        Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
        escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
        a una lista de direcciones IP y a una fecha de caducidad. 401 significa
        que la clave es incorrecta, se revocó o expiró; 403 significa que no se
        envió ninguna clave, que la clave no tiene acceso a este recurso o
        acción, o que la solicitud provino de una dirección fuera de su lista de
        IP; 404 en una ruta de sesión significa que la sesión está fuera de los
        flujos o estados de la clave. Una clave sin acceso a contenido
        multimedia recibe las URL de imágenes, videos y PDF como null, y una
        clave sin permiso de escritura en sesiones recibe los enlaces y tokens
        de sesión como null. Consulta https://docs.didit.me/console/api-keys.

````

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