Overview: Query Builder for Teamwork Projects

HOW TO

How to access the Query Builder for Teamwork Projects

Navigate to  Metrics > Query Builder to access the Query Builder for Teamwork Projects. Click the green + Create Custom Metric button and select your connected Teamwork Projects Account from the Data Source drop-down list.

    Query Builder is available in Plus and Business Accounts. Agency Basic Accounts have access to Query Builder in the Agency Account only.  Request a trial of Query Builder by following these steps.  

How to use the Query Builder for Teamwork Projects

The Query Builder for Teamwork Projects is unique in that it allows you to use the Query Builder for Time Tracking or the Query Builder for Tasks. Your selection should depend on the Custom Metrics you're looking to build. 

IN THIS SECTION

Query Builder for Time Tracking

A
   Custom Metric Name: Enter a name for your Custom Metric. This Custom Metric name will be available in the Designer after saving. 
B
  Metric: For the Query Builder for Time Tracking, the only Metric option is "Time"
C
   Dimension (Optional): The Dimensions parameter re-categorizes the returned Metric value ("Time") based on common criteria. Examples of Dimensions are "Company Name," "Project Name," and "Billable Time."
Pro Tip: Add the word "by" in between the Metric and Dimension in order to determine an appropriate Custom Metric Name. From the Metric and Dimension examples above, we could create the Custom Metrics "Time by Company Name" or "Time by Project Name."
D
   Date Range: Select up to 8 Date Ranges that will be available for the Custom Metric. The Date Ranges selected are the only periods of time that data is synced for this Custom Metric. 
E
   Compare With(Optional): Select a comparison period to measure each Date Range against, like "Previous Period." Data for the comparison period will be synced for each Date Range that is selected.  

This data can be used on a Line Chart or Bar Chart to show past performance. It is also used to calculate the percentage growth or loss of the current Date Range performance vs the comparison Date Range performance. If no Compare With parameter is selected, comparison percentages cannot be displayed for the Custom Metric. 
F
   Filter by(Optional): Filters restrict the data that gets included in the Custom Metric. All data that is returned is tested against the Filter(s). Multiple Filters can be combined using AND boolean logic. 
If the data synced from the Metric and Dimension fields meet the Filter specifications, the data is retained and included in the Custom Metric value. If the data synced from the Metric and Dimension fields don't meet the Filter specifications, the data is excluded from the Custom Metric value.
G
   Data Preview: After clicking  Run query, a Data Preview of the Custom Metric will be displayed. Daily Metric values are displayed in this section, along with the total Metric values for the Date Range in bold at the bottom. You can view the Data Preview for different Date Ranges by clicking on the tabs at the top of the Data Preview. 
Pro Tip : If you don't know which Filters to put in place for your use case, use the Dimension + Data Preview to troubleshoot and get more insight into the data that is returned from your Teamwork Projects Account for each field. Learn more here

Query Builder for Tasks

A
  Custom Metric Name: Enter a name for your Custom Metric. This Custom Metric name will be available in the Designer after saving. 
B
  Metric: For the Query Builder for Tasks, the Metric options are "Number of Tasks" and "Estimated Time"
C
  Dimension (Optional): The Dimensions parameter re-categorizes the returned Metric value based on common criteria. Examples of Dimensions are "Company Name," "Project Name," and "Status."
Pro Tip: Add the word "by" in between the Metric and Dimension in order to determine an appropriate Custom Metric Name. From the Metric and Dimension examples above, we could create the Custom Metrics "Number of Tasks by Company Name," "Estimated Time by Project Name," or "Number of Tasks by Status."
D
  Date Filter: The Date Filter determines which Tasks will be included in the Custom Metric. 
If "Due Date" is selected, the Due Date Options field will be revealed. Here, you can select which Due Date(s) will be included in the Custom Metric.  
If you choose "Completed Date" as the Date Filter, the Date Range field will be revealed. Here, you can select up to aa Date Range that will be available for the Custom Metric. The Date Range selected is the only periods of time that data is synced for this Custom Metric. Any Tasks completed during the specified Date Range(s) will be included in the Custom Metric.

When you add this Custom Metric to a Databoard, the data synced and displayed will still reference the Date Range you selected when building the Custom Metric but the only Date Range option will be "All Time." This is because within Teamwork Projects you can select a wide range of Due Dates, or you could have no Due Date set.

E
  Request Parameters: Choose whether you want to include Completed tasks, Subtasks, etc. in your Custom Metric. 

F
   Additional Filters: Filters restrict the data that gets included in the Custom Metric. All data that is returned is tested against the Filter(s). Multiple Filters can be combined using AND boolean logic. 
If the data synced from the Metric and Dimension fields meet the Filter specifications, the data is retained and included in the Custom Metric value. If the data synced from the Metric and Dimension fields don't meet the Filter specifications, the data is excluded from the Custom Metric value.
G
  Data Preview: After clicking Run query, a Data Preview of the Custom Metric will be displayed. Daily Metric values are displayed in this section, along with the total Metric values for the Date Range in bold at the bottom. You can view the Data Preview for different Date Ranges by clicking on the tabs at the top of the Data Preview. 
Pro Tip : If you don't know which Additional Filters to put in place for your use case, use the Dimension + Data Preview to troubleshoot and get more insight into the data that is returned from your Teamwork Projects Account for each field. Learn more here.  

How to create a Custom Teamwork Projects Metric [Example]

In this example, we'll create a Custom Metric to report on incomplete Tasks for Client #1 with Due Dates set for the current week. We don't want to include any completed Tasks in this Custom Metric. 

1
 Navigate to Metrics > Query Builder   
2
 Click the green + New query button
3
 Select the appropriate Teamwork Projects Data Source
4
 In order to accurately explain what this Custom Metric is reporting on, we'll name the Custom Metric " Incomplete Tasks by Company" 
5
 We want to report on Tasks so we'll select the Task button
6
 For the Metric we'll select Number of Tasks
7
 We want a list of Task Names returned, so we'll select Task Name as the Dimension
8
 Next, we'll select Due Date as the Date Filter, and This Week as the Date Range. This will make it so any Tasks with Due Dates set to this week will be returned for the Custom Metric
9
 In the Request Parameters section, we need to exclude any completed tasks. To do this, we'll set the Attributes Include Completed Tasks and Included Completed Subtasks to False
10
 Lastly, we want to restrict the Custom Metric to only retain data for Client #1. We'll add a Filter to the Additional Filters section that specifies Company Name equals Client 1
11
 Click Run query to generate a Data Preview of the Custom Metric
12
 Once we confirm that these are the results we're looking for, we'll click Save to save the Custom Metric. 

How to add a Custom Teamwork Projects Metric to a Databoard

Learn how to add a Custom Metric to a Databoard here

Additional Information

  • When you add this Custom Metric built using the Query Builder for Tasks to a Databoard, the data synced and displayed will still reference the Date Range you selected when building the Custom Metric but the only Date Range option will be "All Time." This is because within Teamwork Projects you can select a wide range of Due Dates, or you could have no Due Date set.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us