GetRecipientCount

Retrieve campaign recipient estimations from Klaviyo

Returns the estimated recipient count for the given campaign IDs

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

Examples

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: "getrecipientcount"
type: "io.kestra.plugin.klaviyo.campaign.GetRecipientCount"
- 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

apiKey *string

Klaviyo private API Key

The API key for authenticating with Klaviyo.

campaignIds *array

SubType string

List of campaign IDs

Campaign IDs for which to get the estimated number of recipients

baseUrl string

Default https://a.klaviyo.com/api

Base URL

The base URL for the Klaviyo API

fetchType string

Default FETCH

Possible Values

STOREFETCHFETCH_ONENONE

The way you want to store the data

FETCH_ONE output the first row, FETCH output all rows, STORE store all rows in a file, NONE do nothing

Outputs

row object

The row data

rows array

SubType object

The rows data

size integer

The size of the rows fetched

uri string

Format uri

The URI of the stored data

​Get​Recipient​Count

GetRecipientCount