Intro
GitHub is a web-based version control repository and Internet hosting service. Use Domo's GitHub connector to retrieve data about GitHub followers, repositories, organizations, users, gists, and much, much more. To learn more about the GitHub API, visit their page (https://developer.github.com/v3/).
You connect to your GitHub account in the Data Center. This topic discusses the fields and menus that are specific to the GitHub connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.
Prerequisites
To connect to your GitHub account and create a DataSet, you must have your GitHub credentials (i.e. your username/email address and password).
Connecting to Your GitHub Account
This section enumerates the options in the Credentials and Details panes in the GitHub Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.
Credentials Pane
The Domo GitHub connector uses OAuth to connect, so there is no need to enter credentials within Domo. Click Connect (or select Add Account if you have existing GitHub accounts in Domo) to open the GitHub OAuth screen where you can enter your GitHub credentials. Once you have entered valid third-party tool credentials, you can use the same account any time you go to create a new GitHub DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.
Details Pane
This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.
Menu |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Report |
Select the GitHub report you want to run. The following reports are available:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
User Name/Owner Name (Optional) |
Enter the user name or owner name you want to pull data for. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
User Name (Optional) |
Enter the user name you want to pull data for. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Owner Name (Optional) |
Enter the owner name you want to pull data for. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Repository Name (Optional) |
Enter the name of the repository you want to pull data for. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Organization Name (Optional) |
Enter the name of the organization you want to pull data for. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sort (Optional) |
Enter a sort value for your report. This option is available for the below reports:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Order (Optional) |
Enter the sort order if you entered a parameter in the Sort field. Use asc for ascending and desc for descending. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
State of Issue to be Searched (Optional) |
Enter a state to filter by, either open, closed, or all (default is open). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Past Days (Optional) |
Enter the number of past days for which you want to retrieve data. The value can be entered as X, XDay, or XDays, where X is a positive integer. For example: 30Days. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Issue Filter (Optional) |
Enter a value to filter out issues in the authenticated user's context. Possible values are assigned, created, mention, subscribed, and all. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type (Optional) |
Enter the type of item to search for. This option is available for the below reports:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Search Field |
Enter the keyword to search for. |
Other Panes
For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.
FAQs
How do I know my Github credentials are secure?
The login process uses OAuth, so your Github credentials are never seen or stored by Domo. This keeps your login secure. You can revoke Domo's access to your account anytime.
How often can the data be updated?
As often as needed.
Are there any API limits I should be aware of?
You can make up to 5000 requests per hour.
Comments
0 comments
Please sign in to leave a comment.