Skip to content

README.md

Latest commit

 

History

History
2010 lines (1011 loc) · 44.6 KB

README.md

File metadata and controls

2010 lines (1011 loc) · 44.6 KB

Klaviyo JavaScript SDK

  • SDK version: 5.0.0

  • 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 API 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
  • DataPrivacy
  • Events
  • Flows
  • Lists
  • Metrics
  • Profiles
  • Segments
  • Tags
  • Templates

Installation

NPM

You can install this library using npm.

npm install klaviyo-api

source code

Alternatively, you can also run this using this repo as source code, by running one of the following shell commands within the cloned repo:

npm install

and then running JavaScript from the cloned repo.

Usage Example

To instantiate the ConfigWrapper

import {ConfigWrapper} from 'klaviyo-api'

ConfigWrapper("KLAVIYO PRIVATE KEY GOES HERE")

Or if ES6 isn't your thing

var klaviyoSdk = require('klaviyo-api');

klaviyoSdk.ConfigWrapper("KLAVIYO PRIVATE KEY GOES HERE")

To edit the exponential backoff built into the ConfigWrapper you can pass optional parameters

import {ConfigWrapper} from 'klaviyo-api'

ConfigWrapper("KLAVIYO PRIVATE KEY GOES HERE", {
    numOfAttempts: 5, // max number of rety attempts. Default is 3
    timeMultiple: 10, // how exponental the timing is. Default is 5
    startingDelay: 1000, // How long before first retry. Default is 500
})

NOTES:

  • The SDK retries on resolvable errors, namely: rate limits (common) and server errors on klaviyo (rare).
  • The first ConfigWrapper created is the default, if you want to use more than one api key see multi-store instructions below

To call the getProfile operation:

import {Profiles} from 'klaviyo-api';

const profileId = "PROFILE_ID";
const opts = {};

Profiles.getProfile(profileId, opts)
    .then(data => 'Do Something Here')
    .catch(error => 'An error was thrown check the HTTP code with error.status');

or if you want to use async await

import {Profiles} from 'klaviyo-api';

const profileId = "PROFILE_ID";
const opts = {};

// Just make sure you are calling with the async tag ie. async () => {}
try {
    response = await Profiles.getProfile(profileId, opts)
    console.log(response);
} catch (e) {
    console.log(e);
}

once again if you're not using ES6

var KlaviyoSdk = require('klaviyo-api');

var profileId = "PROFILE_ID";
var opts = {};

KlaviyoSdk.Profiles.getProfile(profileId, opts)
    .then(data => 'Do Something Here')
    .catch(error => 'An error was thrown check the HTTP code with error.status');

What the response looks like

The response is an object with three parts: status, headers, and body

import {Profiles} from 'klaviyo-api';

const opts = {};

// how to get your request information
try {
    response = await Profiles.getProfiles(opts)
    const response_body = response.body
    // first index id
    const id = response_body.data[0].id
    // getting the next page cursor
    const next_page_cursor = response_body.links.next
    // rest of the response information
    const status = response.status
    const headers = response.headers
} catch (e) {
    console.log(e);
}

Multiple stores

if you need to use multiple api keys, you can forgo the wrapped api classes and make you own

import {ConfigWrapper, CatalogsApi} from 'klaviyo-api'

const catalogApi = new CatalogsApi(ConfigWrapper("KLAVIYO PRIVATE KEY GOES HERE"))
const r = await catalogApi.createCatalogCategory(body)

Optional Parameters and Json Api Features

Here we will go over

  • Pagination
  • Page size
  • Additional Fields
  • Filtering
  • Sparse Fields
  • Sorting
  • Relationships

Quick rule

As a reminder, the optional parameters are named slightly differently from how you would make the call without the SDK docs, query parameter names have variables that make bad JavaScript names like page[cursor] are transformed to pageCursor. (Remove the weird characters and append words with camelCase). A modern IDE will make the positional arguments look a bit more clear.

Cursor based Pagination

All the endpoints that return a list of results use cursor-based pagination.

Obtain the cursor value from the call you want to get the next page for, then pass it under the pageCursor optional parameter. The page cursor looks like WzE2NDA5OTUyMDAsICIzYzRjeXdGTndadyIsIHRydWVd.

API call:

https://a.klaviyo.com/api/profiles/?page[cursor]=WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd

SDK call:

