OBJECT

Goal

a goal

link GraphQL Schema definition

  • type Goal {
  • # Completion Percentage of a goal for a given date range. start_range/end_range
  • # should be of the form: 'yyyy-mm-dd'
  • #
  • # Arguments
  • # end_range: The end of the date range.
  • # start_range: The start of the date range.
  • completion_percentage_for_range(
  • end_range: String,
  • start_range: String!
  • ): Int
  • # The rate at which this goal is completed
  • completion_rate: String @deprecated( reason: "should use completion_percentage_for_range" )
  • # The creation timestamp of the goal
  • created_at: String!
  • # created user of goal
  • created_user_id: ID
  • # description of goal
  • description: String
  • # due date of goal
  • due_date: String
  • # All goal histories associated with this goal histories.
  • goal_histories: [GoalHistory!]!
  • # The unique identifier of the goal
  • id: ID!
  • # If true, the goal is complete for the given day. date should be of the form:
  • # 'yyyy-mm-dd'
  • #
  • # Arguments
  • # date: The date to check if the goal is completed at that time.
  • is_completed_for_date(date: String!): Boolean
  • # if true, the goal is currently active
  • is_current: Boolean @deprecated( reason: "should use is_completed_for_date field to determine if a goal is completed for a given day" )
  • # if true, a template has been created based off this goal
  • is_used_as_template: Boolean
  • # name of goal
  • name: String
  • # parent id
  • parent_id: ID
  • # The rate at which the parent goal has subgoals completed
  • parent_subgoal_completion_rate: String
  • # Reminder object for a given goal
  • reminder: Reminder
  • # frequency of goal
  • repeat: String
  • # The id of the template used to make this goal
  • source_template_id: String
  • # start date of goal
  • start_on: String!
  • # Streak info for goal
  • #
  • # Arguments
  • # end_range: The end of the date range.
  • # start_range: The start of the date range.
  • streak_info(end_range: String, start_range: String!): [GoalStreakInfo!]
  • # The rate at which a subgoal is completed
  • subgoal_completion_rate: String @deprecated( reason: "should use completion_percentage_for_range" )
  • # Subgoals for a given goal
  • subgoals: [Goal!]
  • # count of subgoals
  • subgoals_count: String
  • # Title hyperlink. Opens when the title is clicked on.
  • title_link: String
  • # Owner of this goal
  • user: User
  • # user id of goal
  • user_id: ID
  • }