Query identities

Description

This method retrieves a list of identities. By default, only the identities are returned: the associated visits, events, and pages are not included in the results.

Request

Method	GET
URL	/identities
Parameters
Name	Value	Mandatory	Description
location	string	no	Filters the identity results based on the given geolocation parameter.
userAgent	string	no	Returns identities with an exact match for the UserAgent attribute.
include_visits	true false	no	If true, each returned identity contains the reference list of associated visits.
include_visits_detail	true (if include_visits=true) false	no	If true, each returned identity contains the associated visits resources. You can only use this parameter if include_visits is set to true.
include_pages	true false	no	If true, each returned identity contains the reference list of the associated pages.
include_pages_detail	true (if include_pages=true) false	no	If true, each returned identity contains the associated pages. You can only use this parameter if include_pages is set to true.
include_events	true false	no	If true, each returned identity contains the reference list of associated events.
include_events_detail	true (if include_events=true) false	no	If true,  each returned identity contains the associated events.You can only use this parameter if include_events is set to true.

Response

The History REST API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTP Response Codes and Errors for further details on the possible codes that this request can return.

HTTP code	200
HTTP Title	OK
Body	JSON array of Identity.

Example

Retrieving Identities with page IDs

The following request retrieves all the identities available, including the associated page IDs.

Request

http://127.0.0.1:9081/server/data/identities?include_pages=true

Response

HTTP/1.1 200 OK
Date: Wed, 12 Dec 2012 15:28:13 GMT
Content-Type: application/json; charset=UTF-8
Date: Wed, 12 Dec 2012 15:28:13 GMT
Accept-Ranges: bytes
Server: Restlet-Framework/2.1.0
Content-Length: 627
[{"eventIds":null,"events":null,
"pageIds":["11ff6de0-446e-11e2-bfd2-00505625a04f"],
"pages":null,"sessionIds":null,"sessions":null,"
identityId":"pat.thompsom@genesyslab.com",
"name":null,"location":null,"entityInCS":null,
"visitScope":"Authenticated","visitIds":null,
"visits":null},
{"eventIds":null,"events":null,
"pageIds":["45f0eda1-3fa4-11e2-aee5-00505625a04f","c489cac0-3fa3-11e2-aee5-00505625a04f",
"06afd7f0-3fa4-11e2-aee50505625a04f"],"pages":null,"sessionIds":null,
"sessions":null,"identityId":"user@genesyslab.com",
"name":null,"location":null,"entityInCS":null,"visitScope":"Authenticated",
"visitIds":null,"visits":null}]