source-klaviyo: upgrade API version for campaigns and profiles to 2023-10-15
#2378
+28
−11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Unlike the 2023-02-22 API version, the 2023-10-15 API version of `profiles` does not include a `subscriptions` field by default. To have `subscriptions` included in `profiles` for the newer API version, it needs to be included in the `additional-fields[profile]` query param.
In the previous 2023-06-15 API version, `campaigns` only returned email campaigns. In API version 2023-10-15 and later, other types of campaigns (like SMS) can be fetched at the same `/campaigns` endpoint. However, it's not possible to fetch more than one type of campaign in a single request-response cycle because only a single campaign type is accepted as a query param. While it's possible to rewrite the `campaigns` stream to fetch these additional campaign types by using stream slices & updated state management techniques, doing so is a relatively large effort. Since our currently enabled captures have email campaigns & no SMS campaigns, I'm punting on adding the functionality to fetch multiple types of campaigns in the `campaigns` stream.
|
I'm holding off on merging until the schema changes are communicated & coordinated with existing users. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
While most streams are using version 2023-10-15 of Klaviyo's API,
campaignsandprofilesare on earlier versions. This PR updates both streams to use API version 2023-10-15.Changes from the updates are mainly to the location of certain properties in each stream's documents.
campaignsThe
attributes.messageproperty is now under therelationships.campaign-messages.data[0].idlocation.profilesThe
attributes.subscriptions.email.marketing.suppressionsfield is renamed toattributes.subscriptions.email.marketing.suppression(i.e. from plural to singular).A note about
campaigns. In API versions including 2023-10-15 and later, Klaviyo now has different types of campaigns. Previously, only email campaigns were returned from the/campaignsendpoint, but in version 2023-10-15 SMS campaigns can also be fetched at that endpoint. However, only a single type of campaign can be fetched in a single request-response cycle because Klaviyo only accepts a single campaign type in the request's query params. While it's possible to rewrite thecampaignsstream to fetch these additional campaign types by using stream slices & updated state management techniques, doing so is a relatively large effort. Since our currently enabled captures have email campaigns & no SMS campaigns,I'm punting on adding the functionality to fetch multiple types of campaigns in the
campaignsstream to a later date.Closes #2367.
Workflow steps:
(How does one use this feature, and how has it changed)
Documentation links affected:
(list any documentation links that you created, or existing ones that you've identified as needing updates, along with a brief description)
Notes for reviewers:
Tested on a local stack. Confirmed
campaignsandprofilesstreams fetch records and complete. Confirmed the other incremental streameventsis not affected by the updates to theIncrementalKlaviyoStreamclass.This change is