Releases
Change log
Version 2.1.7
- Event added:
- User deleted
Version 2.1.6
- Events added:
- Unsubscribe
- Preexisting sync started
- Preexisting sync complete
- Preexisting user created
- Preexisting thing created
- Preexisting user thing associated
Version 2.1.4
(Please refer migration guide)
- Events added
- Thing connected
- Consumable usage
- Firmware upgrade started
- Firmware upgrade completed
- Event changed
- Events
thing_created
andthing_updated
- propertyfirmware
changed tofirmware_version
. - Events
user_created
anduser_updated
- added new propertyutc_offset
.
- Events
- Path changes
- Collect API path changed to
/v2/collect/
. - Consent API path changed to
/v2/api/collect/
.
- Collect API path changed to
- Event properties restrictions:
- Restricted to 20 properties per event.
- Unknown properties are now allowed for events besides
custom_event
andthing_interaction
.
- Authentication method - Supporting Basic authentication only.
Migration guide
Please see below guidelines how to migrate between to new API versions:
Migrating from 2.1.1 to 2.1.4
General Changes
2.1.1 | 2.1.4 | Comments | |
---|---|---|---|
Collect API invocation path | /collect | /v2/collect | |
Consent API invocation path | /v1/api/report | /v2/api/report/ | |
Max keys(event properties) validation | 100 | 20 | |
Authentication method | Bearer and Basic | Basic ONLY | |
All events beside custom_event and thing_interaction | Allowed unrecognized properties | Unknown properties are not allowed | |
Allowed String characters | Limited characters | Regex: /^[a-zA-Z0-9:\-._+@]*$/ | first_name and last_name have limited characters |
Event changes
- Event name
thing_created
:- Property named
firmware
changed tofirmware_version
.
- Property named
- Event name
thing_updated
:- Property named
firmware
changed tofirmware_version
.
- Property named
- Event name
user_created
:- Property added:
Property name | Type | Validation | Is mandatory |
---|---|---|---|
utc_offset | String | Values range: -1200 to +1459 ( format [+/-]HHMM diff from UTC) OR Z OR 0000 | false |
- Event name
user_updated
:- Property added:
Property name | Type | Validation | Is mandatory |
---|---|---|---|
utc_offset | String | Values range: -1200 to +1459 ( format [+/-]HHMM diff from UTC) OR Z OR 0000 | false |
New events
In version 2.1.4 new events were added. For details, please refer Thing connected, Consumable usage, Firmware upgrade started and Firmware upgrade completed events.