Create a goal metric

Creates and adds a goal metric to a specified goal. Note that this replaces an existing goal metric if one already exists.

curl --location --request POST 'https://app.asana.com/api/1.0/goals//setMetric' \ --header 'Content-Type: application/json' \ --data-raw '{ "data": { "currency_code": "EUR", "current_display_value": "8.12", "current_number_value": 8.12, "initial_number_value": 5.2, "precision": 2, "target_number_value": 10.2, "unit": "none" } }'

{ "data": { "gid": "12345", "resource_type": "task", "name": "Grow web traffic by 30%", "owner": { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" }, "due_on": "2019-09-15", "followers": [ { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" } ], "html_notes": "<body>Start building brand awareness.</body>", "is_workspace_level": true, "liked": false, "metric": { "gid": "12345", "resource_type": "task", "currency_code": "EUR", "current_display_value": "8.12", "current_number_value": 8.12, "initial_number_value": 5.2, "precision": 2, "resource_subtype": "number", "target_number_value": 10.2, "unit": "none" }, "notes": "Start building brand awareness.", "start_on": "2019-09-14", "status": "string", "team": { "gid": "12345", "resource_type": "task", "name": "Marketing" }, "time_period": { "gid": "12345", "resource_type": "task", "end_on": "2019-09-14", "period": "Q1", "start_on": "2019-09-13" }, "workspace": { "gid": "12345", "resource_type": "task", "name": "My Company Workspace" }, "likes": [ { "gid": "12345", "user": { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" } } ], "num_likes": 5 } }

Request

Path Params

goal_gid

string

required

Automatically added

Body Params application/json

data

object (GoalMetricBase)

optional

A generic Asana Resource, containing a globally unique identifier.

currency_code

string | null

optional

ISO 4217 currency code to format this custom field. This will be null if the format is not currency.

Example:

EUR

current_display_value

string

optional

Conditional. This string is the current value of a goal metric of type string.

Example:

8.12

current_number_value

number

optional

Conditional. This number is the current value of a goal metric of type number.

Example:

8.12

initial_number_value

number

optional

Conditional. This number is the start value of a goal metric of type number.

Example:

5.2

precision

integer

optional

Only relevant for goal metrics of type ‘Number’. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive.
For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%.

Example:

target_number_value

number

optional

Conditional. This number is the end value of a goal metric of type number.

Example:

10.2

unit

enum<string>

optional

A supported unit of measure for the goal metric, or none.

Allowed values:

nonecurrencypercentage

Examples

Responses

🟢200Successfully created a new goal metric.

application/json

Body

data

object (GoalResponse)

optional

A generic Asana Resource, containing a globally unique identifier.

likes

array[object (Like) {2}]

read-onlyoptional

Array of likes for users who have liked this goal.

num_likes

integer

read-onlyoptional

The number of users who have liked this goal.

Example:

due_on

string | null

optional

The localized day on which this goal is due. This takes a date with format YYYY-MM-DD.

Example:

2019-09-15

followers

array[object (UserCompact) {3}]

optional

Array of users following this goal.

html_notes

string

optional

The notes of the goal with formatting as HTML.

Example:

<body>Start building brand awareness.</body>

is_workspace_level

boolean

optional

Conditional. This property is only present when the workspace provided is an organization. Whether the goal belongs to the workspace (and is listed as part of the workspace’s goals) or not. If it isn’t a workspace-level goal, it is a team-level goal, and is associated with the goal’s team.

Example:

true

liked

boolean

optional

True if the goal is liked by the authorized user, false if not.

Example:

false

metric

object

optional

A generic Asana Resource, containing a globally unique identifier.

notes

string

optional

Free-form textual information associated with the goal (i.e. its description).

Example:

Start building brand awareness.

start_on

string | null

optional

The day on which work for this goal begins, or null if the goal has no start date. This takes a date with YYYY-MM-DD format, and cannot be set unless there is an accompanying due date.

Example:

2019-09-14

status

string | null

optional

The current status of this goal. When the goal is open, its status can be green, yellow, and red to reflect "On Track", "At Risk", and "Off Track", respectively. When the goal is closed, the value can be missed, achieved, partial, or dropped.

team

object

optional

Conditional. This property is only present when the workspace provided is an organization.

time_period

object

optional

A generic Asana Resource, containing a globally unique identifier.

workspace

object

optional

A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.

gid

string

read-onlyoptional

Globally unique identifier of the resource, as a string.

Example:

12345

resource_type

string

read-onlyoptional

The base type of this resource.

Example:

task

name

string

optional

The name of the goal.

Example:

Grow web traffic by 30%

owner

object

optional

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

🟠400400

🟠401401

🟠402402

🟠403403

🟠404404

🔴500500