API elements

API elements are designed to provide a unique structure to describe APIs across all API description and serialization formats.

Data collection API endpoints

Endpoint	Usage	Events Generated
startSession	This endpoint is called when a new user session begins on the client application.	Always fires a conversionFunnel.eligible event
customEvent	This endpoint is called when any relevant event fires on the client application.	The list of relevant events should be defined in the program definition.
conversion	This endpoint is called when a conversion event takes place in the client application.	Always fires a conversionFunnel.conversion event.
exposed	This endpoint is called when a new Nuance engagement launches in the client application.	Always fires a conversionFunnel.exposed event.
logEvent	This endpoint is used to log custom NDEP event, but it supports only all existing events.	Event provided in a request

Business rule collection endpoint

Endpoint	Usage	Events Generated
recommendation	This endpoint requests a business rule recommendation from the client app for the current customer.	Fires a conversionFunnel.targeted event if all conditions are met for one or more business rules (SSVP-59). See also ssbr30.xsd for possible values.

Data collection attributes

Data collection attributes can be passed with each endpoint.

Attribute Type	Name/Value Pairs	Parameter
Session Attributes	Name / value pairs associated with the client session.	Attributes are collected by the sessionID parameter.
Business Rule Attributes	Name / value pairs associated with the business rule.	Can only be passed with the Recommendation Endpoint.
Custom Variables	Name / value pairs containing information that should be persisted.
Engagement Attributes	Name / value pairs associated with the engagement.	Attributes are collected by the engagementID parameter.
Visitor Attributes	Name / value pairs associated with the user / visitor.	Attributes are collected by the customerID parameter.

Configuring attributes

All attributes need to be configured within the database to be used.

Attribute	Usage
siteID	only client with this site can use this attribute
attributeName	only this attribute name can be used
attributeType	only this attribute type is supported
externalCustomerID	can be used only for visitor attributes

Custom variables

Custom variables can be written into the visitor profile. They are used for targeting purposes but they are not available for reporting. When you pass a custom variable, you must specify the variable’s lifespan persistence. Persistence option values are volatile and persistent.