Deliverability Metrics

Deliverability Metrics in Luella represent visibility into the performance of mailboxes that have been onboarded to your workspace. These metrics cover inbox placement, spam detection, promotional tab landings, replies, and overall send volume — all collected from warmup activity and inbox placement test responses.

Metrics are scoped to a date range (fromMetricDate and toMetricDate in YYYY-MM-DD format), and can be filtered by one of:

a specific mailboxId (Note: This is the mailboxId for your onboarded mailbox. Not the email address itself)
a specific clusterId
a specific profileId

Only one of these should be included per request.

The deliverability metric model

This model includes the metric name, value, and the date for which that metric was observed. These represent aggregate stats across test recipients during warmup and inbox placement simulations.

Properties

Name
metricName
Type
string
Description
Name of the metric being returned. Possible values include:
- aggregate:inbox:count — Number of emails that landed in recipient's inbox
- aggregate:spam:count — Number of emails that landed in spam
- aggregate:promotions:count — Number of emails that landed in promotions tab
- aggregate:send:count — Number of warmup emails sent
- aggregate:reply:count — Number of warmup emails that received a reply
Name
metricValue
Type
number
Description
The numerical value of the metric for a given date.
Name
metricDate
Type
string (YYYY-MM-DD)
Description
The date this metric was recorded.

POST/deliverability-metrics/ListDeliverabilityMetrics

List deliverability metrics

Retrieve deliverability metrics over a date range for a specific mailbox, profile, or cluster.

Required attributes

Name
userId
Type
string
Description
ID of the user requesting metrics.
Name
workspaceId
Type
string
Description
The workspace the mailboxes belong to.
Name
metricName
Type
string
Description
Metric to retrieve (see metric model for valid values).
Name
fromMetricDate
Type
string (YYYY-MM-DD)
Description
Start of the date range to pull metrics for.
Name
toMetricDate
Type
string (YYYY-MM-DD)
Description
End of the date range to pull metrics for.

Optional attributes

Name
mailboxId
Type
string
Description
Filter metrics for a specific mailbox (use only one of mailboxId, clusterId, or profileId).
Name
clusterId
Type
string
Description
Filter metrics for a specific cluster (use only one of mailboxId, clusterId, or profileId).
Name
profileId
Type
string
Description
Filter metrics for a specific profile (use only one of mailboxId, clusterId, or profileId).
Name
nextToken
Type
string
Description
Token for pagination.
Name
maxItems
Type
number
Description
Limit the number of results returned.

Request

POST

/deliverability-metrics/ListDeliverabilityMetrics

{
  "userId": "user_123",
  "workspaceId": "workspace_456",
  "metricName": "aggregate:inbox:count",
  "fromMetricDate": "2024-03-01",
  "toMetricDate": "2024-03-31",
  "mailboxId": "mailbox_001"
}

Response

{
  "items": [
    {
      "metricName": "aggregate:inbox:count",
      "metricValue": 52,
      "metricDate": "2024-03-01"
    },
    {
      "metricName": "aggregate:inbox:count",
      "metricValue": 60,
      "metricDate": "2024-03-02"
    }
  ],
  "nextToken": null
}