Jump to: navigation, search

Query identities

ApiRef2.png
GET /identities

Description

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

Operation

Method GET
URL /identities
Name   Value   Mandatory Description
URI Parameters
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_sessions
  • true
  • false
no If true, each returned identity contains the reference list of authentication sessions.
include_sessions_detail
  • true (if include_sessions=true)
  • false
no If true, each returned identity contains the associated authentication sessions. You can only use this parameter if include_sessions 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.

<references />

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 operation can return.

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

Example

Retrieving Identities with page IDs

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

GET /backend/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}]

category:Web Engagement History REST Reference

This page was last edited on February 15, 2013, at 16:01.

Feedback

Comment on this article:

blog comments powered by Disqus