AdEvent

id
Adelya Internal object ID
Alphanumeric (even if yet just number are in), it's the table primary key, returned on persist or use for fast look-up
type
Kind of event
addCA, addPoint, addCredit, note, ...
255 characters max
date
creation date of this event
datetime
idExternal
Your reference
alpha (see faq entry on idExternal) can be null (i.e. not specified) but not the empty string (aka "")
127 characters max
member
Who this event pertains to
see FidelityMember
fvalue
Double value (if applicable, e.g. Turnover Amount)
Double
fparam
Some numeric parameter
Double
sparam
Some string parameter
Alphanumeric
255 characters max
comment
Free text usually used for commenting the event
Alphanumeric
univers
Segmentation textual information
127 characters max
cause
The "father" event of this one
children
Collection of AdEvent which cause is this one
details
Collection of details
See below
startDate
If this event is time based, the beginning of the period
date
endDate
If this event is time based, the end of the period
date
status1
Cancelation status
boolean
true / false
status2
Usage status (e.g. for coupons, indicates if already burned)
boolean
true / false
status3
View or Read status (e.g. for email, 1 indicates an email opened)
boolean
true / false
dateUpdateStatus1
When do status1 was last updated
datetime
dateUpdateStatus2
When do status2 was last updated
datetime
dateUpdateStatus3
When do status3 was last updated
datetime
group
Where was created this event
see Group

AdEventDetails

Depending on your integration, the data of an event may have a collection of "lines" stored into AdEventDetails (e.g. items purchase).

For performance reason, as event are often large collection of objects, details are not returned by GET operation on AdEvent, to retrieve details of an event, you have to make a second request targeting the details attached to the given event (see example below).

id
integer
idExternal
Your reference
String
127 characters max
detailType

Kind of detail line, usually store as a single char
- I for Item
- C for Coupon
- P for Payment
- D for document
20 characters max
class1
Usually line descr
String (mandatory)
127 characters max
class2

A free field but used for standard types
- For type=C detail : the special offer code (Deal code)
- For type=D detail and class3='T' : the uniqueFilename of the file in our platform
- For type=D detail and class3='P': the URL of the file in our platform (in private mode/access)
String
127 characters max
class3

Usually a precision about the usage of the detail value or class
- For type=C detail : the unit of the dicount (%, or currency)
- For type=D detail : the precision of the document (used to know the type of document stored). Values are 'T' for a e-ticket and 'P' for an event proof origin
String
127 characters max
class4
String
127 characters max
class5
String
127 characters max
class6
String
127 characters max
class7
String
127 characters max
class8
String
127 characters max
class9
String
127 characters max
class10

Usually line identifier
- For type=I detail : the Item reference
- For type=C detail : the Trackcode of the offer
- For type=D detail : the Document count (using class3 and counter concatenation)
String (mandatory)
127 characters max
modifier
String
20 characters max
unitValue
unit value (as if qty=1)
Double
quantity
Double(default 1.0)
value
value before modifier(if applicable, e.g. Turnover Amount)
Double
finalValue
final value (if applicable, e.g. Turnover Amount)
Double

Example

Get event details, of event with id:1070213


GET
{
    "AdEventDetail":{
        "event":{
            "id":1070213
        }
    }
}