Webhook and reporting event/properties
Available Events and Device Properties:¶
This chapter explains the data we collect about your devices, which is available via the webhook and reports. For a high-level overview, see the chapter Webhook and batch reporting. We make a distinction between device properties and events. Properties tell something about the device or app, and won't change often. The plugin creates Events once something happens, for example when it sends a notification.
Events¶
We collect the following events and make them available in reports and via the webhook.
attribution¶
When you call the Plot.sendAttributionEvent() method, the plugin creates an attribution event.
| Property name | Type | Description |
|---|---|---|
| device_id | String | The Plot Projects identifier for the device. Automatically generated on app install. |
| device_time | Timestamp | When did it happen on the device. |
| platform | String | iOS or Android. |
| action_id | String | The name of the action. |
| custom_{key}_ | String | Custom properties attached to the attribution event. |
| segment_{segment name}_ | String | Your own segment name and value. |
dwell¶
When a geofence or beacon has both an enter and an exit geotrigger campaign, we calculate the time the user dwells inside that region.
| Property name | Type | Description |
|---|---|---|
| device_id | String | The Plot Projects identifier for the device. Automatically generated on app install. |
| device_time | Timestamp | When did the dwell start on the device. |
| platform | String | iOS or Android. |
| region_id | String | Identifier of the geofence or beacon. |
| region_name | String | The name of the geofence or beacon. |
| enter_campaign_id | String | The campaign on which we detected the geofence/beacon enter. |
| exit_campaign_id | String | The campaign on which we detected the geofence/beacon exit. |
| advertising_id | String | The advertising identifier of the device when set. |
| dwell_time_sec | Integer | Number of seconds the dwell took. |
| dwell_accuracy | Float | The location accuracy of the location events used for calculating the dwell. |
| region_type | String | Geofence or beacon |
| segment_{segment name}_ | String | Your own segment name and value. |
geotrigger¶
The plugin creates a geotrigger event once a data campaign triggers.
| Property name | Type | Description |
|---|---|---|
| device_id | String | The Plot Projects identifier for the device. Automatically generated on app install. |
| device_time | Timestamp | When did it happen on the device. |
| platform | String | iOS or Android. |
| match_id | String | The identifier identifying the match. This identifier allows combining a sent event and a handled event. |
| event_type | String | Whether the geotrigger was sent or handled |
| campaign_id | String | The campaign identifier. |
| campaign_name | String | The name of the campaign. |
| region_latitude | Float | Location of the geofence/beacon triggered as specified in the dashboard. |
| region_longitude | Float | Location of the geofence/beacon triggered as specified in the dashboard. |
| region_radius | Integer | Radius of the geofence/beacon triggered as specified in the dashboard. |
| region_name | String | The name of the region. |
| region_label | String | The label of the region. |
| advertising_id | String | The advertising identifier of the device when set. |
| beacon_uuid | String | The Beacon UUID as specified in the dashboard. |
| beacon_major_id | Integer | The Beacon Major Id as specified in the dashboard. |
| beacon_minor_id | Integer | The Beacon Minor Id as specified in the dashboard. |
| trigger_type | String | The kind of trigger: enter, exit, dwell. |
| segment_{segment name}_ | String | Your own segment name and value. |
notification¶
Each time the plugin sends a notification – shows a notification to the user – we create a notification event. If the user taps on that notification we create another notification event.
| Property name | Type | Description |
|---|---|---|
| device_id | String | The Plot Projects identifier for the device. Automatically generated on app install. |
| device_time | Timestamp | When did it happen on the device. |
| platform | String | iOS or Android. |
| match_id | String | The identifier identifying the match. This identifier allows combining a sent event and an opened event. |
| event_type | String | Whether the notification was sent or opened |
| campaign_id | String | The campaign identifier. |
| campaign_name | String | The name of the campaign. |
| region_latitude | Float | Location of the geofence/beacon triggered as specified in the dashboard. |
| region_longitude | Float | Location of the geofence/beacon triggered as specified in the dashboard. |
| region_radius | Integer | Radius of the geofence/beacon triggered as specified in the dashboard. |
| region_name | String | The name of the region. |
| region_label | String | The label of the region. |
| advertising_id | String | The advertising identifier of the device when set. |
| beacon_uuid | String | The Beacon UUID as specified in the dashboard. |
| beacon_major_id | Integer | The Beacon Major Id as specified in the dashboard. |
| beacon_minor_id | Integer | The Beacon Minor Id as specified in the dashboard. |
| trigger_type | String | The kind of trigger: enter, exit, dwell. |
| segment_{segment name}_ | String | Your own segment name and value. |
location¶
Each time the device determines it's location, it's possible to collect this location.
| Property name | Type | Description |
|---|---|---|
| device_id | String | The Plot Projects identifier for the device. Automatically generated on app install. |
| platform | String | iOS or Android. |
| device_time | Timestamp | When did it happen on the device. |
| latitude | Float | Location of the device. |
| longitude | Float | Location of the device. |
| accuracy | Integer | Accuracy of the location of the device in meters. |
| segment_{segment name}_ | String | Your own segment name and value. |
Device properties¶
We could send the following properties about your app installs:
| Property name | Type | Description |
|---|---|---|
| device_id | String | The Plot Projects identifier for the device. Automatically generated on app install. |
| app_version | String | Version of the app the plugin runs in. |
| platform | String | iOS or Android. |
| platform_version | String | Version of the operating system. |
| plot_version | String | Version of the Plot Plugin. |
| hardware_manufacturer | String | Phone manufacturer. For example, Apple or Samsung. |
| hardware_model | String | Phone model. |
| notification_optin | String | Possible values: yes, no or undefined. |
| location_optin | String | Possible values: for iOS: no, wheninuse or always and for Android yes or no. |
| home_location_latitude | Float | The location of the device where we think the home location is. When unknown, this value is unset. |
| home_location_longitude | Float | The location of the device where we think the home location is. When unknown, this value is unset. |
| work_location_latitude | Float | The location of the device where we think the work location is. When unknown, this value is unset. |
| work_location_longitude | Float | The location of the device where we think the work location is. When unknown, this value is unset. |
| segment_{segment name}_ | String | Your own segment name and value. |