Klaviyo Python SDK

These details have not been verified by PyPI

Project links

Project description

Klaviyo Python SDK

SDK version: 5.0.0
API revision: 2023-07-15

Helpful Resources

Design & Approach

This SDK is a thin wrapper around our API. See our API Reference for full documentation on behavior.

This SDK exactly mirrors the organization and naming convention of the above language-agnostic resources, with a few namespace changes to make it Pythonic (details in Appendix).

Organization

This SDK is organized into the following resources:

Accounts
Campaigns
Catalogs
Data_Privacy
Events
Flows
Lists
Metrics
Profiles
Segments
Tags
Templates

Installation

You can install this library using our pip package here.

Depending on your system configuration, you will need to run one of the following shell commands:

pip install klaviyo-api

pip3 install klaviyo-api

Usage Example

To instantiate the client

NOTE:

The SDK retries on resolvable errors, namely: rate limits (common) and server errors (rare).
The keyword arguments define some advanced settings; the example is populated with the default values.
max_delay denotes total delay (in seconds) across all attempts.

from klaviyo_api import KlaviyoAPI

klaviyo = KlaviyoAPI("YOUR_API_KEY_HERE", max_delay=60, max_retries=3, test_host=None)

Example request

klaviyo.Metrics.get_metrics()

Use Case Examples

How to use filtering, sorting, and spare fieldset JSON API features

Use Case: Get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime.

klaviyo.Events.get_events(
    fields_event=['event_properties'], 
    filter="equals(metric_id,\"aBc123\")", 
    sort='-datetime'
    )

How to filter based on datetime

Use Case: Get profiles that have been updated between two datetimes.

klaviyo.Profiles.get_profiles(
    filter='less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)'
    )

How to use pagination and the page[size] param

Use Case: Use cursor-based pagination to get the next 20 profile records.

klaviyo.Profiles.get_profiles(
    page_cursor="https://a.klaviyo.com/api/profiles/?page%5Bcursor%5D=bmV4dDo6aWQ6OjAxRjNaWk5ITlRYMUtFVEhQMzJTUzRBN0ZY",
    page_size=20
)

NOTE: This page cursor value is exactly what is returned in the self/next/prev response values

How to add additional information to your API response via additional-fields and the `includes` parameter

Use Case: Get a specific profile, return an additional predictive analytics field, and also return the list objects associated with the profile.

klaviyo.Profiles.get_profile(
    '01GDDKASAP8TKDDA2GRZDSVP4H', 
    additional_fields_profile=['predictive_analytics'], 
    include=['lists']
)

How to use our relationship endpoints to see related resources

Use Case: Get all list memberships for a profile with the given profile_id.

klaviyo.Profiles.get_profile_relationships_lists('01GDDKASAP8TKDDA2GRZDSVP4H')

How to see what Klaviyo objects are associated with a specific tag

Use Case: Get all campaigns associated with the given tag_id.

klaviyo.Tags.get_tag_relationships_campaigns('9c8db7a0-5ab5-4e3c-9a37-a3224fd14382')

Error Handling

This SDK throws an ApiException error when the server returns a non-2XX response.

An ApiException consists of the following attributes:

status : int
reason : str

body : bytes

this can be decoded into a native python dictionary as follows:

# to decode to a dictionary
import json
BODY_DICT = json.loads(YOUR_EXCEPTION.body)

# to decode to a string
BODY_STRING = YOUR_EXCEPTION.body.decode('utf-8')

headers : class 'urllib3._collections.HTTPHeaderDict'

This can be interacted with as a normal dictionary:

ex:

date = YOUR_EXCEPTION.headers['Date']
keys = YOUR_EXCEPTION.headers.keys()
values = YOUR_EXCEPTION.headers.values()

Important Notes

The main difference between this SDK and the language-agnostic API Docs that the below endpoints link to is that this SDK automatically adds the revision header corresponding to the SDK version.
Organization: Resource groups and operation_ids are listed below in alphabetical order, first by Resource name, then by OpenAPI Summary. Operation summaries are those listed in the right side bar of the API Reference.
For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
Some keyword args may potentially be required for the API call to succeed, the linked API docs are the source of truth regarding which keyword params are required.
JSON payloads should be passed in as native python dictionaries.
You can override the client private key by passing in an optional _request_auth keyword arg to any API call that takes a private key. As a reminder: do NOT do this client-side/onsite.

