Sherlock

The Sherlock Developer Hub

Welcome to the Sherlock developer hub. You'll find comprehensive guides and documentation to help you start working with Sherlock as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Started with Sherlock

Read below for an overview of the Sherlock API and tracking script.

The Sherlock Javascript tracking script and REST API can be used to send product engagement data to your Sherlock account.

Prerequisite

In order to use this API, you must have an active Sherlock account and custom API key.

The 3 main calls

The API and tracking script has three main calls. They include:

IDENTIFY CALL
The .identify call is used to identify your users and assign specific user traits.

GROUP CALL
The .group call is used to assign users to specific accounts and to create account-level traits.

TRACK CALL
The .track call is used to record specific user actions (ie - events).

Updated 8 months ago

Getting Started with Sherlock


Read below for an overview of the Sherlock API and tracking script.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.