Preview the GraphQL API for Checks

2018-07-11T07:00:00Z

As part of our ongoing work to create a GraphQL API for Checks, you can now query for check runs, suites, and annotation information!

Similar to the REST endpoint, this API is under a preview period. To access this new API during the preview period, you must provide a custom media type in the Accept header:

application/vnd.github.antiope-preview

Note: GraphQL APIs under preview cannot be accessed via the GraphQL Explorer at this time.

Changes to the Checks REST API

As part of this change, we are also changing the response provided by the REST API in the CheckSuiteEvent.

Previously, when querying a check suite, the REST API would return a key named unique_check_runs_count to indicate the quantity of check runs that had run as part of the latest push. Now, this key is called latest_check_runs_count to better indicate which types of check runs are being counted.

For one week, we will make both keys available in the response; on July 18, 2018, we will remove unique_check_runs_count and only provide latest_check_runs_count.

Share your feedback

During the preview period, we may change aspects of these APIs based on developer feedback. If we do, we will announce the changes here on the developer blog, but we will not provide any advance notice.

If you have any questions or feedback, please let us know!