2024-05 Klaviyo Legacy v1 and v2 to v2024-02-15 API Migration
  • 13 Minutes to read
  • Dark
    Light
  • PDF

2024-05 Klaviyo Legacy v1 and v2 to v2024-02-15 API Migration

  • Dark
    Light
  • PDF

Article summary

Introduction

Starting June 30th, 2024, Klaviyo will cease support for Klaviyo Legacy v1 and v2.
These APIs will be replaced by Klaviyo v2024-02-15 API.

Details of Changes

Support Discontinuation

Klaviyo Legacy v1 and v2 will no longer be supported after June 30th, 2024.
Users are advised to migrate to 2024-02-15 API for continued functionality.

New Data Source

The new Klaviyo data source for version 2024-02-15 will be available in the second week of May.
This data source will replace the existing Klaviyo Legacy data source for v1 and v2.

Table of Comparisons

Here is how you can pull data from v1/v2 reports in v2024-02-15:

Campaigns (v1/v2) -> Email Campaigns (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
CampaignsGet all campaigns in an accountGet CampaignsEmail CampaignsGet all Email campaigns in an accountGet Campaigns

Version 2024-02-15 Mapping

{
  "data": [
    {
      "type": "campaign",
      "id": "string",
      "attributes": {
        "name": "string",
        "status": "string",
        "archived": true,
        "audiences": {
          "included": [
            "Y6nRLr"
          ],
          "excluded": [
            "UTd5ui"
          ]
        },
        "send_options": {
          "use_smart_sending": true
        },
        "tracking_options": {
          "is_add_utm": true,
          "utm_params": [
            {
              "name": "utm_medium",
              "value": "campaign"
            }
          ],
          "is_tracking_clicks": true,
          "is_tracking_opens": true
        },
        "send_strategy": {
          "method": "static",
          "options_static": {
            "datetime": "2022-11-08T00:00:00",
            "is_local": true,
            "send_past_recipients_immediately": true
          },
          "options_throttled": {
            "datetime": "2024-04-11T12:54:31.196Z",
            "throttle_percentage": 0
          },
          "options_sto": {
            "date": "2024-04-11"
          }
        },
        "created_at": "2022-11-08T00:00:00",
        "scheduled_at": "2022-11-08T00:00:00",
        "updated_at": "2022-11-08T00:00:00",
        "send_time": "2022-11-08T00:00:00"
      },
      "links": {
        "self": "string"
      },
      "relationships": {
        "campaign-messages": {
          "data": [
            {
              "type": "campaign-message",
              "id": "string"
            }
          ],
          "links": {
            "self": "string",
            "related": "string"
          }
        },
        "tags": {
          "data": [
            {
              "type": "tag",
              "id": "string"
            }
          ],
          "links": {
            "self": "string",
            "related": "string"
          }
        }
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "included": [
    {
      "type": "campaign-message",
      "id": "string",
      "attributes": {
        "label": "string",
        "channel": "string",
        "content": {
          "subject": "Buy our product!",
          "preview_text": "My preview text",
          "from_email": "store@my-company.com",
          "from_label": "My Company",
          "reply_to_email": "reply-to@my-company.com",
          "cc_email": "cc@my-company.com",
          "bcc_email": "bcc@my-company.com"
        },
        "send_times": [
          {
            "datetime": "2022-11-08T00:00:00",
            "is_local": true
          }
        ],
        "render_options": {
          "shorten_links": true,
          "add_org_prefix": true,
          "add_info_link": true,
          "add_opt_out_language": false
        },
        "created_at": "2022-11-08T00:00:00",
        "updated_at": "2022-11-08T00:00:00"
      },
      "links": {
        "self": "string"
      }
    },
    {
      "type": "tag",
      "id": "abcd1234-ef56-gh78-ij90-abcdef123456",
      "attributes": {
        "name": "My Tag"
      },
      "links": {
        "self": "string"
      }
    }
  ]
}

Campaigns (v1/v2) -> SMS Campaigns (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
CampaignsGet all campaigns in an accountGet CampaignsSMS CampaignsGet all SMS campaigns in an accountGet Campaign Message Campaign

Version 2024-02-15 Mapping

{
  "data": {
    "type": "campaign",
    "id": "string",
    "attributes": {
      "name": "string",
      "status": "string",
      "archived": true,
      "audiences": {
        "included": [
          "Y6nRLr"
        ],
        "excluded": [
          "UTd5ui"
        ]
      },
      "send_options": {
        "use_smart_sending": true
      },
      "tracking_options": {
        "is_add_utm": true,
        "utm_params": [
          {
            "name": "utm_medium",
            "value": "campaign"
          }
        ],
        "is_tracking_clicks": true,
        "is_tracking_opens": true
      },
      "send_strategy": {
        "method": "static",
        "options_static": {
          "datetime": "2022-11-08T00:00:00",
          "is_local": true,
          "send_past_recipients_immediately": true
        },
        "options_throttled": {
          "datetime": "2024-04-11T12:54:31.196Z",
          "throttle_percentage": 0
        },
        "options_sto": {
          "date": "2024-04-11"
        }
      },
      "created_at": "2022-11-08T00:00:00",
      "scheduled_at": "2022-11-08T00:00:00",
      "updated_at": "2022-11-08T00:00:00",
      "send_time": "2022-11-08T00:00:00"
    },
    "links": {
      "self": "string"
    },
    "relationships": {
      "campaign-messages": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "tags": {
        "links": {
          "self": "string",
          "related": "string"
        }
      }
    }
  }
}

Email Templates (v1/v2) -> Templates (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
Email TemplatesReturn a list of all the email templates you've createdGet All TemplatesTemplatesGet all templates in an account. Request specific fields using sparse field sets.Get Templates

Version 2024-02-15 Mapping

{
  "data": [
    {
      "type": "template",
      "id": "string",
      "attributes": {
        "name": "string",
        "editor_type": "string",
        "html": "string",
        "text": "string",
        "created": "2022-11-08T00:00:00",
        "updated": "2022-11-08T00:00:00"
      },
      "links": {
        "self": "string"
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

Events(v1/v2) -> Events (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
Events (event_name)Returns a batched timeline of all events in your accountGet Events for All MetricsEventsGet all events in an account. Use filters to narrow your results to specific metrics. Request specific fields using sparse field sets. nclude parameters can be provided to get the following related resource data: metrics, profiles.Get Events

Version 2024-02-15 Mapping

{
  "data": [
    {
      "type": "event",
      "id": "string",
      "attributes": {
        "timestamp": 0,
        "event_properties": {},
        "datetime": "2022-11-08T01:23:45+00:00",
        "uuid": "string"
      },
      "links": {
        "self": "string"
      },
      "relationships": {
        "profile": {
          "data": {
            "type": "profile",
            "id": "string"
          },
          "links": {
            "self": "string",
            "related": "string"
          }
        },
        "metric": {
          "data": {
            "type": "metric",
            "id": "string"
          },
          "links": {
            "self": "string",
            "related": "string"
          }
        },
        "attributions": {
          "data": [
            {
              "type": "attribution",
              "id": "string"
            }
          ],
          "links": {
            "self": "string",
            "related": "string"
          }
        }
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "included": [
    {
      "type": "attribution",
      "id": "925e385b52fb405715f3616c337cc65c",
      "relationships": {
        "event": {
          "data": {
            "type": "event",
            "id": "string"
          }
        },
        "attributed-event": {
          "data": {
            "type": "event",
            "id": "string"
          }
        },
        "campaign": {
          "data": {
            "type": "campaign",
            "id": "string"
          }
        },
        "campaign-message": {
          "data": {
            "type": "campaign-message",
            "id": "string"
          }
        },
        "flow": {
          "data": {
            "type": "flow",
            "id": "string"
          }
        },
        "flow-message": {
          "data": {
            "type": "flow-message",
            "id": "string"
          }
        },
        "flow-message-variation": {
          "data": {
            "type": "flow-message",
            "id": "string"
          }
        }
      },
      "links": {
        "self": "string"
      }
    },
    {
      "type": "metric",
      "id": "string",
      "attributes": {
        "name": "string",
        "created": "string",
        "updated": "string",
        "integration": {}
      },
      "links": {
        "self": "string"
      }
    },
    {
      "type": "profile",
      "id": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "attributes": {
        "email": "sarah.mason@klaviyo-demo.com",
        "phone_number": "+15005550006",
        "external_id": "63f64a2b-c6bf-40c7-b81f-bed08162edbe",
        "first_name": "Sarah",
        "last_name": "Mason",
        "organization": "Example Corporation",
        "title": "Regional Manager",
        "image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
        "created": "2022-11-08T00:00:00",
        "updated": "2022-11-08T00:00:00",
        "last_event_date": "2022-11-08T00:00:00",
        "location": {
          "address1": "89 E 42nd St",
          "address2": "1st floor",
          "city": "New York",
          "country": "United States",
          "latitude": "string",
          "longitude": "string",
          "region": "NY",
          "zip": "10017",
          "timezone": "America/New_York",
          "ip": "127.0.0.1"
        },
        "properties": {
          "pseudonym": "Dr. Octopus"
        }
      },
      "links": {
        "self": "string"
      }
    }
  ]
}

Flows (v1/v2) -> Flows (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
FlowsGet all flows in an account.Get FlowsFlowsGet all flows in an account.Get Flows

Version 2024-02-15 Mapping

{
  "data": [
    {
      "type": "flow",
      "id": "string",
      "attributes": {
        "name": "string",
        "status": "string",
        "archived": true,
        "created": "2022-11-08T00:00:00",
        "updated": "2022-11-08T00:00:00",
        "trigger_type": "Added to List"
      },
      "links": {
        "self": "string"
      },
      "relationships": {
        "flow-actions": {
          "data": [
            {
              "type": "flow-action",
              "id": "string"
            }
          ],
          "links": {
            "self": "string",
            "related": "string"
          }
        },
        "tags": {
          "data": [
            {
              "type": "tag",
              "id": "string"
            }
          ],
          "links": {
            "self": "string",
            "related": "string"
          }
        }
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "included": [
    {
      "type": "flow-action",
      "id": "string",
      "attributes": {
        "action_type": "string",
        "status": "string",
        "created": "2022-11-08T00:00:00",
        "updated": "2022-11-08T00:00:00",
        "settings": {},
        "tracking_options": {
          "add_utm": true,
          "utm_params": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "is_tracking_opens": true,
          "is_tracking_clicks": true
        },
        "send_options": {
          "use_smart_sending": true,
          "is_transactional": true
        },
        "render_options": {
          "shorten_links": true,
          "add_org_prefix": true,
          "add_info_link": true,
          "add_opt_out_language": true
        }
      },
      "links": {
        "self": "string"
      }
    },
    {
      "type": "tag",
      "id": "abcd1234-ef56-gh78-ij90-abcdef123456",
      "attributes": {
        "name": "My Tag"
      },
      "links": {
        "self": "string"
      }
    }
  ]
}

Lists (v1/v2) -> Lists (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
ListsReturn a listing of all the lists in an account.Get ListsListsGet all lists in an account. Use filters to narrow your results. Request specific fields using sparse field sets.Get Lists

Version 2024-02-15 Mapping

{
  "data": [
    {
      "type": "list",
      "id": "Y6nRLr",
      "attributes": {
        "name": "Newsletter",
        "created": "2022-11-08T00:00:00",
        "updated": "2022-11-08T00:00:00",
        "opt_in_process": "double_opt_in"
      },
      "links": {
        "self": "string"
      },
      "relationships": {
        "profiles": {
          "links": {
            "self": "string",
            "related": "string"
          }
        },
        "tags": {
          "data": [
            {
              "type": "tag",
              "id": "string"
            }
          ],
          "links": {
            "self": "string",
            "related": "string"
          }
        }
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "included": [
    {
      "type": "tag",
      "id": "abcd1234-ef56-gh78-ij90-abcdef123456",
      "attributes": {
        "name": "My Tag"
      },
      "links": {
        "self": "string"
      }
    }
  ]
}

All Members List (v1/v2) -> List Profiles (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
All members listGets all of the emails, phone numbers, and push tokens for profiles in a given list or segment.Get List and Segment MembersList ProfilesGet all profiles within a list with the given list ID. Retrieves full profile information for each list member (not just emails, phone numbers, and push tokens). Use filters to narrow your results.Get List Profiles

Version 2024-02-15 Mapping

{
  "data": [
    {
      "type": "profile",
      "id": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "attributes": {
        "email": "sarah.mason@klaviyo-demo.com",
        "phone_number": "+15005550006",
        "external_id": "63f64a2b-c6bf-40c7-b81f-bed08162edbe",
        "first_name": "Sarah",
        "last_name": "Mason",
        "organization": "Example Corporation",
        "title": "Regional Manager",
        "image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
        "created": "2022-11-08T00:00:00",
        "updated": "2022-11-08T00:00:00",
        "last_event_date": "2022-11-08T00:00:00",
        "location": {
          "address1": "89 E 42nd St",
          "address2": "1st floor",
          "city": "New York",
          "country": "United States",
          "latitude": "string",
          "longitude": "string",
          "region": "NY",
          "zip": "10017",
          "timezone": "America/New_York",
          "ip": "127.0.0.1"
        },
        "properties": {
          "pseudonym": "Dr. Octopus"
        },
        "joined_group_at": "2022-11-08T00:00:00",
        "subscriptions": {
          "email": {
            "marketing": {
              "can_receive_email_marketing": true,
              "consent": "SUBSCRIBED",
              "consent_timestamp": "2023-02-21T20:07:38+00:00",
              "last_updated": "2023-02-21T20:07:38+00:00",
              "method": "PREFERENCE_PAGE",
              "method_detail": "Mydomain | Hosting, Domains, and Websites with Web.com ",
              "custom_method_detail": "marketing drive",
              "double_optin": "True",
              "suppression": [
                {
                  "reason": "HARD_BOUNCE",
                  "timestamp": "2023-02-21T20:07:38+00:00"
                }
              ],
              "list_suppressions": [
                {
                  "list_id": "Y6nRLr",
                  "reason": "USER_SUPPRESSED",
                  "timestamp": "2023-02-21T20:07:38+00:00"
                }
              ]
            }
          },
          "sms": {
            "marketing": {
              "can_receive_sms_marketing": true,
              "consent": "SUBSCRIBED",
              "consent_timestamp": "2023-02-21T20:07:38+00:00",
              "method": "TEXT",
              "method_detail": "JOIN",
              "last_updated": "2023-02-21T20:07:38+00:00"
            }
          }
        },
        "predictive_analytics": {
          "historic_clv": 93.87,
          "predicted_clv": 27.24,
          "total_clv": 121.11,
          "historic_number_of_orders": 2,
          "predicted_number_of_orders": 0.54,
          "average_days_between_orders": 189,
          "average_order_value": 46.94,
          "churn_probability": 0.89,
          "expected_date_of_next_order": "2022-11-08T00:00:00"
        }
      },
      "links": {
        "self": "string"
      },
      "relationships": {
        "lists": {
          "links": {
            "self": "string",
            "related": "string"
          }
        },
        "segments": {
          "links": {
            "self": "string",
            "related": "string"
          }
        }
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

Execution in List (v1/v2) -> Get Profiles (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
Execution in listGets all of the emails and phone numbers that have been excluded from a list along with the exclusion reasons and exclusion time.Get All Exclusions for a ListGet profilesGet all profiles that have been excluded from a list. Filter profiles by suppression fields.Get Profiles

Version 2024-02-15 Mapping

{
  "data": [
    {
      "type": "profile",
      "id": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "attributes": {
        "email": "sarah.mason@klaviyo-demo.com",
        "phone_number": "+15005550006",
        "external_id": "63f64a2b-c6bf-40c7-b81f-bed08162edbe",
        "first_name": "Sarah",
        "last_name": "Mason",
        "organization": "Example Corporation",
        "title": "Regional Manager",
        "image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
        "created": "2022-11-08T00:00:00",
        "updated": "2022-11-08T00:00:00",
        "last_event_date": "2022-11-08T00:00:00",
        "location": {
          "address1": "89 E 42nd St",
          "address2": "1st floor",
          "city": "New York",
          "country": "United States",
          "latitude": "string",
          "longitude": "string",
          "region": "NY",
          "zip": "10017",
          "timezone": "America/New_York",
          "ip": "127.0.0.1"
        },
        "properties": {
          "pseudonym": "Dr. Octopus"
        },
        "subscriptions": {
          "email": {
            "marketing": {
              "can_receive_email_marketing": true,
              "consent": "SUBSCRIBED",
              "consent_timestamp": "2023-02-21T20:07:38+00:00",
              "last_updated": "2023-02-21T20:07:38+00:00",
              "method": "PREFERENCE_PAGE",
              "method_detail": "Mydomain | Hosting, Domains, and Websites with Web.com ",
              "custom_method_detail": "marketing drive",
              "double_optin": "True",
              "suppression": [
                {
                  "reason": "HARD_BOUNCE",
                  "timestamp": "2023-02-21T20:07:38+00:00"
                }
              ],
              "list_suppressions": [
                {
                  "list_id": "Y6nRLr",
                  "reason": "USER_SUPPRESSED",
                  "timestamp": "2023-02-21T20:07:38+00:00"
                }
              ]
            }
          },
          "sms": {
            "marketing": {
              "can_receive_sms_marketing": true,
              "consent": "SUBSCRIBED",
              "consent_timestamp": "2023-02-21T20:07:38+00:00",
              "method": "TEXT",
              "method_detail": "JOIN",
              "last_updated": "2023-02-21T20:07:38+00:00"
            }
          }
        },
        "predictive_analytics": {
          "historic_clv": 93.87,
          "predicted_clv": 27.24,
          "total_clv": 121.11,
          "historic_number_of_orders": 2,
          "predicted_number_of_orders": 0.54,
          "average_days_between_orders": 189,
          "average_order_value": 46.94,
          "churn_probability": 0.89,
          "expected_date_of_next_order": "2022-11-08T00:00:00"
        }
      },
      "links": {
        "self": "string"
      },
      "relationships": {
        "lists": {
          "links": {
            "self": "string",
            "related": "string"
          }
        },
        "segments": {
          "links": {
            "self": "string",
            "related": "string"
          }
        }
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

Metrics (v1/v2) -> Metrics (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
MetricsGet all metrics in an account.Get Metrics InfoMetricsGet all metrics in an account. Request specific fields with sparse fieldsets. Filter requests by specific fields, including integration.category and integration.nameGet Metrics

Version 2024-02-15 Mapping

{
  "data": [
    {
      "type": "metric",
      "id": "string",
      "attributes": {
        "name": "string",
        "created": "string",
        "updated": "string",
        "integration": {}
      },
      "links": {
        "self": "string"
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

Campaign Recipients (v1/v2) -> Campaign Recipients (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
Campaign RecipientsReturns summary information about email recipients for the campaign specified that includes each recipient’s email, customer ID, and status.Get Campaign RecipientsCampaign RecipientsGet the estimated recipient count for a campaign with the provided campaign ID.Get Campaign Recipient Estimation

Version 2024-02-15 Mapping

{
  "data": {
    "type": "campaign-recipient-estimation",
    "id": "string",
    "attributes": {
      "estimated_recipient_count": 0
    },
    "links": {
      "self": "string"
    }
  }
}

Profiles (v1/v2) -> Profiles (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
ProfilesGet all profiles in an account.Get ProfilesProfilesGet all profiles in an account.Get Profiles

Version 2024-02-15 Mapping

{
  "data": [
    {
      "type": "profile",
      "id": "01GDDKASAP8TKDDA2GRZDSVP4H",
      "attributes": {
        "email": "sarah.mason@klaviyo-demo.com",
        "phone_number": "+15005550006",
        "external_id": "63f64a2b-c6bf-40c7-b81f-bed08162edbe",
        "first_name": "Sarah",
        "last_name": "Mason",
        "organization": "Example Corporation",
        "title": "Regional Manager",
        "image": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
        "created": "2022-11-08T00:00:00",
        "updated": "2022-11-08T00:00:00",
        "last_event_date": "2022-11-08T00:00:00",
        "location": {
          "address1": "89 E 42nd St",
          "address2": "1st floor",
          "city": "New York",
          "country": "United States",
          "latitude": "string",
          "longitude": "string",
          "region": "NY",
          "zip": "10017",
          "timezone": "America/New_York",
          "ip": "127.0.0.1"
        },
        "properties": {
          "pseudonym": "Dr. Octopus"
        },
        "subscriptions": {
          "email": {
            "marketing": {
              "can_receive_email_marketing": true,
              "consent": "SUBSCRIBED",
              "consent_timestamp": "2023-02-21T20:07:38+00:00",
              "last_updated": "2023-02-21T20:07:38+00:00",
              "method": "PREFERENCE_PAGE",
              "method_detail": "Mydomain | Hosting, Domains, and Websites with Web.com ",
              "custom_method_detail": "marketing drive",
              "double_optin": "True",
              "suppression": [
                {
                  "reason": "HARD_BOUNCE",
                  "timestamp": "2023-02-21T20:07:38+00:00"
                }
              ],
              "list_suppressions": [
                {
                  "list_id": "Y6nRLr",
                  "reason": "USER_SUPPRESSED",
                  "timestamp": "2023-02-21T20:07:38+00:00"
                }
              ]
            }
          },
          "sms": {
            "marketing": {
              "can_receive_sms_marketing": true,
              "consent": "SUBSCRIBED",
              "consent_timestamp": "2023-02-21T20:07:38+00:00",
              "method": "TEXT",
              "method_detail": "JOIN",
              "last_updated": "2023-02-21T20:07:38+00:00"
            }
          }
        },
        "predictive_analytics": {
          "historic_clv": 93.87,
          "predicted_clv": 27.24,
          "total_clv": 121.11,
          "historic_number_of_orders": 2,
          "predicted_number_of_orders": 0.54,
          "average_days_between_orders": 189,
          "average_order_value": 46.94,
          "churn_probability": 0.89,
          "expected_date_of_next_order": "2022-11-08T00:00:00"
        }
      },
      "links": {
        "self": "string"
      },
      "relationships": {
        "lists": {
          "links": {
            "self": "string",
            "related": "string"
          }
        },
        "segments": {
          "links": {
            "self": "string",
            "related": "string"
          }
        }
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

Campaign Metrics (v1/v2) -> Metrics aggregates (v2024-02-15)

Legacy Klaviyo (v1/v2) Report NameDescriptionLegacy Klaviyo (v1/v2) EndpointKlaviyo (v2024-02-15) Report NameDescriptionKlaviyo (v2024-02-15) Endpoint
Campaign MetricsExports event data from Klaviyo, optionally filtering and segmenting on available event properties.Query Event DataMetrics aggregatesQuery and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events. Major bug fix for long-standing issue with dimensions with greater than 1000 values. Results can be filtered and grouped by time, event, or profile dimensions. Request specific fields using sparse field sets.Query Metric Aggregates

Version 2024-02-15 Mapping

{
  "data": {
    "type": "metric-aggregate",
    "id": "string",
    "attributes": {
      "dates": "2022-11-08T00:00:00",
      "data": [
        {
          "dimensions": [
            "string"
          ],
          "measurements": {}
        }
      ]
    },
    "links": {
      "self": "string"
    }
  }
}

Latest Reports in v2024-02-15

What Actions Should You Take?

Users must set up the new Klaviyo data source Rivers following the guidelines outlined in the Klaviyo v2024-02-15 documentation.
It is recommended to complete this migration as soon as possible to avoid disruption of services after June 30th, 2024.


Was this article helpful?