trackBrochureUsage

Tracks brochure usage info back to the SAM at both the TRACKING_EVENT and ACCESSED_EVENT level.

Request

POST /rest/brochures/track

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser

Parameters

Parameter	Type	Required	Description
me	string 100	No	The "Method" related with the tracking event. Current methods are pushnotification, usernotification, newsletter, homebanner. NOTE: this field relates to deeplink param it_method.
mi	string 100	No	The "Metadata Id" associated with the method (usually the PK Key Id so we can link it back to its source. For UserNotification it would be the PK of the top-level Notification record. NOTE: this field relates to deeplink param it_metadata_id.
ca	string 100	No	The "Campaign" (if any) that the tracking event relates to. For "newsletters" this is the "Newsletter Tag". For pushnotification this is the PK of the Notification record. NOTE: this field relates to deeplink param it_campaign.
km	string 256	No	The optional "Key Message" that is associated with for example a specific IVA page or event e.g. "Drug Efficacy".

SAMPLE REQUEST

[
  {
    "lo": 151.2089645862579,
    "to": 28800,
    "id": 3,
    "dt": "2011-12-14T06:31:39.000Z",
    "nm": "TestPDF",
    "bf": "pdf",
    "bt": 0,
    "vd": 345,
    "aa": [
      {
        "st": "2011-12-14T06:31:39.000Z",
        "ai": "1",
        "em": 1,
        "vd": 231,
        "km": "Drug Efficacy",
        "smartEntryId": 456
      }
    ],
    "dv": 1,
    "ns": 1,
    "es": 0,
    "bv": "3",
    "dn": "TestPDF",
    "pt": "iOS",
    "hw": "2",
    "os": "4.3.1",
    "ni": "2.1.16",
    "la": -33.8713419939655,
    "ip": "192.168.0.1",
    "si": "MYSESSIONID_64 chars max",
    "sd": "My Long Session Description1_256 chars max",
    "me": "pushnotification",
    "mi": "123",
    "ca": "My Push Campaign"
  },
  {
    "lo": 151.2089645862579,
    "to": 28800,
    "id": 3,
    "dt": "2011-12-14T06:32:19.000Z",
    "nm": "TestPDF",
    "bf": "pdf",
    "bt": 0,
    "vd": 300,
    "aa": [
      {
        "st": "2011-12-14T06:32:19.000Z",
        "ai": "1",
        "em": 0,
        "vd": 91,
        "km": "Product Info"
      }
    ],
    "dv": 1,
    "ns": 1,
    "es": 0,
    "bv": "3",
    "dn": "TestPDF",
    "pt": "Android",
    "la": -33.8713419939655,
    "ip": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "si": "MYSESSIONID_64 chars max",
    "sd": "My Long Session Description1_256 chars max",
    "me": "newsletter",
    "mi": "456",
    "ca": "My Newsletter Campaign"
  }
]

Response

200 OK

Errors

Exception	Description
WSInvalidParameterException	See Error Definitions
WSInvalidAuthTokenException	See Error Definitions
WSInsufficientPermissionsException	See Error Definitions
WSUserServiceException	See Error Definitions
WSBrochureVersionNotFoundException	See Error Definitions
WSBrochureServiceException	See Error Definitions
WSCacheServiceException	See Error Definitions