> ## 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 enriquecimento de eventos > Consulte contadores da Didit de ingestão e enriquecimento de IP por período: taxa de acerto de cache, IPs únicos e consultas novas por mil eventos. Prompt da API de métricas de enriquecimento de eventos Copiar o prompt para a área de transferência 
  \`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.\`
Colar em O Business Console mostra os mesmos números acima da lista de eventos. Veja [Enriquecimento de IP](https://docs.didit.me/pt-br/transaction-monitoring/events.md#enriquecimento-de-ip) no guia de ingestão de eventos para entender por que a telemetria de baixo valor só consulta o enriquecimento quando outro evento já identificou o endereço, e [Enriquecimento de IP](https://docs.didit.me/pt-br/transaction-monitoring/ip-enrichment.md) para conhecer os campos que um endereço enriquecido contém. ## OpenAPI ````yaml pt-br/openapi-25.json GET /v3/events/enrichment-metrics/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/events/enrichment-metrics/: get: tags: - Monitoring Events summary: Obter as métricas de enriquecimento de eventos description: >- Retorna os contadores de ingestão de eventos e de enriquecimento de IP da sua aplicação em um período, somados em todos os canais (servidor, lote e dispositivo), para que você acompanhe o volume de eventos e confirme que o enriquecimento é resolvido uma vez por endereço único, e não uma vez por evento. O período abrange o dia de hoje mais os `days` dias anteriores, contados por data de calendário em UTC. As três proporções são nulas quando o denominador é zero. Uma chave de API com escopo precisa de `transactions: read`. Consulte [Enriquecimento de IP](https://docs.didit.me/pt-br/transaction-monitoring/events#enriquecimento-de-ip). operationId: get_monitoring_event_enrichment_metrics parameters: - name: days in: query required: false description: >- Duração do período em dias. O padrão é 30; os valores são limitados ao intervalo de 1 a 365, e um valor não inteiro volta para 30. O valor aplicado é retornado como `period_days`. schema: type: integer default: 30 minimum: 1 maximum: 365 example: 30 responses: '200': description: Contadores e proporções do 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: >- Novos eventos armazenados. Repetições idempotentes não são contabilizadas. events_rejected: type: integer description: >- Itens rejeitados dentro de requisições em lote (canais de servidor e de dispositivo). Uma requisição de evento único rejeitada não é contabilizada. enrichment_lookups: type: integer description: >- Eventos cujo endereço IP público foi resolvido, a partir do cache ou de uma nova consulta. enrichment_cache_hits: type: integer description: Consultas respondidas a partir do cache. enrichment_provider_calls: type: integer description: Consultas que exigiram uma nova resolução do endereço. enrichment_skipped_low_value: type: integer description: >- Eventos de telemetria de baixo valor cujo endereço ainda não era conhecido. Eles nunca acionam uma nova resolução por conta própria. unique_ips_seen: type: integer description: Endereços que precisaram de uma nova resolução. period_days: type: integer description: >- O valor de `days` aplicado após o ajuste aos limites permitidos. cache_hit_rate: type: number nullable: true description: >- `enrichment_cache_hits / enrichment_lookups`, arredondado para 4 casas decimais. Nulo quando não houve consultas. unique_ip_ratio: type: number nullable: true description: >- `unique_ips_seen / events_ingested`, arredondado para 4 casas decimais. Nulo quando nenhum evento foi ingerido. provider_calls_per_1k_events: type: number nullable: true description: >- Novas resoluções a cada 1000 eventos ingeridos, arredondadas para 2 casas decimais. Null quando nenhum evento foi ingerido. 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: >- A chave de API com escopo expirou. Somente uma chave expirada recebe `401`; uma chave ausente ou inválida recebe `403`. content: application/json: examples: Expired key: value: detail: This API key has expired. '403': description: >- Ausência de `x-api-key` (uma chave incorreta, revogada ou expirada recebe `401`), uma chave com escopo sem `transactions: read`, uma chave limitada a alguns fluxos ou a sessões aprovadas (essa chave nunca acessa dados de monitoramento de transações) ou uma requisição feita de fora da lista de IPs permitidos da chave. 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 de requisições excedido: requisições `GET` compartilham uma cota de 600 requisições por minuto por chave de API. Aguarde `Retry-After` segundos e tente novamente. headers: Retry-After: description: Segundos de espera antes de tentar novamente. 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: |- 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: >- Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.