Native Time Tracking read data

tl;dr:

* Time tracking is now available:

  • Actual time available as Task.actual_time_minutes
  • Estimated time available as a number custom field
    • Custom.estimated_time
  • Asana-created custom fields include an asana_created_field identifier

Hey folks,

It is now possible to read time tracking information for tasks in the API! Additionally, we have added an asana_created_field field to Custom Fields.

Schema

  • Actual time: the actually recorded amount of time it took for a task to be completed.
    • available as the actual_time_minutes on the full Task resource.
    • this is a read-only sum of all time tracking events for this task
  • Estimated time: the time that was estimated by a user for the completion of a task.
    • available as a number custom field in the following endpoints:
      • GET /custom_fields/{custom_field_gid}
      • GET /workspaces/{workspace_gid}/custom_fields
      • GET /projects/{project_gid}/custom_field_settings
      • GET /portfolios/{portfolio_gid}/custom_field_settings
      • GET /projects/{project_gid}
      • GET /tasks/{task_gid}
    • Estimated time fields will include asana_created_field: estimated_time
  • Asana-created custom field: special custom fields available in the Custom Field Library that are made by Asana and feature the Asana logo badge.
    • when a custom field has the asana_created_field field set to a non-null string, it means this field appears as an Asana-created custom field in the Custom Field Library
    • you can modify the values in these custom fields
    • you cannot add a field with asana_created_field set
    • you cannot delete one with asana_created_field set

You may notice that it is possible to modify the estimated time values with this schema, but not the actual time values. For the moment, while it is possible to modify the estimated time values, we have not locked down the specification for how that affects Time Tracking. In other words, you may update the estimated time values at your own risk.

That said, we’d love to hear your feedback on that functionality. Stay tuned in the future as we continue to add more API functionality for Time Tracking!

Timeline

Date Event
2022-10-21 Original time tracking non-API launch
2023-01-20 First API launch and announcement
2023-02-07 Typo correction

Yours in Developer Relations,
Sasha, on behalf of the Asana API Team

7 Likes