> ## 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 análise de destinos de webhook > Totais de entregas, taxa de falhas e tempos de resposta de um destino de webhook da Didit, globais e por dia UTC, para qualquer intervalo de datas. Obter o prompt da API de análise do destino do webhook Copiar o prompt para a área de transferência \

\`Read delivery statistics for one Didit webhook destination through the Management API.

Endpoint:
GET https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/analytics/

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

Goal:
\- Measure how reliably and how fast my endpoint accepts webhooks, to alert on failures or chart delivery health.

Path parameter:
\- destination_uuid: the destination uuid from GET /v3/webhook/destinations/.

Query parameters (optional):
\- date_from, date_to: UTC days as YYYY-MM-DD, both inclusive. Without them, every delivery of the destination is included. Delivery records are available for about 30 days, so no range reaches further back.

Behavior:
\- summary: total_deliveries, failed_deliveries, error_rate_percentage (whole number, 0 when there are no deliveries), min_response_time_ms, avg_response_time_ms, max_response_time_ms (null when there is no data). A delivery not attempted yet counts in total_deliveries, never in failed_deliveries, and has no response time.
\- points: one entry per UTC day that had deliveries, oldest first, with the same counters plus date. Days without deliveries are omitted, so fill the gaps with zeros when you chart them.
\- Every attempt counts: the first send of an event, each automatic retry and each resend.
\- Failed means HTTP 400 or above. A timeout is recorded as 504 and a connection failure as 503, so both count as failed.

Example call:
curl -X GET "https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/analytics/?date_from=2026-05-01&date_to=2026-05-31" \
-H "x-api-key: YOUR_API_KEY"

Failure modes:
\- 400: { "date_from": ["Date has wrong format. Use one of these formats instead: YYYY-MM-DD."] } or { "date_to": ["date_to must be greater than or equal to date_from."] }
\- 401: { "detail": "This API key has expired." }
\- 403: { "detail": "You do not have permission to perform this action." } or { "detail": "This API key has no read access to webhooks." }
\- 404: { "detail": "Webhook destination not found." }
\- 429: more than 600 GET requests per minute with this key; wait for Retry-After.

Side effects: none. This is a pure read.

For the full integration shape, see /integration/integration-prompt.`

