As of Friday October 16th, access to restricted content on this site now requires you to log in with your Genesys account. If you don't have an account, you can request one at these locations: Request MyPartner Portal Account or Request My Support Account.
Jump to: navigation, search

History REST API

The Web Engagement History REST API reference lists all the RESTful elements that you can use to access the web history stored by the Genesys Web Engagement Server.

Resource Access Template

To access resources, you must respect the following syntax:

Method <schema>://<server>:<port>/server/data/<resourceName>[/<resourceId>[/<sub-resourceName>]]
  • <method> is GET or POST.
  • <schema> is http or https.
  • <server> is the hostname or the IP address of the Web Engagement Server.
  • <port> is the port of the Web Engagement Server.
  • <resourceName> is the name of the requested resource.
  • <resourceId> is the identifier of the requested resource.
  • <sub-resourceName> is the name of a sub-resource.

For instance, to retrieve the list of identities on MyHostname, you can use the following request:

GET http://MyHostname:9081/server/data/identities

To retrieve a given identity, you need its identifier:

GET http://MyHostname:9081/server/data/identities/

To retrieve the pages of user, you can use the following request:

GET http://MyHostname:9081/server/data/identities/


The History REST API contains the following resources:

Note that each resource chapter lists all the operations available with the resource's path, not all the operations related to the resource. For instance, the Event Resource chapter lists all the methods associated with the server/data/events/ path. Additional methods to retrieve events for a given identity are available in the Identity Resource chapter. You can also use the Operations Index to get the complete list of available operations.

This page was last edited on March 10, 2020, at 13:56.


Comment on this article:

blog comments powered by Disqus