Exploring the Graph

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

HTTP Clients

• Curl

• Postman

• Insomnia

GraphQL IDEs

• GraphiQL

• GraphQL Playground

The GraphQL endpoint

The REST API has numerous endpoints; the GraphQL API has a single endpoint:

If you are not a super admin, the endpoint can remain constant no matter what operation you perform. If you are a super admin, you must include the company permalink name in the URL. In this example, the company permalink name is scope

Note that users other than super/company admins can now use GraphQL to run queries.

Using GraphiQL

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

Configuring GraphiQL

1. Getting an OAuth token can be done thru CMS

   1. Log in to CMS as your authorized user and open the Developers Console (F12 usually does this)

   2. Open the Application tab and copy the Auth token from Cookies

       

      Open

      

2. Ensure the authenticated user has the Access Control Rights required by the query to be executed (See Authorization Errors & Reporting Admins).

3. Launch GraphiQL.

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

5. If you don’t already have GraphiQL setup with Headers, do the following;

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

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

      Open

      

   3. Click Save to save the token.

   4. If you hold an analyst license, you can obtain your token thru your user profile on CMS

      1. Login and navigate to Edit Profile

      2. The API Key on the bottom right is your token

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

   6. In the Key field, enter PrivateAccessCode. In the Value field, enter Token token=YWRtaW4xMjU6c2VjcmV0MTI1, where YWRtaW4xMjU6c2VjcmV0MTI1 is a literal value (used to enable early access to the Scope GraphQL API).

   7. Click Save to save the token.

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

6. In the GraphQL Endpoint field, enter the following (include company permalink if necessary)

7. In the Method dropdown menu, select POST.

You can test your access by querying yourself:

If everything worked correctly, this will display the name of the currently authenticated user. You're all set to start making queries.

Accessing the sidebar docs

All types in a GraphQL schema include a description field compiled into documentation. The collapsible Docs pane on the right side of the Explorer page allows you to browse documentation about the type system. The docs are automatically updated and will drop deprecated fields.

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

Variables can be injected into queries and mutations like this:

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:

Troubleshooting errors

Because GraphQL is introspective, the Explorer supports:

• Intelligent typeaheads aware of the current schema

• Validation error previews as you type

If you enter a query that is not well-formed or does not pass schema validation, a popup warns you of an error. If you run the query, the error returns in the response pane.

A GraphQL response contains several keys: a data hash and an errors array.

Authorization errors

Authorization errors indicate that the current user does not have sufficient privileges to access a requested node (or nodes).

Unauthorized nodes that are part of many-to-one relationships (aka “Connections”) are automatically pruned from the response without triggering an error, whereas unauthorized nodes that belong to one-to-one relationships trigger an error.

By way of example, the following query will trigger the following authorization error response when the user executing the query isn’t authorized to read the node identified by id YQLXlUig57gDr1aAak2ojlH98qqDttCUIUwR_Y-MPJRWrdX0sgvvjiOj6fXusYeG:

But, the node in the previous example will be silently removed from the response to the following query without triggering an error:

Unexpected errors

It's possible you might run into an unexpected error that is not related to the schema. If this happens, the message will include a reference code you can use when reporting the issue to support:

If you need additional 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.

Refreshing an OAuth token

Scope OAuth tokens currently expire after 30 days (or “sign-out”, whichever is earlier). Repeat steps 1-5 to obtain a fresh token thru the developers console.