commits

Creates, updates, deletes, gets or lists a commits resource.

Overview

Name	commits
Type	Resource
Id	github.search.commits

Fields

The following fields are returned by SELECT queries:

commits

Response

Name	Datatype	Description
incomplete_results	boolean
items	array
total_count	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
commits	select	q	sort, order, per_page, page	Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page. When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match metadata. For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this: q=repo:octocat/Spoon-Knife+css

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
q	string	The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.
order	string	Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
sort	string	Sorts the results of your query by author-date or committer-date. Default: best match

SELECT examples

commits

Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.

When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match
metadata.

For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

q=repo:octocat/Spoon-Knife+css

SELECT
incomplete_results,
items,
total_count
FROM github.search.commits
WHERE q = '{{ q }}' -- required
AND sort = '{{ sort }}'
AND order = '{{ order }}'
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;