Overview

Gtmhub reports are powered by Gtmhub data sources. In addition to the out-of-the-box reports, Gtmhub allows you to create any additional insights, displaying specific information in custom format, according to your requirements.
Find more information, see Gtmhub connection, data sources, and entities.

Following is detailed information about the content, meaning, and relation of all Gtmhub entities:


GtmhubPlanningSessions

Information about all sessions in your account:

  • id - string
    The internal ID of a session
  • parentid - string
    The internal ID of the parent session. It is an empty string when there is no parent session.
  • start - date
    The start date of the session
  • end - date
    The end date of the session
  • title - string
    The name of the session
  • status - string
    The status of the session.
    Available options: open, locked, and closed.
    When the session is open, in progress, or archived, respectively.
  • workflow_reviewers - integer
    The minimum count of reviewers when approval workflow is enabled for the session.
    Available options: 1 or 2.
  • cadence_type - string
    The cadence that is set for the session.
    Available options: weekly, bi-weekly, and monthly.
  • cadence_totalcadences - integer
    The total count of cadences for this session, calculated based on its length and the cadence type.

GtmhubSessionCadences

Information about how many cadences there are in a certain session and what the period of every cadence is:

  • session_id - string
    The internal ID of the session
  • cadence_order - integer
    The order of every cadence
  • start - date
    The start date of this cadence
  • end - date
    The end date of this cadence

For more information, see OKRs cadence.


GtmhubGoals

Information about all objectives in your account:

  • id - string
    The internal ID of the objective
  • sessionid - string
    The ID of the session this objectives belongs to
  • name - string
    The name of the objective
  • assignee_name - string
    The name of the objective owner. This is the team name or the first and the last names of the user that is the owner of the objective.
  • assignee_type - string
    Indicates whether the objective owner is a team or an individual.
    Available options: team and user.
  • parentid - string
    The ID of the parent objective, under which this objective is aligned. It is an empty string when there is no parent objective.
  • parentgoalsessionid - string
    The ID of the session of the parent objective, under which this objective is aligned. It is an empty string when there is no parent objective.
  • datecreated - date
    The date when the objective was created.
  • dateto - date
    The end date of the objective, inherited from the session end date.
  • datefrom - date
    The start date of the objective, inherited from the session start date.
  • attainment - double
    The progress of the objective as an absolute value. If you want to turn it into a percentage, multiply the value by 100.
  • aggregatedattainment - double
    The average progress of all subobjectives of the objective in the same session. This is an absolute value. If you want to turn it into a percentage, multiply the value by 100.
  • metricscount - integer
    The total count of the key results created under this objective
  • taskscount - integer
    The total count of the tasks created under this objective
  • ownerid - string
    The internal ID of the user or team that owns the objective
  • customfields - string
    The list of all custom fields of the objective, together with their values. This is a JSON string format.
  • workflow_status - string
    The status of the objective, if workflow is enabled  on session level.
    Available options: draft, inReview, and approved.
  • fullaggregatedattainment - double
    The average progress of all objectives and their subobjectives that are aligned under this objective. This is an an absolute value. If you want to turn it into a percentage, multiply the value by 100.
  • childrenaggregatedattainment - double
    The average progress of all direct subobjectives as an absolute value. If you want to turn it into a percentage, multiply the value by 100.
  • designscore_totalpoints - integer
    The value of the design score of this objective
  • attainmenttypestring - string
    Indicates how the objective progress is calculated.
    Available options: average_kr and average_children. When the average is calculated based on the key results or based on the subobjectives.

GtmhubGoalTags

Information about the mapping between the objectives their tags:

  • goal_id - string
    The internal ID of the objective 
  • title - string
    The title of the tag
  • name - string
    The system name of the tag

GtmhubMetrics

Information about all key results in your account:

  • id - string
    The internal ID of the key result
  • goalid - string
    The internal ID of the objective this key results is part of
  • name - string
    The name of the key result
  • target - double
    The target value of the key result
  • initialvalue - double
    The initial value of the key result
  • actual - double
    The current value of the key result
  • attainment - double
    The progress of the key result as an absolute value. If you want to turn it into a percentage, multiply the value by 100
  • progressstatus - string
    The progress status indicator, calculated based on the current value of the key result and ideal progress, marked with dashed line on the key result progress diagram. Used for coloring the key result diagram in red or green.
    Available options: bad and good.
    Indicates whether the key result progress is below or above the ideally expected progress.
  • manualtype - string
    Shows the type of the manual key result.
    Available options: boolean, double, or empty.
    When the key result is Boolean, it is of type Achieved or not. If it is double, the key result has a numeric value as target. If it is empty, the key result is dynamic.
  • softduedate - date
    The soft deadline for achieving this key result
  • duedate - date
    The hard deadline for achieving this key result
  • createdbyid - string
    The internal ID of the user who created the key result
  • ownerid - string
    The internal ID of the user or team that owns the key result
  • critical - double
    The critical value of the key result. Used for key results with type Should stay above and Should stay below a certain target.
  • confidence_value - double
    The value of the confidence level of the key result. If your confidence levels are set to text or emojis, this is the upper limit value of every range.
  • targetoperator - string
    The type if the key result.
    Available options: at_least, at_most, should_stay_above, and should_stay_below.
    At least mean that the key result type is Should increase to or Achieved or not. At most means that the key result type is Should decrease to.
  • insightname - string
    Used for dynamic key results only. This is the internal ID of the insight where the key results originates from.
  • fieldname - string
    Used for dynamic key results only. The field name of the metric which the key results originates from
  • dynamic - boolean
    Indicates whether the key result is dynamic or manual.
    Available options: true and false.
    True stands for a dynamic key result.
  • datecreated - date
    The date when the key result was created
  • customfields - string
    A list of all custom fields of the objective, together with their values. This is a JSON string format.

