GetRecipient

Retrieve campaign recipient estimation jobs from Klaviyo

Retrieve the status of recipient estimation jobs triggered with the Create Campaign Recipient Estimation Job endpoint

yaml
type: "io.kestra.plugin.klaviyo.jobs.GetRecipient"

Examples

Get a single recipient estimation job

yaml
id: klaviyo_get_recipient_job
namespace: company.team

tasks:
  - id: get_recipient_job
    type: io.kestra.plugin.klaviyo.jobs.GetRecipient
    apiKey: "{{ secret('KLAVIYO_API_KEY') }}"
    jobIds:
      - "job_id_1"
    fetchType: FETCH_ONE

Get multiple recipient estimation jobs

yaml
id: "getrecipient"
type: "io.kestra.plugin.klaviyo.jobs.GetRecipient"
- id: get_recipient_jobs
  type: io.kestra.plugin.klaviyo.jobs.GetRecipient
  apiKey: "{{ secret('KLAVIYO_API_KEY') }}"
  jobIds:
    - "job_id_1"
    - "job_id_2"
  fetchType: FETCH

Properties

apiKey *string

Klaviyo private API Key

The API key for authenticating with Klaviyo.

jobIds *array

SubType string

List of recipient estimation job IDs

IDs of the campaigns to get recipient estimation job status

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

GetRecipient