API Error Tracking and Insightech

Shivam Bhonsle Updated by Shivam Bhonsle

API errors happen when there are discrepancies or inaccuracies that occur between your website and API endpoints from different platforms that your website talks to (For example - Shopify, BigCommerce). 

Insightech allows you to track these API errors to see how often they occur, the types of errors that happen, and what their impacts are on your users and website performance.

Types of API Errors you might see on your Website

API errors often cause friction at key parts of your website and customer journeys.This might include: 

  • Blank pages or content not loading
  • Broken features (e.g. links, CTAs, buttons) 
  • Error messages or responses
  • Broken forms 
  • Checkout issues

How to Find API Errors on Insightech

Insightech captures any errors so you can generate metrics, filter these issues and watch sessions about how these users behave on your website. There are three ways to find API errors on the platform:

Search for Sessions with API Errors:

  1. Navigate to Dashboards → Replays → Filter
  2. Select the API Error → Anything
  3. Click Apply

Insightech will retroactively generate a list of all the sessions that contain API errors on your website. Use this to anaylse what parts of your website are experience issues or bugs.

See API Errors in Event List

  1. Navigate to Dashboards → Replays
  2. Select a Replay → Event
  3. Click the API Error checkbox

Insightech will display all the API errors associated in session replay.

How to Segment API Errors on Insightech 

There are five different ways you can filter API website errors through Insightech:

API Error Methods
These are errors that exist when an API request to your website fails. This causes different bugs and broken features across your website.

Insightech tracks users that fail to perform a specific action on your website because of an API error. Use this filter condition to view sessions and improve your customer journey.
API Status Code
This segment tracks a specific status code API error on your website. For example,

#1 - 404 (Status Code) - Page Not Found
#2 - 500 (Status Code) - Internal Server Error.

Use this condition to view all the users that experience these types of errors on your website.
API JSON Path Payload
Your website’s JSON path exists ‘behind-the-scenes’ of your website. Your JSON will generate code based on any API errors that happen on your website.

Insightech will track API errors through the JSON path to identiy the underlying causes for any broken features on your website.
API Error String Payload
If a user experiences an API error, your website may display an error message in plain english. For example,

#1 - "Oops! Something went wrong. Please try again later."
#2 - "Your username or password is incorrect. Please check and try again"

Insigtech retroactively tracks these users. Use this filter condition to find sessions where users directly interact with API error messages on your website
Typical API error messages include a link to more information about the cause of the issue. Insightech tracks this URL as this reflects a specific type of API issue.

Segment sessions by this condition to delve deeper and understand the cause of these issues for you to solve the error.

With Insightech, you should now be able to track and filter API errors on your website. 

How did we do?

Setup API Error Tracking