Comprehensive list of Operations & Parameters

Accounts

Get Account

## Positional Arguments

# id | str

## Keyword Arguments

# fields_account | List[str]

klaviyo.Accounts.get_account(id, fields_account=fields_account)

Get Accounts

## Keyword Arguments

# fields_account | List[str]

klaviyo.Accounts.get_accounts(fields_account=fields_account)

Campaigns

Create Campaign

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign(body)

Create Campaign Clone

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign_clone(body)

Assign Campaign Message Template

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign_message_assign_template(body)

Create Campaign Recipient Estimation Job

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign_recipient_estimation_job(body)

Create Campaign Send Job

## Positional Arguments

# body | dict

klaviyo.Campaigns.create_campaign_send_job(body)

Delete Campaign

## Positional Arguments

# id | str

klaviyo.Campaigns.delete_campaign(id)

Get Campaign

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_message | List[str]
# fields_campaign | List[str]
# fields_tag | List[str]
# include | List[str]

klaviyo.Campaigns.get_campaign(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_tag=fields_tag, include=include)

Get Campaign Campaign Messages

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_message | List[str]
# fields_campaign | List[str]
# fields_template | List[str]
# include | List[str]

klaviyo.Campaigns.get_campaign_campaign_messages(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_template=fields_template, include=include)

Get Campaign Message

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_message | List[str]
# fields_campaign | List[str]
# fields_template | List[str]
# include | List[str]

klaviyo.Campaigns.get_campaign_message(id, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_template=fields_template, include=include)

Get Campaign Message Campaign

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_message | List[str]

klaviyo.Campaigns.get_campaign_message_campaign(id, fields_campaign_message=fields_campaign_message)

Get Campaign Message Relationships Campaign

## Positional Arguments

# id | str

klaviyo.Campaigns.get_campaign_message_relationships_campaign(id)

Get Campaign Message Relationships Template

## Positional Arguments

# id | str

klaviyo.Campaigns.get_campaign_message_relationships_template(id)

Get Campaign Message Template

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_message | List[str]

klaviyo.Campaigns.get_campaign_message_template(id, fields_campaign_message=fields_campaign_message)

Get Campaign Recipient Estimation

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_recipient_estimation | List[str]

klaviyo.Campaigns.get_campaign_recipient_estimation(id, fields_campaign_recipient_estimation=fields_campaign_recipient_estimation)

Get Campaign Recipient Estimation Job

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_recipient_estimation_job | List[str]

klaviyo.Campaigns.get_campaign_recipient_estimation_job(id, fields_campaign_recipient_estimation_job=fields_campaign_recipient_estimation_job)

Get Campaign Relationships Campaign Messages

## Positional Arguments

# id | str

klaviyo.Campaigns.get_campaign_relationships_campaign_messages(id)

Get Campaign Relationships Tags

## Positional Arguments

# id | str

klaviyo.Campaigns.get_campaign_relationships_tags(id)

Get Campaign Send Job

## Positional Arguments

# id | str

## Keyword Arguments

# fields_campaign_send_job | List[str]

klaviyo.Campaigns.get_campaign_send_job(id, fields_campaign_send_job=fields_campaign_send_job)

Get Campaign Tags

## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | List[str]

klaviyo.Campaigns.get_campaign_tags(id, fields_tag=fields_tag)

Get Campaigns

## Positional Arguments

# filter | str

## Keyword Arguments

# fields_campaign_message | List[str]
# fields_campaign | List[str]
# fields_tag | List[str]
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.Campaigns.get_campaigns(filter, fields_campaign_message=fields_campaign_message, fields_campaign=fields_campaign, fields_tag=fields_tag, include=include, page_cursor=page_cursor, sort=sort)

Update Campaign

## Positional Arguments

# id | str
# body | dict

klaviyo.Campaigns.update_campaign(id, body)

Update Campaign Message

## Positional Arguments

