What events + data are collected
List the events and associated meta data passed to your analytics integrations
Events
There are two categories of events that are collected: 1) flow
events and 2) message
events. Flow events are for tracking state transitions in your bot flows: start
, transition
. Message events track the lower level message events send
, receive
, button
.
Event | Category | Data | Description |
---|---|---|---|
start | flow | bot_id ex "Bxxxxxxx"bot ex. "meyabot"flow ex. "hello_world"action ex. "next"state ex. "first"We also send any extra transition data ex. value | Fires when a flow is started. |
transition | flow | bot_id ex "Bxxxxxxx"bot ex. "meyabot"flow ex. "hello_world"action ex. "next"state ex. "first"We also send any extra transition data ex. value | Fires on state transitions within a flow. |
send | message | flow ex. "hello_world"message_id ex "Mxxxxx"text ex. "Hello!" | Fires when your bot sends a message. |
receive | message | flow ex. "hello_world"message_id ex "Mxxxxx"text ex. "Hello!"handled true|false | Fires when your bot receives a message. |
delivery | message | mids ex. mid.1458668856218:ed81099e15d3f4f233watermark ex. 1458668856253seq ex. 37 | Fires when Facebook Messenger has successfully delivered a message to a user. |
read | message | timestamp ex. "1484588999"watermark ex. 1458668856253seq ex. 38 | Fires when Facebook Messenger has acknowledged that a user has read a message. |
button | message | flow ex. "hello_world"message_id ex "Mxxxxx"text ex. "Hello!" | Fires when a user clicks a button. |
liveagent | message | flow ex. "hello_world"message_id ex "Mxxxxx"text ex. "Hello!" | Fires when a human agent responds from a customer service integration. |
Flow events
Consider the following flow diagram depicting where start
and transition
events will fire. The event is associated with the state to the right of the arrow.
User
You can optionally have Meya identify users using data in the user
datastore. Each Analytics service treat users and Personally Identifiable Information (PII) differently. For example, Mixpanel will charge based on the number of users, and Google Analytics forbids collecting PII.
User Privacy
Please consider carefully how and what user data you collect if you enable user profile identification. Respect your users and your company's privacy policies. Read more about PII.
Message text
Optionally, you can capture the raw text in the receive
, send
, button
and liveagent
events. This is turned on by default. You may want to turn this setting off to protect PII.
Updated over 6 years ago