GitHub
The Qlik GitHub connector uses the GitHub REST API to access data from your GitHub repositories, such as the change details of a single commit.
Ways to access your data
To access your GitHub data create a connection and select GitHub as your data source. You are redirected to a GitHub login page. Log into your GitHub account using your credentials to receive an authentication code, and enter this code into the connector.
Creating a data source connection
Loading data from tables
After you authenticate the connector with your account credentials, use the tables to fetch your data. Some tables are preconfigured to access a specific set of data while others let you create custom queries. The table below outlines some of the use cases for some of the tables that are available.
| Table | Available in | Description |
|---|---|---|
| Branches | Data manager and Data load editor | Lists all branches for a specified repository. |
| Commits | Data manager and Data load editor | Lists repository commits after a specified date. The table returns a list of commits and the associated SHA key, which is required to run other tables. |
| FileChanges | Data load editor | Lists which files were changed during a single commit. |
| Issues | Data manager and Data load editor | List issues for a repository. |
| ListTags | Data manager and Data load editor | List tags for a repository. |
| OrganisationRepositories | Data manager and Data load editor | Fetch the list of repositories for a specified organization. This table requires the name of the organization. |
| PullRequests | Data load editor | Lists all pull requests for a specified repository. |
| PullRequestsComments | Data load editor | List comments on a pull request. |
| PullRequestsCommits | Data load editor | List commits on a pull request. The response includes a maximum of 250 commits (API limit). |
| PullRequestsFiles | Data load editor | List pull requests files. The response includes a maximum of 300 files (API limit). |
| PullRequestsReviews | Data load editor | List reviews on a pull request. |
| RateLimit | Data load editor | Shows your current API rate limit status. |
| Releases | Data manager and Data load editor | Information about published releases. This returns a list of releases, which does not include regular Git tags that have not been associated with a release. |
| RepositoryComments | Data manager and Data load editor | List comments on all pull requests in a repository. |
| RequestedUserReview | Data load editor | List user review requests. |
| SingleCommitStats | Data load editor | Use this table to fetch the change stats for a single commit. |
| Statuses | Data manager, Data load editor and standalone | Shows the commit statuses. |
| StatusHistory | Data manager, Data load editor and standalone | Shows the statuses history. |
| UserRepositories | Data manager and Data load editor | Use this table to fetch the list of repositories for the authenticated user. The repository names are required to run other tables. |
To select and load data from a table, enter the required table parameters and click Preview data. Required parameters are marked with an asterisk (*) in the dialog. The table fields are displayed under the Data preview tab. You can select fields individually by selecting the box beside each field name. Select Insert script after you have made your selection.
Creating a connection and selecting data
Listing issues with the Issues table
The Issues table lets you list issues for a specific repository, using the repository name and the date range of the query. You can use the Issue State menu to limit the query to the type of issues you are interested in. Your options are:
- open
- closed
- all
Working with the GitHub API quota limits
The Qlik Web Connectors use the GitHub API to extract data from GitHub and load it into your Qlik Sense app. While reloading your GitHub-based app, you might receive an error message that the connector has reached the GitHub API rate limit and that all subsequent API calls will fail until the connector falls back under the throttling limit. If you receive this error message, then you have exceeded one of the API rate limits.
You receive an error message that you have reached the API rate limit
Reference - GitHub documentation
You can refer to the GitHub developer documentation to learn more about the requirements and restriction imposed by the GitHub API.
Troubleshooting
You receive an error message that you have reached the API rate limit
Possible cause
You have exceeded the API limits that are imposed on the Qlik Web Connectors by the GitHub API.
Proposed action
To reduce the impact of reaching the API rate limits, develop your app with the following in mind:
- Extract only the data you need.
- Reload one GitHub-based application at a time.
- Ensure that loops in your script that make API calls will not result in infinite loops.