# id | str
# body | dict

klaviyo.Campaigns.update_campaign_message(id, body)

Update Campaign Send Job

## Positional Arguments

# id | str
# body | dict

klaviyo.Campaigns.update_campaign_send_job(id, body)

Catalogs

Create Back In Stock Subscription

## Positional Arguments

# body | dict

klaviyo.Catalogs.create_back_in_stock_subscription(body)

Create Catalog Category

## Positional Arguments

# body | dict

klaviyo.Catalogs.create_catalog_category(body)

Create Catalog Category Relationships Items

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.create_catalog_category_relationships_items(id, body)

Create Catalog Item

## Positional Arguments

# body | dict

klaviyo.Catalogs.create_catalog_item(body)

Create Catalog Item Relationships Categories

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.create_catalog_item_relationships_categories(id, body)

Create Catalog Variant

## Positional Arguments

# body | dict

klaviyo.Catalogs.create_catalog_variant(body)

Delete Catalog Category

## Positional Arguments

# id | str

klaviyo.Catalogs.delete_catalog_category(id)

Delete Catalog Category Relationships Items

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.delete_catalog_category_relationships_items(id, body)

Delete Catalog Item

## Positional Arguments

# id | str

klaviyo.Catalogs.delete_catalog_item(id)

Delete Catalog Item Relationships Categories

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.delete_catalog_item_relationships_categories(id, body)

Delete Catalog Variant

## Positional Arguments

# id | str

klaviyo.Catalogs.delete_catalog_variant(id)

Get Catalog Categories

## Keyword Arguments

# fields_catalog_category | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_catalog_categories(fields_catalog_category=fields_catalog_category, filter=filter, page_cursor=page_cursor, sort=sort)

Get Catalog Category

## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_category | List[str]

klaviyo.Catalogs.get_catalog_category(id, fields_catalog_category=fields_catalog_category)

Get Catalog Category Items

## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_item | List[str]
# fields_catalog_variant | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_catalog_category_items(id, fields_catalog_item=fields_catalog_item, fields_catalog_variant=fields_catalog_variant, filter=filter, include=include, page_cursor=page_cursor, sort=sort)

Get Catalog Category Relationships Items

## Positional Arguments

# id | str

## Keyword Arguments

# page_cursor | str

klaviyo.Catalogs.get_catalog_category_relationships_items(id, page_cursor=page_cursor)

Get Catalog Item

## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_item | List[str]
# fields_catalog_variant | List[str]
# include | List[str]

klaviyo.Catalogs.get_catalog_item(id, fields_catalog_item=fields_catalog_item, fields_catalog_variant=fields_catalog_variant, include=include)

Get Catalog Item Categories

## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_category | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_catalog_item_categories(id, fields_catalog_category=fields_catalog_category, filter=filter, page_cursor=page_cursor, sort=sort)

Get Catalog Item Relationships Categories

## Positional Arguments

# id | str

## Keyword Arguments

# page_cursor | str

klaviyo.Catalogs.get_catalog_item_relationships_categories(id, page_cursor=page_cursor)

Get Catalog Item Variants

## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_variant | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_catalog_item_variants(id, fields_catalog_variant=fields_catalog_variant, filter=filter, page_cursor=page_cursor, sort=sort)

Get Catalog Items

## Keyword Arguments

# fields_catalog_item | List[str]
# fields_catalog_variant | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_catalog_items(fields_catalog_item=fields_catalog_item, fields_catalog_variant=fields_catalog_variant, filter=filter, include=include, page_cursor=page_cursor, sort=sort)

Get Catalog Variant

## Positional Arguments

# id | str

## Keyword Arguments

# fields_catalog_variant | List[str]

klaviyo.Catalogs.get_catalog_variant(id, fields_catalog_variant=fields_catalog_variant)

Get Catalog Variants

## Keyword Arguments

# fields_catalog_variant | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Catalogs.get_catalog_variants(fields_catalog_variant=fields_catalog_variant, filter=filter, page_cursor=page_cursor, sort=sort)

Get Create Categories Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_category_bulk_create_job | List[str]
# fields_catalog_category | List[str]
# include | List[str]

