Welcome to the Kuoll API

These docs describe how to install and use Kuoll.

Step 1: Add Script to a Web App

Copy and paste the code below to the bottom of web pages of your web application. In some rare occasion you will need to debug the process of loading

  1. First, install Kuoll NPM module:
    npm install kuoll
  2. Then add start record call into your code:

    This code includes your unique Kuoll API key, and should be copied directly into your code.

    startRecord parameters

    kuoll("startRecord", params) creates new or continues existing record. Most popular parameters are listed below.

    Parameter Default Description
    API_KEY "" API key of your Kuoll account. Required.
    userId "1" User id in your system, searchable from Records page.
    userEmail "" User email, searchable from Records page.
    ignoreUrls [""] XHR requests to ignoreUrls URL patterns will be ignored.
    notes "" User-provided notes. Might be a text of problem description
    createIssueOn {"error": true, "consoleError": true, "serverError": true} Create issue (and persist current record) on JavaScript Error, console.error logging, server XHR 4XX and 5XX response.
    saveStaticResources false Save a copy of js and css files with a record. Might affect network performance.
    localRecording true Defer saving record on server until createIssue called.

    Here your can find complete Kuoll API module documentation.

    Step 2: (Optional) Save Record on User Support Requests

    On user support request please call kuoll("createIssue", ..). createIssue method saves debuggable current user session to server and creates a new issue entry. The default duration of a recorded user session is 3 minutes.

    Kuoll script also creates issues on JavaScript exceptions (Errors), when server XHR returns error reply (HTTP status 4xx or 5xx) and when your web app is logging using the console.error method.
    You can control it with createIssueOn parameter of kuoll('createIssue', {createIssueOn:{...}}. Find detailed description is the table above.

    Connect your Slack account to get new issues notifications. Find a list of created issues here.

    Congratulations! Inspect Recorded Bugs Reports

    Your first record appeared on the issues page. You can also connect with the Slack channel for notifications of new issues.

    Sign up & get API key or try jsbin sandbox app