Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ActiveCampaign Metrics API

The Metrics API from ActiveCampaign — 5 operation(s) for metrics.

ActiveCampaign Metrics API is one of 36 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, and 9 JSON Schemas.

This API exposes 6 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://{yourAccountName}.api-us1.com/api/3.

6 operations 5 paths 5 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://youraccountname.api-us1.com/api/3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ActiveCampaign Metrics API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Token (ApiToken). By default, every request must be authenticated.

  • ApiToken — Your ActiveCampaign API token

Paths & Operations 6

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

Metrics 6
POST
/sms/broadcasts/metrics
ActiveCampaign Get All Broadcast Metrics
getBroadcastMetrics 2 params body → 200
GET
/sms/broadcasts/metrics/snapshot
ActiveCampaign Get Broadcast Snapshot
getBroadcastSnapshot 2 params → 200
POST
/sms/broadcasts/metrics/snapshot
ActiveCampaign Get Broadcast Snapshot
getBroadcastSnapshotByIds body → 200
GET
/sms/broadcasts/metrics/{broadcastId}/failures
ActiveCampaign Get Broadcast Failure Details
getBroadcastFailures 3 params → 200
POST
/sms/broadcasts/export
ActiveCampaign Export Broadcast Metrics
exportBroadcastMetrics body → 200
POST
/sms/broadcasts/{broadcastId}/recipients/export
ActiveCampaign Export Broadcast Recipients
exportBroadcastRecipients 1 param body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are BroadcastMetrics (7 properties), FailureDetail (3 properties), SnapshotResponse (1 property), FailureDetailsResponse (1 property). Each schema is shown below with its type and property counts.

FailureDetail
object
3 properties
BroadcastMetricsResponse
object
1 property
FailureDetailsResponse
object
1 property
SnapshotResponse
object
1 property
BroadcastMetrics
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-metrics-api-openapi.yml Raw ↑

Other APIs ActiveCampaign publishes across the network.

ActiveCampaign Accounts API
ActiveCampaign Addresses API
ActiveCampaign AI API
ActiveCampaign Automations API
ActiveCampaign Branding API
ActiveCampaign Broadcasts API
ActiveCampaign Bulk Import API
ActiveCampaign Calendars API
ActiveCampaign Campaigns API
ActiveCampaign Contacts API
ActiveCampaign Credits API
ActiveCampaign Custom Objects API