Browsee
  • Getting Started
    • How to use Browsee on Shopify Store?
    • Shopify Stores
  • Integration
    • Snippet Integration
      • Direct JS Integration
      • GTM Integration
      • SDK Integration
      • Wordpress Integration
      • Shopify Integration
      • Troubleshooting Integration
    • Managing Recordings
    • API Calls
      • Log Event Call
      • Identify Call
      • Session Url
      • Generate Secret Key
      • Data Export API
      • Track HTTP API
      • Identify HTTP API
  • Understand Your Users
    • Session Search
      • Date Range
      • User Actions
      • User Attributes
      • Session Tags
        • Network Errors and Slowness
        • Javascript (JS) Errors
        • Frustration Clicks or Rage Clicks
        • Broken Links
        • U Turn
        • Searching For Something
        • Going in Circles
        • High Engagement
        • High Input Time
        • Repeat Pages
        • Repeat Events
      • Regular Expression Search
    • Segments
    • Segment Analytics and Alerts
    • Subscribe to a Segment
    • Configure Dashboard
    • Session Replays - Save, Share, and Delete
    • User Experience Issues
  • Heatmaps
    • Heatmaps
    • Create Heatmaps
    • Compare Heatmaps Across Date Ranges
    • Segmentation in Heatmaps
    • Heatmap Sessions
    • Dynamic Heatmaps
  • Funnels
    • Creating Funnels
    • Funnel Analytics and Alerts
  • FAQ
    • Frequently Asked Questions
    • FAQ - Browsee Installation
    • FAQ - Account and Project
    • FAQ - Session Recordings
    • FAQ - Heatmaps
    • FAQ - Payment & Plans
  • Project
    • Add User
    • Add Project
    • Setting Up SSO Login
    • Third Party Integrations
    • Content Security Policies
  • Plans and Billing
    • Recording and Sampling
  • Data Privacy
    • Privacy
    • Do Not Track Settings
    • Link Browsee with your Privacy Policy
    • GDPR Compliance
  • Feedback & Popups
    • Creating Notifications
    • When to Show
    • Where to Show
    • Advanced Targeting
    • Feedback Widget
    • Integrations
  • Request A Feature
    • Request a New Feature
Powered by GitBook
On this page
  • Identify API
  • identify
  • Using the identify API

Was this helpful?

  1. Integration
  2. API Calls

Identify HTTP API

You can use Browsee's HTTP Identify API to send useful information about a user from other platforms like your mobile app or application server.

PreviousTrack HTTP APINextSession Search

Last updated 4 years ago

Was this helpful?

This API can be used in tandem with , to send extra information about a user like its tags, location etc.

Similar, to the Track API, you will need your project API key. This key is available on your Project's . To learn more about how to get this KEY .

Identify API

identify

POST https://api.browsee.io/api/v1/identify

An API to send custom information about a user

Request Body

Name
Type
Description

apiKey

string

Your Project's API Key

userId

string

A unique identifier of the user in your database. At least one of userId or anonymousId is required.

traits

object

JSON Dictionary Object of the traits to assign users like name, email and others. See below for special keys and examples.

anonymousId

string

This is an identifier that can be sent to tie a series of events and the information sent in this identify call to a certain user and a session. In case you are sending userId, this is not required, otherwise, it is required

timestamp

string

Timestamp of the event in ISO-8601 format date string "2021-12-02T00:30:08.276Z". If not provided we assume the time of receipt.

{
    "status": "success"
}
{
    "status": "failure",
    "message": <Problem in request parameters>
}

Using the identify API

You can send any information in the traits object like

{
 name: 'Jon Snow',
 email: 'knowsnothing@gmail.com',
 location: 'Castle Black'
}
  • Some keys like name, email, phone and $tags are special keys. When you send them in an identify call, you can see them on the right hand side of a session panel and search for the session using these keys from session search.

  • $tags.can be used to assign free from text labels to sessions. These can then be searched back in session search.

{'$tags': ["Logged In", "Cohort 78435"]}
Track HTTP API
settings page
Easily search for sessions with name, email and tags
see