Audit your Klaviyo API usage
Learn how to audit your API endpoint usage, so you can migrate to Klaviyo’s newest APIs.
Users of Klaviyo's v1/v2 APIs have until June 30, 2024 to migrate to our new APIs. At this time, our v1/v2 APIs will officially be retired. To learn more about Klaviyo’s API lifecycle, check out our API versioning and deprecation policy.
It is important to migrate to our new APIs before retired connections cause data failures in your account. It is best practice to connect your apps to the latest stable version of our APIs every 6-9 months. Migration to our newest APIs begins with auditing your endpoint usage to manage calls to our v1/v2 APIs.
To this end, you can download an API report, which is a CSV containing all v1/v2 API calls coming from your account.
You can also:
- Review private API keys and labels.
- Utilize Klaviyo’s API usage tools, such as the API activity dashboard.
- Check custom metrics and profile properties.
Use the API report
Download the report
Please note that the API report CSV only contains v1/v2 API usage data. Data refreshes once every 24 hours and looks back 14 days.
From the Developer tools dashboard, locate the Audit API Endpoints section.
Click Export API Report to begin exporting your API usage data. Depending on the quantity of API usage data in your account, the download may take several minutes. When the export completes, the CSV file will have the following name format: privatekey_yyyy_mm_dd.csv
Included fields
| Field name | Description |
|---|---|
| HTTP Method | The HTTP method of the call (e.g., GET, POST, PATCH) |
| Deprecated Endpoint URL | URL of the legacy endpoint |
| Company ID / Public API Key | Public API key used to make the request |
| Private API Key | Private API key used to make the request |
| Key Label | Any labels attached to the request |
| Key Created Date | Date the request was created |
| Key Scopes | Scopes that the private API key can call to make the request |
| Key Access Level | Level of permissions used by your scopes (e.g., read, write, full) |
| Most Recent Request Timestamp | Timestamp of the most recent request in UNIX |
| Number of Requests | Quantity of API requests made |
| Legacy Endpoint Docs | Link to the URL of the legacy endpoint used |
| Docs for New Equivalent Endpoints | Link to the URL of the equivalent new endpoint that should be used |
| Namespace | Relevant namespace for the endpoint used in the request |
| Private Key Auth | Auth headers used to make the request |
| Report Time Range Start | Starting date range of the audit report |
| Report Time Range End | Ending date range of the audit report |
| Report Download Timestamp | Time and date when the report was downloaded |
Review private API keys and labels
Reviewing your account’s private API keys page can provide insight into where your API calls are being made. Work backwards with private API keys and labels to check your codebases for active v1/v2 API usage.
Utilize Klaviyo’s API usage tools
To view endpoints currently being used to access your account(s), use our tools for monitoring API usage. You can monitor recent activity with the API activity dashboard and view recent API requests in the API call log.
Check custom metrics and profile properties
Within the Metrics tab, you can filter by API using the dropdown. In the Profiles tab, you can check for custom profile properties. Audit how this data enters your system to determine whether or not you use legacy v1/v2 endpoints.
You might be currently using our klaviyo object to capture certain metrics such as Active on Site, Viewed Product, Added to Cart, Started Checkout, or more. Calls from the klaviyo object are being migrated under the hood and will continue to be supported in the future.
You may have additional metric types depending on how you have set up your custom integration. Be sure to audit your accounts so you know what metrics are coming from our klaviyo object vs direct API calls. Calls made directly from our APIs will need to be migrated.
Migrate from v1/v2 to our new APIs
Once you have audited your API endpoint usage, you can migrate to our new APIs. Check out a full list of our top migration resources.
Additional resources
Updated about 1 year ago