Data Inventory
Last updated
Last updated
© Worklytics Co.
The following table(s) contains detailed examples of the metadata fields available from the GitHub API endpoints Worklytics leverages. In order to pseudonymize and sanitize PII and other potentially sensitive data, Worklytics provides access to a Data Loss Prevention (DLP) Proxy, which allows customers to pre-filter metadata, within customer infrastructure, before it is sent to Worklytics for processing.
These are the fields Worklytics recommends but the Worklytics DLP Proxy provides full field-level control and therefore any field may be removed or sanitized.
Field descriptions are taken from third party API documentation, these are maintained on a best effort basis and Worklytics can not guarantee their indefinite accuracy. Please refer to the source API site for the most up-to-date documentation.
How to read the "DLP Proxy" column in the table(s):
🔴 This field is completely redacted by the DLP Proxy
⭕ This field is transformed, usually partially redacted
🟡 This field is "pseudonymized" by the DLP Proxy: only a SHA256 hash of its value is sent to Worklytics; never the value itself
To see only the fully sanitized version of this document, click here.
Worklytics requires access to the following API primary endpoints:
Model | Description | API docs |
---|---|---|
Used to list all users who are members of an organization, individual users, and team members
Endpoints:
| ||
Used to retrieve a list of branches in a repository
Endpoints:
| ||
Used to list all reviews for a specified pull request
Endpoints:
| ||
Used to list comments on issues
Endpoints:
| ||
Used to list events on an issue's timeline
Endpoints:
| ||
Used to retrieve all teams in an organization (only visible ones, subject to granted access)
Endpoints:
| ||
Used to retrieve a list of users from an organization's SAML identity provider (see DLP Proxy documentation for query details)
Endpoints:
| ||
Used to retrieve the audit log for an organization
Endpoints:
| ||
Used to retrieve a lists of pull requests (or an individual one) in a specified repository
Endpoints:
| ||
Used to retrieve comments of a pull request (or comments in one of its reviews)
Endpoints:
| ||
Used to retrieve a list of commits for a given repository (or a pull request)
Endpoints:
| ||
Used to retrieve a list of users from an organization's members with role (see DLP Proxy documentation for query details)
Endpoints:
| ||
Used to retrieve a list of repositories for the specified organization
Endpoints:
| ||
Used to retrieve a list of issues from a repo (or an individual issue)
Endpoints:
| ||
Used to retrieve a list of events
Endpoints:
|
API docs: https://docs.github.com/en/rest/orgs/members?apiVersion=2022-11-28#list-organization-members
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🟡 Pseudonymized |
| String |
Raw example: |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🟡 Pseudonymized |
| String |
Raw example: |
🔴 Redacted |
| N/A | |
🟡 Pseudonymized |
| String | |
🔴 Redacted |
| N/A | |
🟡 Pseudonymized |
| String |
Raw example: |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🟢 Allowed |
| boolean | |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🟢 Allowed |
| String | |
🔴 Redacted |
| N/A |
API docs: https://docs.github.com/en/rest/reference/repos#branches
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🟢 Allowed |
| Commit | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean |
API docs: https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#list-reviews-for-a-pull-request
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🟡 Pseudonymized |
| Links | |
🔴 Redacted |
| LinkReference | |
🔴 Redacted |
| String | |
🔴 Redacted |
| LinkReference | |
🔴 Redacted |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟡 Pseudonymized |
| User | |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String | |
🟡 Pseudonymized |
| String |
Raw example: |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| String |
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🔴 Redacted |
| String | |
🟡 Pseudonymized |
| User | |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String | |
🟡 Pseudonymized |
| String |
Raw example: |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| String |
API docs: https://docs.github.com/en/rest/issues/timeline
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🟢 Allowed |
| String | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String |
API docs: https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#list-teams
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🔴 Redacted |
| N/A | |
🟢 Allowed |
| Long | |
🔴 Redacted |
| N/A | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Team | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String |
API docs: https://docs.github.com/en/graphql/reference/objects#organization
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🟡 Pseudonymized |
| SamlIdentityProvider | |
🟡 Pseudonymized |
| ExternalIdentities | |
🟡 Pseudonymized |
| List of Edge | |
🟡 Pseudonymized |
| Node | |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| SamlIdentity | |
🟡 Pseudonymized |
| List of Email | |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String | |
🟡 Pseudonymized |
| User | |
🟡 Pseudonymized |
| String | |
🟢 Allowed |
| Pagination | |
🟢 Allowed |
| String | |
🟢 Allowed |
| boolean | |
🔴 Redacted |
| N/A |
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🟢 Allowed |
| Instant | |
🟢 Allowed |
| String | |
🟡 Pseudonymized |
| String | |
🟢 Allowed |
| String | |
🔴 Redacted |
| String | |
🔴 Redacted |
| String | |
🟢 Allowed |
| Instant | |
🔴 Redacted |
| N/A | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🔴 Redacted |
| N/A | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🔴 Redacted |
| N/A | |
🔴 Redacted |
| N/A | |
🟡 Pseudonymized |
| String | |
🟡 Pseudonymized |
| String | |
🔴 Redacted |
| N/A |
API docs: https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🟢 Allowed |
| Links | |
🟢 Allowed |
| LinkReference | |
🟢 Allowed |
| String | |
🟢 Allowed |
| LinkReference | |
🟢 Allowed |
| String | |
🟢 Allowed |
| LinkReference | |
🟢 Allowed |
| String | |
🟢 Allowed |
| LinkReference | |
🟢 Allowed |
| String | |
🟢 Allowed |
| LinkReference | |
🟢 Allowed |
| String | |
🟢 Allowed |
| LinkReference | |
🟢 Allowed |
| String | |
🟢 Allowed |
| LinkReference | |
🟢 Allowed |
| String | |
🟢 Allowed |
| LinkReference | |
🟢 Allowed |
| String | |
🟢 Allowed |
| LinkReference | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| User | |
🟢 Allowed |
| List of User | |
🟢 Allowed |
| String | |
🟢 Allowed |
| AutoMerge | |
🟢 Allowed |
| User | |
🟡 Pseudonymized |
| CommitReference | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟡 Pseudonymized |
| Repository | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🔴 Redacted |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🔴 Redacted |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| License | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🔴 Redacted |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🔴 Redacted |
| User | |
🟢 Allowed |
| Permission | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| String | |
🟢 Allowed |
| SecurityAndAnalysis | |
🟢 Allowed |
| SecurityFlag | |
🟢 Allowed |
| String | |
🟢 Allowed |
| SecurityFlag | |
🟢 Allowed |
| SecurityFlag | |
🟢 Allowed |
| SecurityFlag | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| List of String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| User | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟡 Pseudonymized |
| CommitReference | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟡 Pseudonymized |
| Repository | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🔴 Redacted |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🔴 Redacted |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| License | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🔴 Redacted |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🔴 Redacted |
| User | |
🟢 Allowed |
| Permission | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| String | |
🟢 Allowed |
| SecurityAndAnalysis | |
🟢 Allowed |
| SecurityFlag | |
🟢 Allowed |
| String | |
🟢 Allowed |
| SecurityFlag | |
🟢 Allowed |
| SecurityFlag | |
🟢 Allowed |
| SecurityFlag | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| List of String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| User | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| List of Label | |
🟢 Allowed |
| String | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| User | |
🟢 Allowed |
| Milestone | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| User | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Boolean | |
🟢 Allowed |
| List of User | |
🟢 Allowed |
| List of Team | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Team | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🔴 Redacted |
| String | |
🟡 Pseudonymized |
| User | |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String | |
🟡 Pseudonymized |
| String |
Raw example: |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| String |
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| Long | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Instant | |
🔴 Redacted |
| String | |
🟡 Pseudonymized |
| User | |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String | |
🟡 Pseudonymized |
| String |
Raw example: |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| String |
API docs: https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28
DLP Proxy docs: GitHub
DLP Proxy | Property Name | Type | Description |
---|---|---|---|
🟡 Pseudonymized |
| User | |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String |
Raw example: |
🟡 Pseudonymized |
| String | |
🟡 Pseudonymized |
| String |
Raw example: |
🟢 Allowed |
| boolean | |
🟢 Allowed |
| String | |
🟢 Allowed |
| String | |
🔴 Redacted |
| N/A | |
🟢 Allowed |
| CommitMetadata | |
🟢 Allowed |
| Actor | |
🟢 Allowed |
| Instant | |
🟢 Allowed |
| String | |
🟢 Allowed |
| Integer | |
🟢 Allowed |