Identify

The identify endpoint is an optional endpoint that lets you add important properties to a user's profile as key-value pairs. Doing this can give you a more complete understanding of the user at a glance. Plus, these properties can be useful for finding, sorting, and grouping users.

For example, you might add a user’s email address, membership level, or last login date to their profile. Then, you can use these details to find all users with a specific membership or other criteria.

SaasHound Events

Endpoint Url

POST
https://api.saashound.co/identify

This endpoint allows you to send log events to SaasHound.

Request Headers

Parameter Type Description Required
Content-Type * string application/json Required
Authorization * string Bearer <TOKEN> Required

Request Params

Parameter Type Description Required
project string The project associated with the metric Optional
userId string A unique identifier for the user Optional
properties Record<string, any> Additional properties to be stored with the identified user Optional

Response

{
success: true,
statusCode: 200,
}

Example Code

Terminal window
curl --location --request POST 'https://api.saashound.com/identify' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"project": "my-project",
"userId": "user-1254",
"properties": { "city": "San Francisco", "state": "CA" }
}'