import { ConfigWrapper, ProfilesApi } from 'klaviyo-api'
const profilesApi = new ProfilesApi(ConfigWrapper("<Your Private Key Here>"))

const profileList = await profilesApi.getProfiles({pageCursor: 'WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd'})

You get the cursor for the next page from body.link.next which returns the entire URL of the next call but the sdk will accept the entire link and use only the relevant cursor.

Here is an example of getting the second next and passing in the page cursor:

import { ConfigWrapper, ProfilesApi } from 'klaviyo-api'
const profilesApi = new ProfilesApi(ConfigWrapper("<Your Private Key Here>"))

try {
    const profilesListFirstPage = await profilesApi.getProfiles()
    const nextPage = profilesList.body.links.next
    const profileListSecondPage = await profilesApi.getProfiles({pageCursor: nextPage})
    console.log(profileListSecondPage.body)
} catch (e) {
    console.log(e)
}

There are more page cursors than just next, check the endpoint's docs or the response type, but often there is first, last, next and prev.

Page Size

Some endpoint you can get a larger or smaller page size by using the pageSize parameter.

API call:

https://a.klaviyo.com/api/profiles/?page[size]=20

SDK call:

import { ConfigWrapper, ProfilesApi } from 'klaviyo-api'
const profilesApi = new ProfilesApi(ConfigWrapper("<Your Private Key Here>"))

const profileList = await profilesApi.getProfiles({pageSize: 20})

Additional Fields

Additional fields are used to populate part of the response that would be null otherwise. For the getProfile endpoint you can pass in a request to get the predictive analytics of the profile. Using the additionalFields parameter often will change the rate limit of the endpoint so be sure to keep an eye on your usage.

API call

https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?additional-fields[profile]=predictive_analytics

SDK call:

import { ConfigWrapper, ProfilesApi } from 'klaviyo-api'
const profilesApi = new ProfilesApi(ConfigWrapper("<Your Private Key Here>"))

const profileId = '01GDDKASAP8TKDDA2GRZDSVP4H'
const profile = await profilesApi.getProfile(profileId, {additionalFieldsProfile: ['predictive_analytics']})

// If your profile has enough information for predictive analytis it will populate
console.log(profile.body.data.attributes.predictiveAnalytics)

Filtering

Filter by passing the filter as a string as under the optional parameter filter. Note that when filtering by a property it will be snake_case instead of camelCase, ie. metric_id

Read more about formatting your filter strings in our developer documentation

Here is an example of a filter string for results between two date times: less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)

Here is a code example filter for profiles with the matching emails:

https://a.klaviyo.com/api/profiles/?filter=any(email,["[email protected]","[email protected]"]

SDK call:

import { ConfigWrapper, ProfilesApi } from 'klaviyo-api'
const profilesApi = new ProfilesApi(ConfigWrapper("<Your Private Key Here>"))

const filter = 'any(email,["[email protected]","[email protected]"])'
// remember { filter: filter } is the same as {filter}
const profileList = await profilesApi.getProfiles({filter})

Sparse Fields

If you only want a specific subset of data from a specific query you can use sparse fields to request only the specific properties. The SDK expands the optional sparse fields into their own option, where you can pass a list of the desired items to include.

To get a list of event properties the API call you would use is:

https://a.klaviyo.com/api/events/?fields[event]=event_properties

SDK call:

import { ConfigWrapper, EventsApi } from 'klaviyo-api'
const eventsApi = new EventsApi(ConfigWrapper("<Your Private Key Here>"))

const eventsList = await eventsApi.getEvents({fieldsEvent: ["event_properties"]})

Sorting

Your can request the results of specific endpoints to be ordered by a given parameter. The direction of the sort can swapped by adding a - in front of the sort key. For example datetime will be ascending while -datetime will be descending.

If you are unsure about the available sort fields you can always check the documentation for the endpoint you are using. For a comprehensive list that links to the documentation for each function check the Endpoints section below.

API Call to get events sorted by oldest to newest datetime:

https://a.klaviyo.com/api/events/?sort=-datetime

SDK call:

import { ConfigWrapper, EventsApi } from 'klaviyo-api'
const eventsApi = new EventsApi(ConfigWrapper("<Your Private Key Here>"))

const events = await eventsApi.getEvents({sort: '-datetime'})

Includes

You can add additional information to your API response via additional fields and the includes parameter. This allows you to get information about two or more objects from a single API call. Using the includes parameter often changes the rate limit of the endpoint so be sure to take note.

