Skip to content
Anlyon
Esc
↑↓navigate↵open⌘Jpreview

Get delivery analytics

Returns message, schedule, workflow, destination, bandwidth, and error analytics.

GET/api/v2/analytics/delivery
Authorization
AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

or
better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Query parameters
startDatestring<date-time>

Start date for filtering (ISO 8601 format)

endDatestring<date-time>

End date for filtering (ISO 8601 format)

granularitystring
default: "day"
Allowed:hourdayweekmonth
environmentIdstring<uuid>
limitinteger
min 1 · max 100 · default: 10
Header parameters
X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128
Responses
200

Message, schedule, and workflow delivery analytics returned.

successbooleanrequired
Allowed:true
dataDeliveryAnalyticsDatarequired
Show properties
rangeAnalyticsRangeMetadatarequired
Show properties
startDatestring<date-time>required
endDatestring<date-time>required
granularitystringrequired
Allowed:hourdayweekmonth
truncatedbooleanrequired

True when the requested range exceeded plan retention.

retentionDaysinteger | nullrequired

Null means unlimited retention.

min 1
scopeAnalyticsScopeMetadatarequired
Show properties
workspaceIdstring<uuid>required
environmentIdstring<uuid> | nullrequired
messagesMessageAnalyticsDatarequired
Show properties
publishedintegerrequired
min 0
deliveredintegerrequired
min 0
failedintegerrequired
min 0
pendingintegerrequired
min 0
successRatenumberrequired
min 0 · max 100
averageDeliveryTimeintegerrequired

Average delivery time in milliseconds., example: 142

min 0
messageSeriesMessageTimeSeriesPoint[]required
Show properties
Array of MessageTimeSeriesPoint
periodstringrequired

Bucket label formatted for the requested granularity., example: 2026-W29

publishedintegerrequired
min 0
deliveredintegerrequired
min 0
failedintegerrequired
min 0
bandwidthBytesintegerrequired
min 0
schedulesobjectrequired
workflowsobjectrequired
topUrlsTopUrlAnalytics[]required
Show properties
Array of TopUrlAnalytics
urlstring<uri>required
messageCountintegerrequired
min 0
successCountintegerrequired
min 0
failureCountintegerrequired
min 0
successRatenumberrequired
min 0 · max 100
errorsErrorDistributionItem[]required
Show properties
Array of ErrorDistributionItem
errorMessagestringrequired
countintegerrequired
min 0
400

Bad Request - Invalid input data

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
401

Unauthorized - Invalid or missing API key

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
429

Too Many Requests - Rate limit exceeded

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.anlyon.com/api/v2/analytics/delivery' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "success": true,
  "data": {
    "range": {
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "granularity": "hour",
      "truncated": true,
      "retentionDays": 1
    },
    "scope": {
      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563"
    },
    "messages": {
      "published": 1000,
      "delivered": 950,
      "failed": 30,
      "pending": 20,
      "successRate": 95,
      "averageDeliveryTime": 0
    },
    "messageSeries": [
      {
        "period": "string",
        "published": 120,
        "delivered": 116,
        "failed": 4
      }
    ],
    "bandwidthBytes": 0,
    "schedules": {},
    "workflows": {},
    "topUrls": [
      {
        "url": "https://example.com/webhook",
        "messageCount": 500,
        "successCount": 490,
        "failureCount": 10,
        "successRate": 98
      }
    ],
    "errors": [
      {
        "errorMessage": "string",
        "count": 0
      }
    ]
  }
}