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.

This API can be used in tandem with Track HTTP API, 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 settings page. To learn more about how to get this KEY see.

Identify API
post
identify
https://api.browsee.io/api/v1/identify
An API to send custom information about a user
Request
Response
Request
Body Parameters
apiKey
required
string
Your Project's API Key
userId
required
string
A unique identifier of the user in your database. At least one of userId or anonymousId is required.
traits
optional
object
JSON Dictionary Object of the traits to assign users like name, email and others. See below for special keys and examples.
anonymousId
optional
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
optional
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.
Response
200: OK
When data is successfully received
{
    "status": "success"
}
400: Bad Request
{
    "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: '[email protected]',
 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.
Easily search for sessions with name, email and tags
$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

Next - Integration

Managing Recordings

Last updated 3 months ago

Identify HTTP API

Identify API

postidentify

Using the identify API

post
identify