klaviyo.Catalogs.get_create_categories_job(job_id, fields_catalog_category_bulk_create_job=fields_catalog_category_bulk_create_job, fields_catalog_category=fields_catalog_category, include=include)

Get Create Categories Jobs

## Keyword Arguments

# fields_catalog_category_bulk_create_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_create_categories_jobs(fields_catalog_category_bulk_create_job=fields_catalog_category_bulk_create_job, filter=filter, page_cursor=page_cursor)

Get Create Items Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_item_bulk_create_job | List[str]
# fields_catalog_item | List[str]
# include | List[str]

klaviyo.Catalogs.get_create_items_job(job_id, fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, fields_catalog_item=fields_catalog_item, include=include)

Get Create Items Jobs

## Keyword Arguments

# fields_catalog_item_bulk_create_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_create_items_jobs(fields_catalog_item_bulk_create_job=fields_catalog_item_bulk_create_job, filter=filter, page_cursor=page_cursor)

Get Create Variants Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_variant_bulk_create_job | List[str]
# fields_catalog_variant | List[str]
# include | List[str]

klaviyo.Catalogs.get_create_variants_job(job_id, fields_catalog_variant_bulk_create_job=fields_catalog_variant_bulk_create_job, fields_catalog_variant=fields_catalog_variant, include=include)

Get Create Variants Jobs

## Keyword Arguments

# fields_catalog_variant_bulk_create_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_create_variants_jobs(fields_catalog_variant_bulk_create_job=fields_catalog_variant_bulk_create_job, filter=filter, page_cursor=page_cursor)

Get Delete Categories Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_category_bulk_delete_job | List[str]

klaviyo.Catalogs.get_delete_categories_job(job_id, fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job)

Get Delete Categories Jobs

## Keyword Arguments

# fields_catalog_category_bulk_delete_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_delete_categories_jobs(fields_catalog_category_bulk_delete_job=fields_catalog_category_bulk_delete_job, filter=filter, page_cursor=page_cursor)

Get Delete Items Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_item_bulk_delete_job | List[str]

klaviyo.Catalogs.get_delete_items_job(job_id, fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job)

Get Delete Items Jobs

## Keyword Arguments

# fields_catalog_item_bulk_delete_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_delete_items_jobs(fields_catalog_item_bulk_delete_job=fields_catalog_item_bulk_delete_job, filter=filter, page_cursor=page_cursor)

Get Delete Variants Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_variant_bulk_delete_job | List[str]

klaviyo.Catalogs.get_delete_variants_job(job_id, fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job)

Get Delete Variants Jobs

## Keyword Arguments

# fields_catalog_variant_bulk_delete_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_delete_variants_jobs(fields_catalog_variant_bulk_delete_job=fields_catalog_variant_bulk_delete_job, filter=filter, page_cursor=page_cursor)

Get Update Categories Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_category_bulk_update_job | List[str]
# fields_catalog_category | List[str]
# include | List[str]

klaviyo.Catalogs.get_update_categories_job(job_id, fields_catalog_category_bulk_update_job=fields_catalog_category_bulk_update_job, fields_catalog_category=fields_catalog_category, include=include)

Get Update Categories Jobs

## Keyword Arguments

# fields_catalog_category_bulk_update_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_update_categories_jobs(fields_catalog_category_bulk_update_job=fields_catalog_category_bulk_update_job, filter=filter, page_cursor=page_cursor)

Get Update Items Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_item_bulk_update_job | List[str]
# fields_catalog_item | List[str]
# include | List[str]

klaviyo.Catalogs.get_update_items_job(job_id, fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, fields_catalog_item=fields_catalog_item, include=include)

Get Update Items Jobs

## Keyword Arguments

# fields_catalog_item_bulk_update_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_update_items_jobs(fields_catalog_item_bulk_update_job=fields_catalog_item_bulk_update_job, filter=filter, page_cursor=page_cursor)

Get Update Variants Job

## Positional Arguments

# job_id | str

## Keyword Arguments

# fields_catalog_variant_bulk_update_job | List[str]
# fields_catalog_variant | List[str]
# include | List[str]

