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

• Troubleshooting errors

• OAuth Token

Recommended HTTP Clients & GraphQL IDEs

...

• Curl

• Postman

• Insomnia

GraphQL IDEs

• Scope GraphQL Explorer

• GraphiQL

• GraphQL Playground

...

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.

Configuring GraphiQL

1. Get an OAuth token.

2. Launch GraphiQL.

3. In the upper-right corner of GraphiQL, click Edit HTTP Headers.

4. In the upper-right corner of the modal dialog, click + Add Header.

5. In the Key field, enter Authorization. In the Value field, enter Token token=<token>, where <token> is your generated OAuth token.

   

6. Click the checkmark to the right of the token to save it.

7. In the upper-right corner of the modal dialog, click + Add Header.

8. In the Key field, enter PrivateAccessCode. In the Value field, enter Token token=YWRtaW4xMjU6c2VjcmV0MTI1, where YWRtaW4xMjU6c2VjcmV0MTI1 is a literal value (used to control early access to beta features).

   

9. Click the checkmark to the right of the token to save it.

10. To return to the editor, click outside of the Edit HTTP Headers modal.

11. In the GraphQL Endpoint field, enter https://cms.scopear.com/api/v3/graphql.

12. In the Method dropdown menu, select POST.

...