What is this data source used for?

Gtmhub Reports are powered by Gtmhub Data Sources. Beside the out-of-the-box reports, Gtmhub allows you to create any additional insights showing the exact information you need in the format you like.
Find more about the connector itself in this article. 

Detailed description

Here you will find detailed information on the content, meaning and relation of all Gtmhub entities.

GtmhubPlanningSessions - information about all sessions that lives on your account:

  • id - string - the internal ID of a session
  • parentid - string - the internal ID of the parent session. Equal to 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 session status. Available options:
                   "open" means the session is in status "Open"
                   "locked" means the session is in status "In Progress"
                   "closed" means the session is in status "Archived"
  • workflow_reviewers - integer - the minimum count of the needed reviewers when approval workflow is enabled for this session - 1 or 2.
  • cadence_type - string - what the cadence set for this session WEEKLY, BI-WEEKLY or MONTHLY
  • cadence_totalcadences - integer - the total count of cadences for this session,       calculated based on it's length an cadence type 

________________________________________________________

GtmhubSessionCadences - here you can find information of how many cadences there are in a certain session and what is the period of every cadence:

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

________________________________________________________

GtmhubGoals - all Objectives that live on your account:

  • id - string - the internal ID of the objective
  • sessionid - string - the ID of the session this objectives lives in
  • name - string - the name of the objective
  • assignee_name - string - the name of the objective owner - this is the team name or first and last name of the individual, to whom the objective is assigned
  • assignee_type - string - indicated if the objective owner is team or individual.         Available options:
                   "team" - objective is owned by a team
                   "user" - objective is owned by an employee
  • parentid - string - the ID of the objective this one is aligned under. Equal to empty string when there is no parent session.
  • parentgoalsessionid - string - the ID of the session the parent objective lives in.     Equal to empty string when there is no parent session.
  • 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 need to turn it into a percentage, multiply the value by 100
  • aggregatedattainment - double - the average progress of all sub-objectives that live within the same session as an absolute value. If you need to turn it into a percentage, multiply the value by 100
  • metricscount - integer - total count of Key Results created under this objective
  • taskscount - integer - total count of Tasks assigned under this objective
  • ownerid - string - the internal ID of the user or team owning the objective
  • customfields - string - list of all custom fields and their values created on objective level in a json string format
  • workflow_status - string - the status of the objective if workflow is enabled  on      session level. Available options:
                   "draft" - objective is still in draft state
                   "inReview" - objective is sent for approval
                   "approved" - objective is approved
  • fullaggregatedattainment - double - the average progress of all objectives and their sub-objectives aligned under this one as an absolute value. If you need to turn it into a percentage, multiply the value by 100
  • childrenaggregatedattainment - double - the average progress of all direct sub-objectives as an absolute value. If you need 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" - average of objective's key results
    "average_children" - average of objective's sub-objectives

________________________________________________________

GtmhubGoalTags - mapping between the objectives and tags attached to them:

  • 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 - 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 - current value of the key result
  • attainment - double - the progress of the key result as an absolute value. If you need to turn it into a percentage, multiply the value by 100
  • progressstatus - string - progress status indicator calculated based on the current value of the key result and ideal progress, marked with punctual line on the key result progress diagram. Used for coloring the key result diagram in red or green  
                   "bad" - key result progress is below the ideally expected progress, the                     graph is colored in red
                   "good" - key result progress is equal or above the ideally expected                           progress, the graph is colored in green
  • manualtype - string - shows if the type of manual key result is
                   "boolean" - key result type is "Achieved or not"
                   "double" - key result has actual value target
                   "" - empty string, indicating 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 owning the key result
  • critical - double - the critical value of the key result. Used for key results with type "Should stay above/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 - it will be the upper limit value of every range
  • targetoperator - string - what is the type if the key result. Available options:
                   "at_least" - key result type is "Should increase to" or "Achieved or not"
                   "at_most" - key result type is "Should decrease to"
                   "should_stay_above" - key result type is "Should stay above"                                    "should_stay_below" - key result type is "Should stay below"
  • insightname - string - used for dynamic key results only. This is the internal ID of the insight the key results originates from
  • fieldname - string - used for dynamic key results only. The field name of the metric from which the key results originates from  
  • dynamic - boolean - if the key result is manual or dynamic.
                   "true" - dynamic key result
                   "false" - manual key result
  • datecreated - date - the date when the key result was created
  • customfields - string - list of all custom fields and their values created on objective level in a json string format

________________________________________________________

GtmhubMetricSnapshots - contains information for all key results updates:

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

________________________________________________________

GtmhubTeams - list of all teams on 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 this one is aligned under
  • description - string - the description of the team 
  • manager - string - the internal ID of the employee assigned as manager to this team
  • customfields - string - list of all custom fields and their values created on team level in a json string format

________________________________________________________

GtmhubTeamMembers - mapping between the teams and the their members:
Note: the team manager is not part of the mapping!

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

________________________________________________________

GtmhubUsers - list of all users/employees on your account:  

  • id - string - the internal ID of the user
  • email - string - the email address the user is invited with
  • name - string - the username of the user, equals the email address
  • firstname - string - first name of the user
  • lastname - sting - last name of the user
  • invitedby - string - the internal ID of the user who invited this employee
  • datecreated - date - the date when the user was created, e.g. his first login into the platform
  • dateinvited - date - the date the user was invited
  • customfields - string - list of all custom fields and their values created on user level in a json string format

________________________________________________________

GtmhubRoles - list of all permission roles in your account:

  • id - string - the internal ID of the permission role set
  • name - string - the name of the role set

________________________________________________________

GtmhubUserRoles - mapping between users and the roles they are assigned to:

  • roleid - string - the internal ID of the permission role set attached to the user 
  • userid - string - the internal ID of the user 

________________________________________________________

GtmhubAssignees - list of all employees and team owning objective, key results or tasks:

  • id - string - the internal ID of the team or employee
  • name - string - the name of the team or first and last name of the employee
  • email - string - the email address of the employee; empty in case of a team
  • color - string - the HEX color code of the team avatar; empty in case of an employee
  • avatar - string - internal name of the symbol selected for the team avatar; empty in case of an employee
  • picture - string - the URL of the user picture
  • type - string - indicating if this is team or employee. Available options:
                   "team" - owner is a team
                   "user" - owned is an employee

________________________________________________________

GtmhubTasks - list of all tasks in your account:

  • name - string - the name of the task
  • externalid - string - used in case of Jira task only. The URL of the Jira issue linked to Gtmhub as task
  • externalsystem - string - indicates if the task is coming from Jira. Equals to "jira" is so, otherwise the field is empty.
  • description - string - the description of the task
  • status - string - the status of the task. Available options for Gtmhub tasks:
                   "To Do" - the status of the task is "To Do"
                   "In Progress" - the status of the task is "In Progress"                                                    "Done" - the status of the task is "Done"
  • priority - integer - priority of the task
  • parentid - string - the internal ID of the objective the task is attached to
  • ownerid - string - the internal ID of the team or user owning the task
  • tasktype - string - the jira issue type linked to this task
  • parenttype - string - what is the type of the parent object the task is attached to. Available options:
                   "goal" - if the task is attached to an objective
                   "" - empty string if the task is stand alone
  • datecreated - date - the date the task was created
  • duedate - date - the due date by when the task should be completed
  • customfields - string - list of all custom fields and their values created on task level in a json string format
Did this answer your question?