Quickstart
Getting started with Attuitive.
Last updated
Getting started with Attuitive.
Last updated
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 , and create new API key.
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.
Notice how in our initial request we included a traits
object containing some attributes about our user?
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.
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.
With an API key ready to go you can begin to identify your users. You can do this via a POST
request to the endpoint, replacing <API_KEY>
with your API key value:
The example provided uses 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.
Check out the documentation on the for more details.
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 endpoint.
We'll now make a POST
request to the endpoint. Make sure to replace <API_KEY>
and <USER_ID>
with the collected values.
Check out the documentation on the for more details.
Unsure about Identifiers & Traits? .