GraphQL API - Arize AX Docs

What is GraphQL?

GraphQL is a query language for APIs that provides a programmatic way of accessing (query) and modifying (mutation) entities within the Arize AX platform, offering precise and flexible queries for an in-depth integration with your existing tooling and infrastructure. For a brief overview of GraphQL itself, please consult our introduction.

Queries on the Arize GraphQL API are available to all accounts. Mutations are available to enterprise-grade customers. To upgrade your account contact support@arize.com.

Why Use The Arize GraphQL API?

The Arize GraphQL API enables customers to integrate Arize with their internal systems for a repeatable and consistent setup. Use the API to:

• Bulk create custom monitors with complex filters or baselines
• Export existing monitor configuration, make edits, and bring edits back into Arize AX
• Build automation by integrating Arize AX with internal services

GraphQL Benefits for the Arize AX API

1. GraphQL operates with well-defined schemas and types which allow users to automatically document the API and validate queries and mutations without relying on the server.
2. GraphQL enables users to specify their returned data in a single query. Users get to precisely define the data they want — which means querying less to get what you need. This saves time, reduces computational load, and lessens network expenses.
3. GraphQL is Language agnostic. This means you can implement our GraphQL API in your preferred language for a more intuitive understanding.

About GraphQL

The GraphQL data query language is:

• 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.
• 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.

The GraphQL API is being actively iterated on, so some aspects may change.