GtmhubMetricSnapshots

Information about all key results updates:

  • id - string
    The internal ID of the update
  • createdat - date
    The date when the key result update was made
  • value - string
    The key result value applied with this update
  • comment - string
    The content of the note left by the user during the update
  • confidence - double
    The confidence level value applied with this update. If the confidence levels are set to text or emojis, it is the upper limit value of every range
  • modifiedby - string
    The internal ID of the user who made the update
  • metricid - string
    The internal ID of the key result
  • attainment - double
    The absolute value of the key result progress achieved with this update. If you want to turn it into a percentage, multiply the value by 100
  • attainmentchange - double
    The absolute value of the change in this key result, achieved with this update. If you want to turn it into a percentage, multiply the value by 100
  • customfields - string
    The list of all custom fields on key result update level and their values, added by the user during the update. This is a JSON string format.

GtmhubTeams

Information about all teams in your account:

  • id - string
    The internal ID of the team
  • name - string
    The name of the team
  • parentid - string
    The internal ID of the parent team
  • description - string
    The description of the team 
  • manager - string
    The internal ID of the employee assigned as manager of this team
  • customfields - string
    A list of all custom fields and their values created on team level in a JSON string format

GtmhubTeamMembers

Information about the mapping between the teams and the their members:

  • team_id - string
    The internal ID of the team 
  • user_id - string
    The internal ID of the employee part of this team

NOTE: The team manager is not part of the mapping.


GtmhubUsers

Information about all users in your account:  

  • id - string
    The internal ID of the user
  • email - string
    The email address the user
  • name - string
    The username of the user. In Gtmhub it equals to the email address.
  • firstname - string
    The first name of the user
  • lastname - sting
    The last name of the user
  • invitedby - string
    The internal ID of the user who invited this user
  • datecreated - date
    The date when the user was created. This is the first login in the platform
  • dateinvited - date
    The date when the user was invited
  • customfields - string
    The list of all custom fields and their values created for the user in a JSON string format

GtmhubRoles

Information about all roles in your account:

  • id - string
    The internal ID of the role
  • name - string
    The name of the role

GtmhubUserRoles

Information about the mapping between users and their roles:

  • roleid - string
    The internal ID of the role assigned to the user 
  • userid - string
    The internal ID of the user

GtmhubAssignees

Information about all employees and teams owning objective, key results, and tasks:

  • id - string
    The internal ID of the team or the employee
  • name - string
    The name of the team or the first and the last names of the employee
  • email - string
    The email address of the employee. It is empty, if the owner is a team.
  • color - string
    The HEX color code of the team avatar. It is empty, if the owner is an employee.
  • avatar - string
    The internal name of the symbol of the team avatar. It is empty, if the owner is an employee
  • picture - string
    The URL of the user picture
  • type - string
    Indicates whether the owner is a team or an employee.
    Available options: team and user.

GtmhubTasks

Information about all tasks in your account:

  • name - string
    The name of the task
  • externalid - string
    Used only if the task is a Jira task. The URL of the Jira issue that is linked to the Gtmhub task.
  • externalsystem - string
    Indicates if the task is coming from Jira.
    Available options: jira or empty.
  • description - string
    The description of the task
  • status - string
    The status of the task.
    Available options: To Do, In Progress, and Done.
  • priority - integer
    The priority of the task
  • parentid - string
    The internal ID of the objective that task belongs to
  • ownerid - string
    The internal ID of the team or user owning the task
  • tasktype - string
    The type of the Jira issue, linked to this task
  • parenttype - string
    The type of the parent object that the task belongs to.
    Available options: goal and empty.
    This indicates whether the task has a parent objective or is a stand alone task.
  • datecreated - date
    The date when the task was created
  • duedate - date
    The due date when the task should be completed
  • customfields - string
    A list of all custom fields and their values created for the task in a JSON string format
Did this answer your question?