Jump to: navigation, search

Query identities by visit

Description

This method retrieves a list of identities for the given visit ID.

Request

Method GET
URL /visits/${visitId}/identities
Parameters
Name   Value   Mandatory Description
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 sessions.
include_sessions_detail
  • true (if include_sessions=true)
  • false
no If true, each returned identity contains the associated 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.
association
  • "Authenticated" 
  • "Recognized"
no Defines the type of association between the current visit and the returned identity.

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

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on November 6, 2015, at 12:00.