timeline

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

Overview

Name	timeline
Type	Resource
Id	github.issues.timeline

Fields

The following fields are returned by SELECT queries:

list_events_for_timeline

Response

Name	Datatype	Description
id	integer
commit_id	string
node_id	string
_links	object
actor	object	A GitHub user. (title: Simple User)
assignee	object	A GitHub user. (title: Simple User)
author	object	Identifying information for the git-user
author_association	string	How the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
blocked_by	object	A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). (title: Issue Reference)
blocking	object	A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). (title: Issue Reference)
body	string	Contents of the issue comment (example: What version of Safari were you using when you observed this bug?)
body_html	string
body_text	string
comments	array
commit_url	string
committer	object	Identifying information for the git-user
created_at	string
dismissed_review	object
event	string
html_url	string (uri)
intent	object	The intent behind an agent's action on an issue, including the rationale and confidence. Present (and null when the event carried no agent intent) on supported event types while the issue suggestions feature is enabled for the repository; the property is omitted entirely when the feature is disabled or the event type does not support intent. (title: Issue Event Intent)
issue_type	object	The type of issue. (title: Issue Type)
issue_url	string (uri)
label	object
lock_reason	string	(example: "off-topic")
message	string	Message describing the purpose of the commit (example: Fix #42)
milestone	object
minimized	object	Details about why an issue comment was minimized. (title: Minimized Issue Comment)
parent_issue	object	A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). (title: Issue Reference)
parents	array
performed_via_github_app	object	GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
pin	object	Context around who pinned an issue comment and when it was pinned. (title: Pinned Issue Comment)
prev_issue_type	object	The type of issue. (title: Issue Type)
project_card	object
pull_request_url	string (uri)	(example: https://api.github.com/repos/octocat/Hello-World/pulls/12)
reactions	object	(title: Reaction Rollup)
rename	object
requested_reviewer	object	A GitHub user. (title: Simple User)
requested_team	object	Groups of organization members that gives permissions on specified repositories. (title: Team)
review_requester	object	A GitHub user. (title: Simple User)
sha	string	SHA for the commit (example: 7638417db6d59f3c431d3e1f261cc637155684cd)
source	object
state	string	(example: CHANGES_REQUESTED)
state_reason	string
sub_issue	object	A minimal reference to an issue linked from a timeline event (e.g. sub-issue, parent-issue, or dependency events). (title: Issue Reference)
submitted_at	string (date-time)
tree	object
updated_at	string (date-time)	(example: 2011-04-14T16:00:49Z)
url	string
user	object	A GitHub user. (title: Simple User)
verification	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_events_for_timeline	select	owner, repo, issue_number	per_page, page, exclude	List all timeline events for an issue.

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
issue_number	integer	The number that identifies the issue.
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.
exclude	string	A comma-separated list of timeline event names to exclude from the response.
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."

SELECT examples

list_events_for_timeline

List all timeline events for an issue.

SELECT
id,
commit_id,
node_id,
_links,
actor,
assignee,
author,
author_association,
blocked_by,
blocking,
body,
body_html,
body_text,
comments,
commit_url,
committer,
created_at,
dismissed_review,
event,
html_url,
intent,
issue_type,
issue_url,
label,
lock_reason,
message,
milestone,
minimized,
parent_issue,
parents,
performed_via_github_app,
pin,
prev_issue_type,
project_card,
pull_request_url,
reactions,
rename,
requested_reviewer,
requested_team,
review_requester,
sha,
source,
state,
state_reason,
sub_issue,
submitted_at,
tree,
updated_at,
url,
user,
verification
FROM github.issues.timeline
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND issue_number = '{{ issue_number }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
AND exclude = '{{ exclude }}'
;