Monitor your app

Learn how to monitor both the technical health of your OAuth app’s API usage and its business performance metrics within the Klaviyo App Marketplace. Additionally, learn how to review API logs for your app in order to troubleshoot customer errors.

You can access all monitoring tools through the Insights tab on your app management page.

🚧

Note

The app monitoring feature is only available if multi-factor authentication (MFA) is required for all users on the account

Overview Tab

The main Insights tab summarizes your app's key performance metrics from the Marketplace and API usage, including:

• App performance
  • Summary of listing page views, installs and uninstalls
• Accounts
  • How many active accounts have your app installed
• API activity
  • Recent request activity
• API usage
  • Breakdown of which endpoint(s) if any have a high error rate
• API revisions
  • Whether your app is calling any retired or deprecated API revisions

API filter criteria

The API activity, usage and revisions can be filtered by account public API key, endpoint, status, and time period. If no available data matches the given criteria, the dashboard will display No Data Available. To reset your filter criteria to the default values, click Clear.

Account public API key

The Klaviyo public API key of the account making the call.

Endpoint

Results can be filtered by any endpoint.

Status

Results can be filtered by the status of your API calls. For more information about what each code indicates and how to resolve errors, refer to the status codes and errors guide.

• All statuses (default)
• All success codes
  • 200 - OK
  • 201 - Created
  • 202 - Accepted
  • 204 - No content
• All failed codes
• All 4xx codes
  • 400 - Bad request
  • 401 - Not authorized
  • 403 - Forbidden
  • 404 - Not found
  • 422 - Unprocessable entity
  • 429 - Rate limit
• All 5xx codes
  • 500 - Server error
  • 502 - Service unavailable

Date

Results can be filtered by the following time periods, based on your account’s current time zone:

• Today (default)
• Last 3 hours
• Last 24 hours
• Last 3 days
• Last 7 days
• Last 30 days
• Last 90 days

Performance Tab

The Performance tab provides in-depth metrics and trends on your app listing's performance.

App page views

This chart tracks the total number of times your app's listing page was viewed within the Klaviyo App Marketplace over the selected time period. Use this data to measure the top-of-funnel interest and visibility of your app. Monitoring the trend helps you assess the effectiveness of your listing content, search optimization, and any external marketing efforts driving traffic to the Marketplace.

Installs and uninstalls

This chart displays the number of installs and uninstalls over the selected time period. Installs reflect the rate of adoption and new customer acquisition, while Uninstalls represent churn. By viewing these metrics together, you can quickly analyze the net growth of your active customer base. Use this chart to correlate product updates, bug fixes, or customer support initiatives with changes in churn rate, and to identify the success rate of acquisition campaigns.

Filter criteria

The Performance tab can be filtered by date range and comparison range.

Date range

Results can be filtered by the following time periods, based on your account’s current time zone:

• Last 7 days
• Last 30 days (default)
• Last 90 days
• Year-to-date
• All time
• Custom

Comparison range

Results can be compared against the following time periods, based on your account’s current time zone:

• Previous period (default)
• Previous year
• Custom

Logs Tab

Our API logs tool displays aggregate metrics at the application level (as opposed to the account level).

📘

Data retention

The API logs tool retains 14 days worth of API logs. API logs past this date will be unavailable, although the high-level aggregate information will continue to be stored in the API activity dashboard.

In the Logs page, you can view the full request and response for each individual API call. To do this, click its corresponding link under the Date column.

Filter criteria

The API logs can be filtered by account public API key(s), method(s), status code(s), API revision(s), date, and additional ID fields.

Account public API key

The account public API key of the account making the call.

Method

Filter your results by the HTTP method used to make the request:

• GET
• POST
• PUT
• PATCH
• DELETE

Status code

Results can be filtered by API call status. For more information about what each code indicates and how to resolve errors, refer to the status codes and errors guide.

• All success codes
  • 200 - OK
  • 201 - Created
  • 202 - Accepted
  • 204 - No content
• All failed codes
• All 4xx codes
  • 400 - Bad request
  • 401 - Not authorized
  • 403 - Forbidden
  • 404 - Not found
  • 422 - Unprocessable entity
  • 429 - Rate limit
• All 5xx codes
  • 500 - Server error
  • 502 - Service unavailable

API revision

Search for requests made using a specific API revision.

Date

Results can be filtered by the following time periods, based on your account’s current time zone:

• Today (default)
• Last 3 hours
• Last 24 hours
• Last 3 days
• Last 7 days
• Last 30 days
• Last 90 days
• Custom

ID

Search by various identifiers such as call ID, error ID, async job ID, resource ID, metrics, and more.

Accounts Tab

The Accounts tab provides a full list of all active accounts with your app currently installed.

The information displayed for each active account includes:

• Klaviyo Account Name
• Klaviyo Account ID
• Klaviyo Install Date/Time