activities

Creates, updates, deletes, gets or lists an activities resource.

Overview

Name	activities
Type	Resource
Id	github.repos.activities

Fields

The following fields are returned by SELECT queries:

list_activities

Response

Name	Datatype	Description
id	integer
node_id	string	(example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
activity_type	string	The type of the activity that was performed. (push, force_push, branch_deletion, branch_creation, pr_merge, merge_queue_merge) (example: force_push)
actor	object	A GitHub user. (title: Simple User)
after	string	The SHA of the commit after the activity. (example: 827efc6d56897b048c772eb4087f854f46256132)
before	string	The SHA of the commit before the activity. (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
ref	string	The full Git reference, formatted as refs/heads/<branch name>. (example: refs/heads/main)
timestamp	string (date-time)	The time when the activity occurred. (example: 2011-01-26T19:06:43Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_activities	select	owner, repo	direction, per_page, before, after, ref, actor, time_period, activity_type	Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. For more information about viewing repository activity, see "Viewing activity and data for your repository."

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
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.
activity_type	string	The activity type to filter by. For example, you can choose to filter by "force_push", to see all force pushes to the repository.
actor	string	The GitHub username to use to filter by the actor who performed the activity.
after	string	A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
before	string	A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
direction	string	The direction to sort the results by.
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
ref	string	The Git reference for the activities you want to list. The ref for a branch can be formatted either as refs/heads/BRANCH_NAME or BRANCH_NAME, where BRANCH_NAME is the name of your branch.
time_period	string	The time period to filter by. For example, day will filter for activity that occurred in the past 24 hours, and week will filter for activity that occurred in the past 7 days (168 hours).

SELECT examples

list_activities

Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

For more information about viewing repository activity,
see "Viewing activity and data for your repository."

SELECT
id,
node_id,
activity_type,
actor,
after,
before,
ref,
timestamp
FROM github.repos.activities
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND direction = '{{ direction }}'
AND per_page = '{{ per_page }}'
AND before = '{{ before }}'
AND after = '{{ after }}'
AND ref = '{{ ref }}'
AND actor = '{{ actor }}'
AND time_period = '{{ time_period }}'
AND activity_type = '{{ activity_type }}'
;