API call to get profile information and the information about the lists the profile is in:

https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?include=lists

SDK call:

import { ConfigWrapper, ProfilesApi } from 'klaviyo-api'
const profilesApi = new ProfilesApi(ConfigWrapper("<Your Private Key Here>"))

const profileId = '01GDDKASAP8TKDDA2GRZDSVP4H'
const profile = await profilesApi.getProfile(profileId, {include:["lists"]})

// Profile information is accessed the same way with
console.log(profile.body.data)
// Lists related to the profile with be accessible via the included array
console.log(profile.body.included)

Note about sparse fields and relationships: you can request only specific fields of the included object as well.

import { ConfigWrapper, ProfilesApi } from 'klaviyo-api'
const profilesApi = new ProfilesApi(ConfigWrapper("<Your Private Key Here>"))

const profileId = '01GDDKASAP8TKDDA2GRZDSVP4H'
// Use the fieldsLists property to request only the list name
const profile = await profilesApi.getProfile(profileId, { fieldsList: ['name'], include: ["lists"])

// Profile information is accessed the same way with
console.log(profile.body.data)
// Lists related to the profile with be accessible via the included array
console.log(profile.body.included)

Relationships

The Klaviyo API has a series of endpoints to expose the relationships between different Klaviyo Items. You can read more about relationships inour documentation.

Here are some use cases and their examples:

API call to get the list membership for a profile with the given profile ID:

https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/relationships/lists/

SDK call:

import { ConfigWrapper, ProfilesApi } from 'klaviyo-api'
const profilesApi = new ProfilesApi(ConfigWrapper("<Your Private Key Here>"))

const profileId = '01GDDKASAP8TKDDA2GRZDSVP4H'
const profileRelationships = await profilesApi.getProfileRelationshipsLists(profileId)

For another example:

Get all campaigns associated with the given tag_id.

API call:

https://a.klaviyo.com/api/tags/9c8db7a0-5ab5-4e3c-9a37-a3224fd14382/relationships/campaigns/

SDK call:

import { ConfigWrapper, TagsApi } from 'klaviyo-api'
const tagsApi = new TagsApi(ConfigWrapper("< Your private key here >"))

const tagId = '9c8db7a0-5ab5-4e3c-9a37-a3224fd14382'
const relatedCampagins = tagsApi.getTagRelationshipsCampaigns(tagId)

Combining

You can use any combination of the features outlines above in conjunction with one another.

API call to get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime:

https://a.klaviyo.com/api/events/?fields[event]=event_properties&filter=equals(metric_id,"URDbLg")&sort=-datetime

SDK call:

import { ConfigWrapper, EventsApi } from 'klaviyo-api'
const eventsApi = new EventsApi(ConfigWrapper("<Your Private Key Here>"))

const metricId = 'URDbLg'
const filter = `equal(metric_id,"${metricId}")`
const events = await eventsApi.getEvents({ fieldsEvent: ['event_properties'], filter, sort: '-datetime'})

Comprehensive list of Operations & Parameters

NOTE:

  • Organization: Resource groups and operation_ids are listed 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 args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.

AccountsApi

Get Account

const Accounts.getAccount(id, opts)

Get Accounts

const Accounts.getAccounts(opts)

CampaignsApi

Create Campaign

const Campaigns.createCampaign(body)

Create Campaign Clone

const Campaigns.createCampaignClone(body)

Assign Campaign Message Template

const Campaigns.createCampaignMessageAssignTemplate(body)

Create Campaign Recipient Estimation Job

const Campaigns.createCampaignRecipientEstimationJob(body)

Create Campaign Send Job

const Campaigns.createCampaignSendJob(body)

Delete Campaign

const Campaigns.deleteCampaign(id)

Get Campaign

const Campaigns.getCampaign(id, opts)

Get Campaign Campaign Messages

const Campaigns.getCampaignCampaignMessages(id, opts)

Get Campaign Message

const Campaigns.getCampaignMessage(id, opts)

Get Campaign Message Campaign

const Campaigns.getCampaignMessageCampaign(id, opts)

Get Campaign Message Relationships Campaign

const Campaigns.getCampaignMessageRelationshipsCampaign(id)

Get Campaign Message Relationships Template

const Campaigns.getCampaignMessageRelationshipsTemplate(id)

Get Campaign Message Template

const Campaigns.getCampaignMessageTemplate(id, opts)

Get Campaign Recipient Estimation

const Campaigns.getCampaignRecipientEstimation(id, opts)

Get Campaign Recipient Estimation Job

const Campaigns.getCampaignRecipientEstimationJob(id, opts)

Get Campaign Relationships Campaign Messages

const Campaigns.getCampaignRelationshipsCampaignMessages(id)

Get Campaign Relationships Tags

const Campaigns.getCampaignRelationshipsTags(id)

Get Campaign Send Job

const Campaigns.getCampaignSendJob(id, opts)

Get Campaign Tags

const Campaigns.getCampaignTags(id, opts)

Get Campaigns

const Campaigns.getCampaigns(filter, opts)

Update Campaign

const Campaigns.updateCampaign(body, id)

Update Campaign Message

const Campaigns.updateCampaignMessage(body, id)

Update Campaign Send Job

const Campaigns.updateCampaignSendJob(body, id)

CatalogsApi

Create Back In Stock Subscription

const Catalogs.createBackInStockSubscription(body)

Create Catalog Category

const Catalogs.createCatalogCategory(body)

Create Catalog Category Relationships Items

const Catalogs.createCatalogCategoryRelationshipsItems(body, id)

Create Catalog Item

const Catalogs.createCatalogItem(body)

Create Catalog Item Relationships Categories

const Catalogs.createCatalogItemRelationshipsCategories(body, id)

Create Catalog Variant

const Catalogs.createCatalogVariant(body)

Delete Catalog Category

const Catalogs.deleteCatalogCategory(id)

Delete Catalog Category Relationships Items

const Catalogs.deleteCatalogCategoryRelationshipsItems(body, id)

Delete Catalog Item

const Catalogs.deleteCatalogItem(id)

Delete Catalog Item Relationships Categories

const Catalogs.deleteCatalogItemRelationshipsCategories(body, id)

Delete Catalog Variant

const Catalogs.deleteCatalogVariant(id)

Get Catalog Categories

const Catalogs.getCatalogCategories(opts)

Get Catalog Category

const Catalogs.getCatalogCategory(id, opts)

Get Catalog Category Items

const Catalogs.getCatalogCategoryItems(id, opts)

Get Catalog Category Relationships Items

const Catalogs.getCatalogCategoryRelationshipsItems(id, opts)

Get Catalog Item

const Catalogs.getCatalogItem(id, opts)

Get Catalog Item Categories

const Catalogs.getCatalogItemCategories(id, opts)

Get Catalog Item Relationships Categories

const Catalogs.getCatalogItemRelationshipsCategories(id, opts)

Get Catalog Item Variants

const Catalogs.getCatalogItemVariants(id, opts)

Get Catalog Items

const Catalogs.getCatalogItems(opts)

Get Catalog Variant

const Catalogs.getCatalogVariant(id, opts)

Get Catalog Variants

const Catalogs.getCatalogVariants(opts)

Get Create Categories Job

const Catalogs.getCreateCategoriesJob(jobId, opts)

Get Create Categories Jobs

const Catalogs.getCreateCategoriesJobs(opts)

Get Create Items Job

const Catalogs.getCreateItemsJob(jobId, opts)

Get Create Items Jobs

const Catalogs.getCreateItemsJobs(opts)

Get Create Variants Job

const Catalogs.getCreateVariantsJob(jobId, opts)

Get Create Variants Jobs

const Catalogs.getCreateVariantsJobs(opts)

Get Delete Categories Job

const Catalogs.getDeleteCategoriesJob(jobId, opts)

Get Delete Categories Jobs

const Catalogs.getDeleteCategoriesJobs(opts)

Get Delete Items Job

const Catalogs.getDeleteItemsJob(jobId, opts)

Get Delete Items Jobs

const Catalogs.getDeleteItemsJobs(opts)

Get Delete Variants Job

const Catalogs.getDeleteVariantsJob(jobId, opts)

Get Delete Variants Jobs

const Catalogs.getDeleteVariantsJobs(opts)

Get Update Categories Job

const Catalogs.getUpdateCategoriesJob(jobId, opts)

Get Update Categories Jobs

const Catalogs.getUpdateCategoriesJobs(opts)

Get Update Items Job

const Catalogs.getUpdateItemsJob(jobId, opts)

Get Update Items Jobs

const Catalogs.getUpdateItemsJobs(opts)

Get Update Variants Job

const Catalogs.getUpdateVariantsJob(jobId, opts)

Get Update Variants Jobs

const Catalogs.getUpdateVariantsJobs(opts)

Spawn Create Categories Job

const Catalogs.spawnCreateCategoriesJob(body)

Spawn Create Items Job

const Catalogs.spawnCreateItemsJob(body)

Spawn Create Variants Job

const Catalogs.spawnCreateVariantsJob(body)

Spawn Delete Categories Job

const Catalogs.spawnDeleteCategoriesJob(body)

Spawn Delete Items Job

const Catalogs.spawnDeleteItemsJob(body)

Spawn Delete Variants Job

const Catalogs.spawnDeleteVariantsJob(body)

Spawn Update Categories Job

const Catalogs.spawnUpdateCategoriesJob(body)

Spawn Update Items Job

const Catalogs.spawnUpdateItemsJob(body)

Spawn Update Variants Job

const Catalogs.spawnUpdateVariantsJob(body)

Update Catalog Category

const Catalogs.updateCatalogCategory(body, id)

Update Catalog Category Relationships Items

const Catalogs.updateCatalogCategoryRelationshipsItems(body, id)

Update Catalog Item

const Catalogs.updateCatalogItem(body, id)

Update Catalog Item Relationships Categories

const Catalogs.updateCatalogItemRelationshipsCategories(body, id)

Update Catalog Variant

const Catalogs.updateCatalogVariant(body, id)

DataPrivacyApi

Request Profile Deletion

const DataPrivacy.requestProfileDeletion(body)

EventsApi

Create Event

const Events.createEvent(body)

Get Event

const Events.getEvent(id, opts)

Get Event Metric

const Events.getEventMetric(id, opts)

Get Event Profile

const Events.getEventProfile(id, opts)

Get Event Relationships Metric

const Events.getEventRelationshipsMetric(id)

Get Event Relationships Profile

const Events.getEventRelationshipsProfile(id)

Get Events

const Events.getEvents(opts)

FlowsApi

Get Flow

const Flows.getFlow(id, opts)

Get Flow Action

const Flows.getFlowAction(id, opts)

Get Flow For Flow Action

const Flows.getFlowActionFlow(id, opts)

Get Flow Action Messages

const Flows.getFlowActionMessages(id, opts)

Get Flow Action Relationships Flow

const Flows.getFlowActionRelationshipsFlow(id)

Get Flow Action Relationships Messages

const Flows.getFlowActionRelationshipsMessages(id, opts)

Get Flow Flow Actions

const Flows.getFlowFlowActions(id, opts)

Get Flow Message

const Flows.getFlowMessage(id, opts)

Get Flow Action For Message

const Flows.getFlowMessageAction(id, opts)

Get Flow Message Relationships Action

const Flows.getFlowMessageRelationshipsAction(id)

Get Flow Relationships Flow Actions

const Flows.getFlowRelationshipsFlowActions(id, opts)

Get Flow Relationships Tags

const Flows.getFlowRelationshipsTags(id)

Get Flow Tags

const Flows.getFlowTags(id, opts)

Get Flows

const Flows.getFlows(opts)

Update Flow Status

const Flows.updateFlow(body, id)

ListsApi

Create List

const Lists.createList(body)

Add Profile To List

const Lists.createListRelationships(body, id)

Delete List

const Lists.deleteList(id)

Remove Profile From List

const Lists.deleteListRelationships(body, id)

Get List

const Lists.getList(id, opts)

Get List Profiles

const Lists.getListProfiles(id, opts)

Get List Relationships Profiles

const Lists.getListRelationshipsProfiles(id, opts)

Get List Relationships Tags

const Lists.getListRelationshipsTags(id)

Get List Tags

const Lists.getListTags(id, opts)

Get Lists

const Lists.getLists(opts)

Update List

const Lists.updateList(body, id)

MetricsApi

Get Metric

const Metrics.getMetric(id, opts)

Get Metrics

const Metrics.getMetrics(opts)

Query Metric Aggregates

const Metrics.queryMetricAggregates(body)

ProfilesApi

Create Profile

const Profiles.createProfile(body)

Get Profile

const Profiles.getProfile(id, opts)

Get Profile Lists

const Profiles.getProfileLists(id, opts)

Get Profile Relationships Lists

const Profiles.getProfileRelationshipsLists(id)

Get Profile Relationships Segments

const Profiles.getProfileRelationshipsSegments(id)

Get Profile Segments

const Profiles.getProfileSegments(id, opts)

Get Profiles

const Profiles.getProfiles(opts)

Subscribe Profiles

const Profiles.subscribeProfiles(body)

Suppress Profiles

const Profiles.suppressProfiles(body)

Unsubscribe Profiles

const Profiles.unsubscribeProfiles(body)

Unsuppress Profiles

const Profiles.unsuppressProfiles(body)

Update Profile

const Profiles.updateProfile(body, id)

SegmentsApi

Get Segment

const Segments.getSegment(id, opts)

Get Segment Profiles

const Segments.getSegmentProfiles(id, opts)

Get Segment Relationships Profiles

const Segments.getSegmentRelationshipsProfiles(id, opts)

Get Segment Relationships Tags

const Segments.getSegmentRelationshipsTags(id)

Get Segment Tags

const Segments.getSegmentTags(id, opts)

Get Segments

const Segments.getSegments(opts)

Update Segment

const Segments.updateSegment(body, id)

TagsApi

Create Tag

const Tags.createTag(body)

Create Tag Group

const Tags.createTagGroup(body)

Create Tag Relationships Campaigns

const Tags.createTagRelationshipsCampaigns(body, id)

Create Tag Relationships Flows

const Tags.createTagRelationshipsFlows(body, id)

Create Tag Relationships Lists

const Tags.createTagRelationshipsLists(body, id)

Create Tag Relationships Segments

const Tags.createTagRelationshipsSegments(body, id)

Delete Tag

const Tags.deleteTag(id)

Delete Tag Group

const Tags.deleteTagGroup(id)

Delete Tag Relationships Campaigns

const Tags.deleteTagRelationshipsCampaigns(body, id)

Delete Tag Relationships Flows

const Tags.deleteTagRelationshipsFlows(body, id)

Delete Tag Relationships Lists

const Tags.deleteTagRelationshipsLists(body, id)

Delete Tag Relationships Segments

const Tags.deleteTagRelationshipsSegments(body, id)

Get Tag

const Tags.getTag(id, opts)

Get Tag Group

const Tags.getTagGroup(id, opts)

Get Tag Group Relationships Tags

const Tags.getTagGroupRelationshipsTags(id)

Get Tag Group Tags

const Tags.getTagGroupTags(id, opts)

Get Tag Groups

const Tags.getTagGroups(opts)

Get Tag Relationships Campaigns

const Tags.getTagRelationshipsCampaigns(id)

Get Tag Relationships Flows

const Tags.getTagRelationshipsFlows(id)

Get Tag Relationships Lists

const Tags.getTagRelationshipsLists(id)

Get Tag Relationships Segments

const Tags.getTagRelationshipsSegments(id)

Get Tag Relationships Tag Group

const Tags.getTagRelationshipsTagGroup(id)

Get Tag Tag Group

const Tags.getTagTagGroup(id, opts)

Get Tags

const Tags.getTags(opts)

Update Tag

const Tags.updateTag(body, id)

Update Tag Group

const Tags.updateTagGroup(body, id)

TemplatesApi

Create Template

const Templates.createTemplate(body)

Create Template Clone

const Templates.createTemplateClone(body)

Create Template Render

const Templates.createTemplateRender(body)

Delete Template

const Templates.deleteTemplate(id)

Get Template

const Templates.getTemplate(id, opts)

Get Templates

const Templates.getTemplates(opts)

Update Template

const Templates.updateTemplate(body, id)

Appendix

Limitations

  • The api_key is set at the global level: this means that if you manage multiple stores, you will need to run the code for each store in a different environment

Refresher on catching exceptions:

try {
    await YOUR_CALL
} catch (e) {
    print(e.status, e.body, e.headers)
}

Namespace

In the interest of making the SDK follow conventions, we made the following namespace changes relative to the language agnostic resources up top.

  1. dashes - are removed in favor of camelCase
  2. all other non-alphanumeric symbols, including spaces, are removed.

For example:

  • get-campaigns becomes getCampaigns
  • Track & Identify becomes TrackIdentify

Parameters & Arguments

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

We stick to the following convention for parameters/arguments

  1. All parameters are passed as function args.
  2. All optional params, as well as all Body and Form Data params (including required ones), are passed in a single object param.
  3. All query and path params that are tagged as required in the docs are passed as positional args.
  4. There is no need to pass in your private api_key for any operations, as it is defined upon ConfigWrapper instantiation; public key is still required where its used.