Klaviyo GetRecipientCount

Klaviyo GetRecipientCount

Certified

Estimate recipients for campaigns

Retrieves Klaviyo recipient estimations for the provided campaign IDs; fetchType (default FETCH) controls row vs. file output and the task waits ~1s between API calls.

yaml
type: io.kestra.plugin.klaviyo.campaign.GetRecipientCount

Get recipient estimation for a single campaign

yaml
id: klaviyo_get_recipient_estimation
namespace: company.team

tasks:
  - id: get_estimation
    type: io.kestra.plugin.klaviyo.campaign.GetRecipientCount
    apiKey: "{{ secret('KLAVIYO_API_KEY') }}"
    campaignIds:
      - "campaign_id_1"
    fetchType: FETCH_ONE

Get recipient estimations for multiple campaigns

yaml
id: klaviyo_recipient_count
namespace: company.team

tasks:
  - id: get_estimations
    type: io.kestra.plugin.klaviyo.campaign.GetRecipientCount
    apiKey: "{{ secret('KLAVIYO_API_KEY') }}"
    campaignIds:
      - "campaign_id_1"
      - "campaign_id_2"
    fetchType: FETCH
Properties

Klaviyo private API Key

Klaviyo Private API Key sent as Klaviyo-API-Key; keep secret.

SubTypestring

Campaign IDs

Klaviyo campaign IDs to estimate recipients for; preserves input order.

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
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.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaulthttps://a.klaviyo.com/api

Base URL

Klaviyo API base URL; defaults to https://a.klaviyo.com/api.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch strategy

Controls output: FETCH_ONE first row, FETCH all rows (default), STORE writes all rows to internal storage, NONE skips output.

Single row data

SubTypeobject

All rows data

Fetched row count

Formaturi

URI of stored data