Resources
Data Source Type: | REST/URL |
Authentication: | Basic HTTP Authentication |
Sample Query: | https://api.myintervals.com/task/ More samples available here: Intervals API examples |
API Documentation: | Intervals API docs |
Date Ranges: | Klipfolio Date Ranges |
Step-by-Step
Creating a data source using Intervals
To create a data source using Intervals data, you need to accomplish 4 tasks:
- Start the data source creation process.
- Find your Intervals API token.
- Authenticate with Intervals.
- Write a query and enter it into Klipfolio.
Note: This guide assumes that you already have an active Intervals account.
Step 1: Start the data source creation process
To create a data source using Intervals, go to the Service Connectors page in Klipfolio and select Intervals.
Step 2: Find your Intervals API Token
Go here for information on finding your Intervals API token-based authentication.
Step 3: Authenticate with Intervals
- At Username enter your Intervals username.
- At Password enter your Intervals password.
Note: The user token is a unique 11-character alphanumeric (eg: 6bv066nezv4) and is entered in the Username field. An arbitrary value such as x is entered in the password field.
Step 4: Write a query and enter it in Klipfolio
You will need to refer to the Intervals documentation to write a query.
- Enter our query in the URL field in the Klipfolio REST connector.
Example: https://api.myintervals.com/task/?excludeclosed=true&sortfield=datedue&limit=50
Edit the query date ranges and save
Many Klips that use Intervals data need a date range that is dynamic (for example, past 30 days). In this section we're going to change the query from a fixed range to a dynamic one.
- Enter
start-date={date.last30Days}
at the end of your Query URL (after the?
). - Enter
&end-date={date.today}
at the end of your Query URL (after thestart-date
parameter). - Click the Get data button.
- Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source here.
- Click Continue.
- Name, choose refresh settings, and, optionally, share your data source.
- Click Save.
Example: https://api.myintervals.com/task/?excludeclosed=true&sortfield=datedue&limit=50&start-date={date.last30Days}&end-date={date.today}
Common date range expressions:
- {date.today}
- {date.last30Days}
- {date.startOfQuarter}
- And many more...