Mailchimp Reports GetCampaignReport

Mailchimp Reports GetCampaignReport
Certified
Get a Mailchimp campaign report

Reads the report summary of a sent campaign with GET /reports/{campaignId}.

The report exposes emailsSent, unsubscribed, opens, clicks and bounces (the last three keep their nested Mailchimp keys such as opens_total), plus id, sendTime, listId and subjectLine when present; every other Mailchimp field keeps its original key. Use fields to trim the response.

yaml
type: io.kestra.plugin.mailchimp.reports.GetCampaignReport

Examples

Get opens and clicks of a campaign.

yaml
id: mailchimp_campaign_report
namespace: company.team

tasks:
  - id: report
    type: io.kestra.plugin.mailchimp.reports.GetCampaignReport
    apiKey: "{{ secret('MAILCHIMP_API_KEY') }}"
    campaignId: "42694e9e57"
    fields:
      - emails_sent
      - opens.opens_total
      - clicks.clicks_total

Properties

campaignId *string

Campaign ID

Id of a sent campaign, as returned by ListCampaigns.

accessToken string

OAuth access token

Set exactly one of apiKey or accessToken. server is required with an access token.

apiKey string

Mailchimp API key

Set exactly one of apiKey or accessToken. The data center is taken from the key suffix (for example -us19) unless server is set.

assets

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions

io.kestra.core.models.assets.AssetsDeclaration

assetFailureBehaviorstring

Possible Values

IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

io.kestra.core.models.assets.AssetIdentifier

id*string

Min length1

typestring

outputs

The assets produced as outputs.

io.kestra.plugin.ee.assets.Dataset

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.File

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.Table

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.VM

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.External

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.Custom

id*string

Min length1

Max length150

type*string

Min length1

Custom asset type

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

baseUrl string

Base URL override

Replaces https://<server>.api.mailchimp.com/3.0. The credential is sent to this URL, so it must be an https *.api.mailchimp.com host.

fields array

SubTypestring

Fields

Restrict the response to these Mailchimp fields, using Mailchimp's dotted syntax, e.g. emails_sent, opens.opens_total.

maxRetries integerstring

Default3

Max retries

Retries done by this plugin on HTTP 429 (all methods) and on 5xx or I/O errors (GET and PUT only), with exponential backoff. Default 3, between 0 and 10. Kestra's HTTP client also replays a GET or PUT once after a 429 or 503 on its own, so 0 only turns off the plugin's retries.

server string

Data center

Mailchimp data center such as us19. Required with accessToken, optional with apiKey (overrides the key suffix).

timeout string

DefaultPT2M

Request timeout

Idle read timeout of each call: how long to wait without receiving data. Default PT2M, must be positive. Mailchimp itself cuts requests off after 120 seconds.

Outputs

report object

Report

The campaign report summary, with the main fields in camelCase and the rest under their Mailchimp keys.