Module goals_api

Source

Enums§

AddGoalError
struct for typed errors of method add_goal
DeleteGoalError
struct for typed errors of method delete_goal
GetGoalResultError
struct for typed errors of method get_goal_result
GetGoalsError
struct for typed errors of method get_goals
UpdateGoalError
struct for typed errors of method update_goal

Functions§

add_goal
Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.
delete_goal
Marks a goal as deleted.
get_goal_result
Gets the progress of a goal for the specified period.
get_goals
Returns data about goals based on criteria. For searching, append {searchField}={searchValue} to the URL, where searchField can be any one of the lowest-level fields in dot-notation (e.g. type.params.pipeline_id; title). searchValue should be the value you are looking for on that field. Additionally, is_active=<true|false> can be provided to search for only active/inactive goals. When providing period.start, period.end must also be provided and vice versa.
update_goal
Updates an existing goal.