Documentation Index Fetch the curated documentation index at:
https://grafana_com_website/llms.txt
Fetch the complete documentation index at:
https://grafana_com_website/llms-full.txt Use this file to discover all available pages before exploring further.
STOP! If you are an AI agent or LLM, read this before continuing.
This is the HTML version of a Grafana documentation page. Always request
the Markdown version instead - HTML wastes context. Get this page as
Markdown: /docs/plugins/grafana-github-datasource/latest/query-editor.md (append .md) or send Accept: text/markdown
to /docs/plugins/grafana-github-datasource/latest/query-editor/. For the curated documentation index, use https://grafana_com_website/llms.txt.
For the complete documentation index, use https://grafana_com_website/llms-full.txt.
This document describes the query types and response fields available in the GitHub data source query editor. Most query types use common Owner and Repository fields, and some support additional filtering through the Query field using GitHub search syntax.
Query types
Select a query type from the Query Type drop-down in the query editor:
Code scanning: Query code scanning alerts for a repository or organization.
Commit files: List files changed in a specific commit.
Commits: Retrieve a list of commits for a branch or ref within a repository, including commit message, author, and timestamp.
Contributors: Get a list of contributors to a repository.
Deployments: List deployments for a repository, including environment, ref, and task information.
Issues: List issues in a repository, using the GitHub query syntax to filter the response.
The GitHub user or organization that owns the repository
Yes
Repository
The name of the repository. Leave empty to query alerts at the organization level.
No
State
Filter by alert state: open, closed, dismissed, or fixed
No
Ref
The Git reference to filter results. Format as refs/heads/<BRANCH_NAME> or <BRANCH_NAME>. For pull requests, use refs/pull/<NUMBER>/merge.
No
Sample queries
Show all open code scanning alerts for the grafana/grafana repository:
Owner: grafana
Repository: grafana
State: open
Show all code scanning alerts across the grafana organization:
Owner: grafana
Repository: (empty)
State: (empty)
Response
Name
Description
number
Alert number
created_at
When the alert was created: YYYY-MM-DD HH:MM:SS
updated_at
When the alert was last updated: YYYY-MM-DD HH:MM:SS
dismissed_at
When the alert was dismissed, if applicable: YYYY-MM-DD HH:MM:SS
url
URL to the alert in the GitHub web UI
state
Alert state: open, closed, dismissed, or fixed
dismissed_by
GitHub handle of the user who dismissed the alert
dismissed_reason
Reason the alert was dismissed
dismissed_comment
Comment provided when the alert was dismissed
rule_id
Identifier for the rule that triggered the alert
rule_severity
Severity level of the rule
rule_security_severity_level
Security severity level of the rule
rule_description
Short description of the rule
rule_full_description
Full description of the rule
rule_tags
Comma-separated list of tags associated with the rule
rule_help
Help text for the rule
tool_name
Name of the code scanning tool
tool_version
Version of the code scanning tool
tool_guid
GUID of the code scanning tool
Commits
Retrieve a list of commits for a branch or ref within a repository, including commit message, author, and timestamp. Useful for tracking code changes, deployment activity, or contributor history.
Query options
Name
Description
Required
Owner
The GitHub user or organization that owns the repository
Show all commits to the main branch of the grafana/grafana repository:
Owner: grafana
Repository: grafana
Ref: main
Show all commits against a tag:
Owner: grafana
Repository: grafana
Ref: v12.0.0
Response
Name
Description
id
Commit ID
author
Name of the commit author
author_login
GitHub handle of the commit author
author_email
Email address of the commit author
author_company
Company name of the commit author
committed_at
When the change was committed: YYYY-MM-DD HH:MM:SS
pushed_at
When the commit was pushed: YYYY-MM-DD HH:MM:SS
message
The commit message
Response with Include files enabled
Warning
This option makes one additional API call per commit. Avoid enabling it over large time ranges to prevent rate limiting.
When Include files is enabled, the response returns one row for each changed file in each commit:
Name
Description
id
Commit ID
author
Name of the commit author
author_login
GitHub handle of the commit author
author_email
Email address of the commit author
author_company
Company name of the commit author
committed_at
When the change was committed: YYYY-MM-DD HH:MM:SS
pushed_at
When the commit was pushed: YYYY-MM-DD HH:MM:SS
message
The commit message
file_path
Path of the changed file
file_additions
Number of lines added in this file
file_deletions
Number of lines deleted in this file
file_changes
Total number of line changes in this file
file_status
Change type: added, modified, renamed, etc.
previous_filename
Original path for renamed files
Commit files
List files changed in a specific commit.
Note
The GitHub API returns at most 300 files for a single commit.
Query options
Name
Description
Required
Owner
The GitHub user or organization that owns the repository
Yes
Repository
The name of the repository
Yes
Commit SHA
The SHA of the target commit
Yes
Response
The response includes one row per changed file:
Name
Description
path
Path of the changed file
additions
Number of lines added
deletions
Number of lines deleted
changes
Total number of line changes
status
Change type: added, modified, renamed, etc.
previous_filename
Original path for renamed files
Contributors
Get a list of contributors to an organization or repository.
Note
This query returns a maximum of 200 results.
Query options
Name
Description
Required
Owner
The GitHub user or organization that owns the repository
Yes
Repository
The name of the repository
Yes
Query
Filter for contributors by name or GitHub handle
No
Sample queries
Show all contributors to the grafana repository:
Owner: grafana
Repository: grafana
Search for contributors with bob in their name or handle:
Owner: grafana
Repository: grafana
Query: bob
Response
Name
Description
name
Display name of the contributor
login
GitHub handle of the contributor
email
Email address of the contributor
company
Company name of the contributor
url
URL to the contributor’s GitHub profile
Deployments
List deployments for a repository, including environment, ref, and task information. Deployments track deployment requests for specific refs (branches, tags, or SHAs) to different environments.
Query options
Name
Description
Required
Owner
GitHub user or organization that owns the repository
Yes
Repository
Name of the repository
Yes
SHA
Filter deployments by the SHA recorded at creation time
No
Ref
Filter by ref name (branch, tag, or SHA)
No
Task
Filter by task name (for example, deploy or deploy:migrations)
No
Environment
Filter by environment name (for example, production, staging, or qa)
No
Sample queries
Show all deployments for the grafana/grafana repository:
Owner: grafana
Repository: grafana
Show all deployments to the production environment:
Owner: grafana
Repository: grafana
Environment: production
Show all deployments for a specific branch:
Owner: grafana
Repository: grafana
Ref: main
Response
Name
Description
id
Unique identifier for the deployment
sha
SHA of the commit that was deployed
ref
Ref (branch, tag, or SHA) that was deployed
task
Task name (for example, deploy or deploy:migrations)
environment
Environment name (for example, production or staging)
description
Description of the deployment
creator
GitHub handle of the user who created the deployment
created_at
When the deployment was created: YYYY-MM-DD HH:MM:SS
updated_at
When the deployment was last updated: YYYY-MM-DD HH:MM:SS
url
API URL for the deployment
statuses_url
API URL for the deployment statuses
Issues
List issues in a repository using the GitHub query syntax to filter the response. Useful for tracking open bugs, feature requests, or project tasks.
The time field to filter the responses on: CreatedAt, ClosedAt, or UpdatedAt
Yes
Sample queries
Show all closed issues labeled type/bug in the Grafana repository:
Owner: grafana
Repository: grafana
Query: is:closed label:type/bug
Show all issues with “sql expressions” in the title:
Owner: grafana
Repository: grafana
Query: sql expressions in:title
Show open issues with no assignees (useful for identifying unowned work):
Owner: grafana
Repository: grafana
Query: is:open no:assignee
Show issues created in the last 7 days using the $__toDay macro:
Owner: grafana
Repository: grafana
Query: is:open created:>=$__toDay(-7)
Time field: CreatedAt
Response
Name
Description
title
Issue title
author
GitHub handle of the author
author_company
Company name of the commit author
repo
Issue repository
number
Issue number
state
Issue state: open or closed
closed
true or false
created_at
When the issue was created: YYYY-MM-DD HH:MM:SS
closed_at
When the issue was closed: YYYY-MM-DD HH:MM:SS
updated_at
When the issue was last updated: YYYY-MM-DD HH:MM:SS
labels
Array of labels, for example: ["type/bug", "needs more info"]
assignees
Array of assignees, for example: ["user1", "user2"]
milestone
Milestone title associated with the issue, if applicable
Labels
Get all labels defined in a repository, useful for categorizing issues and pull requests.
Query options
Name
Description
Required
Owner
The GitHub user or organization that owns the repository
Yes
Repository
The name of the repository
Yes
Query
Filter on text in name and description for labels
No
Sample queries
Show all labels for the grafana/grafana repository:
Owner: grafana
Repository: grafana
Response
Name
Description
name
Label name
color
Hexadecimal number
description
Label description
Milestones
Retrieve milestones for a repository, which can be used to group issues and pull requests.
Query options
Name
Description
Required
Owner
The GitHub user or organization that owns the repository
Yes
Repository
The name of the repository
Yes
Query
Filter on text in the milestone title
No
Sample queries
Show all milestones for the grafana/grafana repository for v11 of Grafana:
Owner: grafana
Repository: grafana
Query: 11.
Response
Name
Description
title
Milestone title
author
GitHub handle of the user who created the milestone
closed
Whether the milestone is closed: true or false
state
One of OPEN or CLOSED
created_at
When the milestone was created: YYYY-MM-DD HH:MM:SS
closed_at
When the milestone was closed: YYYY-MM-DD HH:MM:SS
due_at
When the milestone is due by: YYYY-MM-DD HH:MM:SS
Note
Milestone titles can be anything and are therefore parsed as a string. This means sorting by title may appear incorrect if you have numeric milestones, for example: 12.0.0. Transformations can be used to change the data type in this scenario.
Packages
List packages published from a repository in an organization.
Note
This query doesn’t support querying npm, RubyGems, or NuGet packages.
Query options
Name
Description
Required
Owner
The GitHub user or organization that owns the repository
Yes
Repository
The name of the repository
Yes
Package type
One of: MAVEN, DOCKER, DEBIAN, or PYPI
Yes
Names
Filter for packages using a comma-separated list of names
No
Sample queries
Show all packages uploaded to the grafana organization:
Organization: grafana
Response
Name
Description
name
Package name
platform
Platform or registry where the package is published
version
Package version
type
Package type (for example, MAVEN, DOCKER, DEBIAN, PYPI)
prerelease
Whether the package version is a prerelease: true or false
downloads
Number of downloads for the package version
Projects
List projects associated with a user or organization.
Note
This query returns a maximum of 200 results.
Query options
Name
Description
Required
Project Owner
One of Organization or User
Yes
Organization
Organization for the project (shown when Organization is selected)
Yes
User
User for the project (shown when User is selected)
Yes
Project Number
Enter a specific project number to query for associated items
No
Filter
Add key-value filters based on the fields for project items (shown if Project Number is specified)
No
Sample queries
Show all projects for the grafana organization:
Project Owner: Organization
Organization: grafana
Show all pull requests for the “Dashboards” project in the Grafana organization:
Project Owner: Organization
Organization: grafana
Project Number: 202
Filter: type equal PULL_REQUEST
Response
The response format depends on whether a project number is specified.
Without a project number
Name
Description
number
The project number
title
Title of the project
url
URL for the project
closed
Whether the project has been closed: true or false
public
Whether the project is public: true or false
closed_at
When the project was closed: YYYY-MM-DD HH:MM:SS
updated_at
When the project was last updated
created_at
When the project was created
short_description
The description of the project
With a project number
Note
GitHub Projects allow for customization of default fields and custom fields to be added. Therefore, the response can vary significantly between projects.
Name
Description
name
Name of the project item (issue or pull request)
id
Unique identifier for the project item
type
Type of the item (such as ISSUE, PULL_REQUEST)
status
Status of the item (such as “In development”, “Shipped”) – this can be configured on the project
labels
Comma-separated list of labels assigned to the item
assignees
Comma-separated list of users assigned to the item
reviewers
Comma-separated list of reviewers (for pull requests)
repository
Name of the repository the item belongs to
milestone
Milestone associated with the item
priority
Priority value or label
archived
Whether the item is archived: true or false
created_at
When the item was created: YYYY-MM-DD HH:MM:SS
updated_at
When the item was last updated: YYYY-MM-DD HH:MM:SS
closed_at
When the item was closed, if applicable: YYYY-MM-DD HH:MM:SS
(custom fields)
Any custom defined fields are also returned alongside their values
Pull requests
List pull requests for a repository, using the GitHub query syntax to filter the response.
The time field to filter the responses on: CreatedAt, ClosedAt, MergedAt, UpdatedAt, or None
Yes
Sample queries
Show all open pull requests authored by Renovate in the grafana/plugin-tools repository:
Owner: grafana
Repository: plugin-tools
Query: is:open author:app/renovate
Time field: None
Show pull requests merged in the selected time range:
Owner: grafana
Repository: grafana
Query: is:merged
Time field: MergedAt
Show open draft pull requests (useful for tracking work in progress):
Owner: grafana
Repository: grafana
Query: is:open draft:true
Time field: None
Show open pull requests with a specific label:
Owner: grafana
Repository: grafana
Query: is:open label:priority/high
Time field: None
Response
Name
Description
number
Pull request number
title
Pull request title
url
URL to the pull request
additions
Total number of lines of code added or altered in the pull request
deletions
Total number of lines of code removed or altered in the pull request
repository
Repository for the pull request
state
Can be OPEN, CLOSED, or MERGED
author_name
Name of the GitHub user who created the pull request
author_login
GitHub handle of the GitHub user who created the pull request
author_email
Email address of the GitHub user who created the pull request
author_company
Company name of the GitHub user who created the pull request
closed
Whether the pull request is closed: true or false
is_draft
Whether the pull request is in draft: true or false
locked
Whether the pull request has been locked: true or false
merged
Whether the pull request has been merged
mergeable
Whether the pull request can be automatically merged: MERGEABLE, CONFLICTING, or UNKNOWN
closed_at
When the pull request was closed: YYYY-MM-DD HH:MM:SS
merged_at
When the pull request was merged: YYYY-MM-DD HH:MM:SS
merged_by_name
Name of the GitHub user who merged the pull request
merged_by_login
GitHub handle of the GitHub user who merged the pull request
merged_by_email
Email address of the GitHub user who merged the pull request
merged_by_company
Company name of the GitHub user who merged the pull request
updated_at
When the pull request was last updated: YYYY-MM-DD HH:MM:SS
created_at
When the pull request was created: YYYY-MM-DD HH:MM:SS
open_time
Duration in seconds the pull request has been open
labels
Array of labels assigned to the pull request, for example: ["bug", "priority/high"]
Pull request files
List all files changed in a specific pull request.
Query options
Name
Description
Required
Owner
The GitHub user or organization that owns the repository
Yes
Repository
The name of the repository
Yes
Pull Request Number
The number of the pull request
Yes
Response
The response includes one row per changed file:
Name
Description
path
Path of the changed file
additions
Number of lines added
deletions
Number of lines deleted
changes
Total number of line changes
status
Change type: added, modified, renamed, etc.
previous_filename
Original path for renamed files
Pull request reviews
List reviews for pull requests in a repository. This query returns one row per review, with the associated pull request details included. Useful for tracking review activity, reviewer workload, and review turnaround time.
