Quickstart

Getting started with Attuitive.

Create an API key

To get started you will need an API key to authenticate any requests you make to Attuitive.

Start by navigating to Settings > API Keys in the Attuitive Console, and create new API key.

Use the Create new API key button in the top right.

Add your first user

With an API key ready to go you can begin to identify your users. You can do this via a POST request to the Identify endpoint, replacing <API_KEY> with your API key value:

curl -X POST https://api.attuitive.com/api/v1/identify \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_KEY>" \
  -d '{
    "identifiers": {
      "email": "jane.doe@example.com",
      "fullName": "Jane Doe"
    },
    "traits": {
      "plan": "Pro",
      "signupDate": "2025-04-10"
    }
  }'

The example provided uses Curl as a basic example to get started quickly. The Attuitive API is HTTP driven so you can also use it from your language of choice such as JavaScript, Python, Rust.

This will create your first user. If you navigate to Users > Overview on the Console you will now see this user appear along with updated statistics. Every user is assigned a unique ID beginning with usr_ which will also have been returned in the Curl request you made.

Check out the documentation on the Identify endpoint for more details.

The user is visible within the users page.

Record something about your user

Notice how in our initial request we included a traits object containing some attributes about our user?

When identifying new users you can do this if you already have known information about them you wish to store. This saves you needing to make an additional API request to the Track endpoint.

If you have an existing user and want to update or record a new attribute you will use this endpoint. Let's do this now with the user we identified above.

Start by getting the unique ID of the user beginning with usr_. You can do this via the Console, or from the body of the response from the Curl request we made.

We'll now make a POST request to the Track endpoint. Make sure to replace <API_KEY> and <USER_ID> with the collected values.

curl -X POST https://api.attuitive.com/api/v1/track/<USER_ID> \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "traits": {
      "churnRisk": "low",
      "plan": "Enterprise"
    }
  }'

You have just updated the traits of your user. The updated user is returned in the Curl request or you can refresh the Console and view them there.

The request did two things:

  • A new trait churnRisk was added.

  • The existing trait plan was updated from "Pro" to "Enterprise".

On the traits in the returned Curl request, or on the Console, notice that signupDate is still present. Traits are always merged with existing traits so you don't need to worry about existing values being cleared when sending updates.

Check out the documentation on the Track endpoint for more details.

Unsure about Identifiers & Traits? See the explanation here.

The user's traits have been updated.
PreviousWelcomeNextWorkspaces

Last updated