Query metrics

GEThttps://myagentmail.com/v1/metrics

Returns counts (sent, received, bounced) and resource totals (inboxes, domains) for a time window. Workspace master keys are locked to their own workspace; tenant master keys can scope with query params.

Query parameters

`from` string	ISO-8601 or epoch seconds/ms. Defaults to 30 days ago.
`to` string	ISO-8601 or epoch seconds/ms. Defaults to now.
`workspace` string
`inbox` string

Responses

200application/jsonOK

`window` object
`from` string	format: date-time
`to` string	format: date-time
`scope` object
`tenantId` string	format: uuid
`workspaceId` string	format: uuid
`inboxId` string	format: uuid
`counts` object
`sent` integer
`received` integer
`bounced` integer
`resources` object
`inboxes` integer
`domains` integer

Authentication

Send your API key in the X-API-Key header (or Authorization: Bearer <key>). Any prefix accepted by this endpoint — tk_, wk_, ak_, or sa_ — is documented in the key prefix table.

Request

import { MyAgentMail } from "myagentmail";

const client = new MyAgentMail({ apiKey: process.env.MYAGENTMAIL_API_KEY! });

// GET /v1/metrics
const result = await client.request("get", "/v1/metrics");

Example response · 200

{
  "window": {
    "from": "2026-05-01T08:11:44.872Z",
    "to": "2026-05-01T08:11:44.872Z"
  },
  "scope": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "workspaceId": "00000000-0000-0000-0000-000000000000",
    "inboxId": "00000000-0000-0000-0000-000000000000"
  },
  "counts": {
    "sent": 0,
    "received": 0,
    "bounced": 0
  },
  "resources": {
    "inboxes": 0,
    "domains": 0
  }
}