Did you ever feel the need to have access to advanced querying in your development systems? If that's the case the data explorer is for you.

The data explorer allows you to easily query pull request and issue data and save these queries as reports. Reports can be pinned as tabs on your priority inbox for easy access.

Reports and pinned reports can also be shared with the whole team.

Building queries

Alright, let's head to the Data explorer. From there you can do a few things to build your report.

The query editor is composed of 5 important sections:

>> 1. Query explainer

The query explainers provides a summary of the query that will be run on our servers. The explainer aims at being a compact and visually friendly representation of the filter created in section 3.

>> 2. View options

This section allows you to configure different flavours for your report. There is only one option available at the moment but more will be proposed in the future.

  • Unnest related issues: Issues resolved by pull requests via auto-linking keywords will be nested under their respective pull request by default and will not appear as individual items in the results. If you wish to list all issues no matter whether they are resolved by pull requests or not then tick this box.

>> 3. Query editor

This section is the most important one. It allows you to create comprehensive filters using AND/OR conditions on item fields (e.g. created_at or author).

The editor provides common matchers for each field type (equal, different, greater/less than etc.).

The editor also provides some dynamic matchers on specific fields:

  • Timestamp fields (created_at, due_on, updated_at etc.) have before/after X hours ago and before/after X hours from now matchers. This makes it more convenient when you want your reports to be dynamic and get updated over time.

  • user fields (author, reviewers etc.) allow you to select yourself (is me and include me in array fields). These filtering helpers are more robust than hardcoding system-specific usernames using = (equal) matchers. By using is me or include me filters, Keypup does the hard work of reconciling who you are in each system.

>> 4. Report results

This section displays all the items - along with their current priority - matching the filter you configured in the query editor. The display is similar to what you can see in your priority inbox.

>> 5. Report save options

Once your query is nice and beautiful you can save your report for later use.

The actions presented are the following:

  • New: start a new report from scratch

  • Save: save the current report. The next screen will propose you to give a name and a description to your report.

  • Save as new: save the current report as a new one. This is convenient when you want to build a new report based on another one.

The following fields are available:

  • Name: Used to keep your reports organized

  • Visibility [admin only]: Whether to keep this report to yourself or share it with the whole team

  • Description: A short description of your report. What benefit does it provide?

  • Pin report: Add this report as a priority inbox tab. If the report is a team report and you pin it, it will be pinned for all members of your team.

Once saved your report will appear in the Saved reports tab:

Adding tabs to the Priority Inbox

Reports created via the Data Explorer can be pinned as a tab on your Priority Inbox. This is an easy way to customize the Priority Inbox and quickly access the items that are mission-critical to your development.

There are two ways to do it.

>> From the Data Explorer

Simply save your report then tick the Pin report to priority inbox tab option. Upon ticking this box a field appears allowing you to configure the order of appearance of the tab.

Custom tabs will always appear after the default tabs (Prioritized, Pending Peer, Coming up and Recently Closed).

Note that if the report is a team report and you pin it, it will be pinned for all members of your team.

>> From the Priority Inbox

You can add a custom tab by clicking on the + (plus) icon in the list of tabs.

This will redirect you to the Data Explorer and set the report to be pinned to your Priority Inbox by default upon saving it.

Did this answer your question?