7pace Timetracker for VSTS' Application Programming Interface (API) feature provides a dedicated URL that allows you to access and extract pure, updated data from Timetracker into the system of your choice as OData feed, e.g. Microsoft Excel, PowerBI, Tableau, Qlikview, SQL, or any third-party system that “talks” the protocol that our API is offering. The API is accessible in VSTS through an OAuth authorization model. You need to create an access token to authenticate the client in order to access the database. Once the data is loaded, you can save the file, and later refresh the data at any time to view updated information from our database. Below, we will guide you through the process of activating the API, creating an access token, and then how to access Timetracker data by authenticating the OData feed (using Excel as an example).
Activating the API
Configuring the API to access 7pace Timetracker for VSTS data is a two-step process. First, you access the Configuration > API page in Timetracker, activate API access, and then create an access token. Second, you will authenticate the OData feed into the system of your choice using that access token.
Once you successfully perform both steps, you can access Timetracker data via the system you have chosen.
1. Log in to your Team Services account.
2. On the main menu bar, click TIME.
3. On the Time menu bar, click Configuration.
4. In the left panel, select "API" -> The Personal API Settings page displays.
Timetracker 4 | API Page
Timetracker 3 | API Page
5. Click the "Activate API Access" checkbox -> Additional information about the API displays, including the access token status, indicating if you have an already-created token that is active, inactive, or not yet created.
Important Info on Access Tokens
An access token is your personal password and allows you to authenticate the OData feed and keep accessing updated Timetracker data indefinitely, just by refreshing the data.
Once you create a token, it is very important that you save it somewhere safe in your system. 7pace Timetracker does not store this access token anywhere in the database and it is displayed on the page only once. If you try to access any other page without first saving the token, it will be lost.
Your access token is valid for a period of one year. On the Personal API settings page, you can view the token's expiry date, (as detailed in the above screenshot) and you can use the same token to authenticate your OData feed for your account until it expires. If you create a new access token, your existing token is deactivated and you will need to authenticate your OData feed again with the new one.
You are now ready to begin the process of accessing 7pace Timetracker data.
Accessing 7pace Timetracker Data by Authenticating OData Feed in Excel
Note: Remember to wrap the parameter values in your query into single (' ') quotes.
1. Open Microsoft Excel.
2. In a new workbook, click the Data tab.
3. On the Data tab, click the New Query menu and select From Other Sources > From OData Feed -> The OData Feed dialog box displays.
4. In the URL field, above, paste the URL of your Timetracker account (from the Personal API section of the "Configuration" tab, as mentioned under "Activating the API", above).
5. Copy the URL and paste it in the URL field.
6. Click the OK button -> The system displays the "Navigator" dialog box upon successful verification of the URL.
7. In the left navigation tree, select TimeExport -> The right pane displays the required and optional fields for you to enter before accessing the data.
8. In the StartDate field, enter the start date from when you want to access the data.
Enter the date in
9. In the EndDate field, enter the end date up to which you want to access the data.
Enter the date in
(Optional) In the IsComputeTopPbi field, enter true to enable it.
(Optional) In the GroupByDays field, enter true to enable it.
(Optional) In the IsBillable field, enter true to enable it.
10. Click the Apply button -> The system displays a dialog box to authenticate your OData feed.
11. Copy your access token. You can either use a new access token or you can copy the access token that you already created and stored in your system.
12. In the left pane, click Basic.
13. In the Password field, paste the access token that you created.
Note: Leave the Username field blank.
14. Click the Connect button -> The Navigator dialog box displays a preview of your OData feed if authentication is successful.
15. Click the Load button -> The data is loaded to Excel and the corresponding query is listed at the right side under "Workbook Queries".
16. Click the query to load the corresponding data.
(Optional) Select the query and click the Refresh button () to refresh the data corresponding to the query.
Using 7pace Timetracker API in Your Own Project
To help you access Timetracker's data through our API, we've provided the source code of a simple application that demonstrates basic Timetracker API usage in GitHub.
You can get more information about our API model and parameters at Configuration->API->Timetracker API Reference.