How to Use Zipy

Getting started with Zipy

In this guide, you'll learn how to set up Zipy for error tracking, enabling you to capture user sessions and diagnose issues effectively. You'll be ready to track down bugs in your applications within minutes.

Step 1: Sign up and set up

1. Go to Zipy’s website.
2. Click on the “Get Started” button on the homepage.
3. Fill in your details to create an account. You can use your email or sign up via Google.
4. Once registered, log in to your new account.
5. Follow the on-screen instructions to add your application. You’ll receive a unique project key for integration.

Step 2: Your first error tracking session

1. Install the Zipy SDK in your application. Depending on your tech stack, follow the provided integration guide.
2. For JavaScript, run the following command in your terminal:

npm install @zipy/sdk

1. In your application’s main file, import and initialise Zipy:

import Zipy from '@zipy/sdk';
   Zipy.init('YOUR_PROJECT_KEY');

1. Trigger an error in your application (e.g., throw a new Error in your code).
2. Go back to your Zipy dashboard. Click on the “Errors” tab on the left menu. You should see the error you triggered along with session details.

Step 3: Get better results

1. Use the filters in the “Errors” tab to sort by severity or frequency to focus on critical issues.
2. Click on an error to view the session replay. This will show you the user actions leading to the error.
3. Take advantage of the “Logs” section to see detailed error messages and stack traces that can help in debugging.
4. Set up notifications for critical errors by going to “Settings” > “Notifications” and selecting your preferred method (email, Slack, etc.).

Pro tip

Regularly check the “Insights” tab to get an overview of recurring issues. This can help you prioritise fixes and improve your application over time.

Common mistake to avoid

Many users forget to properly initialise the Zipy SDK in their applications. Make sure you place the initialisation code at the top of your main application file to capture all errors effectively.