Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

Metrics

Every metrics endpoint, generated from the API's own schemas.

What happened to the mail

get/api/v1/metrics

Counted from the event log rather than from the messages: a message row says what was sent, and whether it bounced is something the provider told us afterwards. `identity_id` narrows it to one mailbox, which is the question worth asking when you run several — reputation belongs to the address that sent the mail. `delivery_rate` is null rather than zero when nothing was sent.

Parameters

  • daysnumber
  • identity_iduuid

Responses

  • 200The window.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/metrics \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json