klaviyo.Catalogs.get_update_variants_job(job_id, fields_catalog_variant_bulk_update_job=fields_catalog_variant_bulk_update_job, fields_catalog_variant=fields_catalog_variant, include=include)

Get Update Variants Jobs

## Keyword Arguments

# fields_catalog_variant_bulk_update_job | List[str]
# filter | str
# page_cursor | str

klaviyo.Catalogs.get_update_variants_jobs(fields_catalog_variant_bulk_update_job=fields_catalog_variant_bulk_update_job, filter=filter, page_cursor=page_cursor)

Spawn Create Categories Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_create_categories_job(body)

Spawn Create Items Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_create_items_job(body)

Spawn Create Variants Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_create_variants_job(body)

Spawn Delete Categories Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_delete_categories_job(body)

Spawn Delete Items Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_delete_items_job(body)

Spawn Delete Variants Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_delete_variants_job(body)

Spawn Update Categories Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_update_categories_job(body)

Spawn Update Items Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_update_items_job(body)

Spawn Update Variants Job

## Positional Arguments

# body | dict

klaviyo.Catalogs.spawn_update_variants_job(body)

Update Catalog Category

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_category(id, body)

Update Catalog Category Relationships Items

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_category_relationships_items(id, body)

Update Catalog Item

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_item(id, body)

Update Catalog Item Relationships Categories

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_item_relationships_categories(id, body)

Update Catalog Variant

## Positional Arguments

# id | str
# body | dict

klaviyo.Catalogs.update_catalog_variant(id, body)

Data_Privacy

Request Profile Deletion

## Positional Arguments

# body | dict

klaviyo.Data_Privacy.request_profile_deletion(body)

Events

Create Event

## Positional Arguments

# body | dict

klaviyo.Events.create_event(body)

Get Event

## Positional Arguments

# id | str

## Keyword Arguments

# fields_event | List[str]
# fields_metric | List[str]
# fields_profile | List[str]
# include | List[str]

klaviyo.Events.get_event(id, fields_event=fields_event, fields_metric=fields_metric, fields_profile=fields_profile, include=include)

Get Event Metric

## Positional Arguments

# id | str

## Keyword Arguments

# fields_metric | List[str]

klaviyo.Events.get_event_metric(id, fields_metric=fields_metric)

Get Event Profile

## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_profile | List[str]

klaviyo.Events.get_event_profile(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile)

Get Event Relationships Metric

## Positional Arguments

# id | str

klaviyo.Events.get_event_relationships_metric(id)

Get Event Relationships Profile

## Positional Arguments

# id | str

klaviyo.Events.get_event_relationships_profile(id)

Get Events

## Keyword Arguments

# fields_event | List[str]
# fields_metric | List[str]
# fields_profile | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# sort | str

klaviyo.Events.get_events(fields_event=fields_event, fields_metric=fields_metric, fields_profile=fields_profile, filter=filter, include=include, page_cursor=page_cursor, sort=sort)

Flows

Get Flow

## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]
# fields_flow | List[str]
# fields_tag | List[str]
# include | List[str]

klaviyo.Flows.get_flow(id, fields_flow_action=fields_flow_action, fields_flow=fields_flow, fields_tag=fields_tag, include=include)

Get Flow Action

## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]
# fields_flow_message | List[str]
# fields_flow | List[str]
# include | List[str]

klaviyo.Flows.get_flow_action(id, fields_flow_action=fields_flow_action, fields_flow_message=fields_flow_message, fields_flow=fields_flow, include=include)

Get Flow For Flow Action

## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow | List[str]

klaviyo.Flows.get_flow_action_flow(id, fields_flow=fields_flow)

Get Flow Action Messages

## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_message | List[str]
# filter | str
# page_size | int
# sort | str

klaviyo.Flows.get_flow_action_messages(id, fields_flow_message=fields_flow_message, filter=filter, page_size=page_size, sort=sort)

Get Flow Action Relationships Flow

## Positional Arguments

# id | str

klaviyo.Flows.get_flow_action_relationships_flow(id)

Get Flow Action Relationships Messages

## Positional Arguments

# id | str

## Keyword Arguments

# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Flows.get_flow_action_relationships_messages(id, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)

Get Flow Flow Actions

## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Flows.get_flow_flow_actions(id, fields_flow_action=fields_flow_action, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)

Get Flow Message

## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]
# fields_flow_message | List[str]
# include | List[str]

klaviyo.Flows.get_flow_message(id, fields_flow_action=fields_flow_action, fields_flow_message=fields_flow_message, include=include)

Get Flow Action For Message

## Positional Arguments

# id | str

## Keyword Arguments

# fields_flow_action | List[str]

klaviyo.Flows.get_flow_message_action(id, fields_flow_action=fields_flow_action)

Get Flow Message Relationships Action

## Positional Arguments

# id | str

klaviyo.Flows.get_flow_message_relationships_action(id)

Get Flow Relationships Flow Actions

## Positional Arguments

# id | str

## Keyword Arguments

# filter | str
# page_size | int
# sort | str

klaviyo.Flows.get_flow_relationships_flow_actions(id, filter=filter, page_size=page_size, sort=sort)

Get Flow Relationships Tags

## Positional Arguments

# id | str

klaviyo.Flows.get_flow_relationships_tags(id)

Get Flow Tags

## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | List[str]

klaviyo.Flows.get_flow_tags(id, fields_tag=fields_tag)

Get Flows

## Keyword Arguments

# fields_flow_action | List[str]
# fields_flow | List[str]
# fields_tag | List[str]
# filter | str
# include | List[str]
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Flows.get_flows(fields_flow_action=fields_flow_action, fields_flow=fields_flow, fields_tag=fields_tag, filter=filter, include=include, page_cursor=page_cursor, page_size=page_size, sort=sort)

Update Flow Status

## Positional Arguments

# id | str
# body | dict

klaviyo.Flows.update_flow(id, body)

Lists

Create List

## Positional Arguments

# body | dict

klaviyo.Lists.create_list(body)

Add Profile To List

## Positional Arguments

# id | str
# body | dict

klaviyo.Lists.create_list_relationships(id, body)

Delete List

## Positional Arguments

# id | str

klaviyo.Lists.delete_list(id)

Remove Profile From List

## Positional Arguments

# id | str
# body | dict

klaviyo.Lists.delete_list_relationships(id, body)

Get List

## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_list | List[str]
# fields_list | List[str]
# fields_tag | List[str]
# include | List[str]

klaviyo.Lists.get_list(id, additional_fields_list=additional_fields_list, fields_list=fields_list, fields_tag=fields_tag, include=include)

Get List Profiles

## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_profile | List[str]
# filter | str
# page_cursor | str
# page_size | int

klaviyo.Lists.get_list_profiles(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size)

Get List Relationships Profiles

## Positional Arguments

# id | str

## Keyword Arguments

# page_cursor | str

klaviyo.Lists.get_list_relationships_profiles(id, page_cursor=page_cursor)

Get List Relationships Tags

## Positional Arguments

# id | str

klaviyo.Lists.get_list_relationships_tags(id)

Get List Tags

## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | List[str]

klaviyo.Lists.get_list_tags(id, fields_tag=fields_tag)

Get Lists

## Keyword Arguments

# fields_list | List[str]
# fields_tag | List[str]
# filter | str
# include | List[str]
# page_cursor | str

klaviyo.Lists.get_lists(fields_list=fields_list, fields_tag=fields_tag, filter=filter, include=include, page_cursor=page_cursor)

Update List

## Positional Arguments

# id | str
# body | dict

klaviyo.Lists.update_list(id, body)

Metrics

Get Metric

## Positional Arguments

# id | str

## Keyword Arguments

# fields_metric | List[str]

klaviyo.Metrics.get_metric(id, fields_metric=fields_metric)

Get Metrics

## Keyword Arguments

# fields_metric | List[str]
# filter | str
# page_cursor | str

klaviyo.Metrics.get_metrics(fields_metric=fields_metric, filter=filter, page_cursor=page_cursor)

Query Metric Aggregates

## Positional Arguments

# body | dict

klaviyo.Metrics.query_metric_aggregates(body)

Profiles

Create Profile

## Positional Arguments

