Introducing the Goals API

AndrewWong · August 5, 2021, 3:44am

Hello all! Our team is committed to deliver a feature-rich API, and today we’re excited to announce new API endpoints available for Goals!

With Goals, you can drive alignment across your company by consolidating goals and tying them directly to your teams’ work. We’re introducing this functionality in the API, so you can now build custom integrations to programmatically:

Get a holistic view of your organization’s goals in a single place
Automate large amounts of work and progress updates
Make changes to goals in your tools of choice

Now, on to the good stuff! Here’s what we’ve added:

HTTP method	API endpoint
GET	/goals/{goal_gid}
PUT	/goals/{goal_gid}
DELETE	/goals/{goal_gid}
GET	/goals
POST	/goals
POST	/goals/{goal_gid}/setMetric
POST	/goals/{goal_gid}/setMetricCurrentValue
POST	/goals/{goal_gid}/addSubgoal
POST	/goals/{goal_gid}/removeSubgoal
POST	/goals/{goal_gid}/addFollowers
POST	/goals/{goal_gid}/removeFollowers
POST	/goals/{goal_gid}/addSupportingWork
POST	/goals/{goal_gid}/removeSupportingWork
GET	/goals/{goal_gid}/subgoals
GET	/goals/{goal_gid}/supportingWork
GET	/time_periods/{time_period_gid}
GET	/time_periods

Head over to our docs to see how it all works!

As always, feel free to leave comments and questions here. Be sure to check back for more updates and announcements as well as we continue to add new features to the API. Happy goal-achieving!

AndrewWong · August 5, 2021, 3:45am

Bastien_Siebman · August 5, 2021, 10:10am

Great news, already using that API! Keep it coming

AndrewWong · August 20, 2021, 8:27pm

A quick update today: we’ve exposed endpoints for Time Periods and for creating a Goal through the API. The table in the original post has been updated as well. Happy Friday, everyone!

Bruno_Zamberlan · January 23, 2022, 11:50pm

Is it working now? I´m trying to use all the methods associate with goals and i´ve been receiving this:

“Client’ object has no attribute 'goals”. Shoud I use a different endpoint? I´m trying to do this request with Python using the examples on Asana API page.

Thanks

M_Àngels_Jover · January 25, 2022, 10:14am

Hi @AndrewWong

I have a question, I try to access the goals (https://app.asana.com/api/1.0/goals) but I get this error message:

{“errors”:[{“message”:“You should specify one of portfolio, project, workspace, team”,“help”:“For more information on API status codes and how to handle them, read the docs on errors: Asana”}]}

I have the workspace ID however I don’t know how to add in the URL, could you please help me?

Thank you very much!

M.

Phil_Seeman · January 25, 2022, 7:40pm

Hi @M_Àngels_Jover,

Here is the syntax for that:

https://app.asana.com/api/1.0/goals?workspace=111403789277882

cc: @AndrewWong
Andrew, the example for this endpoint in the API docs isn’t right; it doesn’t show the use of a qualifier like workspace, portfolio, etc. so IMO it makes sense that users like this would be confused.

Mayank_Sharma · February 21, 2022, 12:29am

Hey @Bruno_Zamberlan ,
In case you’re still looking for a solution, I have one for you:
You need to connect the goals resource to the asana client object:

Once done, you should be able to use all the functions described in:

github.com

maany/python-asana/blob/master/asana/resources/gen/goals.py

# coding=utf-8
class _Goals:

    def __init__(self, client=None):
        self.client = client

    def add_followers(self, params=None, **options):
        """Add a collaborator to a goal
        :param Object params: Parameters for the request
        :param **options
            - opt_fields {list[str]}:  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
            - opt_pretty {bool}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
        :return: Object
        """
        if params is None:
            params = {}
        path = "/goals/{goal_gid}/addFollowers"
        return self.client.post(path, params, **options)

    def add_subgoal(self, params=None, **options):

This file has been truncated. show original

Good luck

Bruno_Zamberlan · April 1, 2022, 1:46pm

Thanks! I collect the latest version on the GitHub and installed it. Now It´s been available to me!

Appflow_Persistent · June 9, 2022, 10:38am

Hi @M_Àngels_Jover , Can you help me for the Goals api? How can I find workspace ID? I don’t find any option for that in asana

John_Rolfe · June 16, 2022, 10:08am

@Phil_Seeman @Bastien_Siebman
Hi guys! I really need you help.
I am working on a big project that involves collecting all the gaols that are stored in Asana and showing them in a Tableau dashboard. I can connect, get users, get gaols, etc…no problem.

My problem is trying to get a subgoals and parent goals - I keep getting errors and I cannot use the response coming from the API.

So, as an example I am using it is way. Where the parent goal_gid is from the url of the parent goal in Asana.

result = client.goals.get_subgoals_for_goal(1201900678911488, opt_pretty=True)

Result then shows <generator object PageIterator.items at 0x7f706aeaac00>

However, when I keep trying to get at the data I keep running into the error of TypeError: ‘int’ object is not iterable

The end goal is to get this into a Pandas dataframe so I can do more things to the data!

Please help!

Bastien_Siebman · June 16, 2022, 4:06pm

that’s the method from the client you are using? the “not utterable” error makes me think there is an issue around iteration/pagination, maybe get subgoals gives you a collection and not an array. Does this help debug?

Phil_Seeman · June 17, 2022, 12:21am

Yeah it looks like a bug in the Asana client to me. I would try it in Postman; if it works there, then that pretty much says it’s a client bug and you should report it to api-support at asana dot com.

Bastien_Siebman · June 17, 2022, 7:23am

Unless you are giving the wrong parameters, like an id as a number instead of a string.

Taiki_Ogasawara · June 29, 2022, 1:04am

hello.
I’m using this API and I get the following error:

self.client.goals.get_subgoals_for_goal (goal_gid = '1202357121126643', limit = 100)
'Invalid Request: parent: Not a Long: {goal_gid}'

Please give me some advice.

John_Rolfe · July 11, 2022, 10:23am

Taiki - this connector does not work for the subgoals. you need to bypass the client provided use requests to get the data.

#Create loop for cycling though the list of Sub Goal Gids
for index, row in Goal_details_all_df.iterrows():
request_string = “https://app.asana.com/api/1.0/goals/” + row[‘gid’] + “/subgoals?opt_pretty=true&opt_fields=followers,assignee”
response = requests.get(request_string, headers={‘Authorization’: Token_string})
response_text = response.json()
df = pd.read_json(json.dumps(response_text))
df[‘Parent_sub_goal_gid’] = row[‘gid’]
Sub_Goal_details_all_df2 = Sub_Goal_details_all_df2.append(df)