Using Traces

The traces REST API provides a generic traceability mechanism regardless of the type of action or platform where it occurs. To accomplish this goal, it is channel-agnostic, meaning it does not rely on any platform-specific session identifiers (cookies, for example). Thus, each user is responsible for ensuring the persistence and association of such information.

For use cases where session identifiers are available (web browsers, for example), Prisma Campaigns recommends using the existing native SDK.

What is a trace?

Customers engage with Prisma Campaigns in different sessions called visits or trails. A trace is a method to group those visits. The most frequent use case consists of a prospective client interacting several times with different sections of the website, mobile app, or another channel. Prisma Campaigns creates a new trace the first time a user launches the application, or when they close a previous one (perhaps because he/she has already converted to another promotion).

The posted information is an EDN or JSON object with two fields (both optional):

data = {
   :app-token "D17C100F-0668-400A-AF91-967FE1A09A9E"
   :customer-id "5114932"
}

data = {
   "app-token": "D17C100F-0668-400A-AF91-967FE1A09A9E",
   "customer-id": "5114932"
}

If the person interacting with the application is not known, the customer-id field can be empty. In that case, the system will create an anonymous client for that interaction. The response is also an EDN or JSON object with a trace identifier, which will be used during subsequent visits to keep it linked. In case the trace is generated with an anonymous client ID, the API will return it as part of the output.

response = {
   :trace-id "D17C100F-0668-400A-AF91-967FE1A09A9E"
   :customer-id "5114932"
}

The result is defined by one of the following HTTP status codes:

Visits

Prisma Campaigns will generate a new trail whenever a user visits the web site, opens the mobile application or interacts with any other alternative channel:

The posted information is an EDN or JSON object with three fields where two (platform and language) are optional:

data = {
    :language "en-US"
    :platform "Chrome Browser"
    :channel: "atm"
}

data = {
    "language": "en-US",
    "platform": "Chrome Browser",
    "channel": "atm"
}

The response is also an EDN or JSON object that includes a trail ID:

response = {
 :trail-id "D17C100F-0668-400A-AF91-967FE1A09A9E"
}

response = {
 "trail-id": "D17C100F-0668-400A-AF91-967FE1A09A9E"
}

The result is defined by one of the following HTTP status codes:

Activity

The following table lists the different activities that can be done during a visit:

The actual execution is carried out through an API action:

data = {
 :name "conversion"
 :type :trail-action/conversion
 :data [{:name "field1"
         :value "value1"}
        {:name "field2"
         :value "value2"}]
}

data = {
 "name": "conversion",
 "type": "conversion",
 "data": [{"name": "field1",
         "value": "value1"},
        {"name": "field2"
         "value": "value2"}]
}

The result is defined by one of the following HTTP status codes:

Conversion and No interest

By using the action API, it is possible to indicate when a client converts or if he/she is not interested in a campaign. Each action has a corresponding type, and the only required parameter is tracking-token (obtained previously in the channel).

For EDN, the following information is sent along with the action:

Example 1 (conversion):

data = {
    :name "conversion"
    :type :trail-action/conversion
    :data [{:name "tracking-token"
          :value "value"}]
}

Example 2 (dismiss):

data = {
    :name "dismiss"
    :type :trail-action/dismiss
    :data [{:name "tracking-token"
         :value "value"}]
}

For JSON, the action type should not include the :trail-action/ preffix:

Example 1:

data = {
    "name": "conversion",
    "type": "conversion",
    "data": [{"name": "tracking-token", "value": "value"}]
}

Example 2:

data = {
    "name": "dismiss",
    "type": "dismiss",
    "data": [{"name": "tracking-token", "value": "value"}]
}

Important: Once conversion or dismiss are invoked on a trace, it cannot be used again and a new trace will be created for subsequent actions, visits or synchronizations. In case the same trace is used, it will result in an HTTP 400 response.

Related Articles

• Stop Displaying a Campaign After Conversion