# body | dict

klaviyo.Profiles.create_profile(body)

Get Profile

## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_list | List[str]
# fields_profile | List[str]
# fields_segment | List[str]
# include | List[str]

klaviyo.Profiles.get_profile(id, additional_fields_profile=additional_fields_profile, fields_list=fields_list, fields_profile=fields_profile, fields_segment=fields_segment, include=include)

Get Profile Lists

## Positional Arguments

# id | str

## Keyword Arguments

# fields_list | List[str]

klaviyo.Profiles.get_profile_lists(id, fields_list=fields_list)

Get Profile Relationships Lists

## Positional Arguments

# id | str

klaviyo.Profiles.get_profile_relationships_lists(id)

Get Profile Relationships Segments

## Positional Arguments

# id | str

klaviyo.Profiles.get_profile_relationships_segments(id)

Get Profile Segments

## Positional Arguments

# id | str

## Keyword Arguments

# fields_segment | List[str]

klaviyo.Profiles.get_profile_segments(id, fields_segment=fields_segment)

Get Profiles

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_profile | List[str]
# filter | str
# page_cursor | str
# page_size | int
# sort | str

klaviyo.Profiles.get_profiles(additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size, sort=sort)

Subscribe Profiles

## Positional Arguments

# body | dict

klaviyo.Profiles.subscribe_profiles(body)

Suppress Profiles

## Positional Arguments

# body | dict

klaviyo.Profiles.suppress_profiles(body)

Unsubscribe Profiles

## Positional Arguments

# body | dict

klaviyo.Profiles.unsubscribe_profiles(body)

Unsuppress Profiles

## Positional Arguments

# body | dict

klaviyo.Profiles.unsuppress_profiles(body)

Update Profile

## Positional Arguments

# id | str
# body | dict

klaviyo.Profiles.update_profile(id, body)

Segments

Get Segment

## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_segment | List[str]
# fields_segment | List[str]
# fields_tag | List[str]
# include | List[str]

klaviyo.Segments.get_segment(id, additional_fields_segment=additional_fields_segment, fields_segment=fields_segment, fields_tag=fields_tag, include=include)

Get Segment Profiles

## Positional Arguments

# id | str

## Keyword Arguments

# additional_fields_profile | List[str]
# fields_profile | List[str]
# filter | str
# page_cursor | str
# page_size | int

klaviyo.Segments.get_segment_profiles(id, additional_fields_profile=additional_fields_profile, fields_profile=fields_profile, filter=filter, page_cursor=page_cursor, page_size=page_size)

Get Segment Relationships Profiles

## Positional Arguments

# id | str

## Keyword Arguments

# page_cursor | str

klaviyo.Segments.get_segment_relationships_profiles(id, page_cursor=page_cursor)

Get Segment Relationships Tags

## Positional Arguments

# id | str

klaviyo.Segments.get_segment_relationships_tags(id)

Get Segment Tags

## Positional Arguments

# id | str

## Keyword Arguments

# fields_tag | List[str]

klaviyo.Segments.get_segment_tags(id, fields_tag=fields_tag)

Get Segments

## Keyword Arguments

# fields_segment | List[str]
# fields_tag | List[str]
# filter | str
# include | List[str]
# page_cursor | str

klaviyo.Segments.get_segments(fields_segment=fields_segment, fields_tag=fields_tag, filter=filter, include=include, page_cursor=page_cursor)

Update Segment

## Positional Arguments

# id | str
# body | dict

klaviyo.Segments.update_segment(id, body)

Templates

Create Template

## Positional Arguments

# body | dict

klaviyo.Templates.create_template(body)

Create Template Clone

## Positional Arguments

# body | dict

klaviyo.Templates.create_template_clone(body)

Create Template Render

## Positional Arguments

# body | dict

klaviyo.Templates.create_template_render(body)

Delete Template

## Positional Arguments

# id | str

klaviyo.Templates.delete_template(id)

Get Template

## Positional Arguments

# id | str

## Keyword Arguments

# fields_template | List[str]

klaviyo.Templates.get_template(id, fields_template=fields_template)

Get Templates

## Keyword Arguments

