Get Campaign Metrics
customer_io.get_campaign_metrics
ActionCRM & salesconnection required
Calls the Customer.io API with the connection's credentials.
Read an automation's delivery metrics as a time series over an explicit window, using the version 2 reporting endpoint.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Customer.io
- Secret shape
- {"site_id": "…", "api_key": "…", "app_api_key": "…"} — the Site ID and Track API key for the Track nodes, the App API key for the rest
- Config it needs
- region, workspace_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
campaign_id The automation's numeric id, from its URL in the dashboard. | string | Yes | — | — | 7 |
res The increment for each point in the series. Required by Customer.io whenever a window is given. | string | No | — | one of "hours", "hourly", "days", "daily", "weeks", "weekly", "months", "monthly" | — |
start The start of the window, as a Unix timestamp in seconds. | number | No | — | ≥ 0 | — |
end The end of the window, as a Unix timestamp in seconds. Customer.io allows at most ten years from the start. | number | No | — | ≥ 0 | — |
tz The time zone the window is expressed in, as a region name such as 'America/New_York'. Defaults to UTC. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"campaign_id": "7"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
start The start of the window Customer.io used, ISO 8601. | string | — |
end The end of the window Customer.io used, ISO 8601. | string | — |
res The resolution the series was built at. | string | — |
metric The series, keyed by metric name under 'series'. | object | — |
{
"end": "",
"metric": {},
"res": "",
"start": ""
}See Get Campaign Metrics run in a workflow.
In a technical demo we add the Customer.io connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.