| Note |
|---|
The Scope GraphQL API and Webhooks are in Preview mode. Functionality and compatibility is subject to change. |
Learn useful terminology and concepts related to using the Scope GraphQL API.
...
A specification. The spec determines the validity of the schema on the API server. The schema determines the validity of client calls.
Strongly typed. The schema defines an API's type system and all object relationships. See “Schema”.
Introspective. A client can query the schema for details about the schema.
Hierarchical. The shape of a GraphQL call mirrors the shape of the JSON data it returns. Nested fields let you query for and receive only the data you specify in a single round trip.
An application layer. GraphQL is not a storage model or a database query language. The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored. See “Using Global Node IDs”.
Why Scope is using GraphQL
...
The Scope GraphQL API represents an architectural and conceptual shift from the Scope REST APIs. You will likely encounter some new terminology in the GraphQL API reference docs.
Schema
A schema defines a GraphQL API's type system.
...
All calls are validated and executed against the Scope GraphQL public schema:
Allowed operations: queries and mutations.
Schema-defined types: scalars, objects, enums, interfaces, unions, and input objects.
...
For other information, such as authentication and rate limit details, check out the guides.
Field
A field is a unit of data you can retrieve from an object. As the official GraphQL docs say: "The GraphQL query language is basically about selecting fields on objects."
...
The Scope GraphQL API has limitations in place to protect against excessive or abusive calls to Scope's servers.
Node limit
To pass schema validation, all GraphQL API v3 calls must meet these standards:
...
Dividing by 100 and rounding up gives us the final score of the query: 21
Further reading
See “Public Schema” to view reference documentation and learn about the data types available in the GraphQL API public schema.
See “Guides” to learn how to use the Scope GraphQL Explorer to interact with the Scope GraphQL API on real data and leverage the Scope GraphQL API for a variety of tasks.