This endpoint gives you access to the powerful search and filtering abilities of People CRM.

Filters

You can filter the list of returned People using the filters parameter, giving you the ability to fine-tune your query based on the rich tracking information stored in GoSquared.

Results can be filtered on events (see Event Types) or properties (see Property Types).

The filters parameter can be complex so we advise that you look at an existing Smart Group to begin with to see how your pre-existing Smart Groups filter results. Using the Query Builder on the right you can graphically build up a filters object using any combination of filters. You can then see the Example Request below with the generated json query.

For reference, when using filters key will be element you are filtering on, either a property or event. Path will be the specific property or event you are filtering on, for example for a property that could be 'email'. Operator will be the notation or criteria for that path, such as 'contains'. Value will be the specific value of that path you are filtering on.

For example, if wanted to build a filter for any users with an email containing 'GoSquared', it would be as follows:

key: 'property'

path: 'email'

operator: 'contains'

value: 'GoSquared'

Retrieve a single profile from People CRM by its person_id. This will return a list of all the properties that have been set on the profile.

Delete a single profile from People CRM by its person_id. This will delete the profile and all its associated data. If this person is subsequently tracked again in the future, a new blank profile will be created for them, unless you use the blacklist parameter.

This endpoint requires an API key with Write People permission.

Note: This action is irreversible – deleted data cannot be recovered.

Retrieves a paginated list of devices that a specific person has used. The devices are returned in chronological order based on when the device was last used (sorted newest to oldest).

Retrieves a list of tracked events associated with a Person in reverse chronological order. This list can be filtered based on the type for events, which are events that you have tracked, and sessionEvents - GoSquared tracking events such as pageviews and session beginning and endings. You can also specify a date range to filter for.

The query parameter allows you to search through a Person's event history based on the name of the event