GetCampaign

Retrieve campaigns for campaign messages

Return the related campaigns for given campaign message IDs

yaml
type: "io.kestra.plugin.klaviyo.campaign.messages.GetCampaign"

Examples

Get campaign for a single message

yaml
id: klaviyo_get_campaign_for_message
namespace: company.team

tasks:
  - id: get_campaign
    type: io.kestra.plugin.klaviyo.campaign.messages.GetCampaign
    apiKey: "{{ secret('KLAVIYO_API_KEY') }}"
    messageIds:
      - "message_id_1"
    fetchType: FETCH_ONE

Get campaigns for multiple messages

yaml
id: "getcampaign"
type: "io.kestra.plugin.klaviyo.campaign.messages.GetCampaign"
- id: get_campaigns
  type: io.kestra.plugin.klaviyo.campaign.messages.GetCampaign
  apiKey: "{{ secret('KLAVIYO_API_KEY') }}"
  messageIds:
    - "message_id_1"
    - "message_id_2"
  fetchType: FETCH

Properties

apiKey *string

Klaviyo private API Key

The API key for authenticating with Klaviyo.

messageIds *array

SubType string

List of message IDs

Campaign message IDs for which to retrieve related campaigns

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​Campaign

GetCampaign