Export data to Excel via the API
This article really shows the power of the Forecast API. You can export virtually anything by obtaining an API-key from Forecast, and connecting it to your other app or service. This is definitely a more technical article, but we will help guide you through the steps to connect and import your data into Excel in the easiest possible manner.
Being able to export your data is really a powerful tool. It lets you use your data across various apps and services, even services we're not natively supporting with a native integration yet, e.g. your internal systems or another third-party app.
The great thing about this guide is that you only have to go through it once. From then after you just ask Excel to refresh the data based on your current setup using the Refresh All button in the Data tab.
Set Up Inquiries in Microsoft Excel
Step 1: Open Excel, and create a blank workbook
Step 2: Go to the Data tab in the menu at the top of Excel. Click New Query, and select From Other Sources → From Web.
Step 3: Click Advanced in the new window
Step 4: Go to the Admin Settings in Forecast using your personal menu at the top right
Step 5: Go to the API-keys tab
Step 6: Click Generate new API-key
Step 7: Copy the new API-key, and go back to Excel
Step 8: Add the information as showcased in this picture, i.e. URL and the GET name of the data you wish to export from Forecast and the Parameters at the bottom of the window, or find the information using the GitHub repository with our API guidelines. Click OK.
- URL: https://api.forecast.it/api/v1/
- GET name: e.g. "projects", "persons", or "time_registrations"
- HTTP request header parameters: "X-FORECAST-API-KEY" and your unique API-key from Forecast in the second field
Step 9: The data has now been downloaded. Click To Table...
Step 10: Click OK
Step 11: Click the small button at the top right of the first column as shown in the picture below. Check or uncheck data as you see fit, and click OK.
Step 12: The data will now show up in your spreadsheet.
Step 13: Right click on the new item in the right sidebar, and go to Properties to rename the data set and enable / disable data points if necessary. Good practice is also to rename the tab / sheet at the bottom if you plan to work with several data sets.
Step 14: Click Close & Load when you are done.
Step 15: You can add more data sets to the same file which makes you able to link data sets, e.g. Person ID with that particular person's time registrations using the "persons" and "time_registrations" API endpoints. Additionally, you can get a better visual view by using the Pivot Table feature.
Remember to name the tabs properly to distinguish later on.