After you have setup your API Token, you can start using the API to configure your account, update your OKRs, or to export and integrate Gtmhub with other business systems. 

Below is an overview of the most common API Methods.  All methods can be found https://app.gtmhub.com/api/v1/docs/#/

Sessions - Goals - Metrics - Tasks

These four methods represent the core functionality of Gtmhub OKRs.  Goals represent Objectives and Metrics the Key Results.  With these methods, you have the ability to:

  • Create new Sessions/Objectives/Key Results/Tasks
  • Query the account for all Sessions/Objectives/Key Results/Tasks
  • Update existing Sessions/Objectives/Key Results/Tasks
  • Delete existing Sessions/Objectives/Key Results/Tasks

Teams - Users - Roles - Permissions

These four methods are provided to help configure an account.  With these methods, you have the ability to:

  • Create new Teams/Users/Roles/Permissions
  • Assign a Role to a specified User or Team
  • Query the account for all Teams/Users/Roles/Permissions
  • Update existing Teams/Users/Roles/Permissions
  • Delete existing Teams/Users/Roles/Permissions

Reports

A main use case for using the API is to extract account stats for use in other systems.  The Reports method provides a quick and convenient way to query the current statistics for a given Team or User.  These reports will return the same information you'd find when viewing a Team or User within the People tab in the dashboard. 

Timeline

The Timeline method provides the audit log for your account.  This can return any updates to the system such as Objectives and Key Results being created/updated/deleted.

Did this answer your question?