# fields_template | List[str]
# filter | str
# page_cursor | str
# sort | str

klaviyo.Templates.get_templates(fields_template=fields_template, filter=filter, page_cursor=page_cursor, sort=sort)

Update Template

## Positional Arguments

# id | str
# body | dict

klaviyo.Templates.update_template(id, body)

Appendix

Global Keyword Args

NOTE: These are arguments that you can apply to any endpoint call, and which are unique to the SDK

We currently support the following global keyword args:

_request_auth : use this to override the client-level api_key which you define upon client instantiation

Refresher on catching exceptions:

try:
    YOUR_CALL
except Exception as e:
    print(e.status)
    print(e.reason)
    print(e.body)
    print(e.headers)

Parameters & Arguments

The parameters follow the same naming conventions as the resource groups and operations.

We stick to the following convention for parameters/arguments

All parameters are passed as function args.
All query and path params that are tagged as required in the docs are passed as positional args.
All optional query params are passed as keyword args.
Where applicable, the body param is passed in as a positional arg, and is expected to be a native python dictionary. Within that dictionary, refer to the API docs to see which fields are required/optional, along with valid values.
There is no need to pass in your private api_key for any operations, as it is defined upon client instantiation; public key is still required where applicable. However, you can pass in an optional _request_auth kwarg to override the client private key for a specific call (REMINDER: don't do this client-side).

Namespace

In the interest of making the SDK Pythonic, we made the following namespace changes relative to the language agnostic resources up top (API Docs, Guides, etc).

Resource names use Title + Snake Casing, (e.g. Data_Privacy)
function names and parameter names use snake case (e.g. get_metrics, and profile_id)

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

14.0.0

Oct 17, 2024

13.0.0

Sep 23, 2024

12.0.0

Aug 29, 2024

11.0.1

Aug 5, 2024

11.0.0

Jul 23, 2024

10.0.0

Jul 15, 2024

9.0.0

Jun 17, 2024

8.0.1

Jun 5, 2024

8.0.0

May 15, 2024

7.0.0

Feb 15, 2024

6.1.0

Dec 15, 2023

6.0.1

Nov 21, 2023

6.0.0

Oct 16, 2023

5.2.0

Sep 15, 2023

5.1.2

Aug 23, 2023

5.1.1

Aug 16, 2023

5.1.0

Aug 15, 2023

This version

5.0.0

Jul 31, 2023

4.0.0

Jul 17, 2023

3.0.0

Jun 15, 2023

2.0.2

Jun 9, 2023

2.0.1

May 30, 2023

2.0.0

Apr 6, 2023

1.3.1

Mar 9, 2023

1.3.0

Mar 1, 2023

1.2.1

Feb 24, 2023

1.2.0

Feb 23, 2023

1.1.0

Jan 25, 2023

1.0.3

Nov 18, 2022

1.0.2

Oct 25, 2022

1.0.1

Oct 20, 2022

1.0.0

Oct 19, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

klaviyo-api-5.0.0.tar.gz (145.6 kB view hashes)

Uploaded Jul 31, 2023 Source

Built Distribution

klaviyo_api-5.0.0-py3-none-any.whl (397.5 kB view hashes)

Uploaded Jul 31, 2023 Python 3

Hashes for klaviyo-api-5.0.0.tar.gz

Hashes for klaviyo-api-5.0.0.tar.gz
Algorithm	Hash digest
SHA256	`9cdd52ba75b699c144198f1847e62e75f370f64cc49caf16b3a11ca0c06d0357`
MD5	`b8b92d11b5f4eb37908970e91ccd9402`
BLAKE2b-256	`7683f66b0e88f7b46f27048ec161328ea5fb8587a0cdf3608d629552d31b2ac4`

Hashes for klaviyo_api-5.0.0-py3-none-any.whl

Hashes for klaviyo_api-5.0.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`e835f4a13070eece007dfb0df887158fa0b9bf05b22e069e898c64c05c3f2043`
MD5	`b7ada3797029aa9eeaa109b6b95a573b`
BLAKE2b-256	`44fd41474172470a460bc4c240e0e56714241f505d97e61809b52938186c1faf`