\
Colar em Utilize este endpoint para acompanhar um destino do webhook durante um período que escolher. Para ver as tentativas individuais associadas a uma falha, liste-as com [Listar entregas do destino do webhook](https://docs.didit.me/pt/management-api/webhook/list-deliveries.md) e abra uma com [Obter entrega do destino do webhook](https://docs.didit.me/pt/management-api/webhook/get-delivery.md).As respostas que a Didit volta a tentar automaticamente são descritas na [política de novas tentativas](https://docs.didit.me/pt/integration/webhooks.md#política-de-novas-tentativas). ## OpenAPI ````yaml pt/openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/analytics/ 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/webhook/destinations/{destination_uuid}/analytics/: get: tags: - Webhook summary: Obter análise do destino do webhook description: >- Totais de entrega, taxa de falha e tempos de resposta para um destino do webhook, ao longo de todo o intervalo (`summary`) e por dia UTC (`points`). Cada tentativa conta como uma entrega: o primeiro envio de um evento, cada [nova tentativa](https://docs.didit.me/pt/integration/webhooks#política-de-novas-tentativas) automática e cada reenvio. Uma entrega é considerada falhada quando o respetivo estado HTTP registado é 400 ou superior, pelo que tempos limite excedidos (registados como `504`) e falhas de ligação (`503`) contam como falhadas; uma entrega ainda na fila conta apenas em `total_deliveries`. Os registos de entrega estão disponíveis durante cerca de 30 dias. Uma chave de API com âmbito restrito necessita de `webhooks: read`. operationId: get_webhook_destination_analytics parameters: - name: destination_uuid in: path required: true description: >- UUID do destino (o `uuid` retornado por `GET /v3/webhook/destinations/`). schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 - name: date_from in: query required: false description: >- Primeiro dia em UTC a incluir, no formato `YYYY-MM-DD` (inclusive). Omitir para começar a partir da entrega mais antiga disponível. `dateFrom` é aceite como alias. schema: type: string format: date example: '2026-10-01' - name: date_to in: query required: false description: >- Último dia UTC a incluir, no formato `YYYY-MM-DD` (inclusive). Não pode ser anterior a `date_from`. `dateTo` é aceite como alias. schema: type: string format: date example: '2026-10-16' responses: '200': description: Estatísticas de entrega para o destino. content: application/json: schema: type: object required: - summary - points properties: summary: type: object description: Totais ao longo do intervalo solicitado. required: - total_deliveries - failed_deliveries - min_response_time_ms - avg_response_time_ms - max_response_time_ms - error_rate_percentage properties: total_deliveries: type: integer minimum: 0 description: Tentativas de entrega, incluindo as que estão na fila. failed_deliveries: type: integer minimum: 0 description: >- Tentativas cujo estado HTTP registado é igual ou superior a 400. min_response_time_ms: type: integer nullable: true description: >- Tentativa mais rápida em milissegundos, ou `null` quando nenhuma tentativa tem um tempo registado. avg_response_time_ms: type: integer nullable: true description: >- Tempo médio de tentativa em milissegundos, arredondado, ou `null` quando nenhuma tentativa tem um tempo registado. max_response_time_ms: type: integer nullable: true description: >- Tentativa mais demorada em milissegundos, ou `null` quando nenhuma tentativa tiver um tempo registado. error_rate_percentage: type: integer minimum: 0 maximum: 100 description: >- `failed_deliveries` / `total_deliveries` x 100, arredondado a um número inteiro. `0` quando não existem entregas. points: type: array description: >- Uma entrada por dia UTC que teve entregas, da mais antiga para a mais recente. Os dias sem entregas são omitidos, pelo que deve preencher as lacunas com zeros ao criar gráficos. items: type: object required: - date - total_deliveries - failed_deliveries - min_response_time_ms - avg_response_time_ms - max_response_time_ms properties: date: type: string format: date description: Dia UTC, `YYYY-MM-DD`. total_deliveries: type: integer minimum: 0 description: >- Tentativas de entrega, incluindo as que estão na fila. failed_deliveries: type: integer minimum: 0 description: >- Tentativas cujo estado HTTP registado é igual ou superior a 400. min_response_time_ms: type: integer nullable: true description: >- Tentativa mais rápida em milissegundos, ou `null` quando nenhuma tentativa tem um tempo registado. avg_response_time_ms: type: integer nullable: true description: >- Tempo médio de tentativa em milissegundos, arredondado, ou `null` quando nenhuma tentativa tem um tempo registado. max_response_time_ms: type: integer nullable: true description: >- Tentativa mais demorada em milissegundos, ou `null` quando nenhuma tentativa tiver um tempo registado. examples: Three days of deliveries: value: summary: total_deliveries: 1250 failed_deliveries: 12 min_response_time_ms: 38 avg_response_time_ms: 164 max_response_time_ms: 5004 error_rate_percentage: 1 points: - date: '2026-10-14' total_deliveries: 410 failed_deliveries: 0 min_response_time_ms: 38 avg_response_time_ms: 152 max_response_time_ms: 911 - date: '2026-10-15' total_deliveries: 395 failed_deliveries: 12 min_response_time_ms: 41 avg_response_time_ms: 190 max_response_time_ms: 5004 - date: '2026-10-16' total_deliveries: 445 failed_deliveries: 0 min_response_time_ms: 40 avg_response_time_ms: 151 max_response_time_ms: 1220 No deliveries in range: value: summary: total_deliveries: 0 failed_deliveries: 0 min_response_time_ms: null avg_response_time_ms: null max_response_time_ms: null error_rate_percentage: 0 points: [] '400': description: >- `date_from` ou `date_to` não é uma data no formato `YYYY-MM-DD`, ou `date_to` é anterior a `date_from`. content: application/json: schema: type: object description: Cada campo inválido mapeado para uma lista de mensagens. additionalProperties: type: array items: type: string examples: Malformed date: value: date_from: - >- Date has wrong format. Use one of these formats instead: YYYY-MM-DD. Reversed range: value: date_to: - date_to must be greater than or equal to date_from. '401': description: >- A chave de API expirou: foi criada com uma data de validade que já passou. Uma chave incorreta ou revogada também recebe `401`; uma chave em falta recebe `403`. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Expired key: value: detail: This API key has expired. '403': description: >- O pedido não é permitido. Um `x-api-key` em falta, inválido ou revogado recebe `You do not have permission to perform this action.` Uma chave com âmbito sem o acesso de que este endpoint necessita recebe uma mensagem a indicar o acesso em falta, e uma chave utilizada fora da sua lista de permissões de IP recebe `This API key can't be used from this IP address.` content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Missing or invalid key: value: detail: You do not have permission to perform this action. Scoped key without webhooks read: value: detail: This API key has no read access to webhooks. Outside the IP allowlist: value: detail: This API key can't be used from this IP address. '404': description: >- Não existe nenhum destino com este UUID para a aplicação, ou foi eliminado. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Destination not found: value: detail: Webhook destination not found. '429': description: >- Limite de pedidos excedido: mais de 600 pedidos GET na janela atual de um minuto para esta chave de API. Aguarde `Retry-After` segundos antes de tentar novamente. headers: Retry-After: description: Segundos a aguardar antes de tentar novamente. schema: type: integer minimum: 1 example: 30 X-RateLimit-Limit: description: Pedidos permitidos na janela de um minuto (600). schema: type: integer example: 600 X-RateLimit-Remaining: description: Pedidos restantes na janela atual. schema: type: integer example: 0 X-RateLimit-Reset: description: Hora Unix (segundos) em que a janela atual é reposta. schema: type: integer example: 1792056120 X-RateLimit-Scope: description: Nome do orçamento que foi excedido. schema: type: string example: generic-get content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. 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/webhook/destinations/11111111-2222-3333-4444-555555555555/analytics/?date_from=2026-10-01&date_to=2026-10-16' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.webhooks.destinations.retrieve_analytics( "11111111-2222-3333-4444-555555555555", ) 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.webhooks.destinations.retrieveAnalytics("11111111-2222-3333-4444-555555555555"); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.RetrieveAnalytics(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsRetrieveAnalyticsParams{})\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.webhooks().destinations().retrieveAnalytics("11111111-2222-3333-4444-555555555555"); System.out.println(result); - lang: php label: PHP source: >- webhooks->destinations->retrieveAnalytics('11111111-2222-3333-4444-555555555555'); print_r($result->toArray()); - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.webhooks.destinations.retrieve_analytics("11111111-2222-3333-4444-555555555555") 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.Webhooks.Destinations.RetrieveAnalyticsAsync("11111111-2222-3333-4444-555555555555"); Console.WriteLine(JsonSerializer.Serialize(result)); components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.