OVERVIEW
Last Updated: Aug 1, 2022
Worklytics leverages OAuth to integrate with 3rd party APIs provided by various SaaS productivity tools in order to access data. In some cases, these APIs provide metadata only access scopes and in others cases scopes are broader. Wherever possible Worklytics drops any unnecessary content and/or attachments at the time of ingestion. This document provides detail on the access scopes utilized and the fields returned by each of the relevant APIs.
APIs access may also be filtered at the field level using the Worklytics Pseudonymization Proxy. The Worklytics Proxy can be configured to ensure that no personally identifiable data (PII) or sensitive fields are returned to Worklytics for analysis.
DATA REQUIREMENTS BY APP
Below we’ve listed which fields we have access to for each of the tools we integrate with.
Please Note: 3rd-Party APIs are constantly evolving and the specific fields provided are out of our direct control, so this documentation is merely our starting point for each specific API.
Microsoft Office 365 Email (Metadata Only)
Microsoft Azure Active Directory (Azure AD)
Slack Discovery (Requires Proxy)
Microsoft Office 365 Email (Metadata Only)
Note that Worklytics requires access to Active Directory in order to process Calendar and Email data.
Permission Scopes required to access data:
Name |
Description |
Notes |
Group.Read.All |
Read all groups |
Allows the app to list groups, and to read their properties and all group memberships on behalf of the signed-in user. Also allows the app to read calendar, conversations, files, and other group content for all groups the signed-in user can access. |
MailboxSettings .Read |
Read all user mailbox settings |
Allows the app to read user's mailbox settings without a signed-in user. Does not include permission to edit |
User.Read.All |
Read all users' full profiles |
Allows the app to read the full set of profile properties, group membership, reports and managers of other users in your organization, without a signed-in user. |
Mail.ReadBasic. All |
Read all users email metadata |
Allows the app to read all users mailboxes except Body, BodyPreview, UniqueBody, Attachments, ExtendedProperties, and Extensions. Does not include permissions to search messages. |
See Microsoft reference documentation on permissions scopes for more detail.
Metadata fields used:
Here is the full spec for data returned on Email Messages by the Graph API:
https://docs.microsoft.com/en-us/graph/api/resources/message?view=graph-rest-beta#properties
Note: Because of the ReadBasic scope, we don't receive body, bodyPreview, or attachments)
Messages from the SENT folder per user
Field Name |
Usage / Description of the field |
Required? |
ID |
Unique identifier of the event |
Yes |
Creation date time |
Time event occurred |
Yes |
Last modified date time |
Time that document was last modified |
Yes |
Sent date time |
Time event was sent to recipients |
Yes |
Sender (email addresses / IDs) |
Email address of the sender of the email |
Yes Pseudonymised by Proxy |
To/CC/BCC recipients (email addresses / IDs) |
Email addresses of those copied on the email event |
Yes Pseudonymized by Proxy |
Parent folder |
Name of the parent directory |
Yes |
Conversation Id |
Unique identifier of the email |
Yes |
Internet message Id |
Unique identifier of the internet message event |
Yes |
Subject |
Used in certain analyses of sub. E.g., How many emails contain “Project Spec” in subject |
Optional (Proxy drops by default) |
Fields from the User mailbox settings:
Field Name |
Usage / Description of the field |
Required? |
Working hours start |
The Time that user has set up in the calendar as start of the workday |
Optional |
Working hours end |
The Time that user has set up in the calendar as start of the workday |
Optional |
Time zone |
Time zone chosen by the user for calendar |
Optional |
Microsoft Office 365 Calendar
Note that Worklytics requires access to Active Directory in order to process Calendar and Email data.
Permission Scopes required to access data:
Name |
Description |
Notes |
Group.Read.All |
Read all groups |
Allows the app to list groups, and to read their properties and all group memberships on behalf of the signed-in user. Also allows the app to read calendar, conversations, files, and other group content for all groups the signed-in user can access. |
MailboxSettings.Read |
Read all user mailbox settings |
Allows the app to read user's mailbox settings without a signed-in user. Does not include permission to edit |
User.Read.All |
Read all users' full profiles |
Allows the app to read the full set of profile properties, group membership, reports and managers of other users in your organization, without a signed-in user. |
openid |
Sign users in |
Allows users to sign in to the app with their work or school accounts and allows the app to see basic user profile information. |
OnlineMeetings.Read.All |
Read Online Meeting details from the app |
Allows the app to read online meeting details in your organization without a signed-in user. |
Calendars.Read |
Read calendars in all mailboxes |
Allows the app to read events of all calendars without a signed-in user. |
See Microsoft reference documentation on permissions scopes for more detail.
Metadata fields used:
Here is the full spec for data returned on Calendar Events:
https://docs.microsoft.com/en-us/graph/api/resources/event?view=graph-rest-beta#properties
Events by user:
Field Name |
Usage / Description of field |
Required? |
Attendees > Email address / ID |
Email address of the attendee for event |
Yes Pseudonymized by Proxy |
Attendees > Response type (accepted / declined /… ) |
How the attendee responded |
Yes |
Attendees > Type of attendee (required / optional / resource) |
Whether attendees was required to attend - also marks off if an "invitee" is in fact just a resource like a conference room. |
Yes |
Created date time |
Date and time event created |
Yes |
Last modified date time |
Date and time modified |
Yes |
Location: name |
Location for the event |
Optional (Proxy drops by default) |
Subject |
Title of the event |
Optional (Proxy drops by default) |
Event start date time |
Event start time and date |
Yes |
Event end date time |
Scheduled end date and time |
Yes |
Is cancelled |
Whether an event got cancelled |
Yes |
icalUID |
ID for the calendar event |
Yes |
ID |
Unique event identifier |
Yes |
Organizer ( email address / ID) |
Name of the person organizing the event |
Yes Psuedonymized by Proxy |
Event type (single instance / occurrence / series master) |
Marks whether the event is a single meeting or recurring |
Yes |
UID |
Unique event identifier |
Yes |
WebLink |
permalink |
Optional (Proxy drops by default) |
Microsoft Teams
Note that Worklytics requires access to Active Directory in order to process Teams data.
Permission Scopes required to access data:
Name |
Description |
Notes |
openid |
Sign users in |
Allows users to sign in to the app with their work or school accounts and allows the app to see basic user profile information. |
CallRecord.Read. All(optional) |
Read videocalls |
Allows the app to read information about calls, such as participants, durations, QoS metrics. There is no CallRecord.ReadBasic.All permission to fetch only metadata. |
Channel.ReadBas ic.All |
Read channels |
Allows the app to read basic teams/groups channels data and list of their members, but not its contents. |
ChannelMessage. Read.All |
Read channel messages |
Allows the app to traverse channels and retrieve the messages and replies. |
Chat.Read.All |
Read user chats |
Allows the app to read non-public chats (one to one conversations, private channels, etcetera) per user. |
Group.Read.All |
Read all groups |
Allows the app to list groups, and to read their properties and all group memberships on behalf of the signedin user. Also allows the app to read calendar, conversations, files, and other group content for all groups the signed-in user can access. |
User.Read.All |
Read all users' full profiles |
Allows the app to read the full set of profile properties, group membership, reports and managers of other users in your organization, without a signed-in user. |
See Microsoft reference documentation on permissions scopes for more detail.
Metadata fields used:
For Microsoft Graph both “Teams” and “Groups” are interchangeable and are retrieved from Active Directory Groups.
Field Category |
Field Name |
Required? |
List Groups in an Active Directory
|
ID |
Yes |
resourceProvisioningOptions (filtering by “Teams”) |
Yes |
|
List Users in an Active Directory
|
ID |
Encrypted by Proxy |
Identities |
Yes Pseudonymised by Proxy |
|
List Channels of a Team/Group
|
Id |
Yes |
Description |
Optional |
|
Display Name |
Optional |
|
isFavouriteByDefault |
Yes |
|
membershipType |
Yes |
|
Is cancelled |
Yes |
|
List Chat Message / Replies / Channel Message per user
|
Id |
Yes |
channelIdentity |
Yes |
|
chatId |
No |
|
replyToId |
Yes |
|
From |
Yes Psuedonymized by Proxy |
|
createdDateTime |
Yes |
|
lastModifiedDateTime |
Yes |
|
deletedDateTime |
Yes |
|
Subject (only length) |
Optional |
|
Body (only length) |
Optional |
|
attachmentList (only length) |
Optional |
|
Mentions |
Yes Psuedonymized by Proxy |
|
Importance |
Yes |
|
Reactions |
Yes |
|
Locale |
Optional |
|
Conversation Member from chat/channel |
ID |
Yes (Encrypted by Proxy) |
Microsoft Azure Active Directory (Azure AD)
Permission Scopes required to access data:
Name |
Description |
Notes |
Openid / User.Read |
Sign users in |
Allows users to sign in to the app with their work or school accounts and allows the app to see basic user profile information. |
Directory.Read.All |
Read directory data |
Allows the app to read data in your organization's directory, such as users, groups and apps |
AdministrativeUnit. Read.All |
Read administrative units |
Allows the app to read administrative units and administrative unit membership on behalf of the signed-in user |
Group.Read.All |
Read all groups |
Allows the app to list groups, and to read their properties and all group memberships on behalf of the signed-in user. Also allows the app to read calendar, conversations, files, and other group content for all groups the signed-in user can access. |
MailboxSettings.Re ad |
Read all user mailbox settings |
Allows the app to the read user's mailbox settings. Does not include permission to send mail |
User.Read.All |
Read all users' full profiles |
Allows the app to read the full set of profile properties, group membership, reports and managers of other users in your organization, without a signed-in user. |
See Microsoft reference documentation on permissions scopes for more detail.
Metadata fields used:
Field Category |
Field Name |
Required? |
Groups
|
Id |
Yes |
Type |
Yes |
|
Display name |
Optional |
|
|
Yes |
|
Group Members
|
Id |
Yes Encrypted by Proxy |
Type |
Yes |
|
Users
|
Id |
Yes Encrypted by Proxy |
Display name |
Proxy drops by default |
|
Given name |
Proxy drops by default |
|
Surname |
Proxy drops by default |
|
Hire date |
Yes |
|
|
Yes Pseudonymized by Proxy |
|
Mailbox settings - Timezone |
Optional |
|
Mailbox settings - Workday hours start |
Optional |
|
Mailbox settings -Working hours end |
Optional |
Gmail (Metadata only)
We use the Gmail Metadata oAuth Scope to gather gmail data: https://www.googleapis.com/auth/gmail.metadata
Relevant API documentation on metadata we can access:
- https://developers.google.com/gmail/api/v1/reference/users/messag es/get
- https://developers.google.com/gmail/api/v1/reference/users/messag es#resource
Metadata fields used:
Events by user
Field Name |
Usage / Description of the field |
Required? |
Message ID |
|
Yes |
Thread ID |
|
Yes |
Subject |
Used in certain analyses of sub. E.g., How many emails contain “Project Spec” in subject |
Optional (Proxy drops by default) |
To |
|
Yes Pseudonymized by Proxy |
From |
|
Yes Pseudonymized by Proxy |
CC |
|
Yes Pseudonymized by Proxy |
BCC |
|
Yes Pseudonymized by Proxy |
Labels |
Email labels |
Yes |
sendDate |
|
Yes |
Size estimate |
|
Yes |
Google Calendar
We use the following permission scopes to access event data
- https://www.googleapis.com/auth/calendar.readonly
- https://www.googleapis.com/auth/admin.directory.user.readonly
Relevant API documentation on metadata we can access:
- https://developers.google.com/calendar/v3/reference/events#resource
- https://developers.google.com/calendar/v3/reference/calendars#resource
Metadata fields used:
Field Name |
Usage / Description of the field |
Required? |
List of all events per user |
|
Yes (User ID Encrypted by Proxy) |
Event ID |
Unique ID for each event |
Yes |
Event time and date |
Date and time of event |
Yes |
Event Creator |
Original creator |
Yes Pseudonymized by Proxy |
Event Attendees |
List of all attendees |
Yes Pseudonymized by Proxy |
Event Responses (Attending, declined) |
Used to understand attendance |
Yes |
Event Summary |
Used in certain analyses |
Optional (Proxy drops by default) |
Event Description |
Used in certain analyses |
Optional (Proxy drops by default) |
Event HTML link |
|
Optional |
Event Location |
|
Optional (Proxy drops by default) |
Event Extended Properties |
|
Yes |
Google Drive (Metadata only)
We use the following permission scopes to access event data
- https://www.googleapis.com/auth/calendar.readonly
- https://www.googleapis.com/auth/admin.directory.user.readonly
Relevant API documentation on metadata we can access:
- https://developers.google.com/drive/api/v2/reference/files
- https://developers.google.com/drive/api/v2/reference/revisions
Metadata fields used:
Field Name |
Usage / Description of the field |
Required? |
List of files |
|
Yes |
List of revisions |
Used to capture all the changes made |
Yes |
File ID |
|
Yes |
File Type |
|
Yes |
createdDate |
|
Yes |
modifiedDate |
|
Yes |
Title |
Used in certain rare analyses of file titles |
Optional Proxy drops by default |
Description |
Used in certain rare analyses of file description |
Optional Proxy drops by default |
Link |
|
Yes |
Mime type |
|
Yes |
File size |
|
Yes |
Revisions list |
|
Yes |
Person\Collaborator role |
E.g., viewer, editor, etc |
Yes |
Google Directory / Groups
We use the following permission scopes to access event data
- https://www.googleapis.com/auth/admin.directory.user.readonly
- https://www.googleapis.com/auth/admin.directory.user.alias.readonly
- https://www.googleapis.com/auth/admin.directory.domain.readonly
- https://www.googleapis.com/auth/admin.directory.group.readonly
- https://www.googleapis.com/auth/admin.directory.group.member.readonly
- https://www.googleapis.com/auth/admin.directory.orgunit.readonly
- https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly
Relevant API documentation on metadata we can access:
- https://developers.google.com/admin-sdk/directory/v1/reference/users#resource
- https://developers.google.com/admin-sdk/directory/v1/reference/groups
Metadata fields used:
Field Name |
Usage / Description of the field |
Required? |
List of domains
|
Domains in the org |
Yes |
List of groups (mailing lists), roles, orgunits |
Used for expansion of email groups |
Yes |
List of users per group |
|
Yes Pseudonymized by Proxy |
List of users |
|
Yes Pseudonymized by Proxy |
User Email, Aliases, nonEditableAliases, posixAccounts, ims |
|
Yes Pseudonymized by Proxy |
User creationTime/deletionTime | Used if no dates available from HRIS | Optional |
User locations | Used for timezone management | Optional |
User GID |
|
Yes Encrypted by Proxy |
User customerId, id
|
Used for account linking |
Yes Encrypted by Proxy |
User names |
|
Yes Psuedonymized by Proxy |
User email aliases |
|
Yes Psuedonymized by Proxy |
User isAdmin / isDelegatedAdmin / suspended/ isMailboxsetup | Account state | Yes |
User languages |
Used for segmentation | Optional |
User relations |
Used for segmentation | Optional |
Google Meet
Worklytics supports the retrieval of Google Meet activity data through the Google Activity Audit (https://developers.google.com/admin-sdk/reports) and their Admin SDK API.
We use the following permission scopes to access event data:
Relevant API documentation on metadata we can access:
- https://developers.google.com/admin-sdk/reports/reference/rest
- https://developers.google.com/admin-sdk/reports/v1/guides/authorizing
Metadata fields used:
Field Name |
Usage / Description of the field |
Required? |
Event id |
|
Yes |
Event time |
|
Yes |
Actor Id |
|
Yes Encrypted by Proxy |
Actor email id |
|
Yes Psuedonomized by Proxy |
Actor customer id |
|
Yes |
Events list |
Event is a poliformic that provides different values depending on the application. |
Yes
|
Event Type |
|
Yes |
Event Name |
|
Yes |
Parameters (call duration, call quality) |
|
Yes |
Google Chat
Worklytics supports the retrieval of Google Chat activity data through the Google
Activity Audit (https://developers.google.com/admin-sdk/reports) and their Admin SDK API.
Scopes required:
https://developers.google.com/admin-sdk/reports/v1/guides/authorizing
- Scope: https://www.googleapis.com/auth/admin.reports.audit.readonly
- Description: Read-only access when retrieving an activity report Relevant API documentation on metadata we can access:
Calls used:
Relevant API documentation on metadata we can access
https://developers.google.com/admin-sdk/reports/reference/rest
- List activities for application = chat
- https://developers.google.com/admin-sdk/reports/v1/reference/activities/list
Metadata fields used:
Field Name |
Usage / Description of the field |
Required? |
Event id |
|
Yes |
Event time |
|
Yes |
Actor Id |
|
Yes Psuedonomized by Proxy |
Actor email id, |
|
Yes Psuedonomized by Proxy |
Actor customer id |
|
Yes |
Events list |
Event is a poliformic that provides different values depending on the application. For GChat, usual values contain:
|
Yes |
Slack Discovery API (Requires Proxy)
Worklytics supports multiple avenues for importing Slack data including directly importing (sanitized) Slack Exports from an S3 Bucket or similar shared storage. The documentation below refers to our integration with the Slack Discovery API. Please contact us for more information on alternative configurations.
Scopes required:
Permission Scopes used: |
- "discovery:read" |
Relevant API Documentation
https://api.slack.com/enterprise/discovery(CONFIDENTIAL)
Metadata fields used:
Field Category |
Field Name |
Usage / Description of the field |
Required? |
Conversation |
ID |
|
Yes |
|
Creation date |
|
Yes |
|
Name |
|
Optional |
|
Topic |
|
Optional |
|
Creator ID |
|
Yes Psuedonomized by Proxy |
Conversation Members |
Member ID |
|
Yes Psuedonomized by Proxy |
Messages |
Channel ID |
|
Yes |
|
Timestamp |
|
Yes |
|
Body (just length) |
|
No (Proxy drops by default) |
|
Author ID |
|
Yes Psuedonomized by Proxy |
|
Reactions |
|
Yes |
|
Mentions |
|
Yes |
Users |
User IDs |
|
Yes Encrypted by Proxy |
|
User names |
|
Yes Psuedonomized by Proxy |
|
Last update time |
|
Yes |
|
|
|
Yes Psuedonomized by Proxy |
|
Type (bot, person) |
|
Yes |
Recent Conversations |
Channel IDs |
|
Yes |
Slack Public Channels only
Permission Scopes used: |
- "channels:history" - "channels:read" - "users:read" - "users:read.email" |
Relevant API Documentation
Metadata fields used:
Field Category |
Field Name |
Usage / Description of the field |
Required? |
Public Conversation |
ID |
|
Yes |
|
Creation date |
|
Yes |
|
Name |
|
No |
|
Topic |
|
No |
|
Creator ID |
|
Yes Psuedonomized by Proxy |
|
Members list |
|
Yes Psuedonomized by Proxy |
Messages |
Channel ID |
|
Yes |
|
Timestamp |
|
Yes |
|
Body (length) |
|
No (Proxy drops by default) |
|
Permalink |
|
Yes |
|
Author ID |
|
Yes Psuedonomized by Proxy |
|
Reactions |
|
Yes |
|
Mentions |
|
Yes |
Users |
User names |
|
Yes Psuedonomized by Proxy |
|
Last update time |
|
Yes |
|
|
|
Yes Psuedonomized by Proxy |
|
Type (bot, person) |
|
Yes |
Note: Slack private channels available through Slack Export. Worklytics provides a script which allows your team to clean out all messages and attachments.
Zoom
Note: Zoom integration is under active development and some fields might be dropped or
Permission Scopes used: |
"user:read:admin" "meeting:read:admin" |
Relevant API Documentation: |
Metadata fields used:
Field Category |
Field Name |
Usage / Description of the field |
Required? |
Users |
ID |
|
Yes Encrypted by Proxy |
|
Names |
|
Yes Pseudonymised by Proxy |
|
|
|
Yes Pseudonymised by Proxy |
|
Timezone |
|
Yes |
|
Creation time |
|
Yes |
|
Last login time |
|
Yes |
Meetings |
UUID |
|
Yes |
|
ID |
|
Yes |
|
Host ID |
|
Yes |
|
Topic |
|
No (Proxy drops by default) |
|
Start time |
|
Yes |
|
End time |
|
Yes |
|
Type |
|
Yes |
|
Duration |
|
Yes |
|
Timezone |
|
Yes |
|
Creation date |
|
Yes |
|
Join URL |
|
Optional |
|
Total minutes |
|
Yes |
|
Participants count |
|
Yes |
|
Participants ID, name, email |
|
Yes Pseudonymised by Proxy |
GitHub
Permission Scopes used: |
"user" "repo" "read:org" "write:repo_hook" "admin:org_hook" |
Relevant API Documentation: |
Methods Used:
Category |
Field Name |
More Details |
Required? |
ID |
|
Yes |
|
|
Names |
|
Yes
|
Login (username) |
|
Yes
|
|
Login (username) |
|
Yes
|
|
|
|
|
Yes
|
Create / Delete Organization Webhooks |
Subscribe to events, all related to repo management (issues, commits, deployment, create repo/PR/branch, commits, start, milestones) |
Used to configure webhooks for events |
Optional |
For repositories allowed in connection settings
Category |
Field Name |
More Details |
Required? |
Commit SHA |
|
Yes |
|
Commit SHA |
|
Yes |
|
|
Message |
|
Yes |
|
Author |
|
Yes |
|
Date |
|
Yes |
|
# Changed files |
|
Yes |
|
# Lines added |
|
Yes |
|
# Lines deleted |
|
Yes |
|
# Commit parents |
|
Yes |
Issue Number |
|
Yes |
|
Author |
|
Yes Pseudonymised by Proxy |
|
|
Date |
|
Yes |
|
Body (length) |
|
No Proxy drops by default |
Event type (action) |
|
Yes |
|
|
User |
|
Yes Pseudonymised by Proxy |
Dates (creation, merge, close) |
|
Yes |
|
|
Title |
|
No Proxy drops by default |
|
Description |
|
No Proxy drops by default |
|
URL |
|
Yes |
|
# Additions |
|
Yes |
|
# Deletions |
|
Yes |
|
# Commits |
|
Yes |
|
# Comments |
|
Yes |
|
# Changed files |
|
|
|
State |
|
Yes |
|
Diff, Issue, Path URLs |
|
No Proxy drops by default |
|
Author |
|
Yes Pseudonymised by Proxy |
Authors |
|
Yes Pseudonymised by Proxy |
|
|
Commiter |
|
Yes Pseudonymised by Proxy |
Reviewer |
|
Yes Pseudonymised by Proxy |
|
|
Comment body (truncated and length) |
|
No Proxy drops by default |
|
Dates |
|
Yes |
JIRA
Permission Scopes used: |
"READ" |
Relevant API Documentation: |
Methods Used:
Category | Field Name | More Details | Required? |
Users | accountId / key | AccountId is used for Jira Cloud; key is used in Jira Server |
Yes Encrypted by Proxy |
Names |
No Proxy drops by default |
||
DisplayName |
No Proxy drops by default |
||
EmailAddress |
Yes Pseudonymised by Proxy |
||
Active | Yes | ||
Locale | Yes | ||
Timezone | Yes | ||
AvatarURLs |
No Proxy drops by default |
||
Group | GroupId | ||
Name |
No Proxy drops by default |
||
Issue Search through SQL | ID | Yes | |
Progress | Yes | ||
Creator ID |
Yes Pseudonymised by Proxy |
||
Assignee ID |
Yes Pseudonymised by Proxy |
||
Watchers IDs |
Yes Pseudonymised by Proxy |
||
Reporter IDs |
Yes Pseudonymised by Proxy |
||
Related Issues IDs | Yes | ||
Time tracking data | Yes | ||
Summary |
No Proxy drops by default |
||
Description (only user IDs mentioned, provided by ADF) |
No Proxy drops by default, UserIds are Pseudonymised by Proxy |
||
URL | Yes | ||
Attachments Authors |
Yes Pseudonymised by Proxy |
||
Dates: creation, resolution, due, lastViewed, etc | Yes | ||
Priority | Yes | ||
Watches | Yes | ||
TimeSpent | Yes | ||
AggregatedProgress | Yes | ||
Status | Yes | ||
Subtasks | Yes | ||
Project | Yes | ||
IssueLinks | Yes | ||
Votes | Yes | ||
Issue ID | Yes | ||
Comment author ID |
Yes Pseudonymised by Proxy |
||
Comment updater author ID |
Yes Pseudonymised by Proxy |
||
User IDs mentioned, (provided by ADF) |
Yes Pseudonymised by Proxy |
||
Creation, update date | Yes | ||
Issue Worklog | Author ID |
Yes Pseudonymised by Proxy |
|
Worklog updater author Id |
Yes Pseudonymised by Proxy |
||
Dates (started, updated) | Yes | ||
Time tracking fields | Yes | ||
Issue Id | Yes | ||
User IDs mentioned, (provided by ADF) |
Yes Pseudonymised by Proxy |
||
Issue changelog | Author ID |
Yes Pseudonymised by Proxy |
|
Creation time | Yes | ||
Field | Yes | ||
FieldType | Yes | ||
FromString |
No Proxy drops by default |
||
ToString |
No Proxy drops by default |
||
tmpToAccountID |
Yes Pseudonymised by Proxy |
||
tmpFromAccountID |
Yes Pseudonymised by Proxy |
||
Project | archivedBy |
Yes Pseudonymised by Proxy |
|
archivedDate | Yes | ||
deletedBy |
Yes Pseudonymised by Proxy |
||
deletedDate | Yes | ||
Webhooks | Issue created, updated, deleted | Optional |
Salesforce
The Salesforce connector is in Alpha, which means that the permissions and fields are not final. Worklytics requires the following permission scopes:
full |
Full Access |
Allows access to all data accessible by the logged-in user, and encompasses all other scopes. |
refresh_token |
Perform requests on your behalf at any time |
Allows to renew access to Salesforce data without requiring to re-authenticate and authorize manually. |
access_token |
Getting access for performing requests on your behalf at any time |
Allows to get access to the resources to download data |
See Salesforce reference documentation on permissions scopes for more detail.
Metadata fields used:
Field Category |
Field Name |
Usage / Description of the field |
Required? |
User Object Fields |
Alias |
|
Yes Pseudonymised by Proxy |
|
AccountId |
|
Yes Encrypted by Proxy |
|
ContactId |
|
Yes Encrypted by Proxy |
|
CreatedDate |
|
Yes |
|
CreatedById |
|
Yes |
|
|
|
Yes Pseudonymised by Proxy |
|
EmailEncodingKey |
|
Yes |
|
Id |
|
Yes Encrypted by Proxy |
|
IsActive |
|
Yes |
|
LastLoginDate |
|
Yes |
|
LastModifiedDate |
|
Yes |
|
ManagerId (not yet used) |
|
Yes Encrypted by Proxy |
|
Name |
|
No Proxy drops by default |
|
TimeZoneSidKey (not yet used) |
|
Yes |
|
Username |
|
Yes Pseudonymised by Proxy |
|
UserRoleId (not yet used) |
|
Yes |
|
UserType |
|
Yes |
Account Object Fields |
Id |
|
Yes |
|
AccountSource |
|
Yes |
|
AnnualRevenue |
|
Yes |
|
CreatedDate |
|
Yes |
|
CreatedById |
|
Yes Pseudonymised by Proxy |
|
IsDeleted |
|
Yes |
|
LastActivityDate |
|
Yes |
|
LastModifiedDate (not used) |
|
Yes |
|
LastModifiedById |
|
Yes |
|
NumberOfEmployees |
|
Yes |
|
OwnerId |
|
Yes Pseudonymised by Proxy |
|
Ownership |
|
Yes |
|
ParentId |
|
Yes |
|
Rating |
|
Yes |
|
Sic |
|
Yes |
|
Type |
|
Yes |
Account History Object Fields |
AccountId |
|
Yes Encrypted by Proxy |
|
ActivityDate |
|
Yes |
|
ActivityDateTime |
|
Yes |
|
ActivitySubtype |
|
Yes |
|
ActivityType |
|
Yes |
|
CallDurationInSeconds |
|
Yes |
|
CallType |
|
Yes |
|
CreatedDate |
|
Yes |
|
CreatedById |
|
Yes |
|
DurationInMinutes |
|
Yes |
|
EndDateTime |
|
Yes |
|
Id |
|
Yes |
|
IsAllDayEvent |
|
Yes |
|
IsDeleted |
|
Yes |
|
IsHighPriority |
|
Yes |
|
IsTask |
|
Yes |
|
LastModifiedDate |
|
Yes |
|
LastModifiedById |
|
Yes |
|
OwnerId |
|
Yes Pseudonymised by Proxy |
|
Priority |
|
Yes |
|
StartDateTime (not used) |
|
Optional |
|
Status |
|
Optional |
|
WhatId (not used) |
|
Optional |
|
WhoId (not used) |
|
Optional |
Asana
Worklytics uses the “default” oauth scope for Asana
Metadata fields used:
Field Category |
Field Name |
Usage / Description of the field |
Required? |
Fields Users |
Name |
|
Yes |
|
Id |
|
Yes Encrypted by Proxy |
|
|
|
Yes Pseudonymised by Proxy |
Fields Workspace |
Id |
|
Yes |
|
name |
|
Yes |
Fields Project |
name |
|
Yes |
|
owner |
|
Yes Pseudonymised by Proxy |
|
layout |
|
Yes |
|
current_status |
|
Yes |
|
due_date |
|
Yes |
|
due_on |
|
Yes |
|
start_on |
|
Yes |
|
html_notes |
|
Yes |
|
archived |
|
Yes |
|
isArchived |
|
Yes |
|
public |
|
Yes |
|
followers |
|
Yes Pseudonymised by Proxy |
|
members |
|
Yes Pseudonymised by Proxy |
|
team |
|
Optional (Proxy drops by default) |
|
workspace |
|
Yes |
|
custom_fields |
|
Yes |
|
custom_field_setti ngs |
|
Yes |
|
created_at |
|
Yes |
|
modified_at |
|
Yes |
Fields Task |
assignee |
|
Yes Pseudonymised by Proxy |
|
assignee_status |
|
Yes |
|
Created_at |
|
Yes |
|
completed |
|
Yes |
|
completed_at |
|
Yes |
|
custom_fields |
|
Yes |
|
dependencies |
|
Yes |
|
dependents |
|
Yes |
|
due_on |
|
Yes |
|
due_at |
|
Yes |
|
external |
|
Yes |
|
followers |
|
Yes Pseudonymised by Proxy |
|
is_rendered_as_separator |
|
Yes |
|
isRenderedAsSeparator |
|
Yes |
|
liked |
|
Yes |
|
likes |
|
Yes |
|
memberships |
|
Yes Pseudonymised by Proxy |
|
name |
|
Yes |
|
html_notes |
|
No Proxy drops by default |
|
num_likes |
|
Yes |
|
Num_subtasks |
|
Yes |
|
parent |
|
Yes |
|
projects |
|
Yes |
|
start_on |
|
Yes |
|
workspace |
|
Yes |
|
tags |
|
Yes |
|
hearted |
|
Yes |
|
hearts |
|
Yes |
|
num_hearts |
|
Yes |
|
numHearts |
|
Yes |
Comments
0 comments
Please sign in to leave a comment.