Type Definitions
Event
Properties:
| Name | Type | Description |
|---|---|---|
id |
Number |
The event identifier |
path |
String |
The event path which provides a logical grouping |
headers |
Array.<module:Analytics~Header> |
The list of headers |
data |
Object |
The event data |
sentAt |
Number |
The epoch value indicating the time when the event was sent |
createdAt |
Number |
The epoch value indicating the time when the event was created |
EventData
Properties:
| Name | Type | Description |
|---|---|---|
path |
String |
The event path which provides a logical grouping |
headers |
Array.<module:Analytics~Header> |
The list of headers |
data |
Object |
The event data |
EventOptions
Properties:
| Name | Type | Description |
|---|---|---|
id |
Number |
The event identifier |
from |
Number |
The epoch value indicating the start of the interval |
to |
Number |
The epoch value indicating the end of the interval |
path |
String |
The event path which provides a logical grouping |
headers |
Array.<module:Analytics~Header> |
The list of headers |
sent |
Boolean |
The flag indicating whether the event was sent or not |
EventResult
Properties:
| Name | Type | Description |
|---|---|---|
id |
String |
The event Identifier |
EventStats
Properties:
| Name | Type | Description |
|---|---|---|
total |
Number |
The current total number of stored events |
sent |
Number |
The current number of sent events |
Header
Properties:
| Name | Type | Description |
|---|---|---|
name |
String |
The header name |
value |
String |
The header value |
Status
Properties:
| Name | Type | Description |
|---|---|---|
lastSent |
Number |
The epoch value indicating the time when the last event was sent |
syncEnabled |
Boolean |
The boolean value indicating whether the cloud sync enabled or not |
events |
Array.<module:Analytics~EventStats> |
The current event stats |