Data Available on Platform Usage

Look up every field of the two Delta Sharing usage tables, how each field type should be analyzed, and the data-volume best practices.

6 min read

Two tables are currently shared via Delta Sharing: platform_aggregated_usage, which holds aggregated client space and workspace data, and platform_detail_usage, which holds per-user activity. Each of their fields is described below.

To get access, please contact your account manager.

How the data is structured

Both tables contain flat data: each row corresponds to the finest level available, i.e. an object type (combined with a module, a workspace and a day, and for table 2, with a user). Metrics are calculated every day for the previous day (D-1).

Each field belongs to one of the three categories below, shown in the Type column of the tables:

TypeMeaning and best practice
DimensionAnalysis axis (date, client space, workspace, module, object type, user…) used to filter or group metrics.
Detailed metricValue specific to each row (object type). It can be summed and analyzed along all dimensions, with no specific handling required.
Global metricValue calculated at a higher level (client space, instance or user) and repeated identically on every row of that level. Do not sum it across object types: use an average, a median, a maximum value, or filter on a single object type. The relevant analysis dimensions are given in the description of each metric.

Table 1: General information (platform_aggregated_usage)

This table contains aggregated data at client space and workspace level. It covers the entire history and is updated daily with the previous day's metrics (D-1). It is suited to tracking platform adoption over time: licenses, active users, and object volume and documentation.

Field nameTypeDescription
time_periodDimensionPeriod considered for data collection: daily.
instanceDimensionCode of the instance where the client is deployed.
clientspace_nameDimensionName of a company's client space.
clientspace_uidDimensionUnique identifier of a client space.
workspace_nameDimensionName of the workspace belonging to a client space.
workspace_uidDimensionUnique identifier of a workspace.
workspace_typeDimensionWorkspace classification: DEV (workspace used for testing purposes, not yet published) or PROD (workspace published and available to readers).
moduleDimensionPlatform module.
obj_typeDimensionObject type existing on the platform.
nb_worskpacesGlobal metricNumber of workspaces in the client space during the period considered. Possible analysis dimensions: time + client space / instance.
assigned_stewardsGlobal metricNumber of Steward licenses assigned in the client space during the period considered. Possible analysis dimensions: time + client space / instance.
assigned_readersGlobal metricNumber of Reader licenses assigned in the client space during the period considered. Possible analysis dimensions: time + client space / instance.
available_stewardsGlobal metricNumber of Steward licenses available in the client space during the period considered. Possible analysis dimensions: time + client space / instance.
available_readersGlobal metricNumber of Reader licenses available in the client space during the period considered. Possible analysis dimensions: time + client space / instance.
active_stewardsGlobal metricNumber of active Stewards in the client space during the period considered. An active Steward is a Steward who logged in and created or modified at least one object. Possible analysis dimensions: time + client space / instance.
active_readersGlobal metricNumber of active Readers in the client space during the period considered. An active Reader is a Reader who logged in and performed at least one click. Possible analysis dimensions: time + client space / instance.
plugins_activatedGlobal metricNumber of DataGalaxy browser plugins activated in the client space during the period considered.
obj_createdDetailed metricNumber of objects created during the period considered, for the module, object type and workspace considered.
obj_deletedDetailed metricNumber of objects deleted during the period considered, for the module, object type and workspace considered.
descr_addedDetailed metricNumber of descriptions added during the period considered, for the module, object type and workspace considered.
links_addedDetailed metricNumber of links added during the period considered, for the module, object type and workspace considered.
obj_viewedDetailed metricNumber of objects viewed during the period considered, for the module, object type and workspace considered.
obj_totalDetailed metricTotal number of existing objects for the object type considered.
obj_descrDetailed metricNumber of objects with a non-empty description.
obj_descr_validatedDetailed metricNumber of objects with a non-empty description and a validated status.

Table 2: User activities (platform_detail_usage)

This table contains non-aggregated data at individual user level. It allows a detailed analysis of each user's activity: logins, creations, modifications, views, etc. It is updated daily with the previous day's metrics (D-1).

User activity data is retained for a rolling 3-month period. If you want to keep a longer history, we recommend storing this data on your side.
Field nameTypeDescription
time_periodDimensionPeriod considered for data collection: daily.
instanceDimensionCode of the instance where the client is deployed.
clientspace_nameDimensionName of a company's client space.
workspace_nameDimensionName of the workspace belonging to a client space.
workspace_uidDimensionUnique identifier of a workspace.
workspace_version_uidDimensionUnique identifier of a workspace version.
workspace_version_nameDimensionName of the workspace version.
workspace_version_statusDimensionStatus of the workspace version.
moduleDimensionPlatform module.
obj_typeDimensionObject type existing on the platform.
user_uidDimensionUnique identifier of a user.
user_nameDimensionUser's first and last name.
user_roleDimensionUser's role, as defined on the platform.
user_teamDimensionList of teams the user is assigned to.
licenseDimensionUser's license type.
is_tokenDimensionBoolean indicating whether the user is an integration token or not. Useful in particular to exclude automated imports from the analysis of human activity.
number_connectionsGlobal metricNumber of times the user logged in to the platform during the period considered. Possible analysis dimensions: time + user + client space / instance.
is_newcomerGlobal metricIndicates whether the user is new (had never logged in before). This metric equals 1 (= true) only on the day of the user's first login. Possible analysis dimensions: time + user + client space / instance.
obj_created_userDetailed metricNumber of objects created by the user.
obj_modified_userDetailed metricNumber of objects modified by the user.
obj_deleted_userDetailed metricNumber of objects deleted by the user.
obj_imported_userDetailed metricNumber of objects imported by the user.
obj_owned_userDetailed metricNumber of objects owned by the user.
link_created_userDetailed metricNumber of links created by the user.
obj_viewedDetailed metricNumber of distinct objects viewed by the user.
nb_viewsDetailed metricTotal number of views (a user can view the same object several times).

How to handle large data volumes

The platform_detail_usage table can become very large for clients with many users. For example, with the 4 default modules (56 object types) over about 92 days, multiplied by the number of users, a client space with more than 240 users quickly exceeds 1 million rows.

  • Prefer a workspace-level token. A client-space-level token multiplies the data by the number of workspaces.

Read more

Related articles

Was this page helpful?