Page Comparison

You can run queries on real Scope data using any HTTP compliant client (HTTP Client) or GraphQL integrated development environment (GraphQL IDE). GraphQL IDEs are typically easier to work with because they include docs, syntax highlighting, and validation errors.

If you need help, see Requesting support.

In this article

• Recommended HTTP Clients & GraphQL IDEs

• The GraphQL endpoint

• About the Scope GraphQL Explorer

• Using GraphiQL

  • Accessing the sidebar docs

  • Using the variable pane

  Requesting support

• Troubleshooting errors

• OAuth Token

...

Scope GraphQL Explorer is an instance of GraphiQL (a GraphQL IDE) that is available in-browser at https://cms.scopear.com/api/v3/graphql/explorer.

Note: Scope has temporarily disabled the Explorer (expected to return ~ Q1 2021'), but you can still use a local GraphiQL client, or any other client, to explore the graph.

Using GraphiQL

To use the GraphiQL app, download and install it from https://www.electronjs.org/apps/graphiql.

...

The Docs sidebar contains the same content that is automatically generated from the schema under "Reference," though it is formatted differently in places.

Using the variable pane

Some example calls include variables written Variables can be injected into queries and mutations like this:

query($number_of_repos:Int$my_custom_node_id_var:String!){
  viewer {
    name
     repositories(last: $number_of_reposnode(id: $my_custom_node_id_var:String) {
       nodes {
         name
       }
     }__typename
   }
}
variables {
   "number_of_reposmy_custom_node_id_var:String": 3"6_kJ_XUGDxMDWkwq2bAK-dKknUQ7GPpsI2yfj691f9L2n6N4sAhdU4urWqNG1RVX"
}

This is the correct format to submit the call via a cURL POST (as long as you escape newlines).

If you want to run the call in the Explorer, enter the query segment in the main pane and the variables in the Query Variables pane below it. Omit the word variables from the Explorer:

{
   "number_of_reposmy_custom_node_id_var:String": 3"6_kJ_XUGDxMDWkwq2bAK-dKknUQ7GPpsI2yfj691f9L2n6N4sAhdU4urWqNG1RVX"
}

...

For questions, bug reports, and discussions about Scope Apps, OAuth Apps, and API development, email api.support@scopear.com. This email group is moderated and maintained by Scope staff, but questions posted to the group are not guaranteed to receive a reply from Scope staff.

Consider reaching out to your Scope representative for:

• guaranteed response from Scope staff

• support requests involving sensitive data or private concerns

• feature requests

• feedback about Scope products

Troubleshooting errors

Because GraphQL is introspective, the Explorer supports:

...

Note: Scope recommends checking for errors before using data in a production environment. In GraphQL, failure is not total: portions of GraphQL queries may succeed while others fail.

If you need help, see Requesting support.

OAuth token

You must obtain a valid OAuth token before attempting to execute queries against, or explore the schema of, the Scope API.

...