The CardioLog SaaS server-side API allows you to send events to CardioLog SaaS from any custom application.
In order to create the event, create an HTTP web request as described below:
HTTP request
HTTP
POST /cardiolog/api/server/events |
Note: Contact Intlock Support for the host address.
Request body
In the request body, supply a JSON representation of an event object:
| Parameter | Type | Description | Required |
|---|---|---|---|
| tid | GUID | Your tenant ID. Contact Intlock Support to get your tenant ID. | Yes |
| et | string (max length 50) | Event type (predefined or custom type). See list of predefined event types below. | Yes |
| ct | DateTime | Client time | No |
| cto | string (max length 6) | The offset from UTC | No |
| sid | string (max length 50) | Session id. Used for grouping multiple events | No |
| url | string (max length 1000) | The URL of the visited page | No |
| un | string (max length 256) | User name. The user principal name for identifying a user | No |
| ua | string (max length 1000) | User agent | No |
| meta | JSON object (max length 255 for key and value) | Metadata. Key-value string collection, containing metadata. | No |
Event types |
|---|
| Pageview |
| Search |
| Search Result Click |
| External Click |
| Ping |
| IpEvent |
| Page Request |
| Search Result Preview |
| Like |
| StarRating |
| Follow |
| Message-interaction |
| Message-view |
| Message-closed |
| Content Created |
| Content Edited |
| Content Deleted |
| Content Liked |
| Content Unliked |
| User Information |
| Comment Posted |
| Replied |
| Interacted With Element |
| Video Play |
| Video Pause |
| Video Loaded |
| Video Failed |
| Video Seeked |
| Video Fullscreen |
Video Sound |
Duration |
Response
If successful, this endpoint returns a
200 OK response code.Example
Request
HTTP
POST /cardiolog/api/server/events { "et": "My Custom Event", "tid": "ffffffff-dddd-ffff-aaaa-ffffffffffff", "ct": "2000-01-01T10:10:50", "cto": "+01:00", "sid": "123456789", "un": "domain\\user", "ua": "Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36", "meta": { "Price": "10", "Currency": "USD", "Amount" : "5" }} |
Response
HTTP
HTTP/1.1 200 OK |