How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dotdigital Messaging API

The Messaging API from Dotdigital — 2 operation(s) for messaging.

Dotdigital Messaging API is one of 63 APIs that Dotdigital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Messaging. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.1.1.

Requests are made against a single base URL, https://{region}-api.dotdigital.com.

2 operations 2 paths 18 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.1
Base URL
https://r1-api.dotdigital.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Dotdigital Messaging API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Messaging 2
GET
/cpaas/analytics/messages
Retrieves message analytics
5 params → 200400404
GET
/cpaas/analytics/messages/metrics
Retrieves message metrics
5 params → 200400404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are messageAnalytics (17 properties), ApiProfilingAnalytics (5 properties), DeliveryTimeMetric (2 properties), messageAnalytics_queued (1 property). Each schema is shown below with its type and property counts.

messageAnalytics_inbound
object
The count of messages received from each channel
1 property
messageAnalytics_deliveredSegements
object
The segment count of delivered messages on each channel
1 property
messageAnalytics_expired
object
The count of expired messages for each channel
1 property
messageAnalytics_queuedSegments
object
The segment count of queued messages on each channel
1 property
messageAnalytics_read
object
The count of messages read for each channel
1 property
ApiProfilingAnalytics
object
API profiling analytics data, including delivery times for different messaging channels on a specific date.
5 properties 2 required
TimeToDeliveredMetrics
object
Delivery time metrics, keyed by delivery time thresholds (in seconds).
messageAnalytics_success
object
The count of messages sent for each channel
1 property
messageAnalytics_expiredSegements
object
The segment count of expired messages on each channel
1 property
messageAnalytics_delivered
object
The count of messages delivered for each channel
1 property
DeliveryTimeMetric
object
Metric for messages delivered within a specific time threshold.
2 properties 2 required
ChannelProfiling
object
Profiling data for a specific messaging channel, including delivery time metrics.
1 property 1 required
messageAnalytics
object
17 properties
messageAnalytics_readSegements
object
The segment count of read messages on each channel
1 property
messageAnalytics_queued
object
The count of queued messages for each channel
1 property
messageAnalytics_undeliverableSegements
object
The segment count of undeliverable messages on each channel
1 property
messageAnalytics_undeliverable
object
The count of undeliverable messages for each channel
1 property
messageAnalytics_successSegements
object
The segment count of sent messages on each channel
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dotdigital-messaging-api-openapi.yml Raw ↑

Other APIs Dotdigital publishes across the network.

Dotdigital Marketing Developer Hub MCP Server
Dotdigital Accounts and Utilities API
Dotdigital API Account API
Dotdigital API Address Book API
Dotdigital API Campaign API
Dotdigital API Campaign From Address API
Dotdigital API Campaign Reporting API
Dotdigital API Campaign Send API
Dotdigital API Contact API
Dotdigital API Contact Import API
Dotdigital API Data Field API
Dotdigital API Document API
Where this information came from

This is an independent, third-party profile of Dotdigital Messaging API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.