countly.events

Follow

Collection events contain overall information about events, as a list of all event keys, given names, and segments for each specific app.

Here is the list of possible fields

Field Description Example
_id App ID 542e95d747f0be510c000004
list An array of all event keys [ "Login", "Buy", "Logout", "Sound", "Lost", "Messaged", "Won", "Achievement", "Shared" ]
map Mapping of event keys to the readable names you give to events { "Buy": { "name": "Purchased IAP" }, "Login": { "name": "User Login" }, "Logout": { "name": "User Logout" }, "Key":{"key": "event key}, "Name":{ "name": "name of the event if it is different from the key" }, 'Description":{ "description": "description of the event"}, "Is_visible:{"is_visible": "true" (it marks the visibility of the event)}, "Count":{"count": "name of the count"}, "Sum":{"sum": "name of the sum"}, "Dur":{"dur": "name of duration"}, "Omit_list:{"omit_list: "a list of omitted segments"}}
segments List of segments that each event has { "Achievement": [ "name" ], "Login": [ "referer" ], "Lost": [ "level", "mode", "difficulty" ], "Won": [ "level", "mode", "difficulty" ], }
overview List of events that are to be shown on the events overview page. { "order": 0(Order in all events fields shown),  "eventKey": ["Fund Transfer Begin"],  "eventProperty": ["count"], "is_event_group": [false](to check if this is a group event),  "eventName": ["Fund Transfer Begin"],   "propertyName": ["Count duration"]}


Here is an example of events document

{
  "_id": "ObjectId(57fb679323b5388e28e2c37e)",
  "list": [
    "Login",
    "star_rating",
    "push_sent",
    "push_open",
    "Achievement",
    "push_action",
    "Logout",
    "Lost",
    "Shared",
    "Purchase",
    "Won",
    "Sound",
    "Buy",
    "long_event_name_1_interaction",
    "long_event_name_2_interaction",
    "long_event_name_1_interaction_user",
    "long_event_name_1_interaction_device",
    "long_event_name_1_interaction_server",
    "Fund Trans. Finalize",
    "Fund Trans. Begin",
    "Credit Card Appl. Start",
    "Credit Card Appl. Send",
    "Checkout",
    "Checkout - Payment",
    "Checkout - Address",
    "Add To Cart",
    "Settings Changed",
    "Checkout - Begin",
    "Bill Payment",
    "Credit Card Application Begin",
    "Credit Card Application",
    "Fund Transfer Begin",
    "Fund Transfer",
    "Add a Car",
    "Use Remote",
    "Add App",
    "Journey",
    "Invoice Generated",
    "Video Call",
    "Used Messaging",
    "Schedule Appointment",
    "1---6 bars",
    "1---5 bars",
    "1---8 bars",
    "1---9 bars",
    "1---10 bars",
    "1---3 bars",
    "1---2 bars",
    "1---7 bars",
    "1---4 bars",
    "1---15 bars",
    "1---5nospace",
    "1---8nospace",
    "1--11segments",
    "Deneme1",
    "deneme2",
    "TMP1",
    "tmpEventForTest",
    "denemee",
    "deneme12"
  ],
  "segments": {
    "Login": [
      "referer",
      "screen",
      "Method",
      null
    ],
    "star_rating": [
      "rating",
      "app_version",
      "platform",
      "platform_version_rate",
      null
    ],
    "push_sent": [
      "i",
      "a",
      null,
      "t",
      "p",
      "ap",
      "tp"
    ],
    "push_open": [
      "i"
    ],
    "Achievement": [
      "name",
      "screen"
    ],
    "push_action": [
      "i",
      "b",
      "a",
      null,
      "t",
      "p",
      "ap",
      "tp"
    ],
    "Lost": [
      "level",
      "mode",
      "difficulty",
      "screen"
    ],
    "Shared": [
      "Referrer",
      "screen"
    ],
    "Won": [
      "level",
      "mode",
      "difficulty",
      "screen"
    ],
    "Sound": [
      "state",
      "screen"
    ],
    "Purchase": [
      "screen"
    ],
    "Logout": [
      "screen"
    ],
    "Buy": [
      "screen"
    ],
    "Fund Trans: Begin": [
      "Source Currency",
      "Destination Currency"
    ],
    "Fund Trans: Finalize": [
      "Result",
      "Failure Reason",
      "Error Code"
    ],
    "Credit Card Appl: Send": [
      "Card Type"
    ],
    "Credit Card Appl: Start": [
      "From"
    ],
    "Add To Cart": [
      "Category",
      null
    ],
    "Checkout": [
      "Delivery Type",
      "Items",
      null
    ],
    "Settings Changed": [
      "Setting",
      null
    ],
    "Bill Payment": [
      "Bill Type",
      "Amount Range",
      "AAAAAAAAA",
      null
    ],
    "Credit Card Application": [
      "Card Type",
      null
    ],
    "Credit Card Application Begin": [
      "From",
      null
    ],
    "Fund Transfer Begin": [
      "Source Currency",
      "Destination Currency",
      null
    ],
    "Fund Transfer": [
      "Result",
      "Failure Reason",
      "Error Code",
      null,
      "Test"
    ],
    "Add App": [
      "app name",
      null
    ],
    "Add a Car": [
      "model",
      null
    ],
    "Use Remote": [
      "operation",
      null
    ],
    "Video Call": [
      "Clinic",
      null
    ],
    "Schedule Appointment": [
      null,
      "Type",
      "Clinic Selected",
      "Condition"
    ],
    "Used Messaging": [
      "Provided Care Plan",
      null
    ],
    "1---10 bars": [
      null,
      "test"
    ],
    "1---2 bars": [
      null,
      "test"
    ],
    "1---3 bars": [
      null,
      "test"
    ],
    "1---4 bars": [
      null,
      "test"
    ],
    "1---5 bars": [
      "test",
      null
    ],
    "1---6 bars": [
      "test",
      null
    ],
    "1---7 bars": [
      null,
      "test"
    ],
    "1---8 bars": [
      "test",
      null
    ],
    "1---9 bars": [
      null,
      "test"
    ],
    "1---15 bars": [
      "test"
    ],
    "1---5nospace": [
      null,
      "test"
    ],
    "1---8nospace": [
      null,
      "test"
    ],
    "1--11segments": [
      null,
      "seg1",
      "seg2",
      "seg3",
      "seg4",
      "seg5",
      "seg6",
      "seg7",
      "seg8",
      "seg9",
      "seg10",
      "seg11"
    ],
    "long_event_name_2_interaction": [],
    "Deneme1": [
      "Deg1"
    ],
    "deneme2": [],
    "TMP1": [],
    "tmpEventForTest": [
      "referer",
      "screen",
      "Method",
      null,
      "name",
      "level",
      "mode",
      "difficulty",
      "Referrer"
    ],
    "denemee": [
      "referer",
      "screen",
      "Method",
      null,
      "name",
      "level",
      "mode",
      "difficulty",
      "Referrer"
    ],
    "deneme12": []
  },
  "map": {
    "Achievement": {
      "key": "Achievement",
      "description": "Description during demo",
      "count": "Times",
      "sum": "Amount ($)",
      "dur": "Time Spent (mins)",
      "category": null,
      "omit_list": []
    },
    "Logout": {
      "name": "Checkout",
      "description": "Event description here",
      "is_visible": false
    },
    "Login": {
      "key": "Login",
      "description": "Triggered as the user logs in to the app",
      "category": "62ab1dc0c077ea8fcd593323",
      "omit_list": [],
      "is_visible": true
    },
    "Lost": {
      "name": "Contact - L2",
      "is_visible": true
    },
    "Shared": {
      "name": "Transaction long name name",
      "is_visible": true
    },
    "Purchase": {
      "name": "Verification",
      "is_visible": true
    },
    "Sound": {
      "key": "Sound",
      "name": "Search",
      "description": "",
      "category": "6363fe5a7eea28f2a74309ff",
      "omit_list": []
    },
    "Won": {
      "name": "Setting",
      "is_visible": true
    },
    "long_event_name_1_interaction": {
      "is_visible": false
    },
    "long_event_name_1_interaction_device": {
      "is_visible": false
    },
    "long_event_name_1_interaction_server": {
      "is_visible": false
    },
    "long_event_name_1_interaction_user": {
      "is_visible": false
    },
    "long_event_name_2_interaction": {
      "key": "long_event_name_2_interaction",
      "name": "long_event_name_2_interaction",
      "description": "asdasds",
      "is_visible": false,
      "count": "Count",
      "sum": "Sum",
      "dur": "Duration",
      "omit_list": []
    },
    "Add App": {
      "is_visible": true
    },
    "Add To Cart": {
      "is_visible": true
    },
    "Add a Car": {
      "is_visible": true
    },
    "Bill Payment": {
      "key": "Bill Payment",
      "description": "",
      "omit_list": []
    },
    "Buy": {
      "is_visible": true
    },
    "Checkout": {
      "is_visible": true
    },
    "Credit Card Appl": {
      " Send": {
        "is_visible": true
      },
      " Start": {
        "is_visible": true
      }
    },
    "Credit Card Application": {
      "is_visible": true
    },
    "Credit Card Application Begin": {
      "is_visible": true
    },
    "Fund Trans": {
      " Begin": {
        "is_visible": true
      },
      " Finalize": {
        "is_visible": true
      }
    },
    "Fund Transfer": {
      "key": "Fund Transfer",
      "description": "",
      "omit_list": [],
      "is_visible": true
    },
    "Fund Transfer Begin": {
      "is_visible": true
    },
    "Schedule Appointment": {
      "is_visible": true
    },
    "Settings Changed": {
      "is_visible": true
    },
    "Use Remote": {
      "is_visible": true
    },
    "Used Messaging": {
      "is_visible": true
    },
    "Video Call": {
      "is_visible": true
    },
    "cmp": {
      "is_visible": true
    },
    "custom": {
      "is_visible": true
    },
    "up": {
      "is_visible": true
    },
    "1---10 bars": {
      "is_visible": true
    },
    "1---15 bars": {
      "is_visible": true
    },
    "1---2 bars": {
      "is_visible": true
    },
    "1---3 bars": {
      "is_visible": true
    },
    "1---4 bars": {
      "is_visible": true
    },
    "1---5 bars": {
      "is_visible": true
    },
    "1---6 bars": {
      "is_visible": true
    },
    "1---7 bars": {
      "is_visible": true
    },
    "1---8 bars": {
      "is_visible": true
    },
    "1---9 bars": {
      "is_visible": true
    },
    "1---5nospace": {
      "is_visible": true
    },
    "1---8nospace": {
      "is_visible": true
    },
    "1--11segments": {
      "is_visible": true
    },
    "undefined": {
      "is_visible": true
    },
    "Deneme1": {
      "key": "Deneme1",
      "description": "Deneme Event",
      "count": "Count",
      "sum": "Sum",
      "dur": "Duration",
      "omit_list": [],
      "is_visible": true
    },
    "deneme2": {
      "key": "deneme2",
      "name": "deneme2",
      "description": null,
      "is_visible": false,
      "count": "Count",
      "sum": "Sum",
      "dur": "Duration",
      "omit_list": []
    },
    "TMP1": {
      "key": "TMP1",
      "name": "TMP",
      "description": "Random",
      "is_visible": true,
      "count": "Count",
      "sum": "Sum",
      "dur": "Duration",
      "omit_list": []
    },
    "deneme12": {
      "key": "deneme12",
      "name": "deneme",
      "description": "",
      "count": "Count",
      "sum": "Sum",
      "dur": "Duration",
      "omit_list": [],
      "is_visible": true
    }
  },
  "order": [
    "Achievement",
    "Logout"
  ],
  "overview": [
    {
      "order": 2,
      "eventKey": "Credit Card Application",
      "eventProperty": "count",
      "is_event_group": false,
      "eventName": "Credit Card Application",
      "propertyName": "Count"
    },
    {
      "order": 3,
      "eventKey": "Purchase",
      "eventProperty": "count",
      "is_event_group": false,
      "eventName": "Verification",
      "propertyName": "Count"
    },
    {
      "order": 4,
      "eventKey": "Logout",
      "eventProperty": "count",
      "is_event_group": false,
      "eventName": "Checkout",
      "propertyName": "Count"
    },
    {
      "order": 5,
      "eventKey": "Checkout - Address",
      "eventProperty": "count",
      "is_event_group": false,
      "eventName": "Checkout - Address",
      "propertyName": "Count"
    },
    {
      "order": 6,
      "eventKey": "1---6 bars",
      "eventProperty": "count",
      "is_event_group": false,
      "eventName": "1---6 bars",
      "propertyName": "Count"
    }
  ],
  "omitted_segments": {
    "Achievement": [],
    "Shared": [],
    "Logout": [],
    "Won": []
  }
}

Looking for help?