Employee Events

Employee Events Data

Filename

events/organizationName_ANONYMIZED_EMPLOYEE_EVENTS_YYYYMMDDZ.extension

Variables:

• default prefix: events/

• organizationName: the slugified name of the organization

• YYYYMMDD, week this file contains data from. Week is in ISO format, being Monday first day of the week.

• extension, depending on the format and compression, see below:

Available formats

Format	Compression	Extension
NDJSON	NONE,GZIP	.json[.gz]
AVRO	NONE,DEFLATE,SNAPPY	.avro
PARQUET	NONE,SNAPPY,GZIP,ZSTD	.parquet[.gz]

Note: CSV is not supported for this file because is not able to represent nested objects.

Glossary

• Source: the tools the organization has connected through Worklytics. Examples:

  • GDrive, Slack, Zoom, GCalendar, GMail, Google Directory, MSFT Office...

• Objects: model pieces of work. Examples of objects:

  • Document or a file in GDrive

  • Slack channel

  • Zoom meeting

  • Calendar event

• Event: actions that happened to an object, performed by employees. Examples of events:

  • Comment, upload or edit a document

  • Message sent in a Slack channel

  • Zoom meeting occurrence (the actual action of attend a meeting)

  • Calendar event attendance

• Work Item: either an object or an event

• Time Spent: Worklytics' estimation of the amount of time a person worked on the event

File contents

This file represents an unnested version of the Items file, showing all events per employee and their estimated time spent on each within a given week.

Each row is a Json object with nested objects. The structure is intended to hold heterogeneous work sources so contents of certain fields may vary depending on the item type. Properties and metrics fields are a good example of this, for example Calendar meetings may have location, Slack message's' may have a message length or Zoom meetings may encode whether they are recurring or not. An entry may be an object and/or an event. Events have the boolean field "event" value set to true.

Events export schema

Field	Type	Description and examples
employeeId	STRING	Employee ID
sourceKindId	STRING	Source of event
id	STRING	The id of the event
eventType	STRING	Type of event: meeting, email, message, document
relationType	STRING	Type of action the employee did (meeting attendance, email sent, message sent, document edited)
eventTime	DATETIME	When the event took place in employee's timezone
eventTimeUTC	TIMESTAMP	When the event took place in Universal Time Coordinated
timeZone	STRING	Employee's time zone
relationProperties	RECORD	Properties associated with the action (example: RSVP status on meeting, lenght of comment,...)
├─ name	STRING	Name
├─ value	STRING	Value
eventProperties	RECORD	Properties of the event, vary across sources (meeting is recurrent, email thread-id, ...)
├─ name	STRING	Name
├─ value	STRING	Value
metrics	RECORD	Metrics for the event. Can be collected from source or derived. Value can either be numeric or a date
├─ name	STRING	Metric name
├─ value	FLOAT	Numeric value (examples: meeting duration, file size)
├─ dateValue	TIMESTAMP	Timestamp (example: meeting start)
estimatedTimeSec	FLOAT	Time spent working exclusively on this event given their concurrent work (in seconds). Equivalent to item's exclusiveTimeSpent
estimatedEventDurationSec	FLOAT	Estimated event duration (in seconds). Equivalent to item's directTimeSpent
parentId	STRING	Parent id of the work item if any

Sample rows

NDJSON example (note examples are pretty printed for documentation purposes otherwise will be presented in one row each)

Here is an example of how a meeting looks like:

{
"employeeId": "E00000123",
"sourceKindId": "gcal",
"id": "[e-mail]:20210123T190000:attendance",
"eventType": "attendance",
"relationType": "attendee",
"eventTime": "2021-01-23T12:00:00",
"eventTimeUTC": "2021-01-23 20:00:00 UTC",
"timeZone": "US/Pacific",
"relationProperties": [
  {
    "name": "participationStatus",
    "value": "NEEDS_ACTION"
  },
  {
    "name": "responseStatus",
    "value": "needsAction"
  }
],
"eventProperties": [
  {
    "name": "onlineMeetingUrl",
    "value": "https://zoom.us/whatever"
  },
  {
    "name": "meetingId",
    "value": "123456789"
  },
  {
    "name": "status",
    "value": "confirmed"
  },
  {
    "name": "meetingType",
    "value": "ONE_OFF"
  },
  {
    "name": "startTz",
    "value": "America/Los_Angeles"
  }
],
"metrics": [
  {
    "name": "start",
    "value": null,
    "dateValue": "2021-01-23 19:00:00 UTC"
  },
  {
    "name": "end",
    "value": null,
    "dateValue": "2021-01-23 20:00:00 UTC"
  },
  {
    "name": "durationMillis",
    "value": "3600000.0",
    "dateValue": null
  },
  {
    "name": "attendeesCount",
    "value": "3.0",
    "dateValue": null
  }
],
"estimatedTimeSec": "3600.0",
"estimatedEventDurationSec": "3600.0",
"parentItemId": "[e-mail]"
}

List of possible values for items and relations. List may grow over time.

Source (integrationId)	Item type	Relation type
gapps_groups	manager
gapps_groups	member
gapps_groups	owner
gcal	attendance	attendee
gcal	attendance	creator
gcal	attendance	organizer
gcal	attendance	resource
gcal	event	attendee
gcal	event	creator
gcal	event	organizer
gdrive	file	owner
gdrive	file	reader
gdrive	file	writer
gdrive	revision	author
github	actor
github	commit	author
github	issue	creator
github	issue_comment	author
github	issue_comment_created	subject
github	issue_comment_edited	subject
github	issue_opened	subject
github	pull	contributor
github	pull	reviewer
github	pull_request	contributor
github	pull_request_assigned	subject
github	pull_request_closed	subject
github	pull_request_comment	author
github	pull_request_create	creator
github	pull_request_edited	subject
github	pull_request_labeled	subject
github	pull_request_merge	merger
github	pull_request_opened	subject
github	pull_request_reopened	subject
github	pull_request_review_comment	author
github	pull_request_review_comment_created	subject
github	pull_request_review_comment_deleted	subject
github	pull_request_review_comment_edited	subject
github	pull_request_review_request_removed	subject
github	pull_request_review_requested	subject
github	pull_request_unassigned	subject
github	pull_request_unlabeled	subject
github	push	sender
gmail	chat	From
gmail	chat	To
gmail	chat_sent	From
gmail	message	BCC
gmail	message	CC
gmail	message	From
gmail	message	To
gmail	message_sent	From
jira	comment	author
jira	comment_created	author
jira	issue	assignee
jira	issue	attachmentAuthor
jira	issue	creator
jira	issue_created	actor
jira	issue_deleted	actor
jira	issue_resolved	actor
jira	issue_updated	actor
slack	channel	channel_creator
slack	channel	channel_member
slack	message	author
slack	message	mentioned
slack	message	reactor