Monitor your app

Learn how to understand the performance and health of your OAuth app in Klaviyo using our API activity chart. Additionally, learn how to review API logs for your app in order to troubleshoot customer errors.

🚧

Note

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

API activity chart

The API activity chart allows you to monitor high-level usage trends and stay informed about any ongoing issues. To access the chart, navigate to the app management page and select the Insights tab.

This chart displays aggregate metrics for all accounts that have installed your app.

On the chart, you’ll see the following:

• Total calls
  The total number of API calls made from your account with the given filter criteria.

• Error rate
  The rate of errored calls out of total calls made.

• Errors
  The total number of error statuses for API calls made from your account.

Filter criteria

The API activity dashboard 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

Logs

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.

To access logs, navigate to the app management page, select the Insights tab, then select Logs. In the Logs page, you can:

• Filter on account public API key(s), method(s), status code(s), API revision(s), date, or various ID fields.
• Search by endpoint.
• View the full request and response for each individual API call. To do this, click its corresponding link under the Date column.View details.

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.