Properties

Track some properties

POSTtracking/properties

Properties are an excellent way of getting to know your users. They contain user information and state.

All properties can be used to search, filter and sort your users in People CRM. The more you track, the better you can understand your users.

GoSquared defines a list of common properties that are useful to track. Some of these special properties are used by GoSquared to provide powerful functionality. For example, email is used to look up additional information about an individual from publicly available sources.

Custom properties

Besides special properties, you can track any property of any data type and GoSquared will make that data searchable, sortable and filterable. Place your custom properties under the custom property.

People CRM needs to know about what kind of data each custom property contains – whether the property is text, a number, or a date etc. Therefore, when you track a custom property, it is automatically assigned a “type” based on the value you send. We can can then make sure the data is searched, sorted and filtered in the correct way for that data. Possible types are Text, Number, Date, Boolean and Null.

For example, if you send a subscription_created property with a value like 2015-03-03T15:00:00+00:00, it will be assigned the Date type. Alternatively, if you send a subscription_value property with a value like 49.99, it will be assigned the Number type. Date detection is fairly lenient, so long as it resembles at least a portion of an ISO 8601 string.

People CRM will always try its best to figure out the most appropriate type for your custom properties. Sometimes it’s not always possible to get it exactly right, such as if you send a numeric Unix timestamp and want it treated as a date. In those cases, you can manually correct the property type in your Project Settings.

Once a custom property is tracked, it will appear in the custom properties list in the People section of Project Settings. There, you can manually change the type of the custom property. This might be necessary if you track a custom property with the wrong data, or if you wish to change what the custom property is used for.

How many different custom properties can I track?

Each GoSquared project can track up to 1000 custom properties. Above this limit, properties with new names will be ignored in that project.

POST Body

person_id

String

The People person ID that this action is associated with.

If the identifier used is an email it should be prefixed with email: like this: email:jon@example.com

visitor_id

String

The anonymous visitor ID that this action is associated with.

properties

Object

email

String

name

String

first_name

String

last_name

String

username

String

avatar

String

URL of an avatar image for this person. Defaults to the Gravatar for the email

description

String

Bio of this person. Will be filled in automatically from social data if available

phone

String

created_at

String

A valid ISO 8601 timestamp of when this user was created. When the user is being identified for the first time, this defaults to the current timestamp

company

Object

name

String

size

Number

industry

String

position

String

custom

Object

Any custom properties associated with this person

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

POST https://api.gosquared.com/tracking/v1/properties

Example Request

curl -X POST -H "Content-Type: application/json" \
  "https://api.gosquared.com/tracking/v1/properties?api_key=demo&site_token=GSN-106863-S" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint