Skip to content

[GraphQL] Add explorer iframe #22413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

[GraphQL] Add explorer iframe #22413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c7252c
[GraphQL] Add explorer iframe
kodster28 May 14, 2025
4706779
fix link
kodster28 May 14, 2025
02dac78
Update src/content/docs/analytics/graphql-api/getting-started/index.mdx
kodster28 May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/content/docs/analytics/graphql-api/getting-started/explorer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: GraphQL explorer
pcx_content_type: reference
sidebar:
order: 1
tableOfContents: false
---

Cloudflare provides a [GraphQL explorer](https://graphql.cloudflare.com/explorer) to learn more about the schema.

<div style="position: relative; padding-top: 56.25%">
<iframe
src="https://graphql.cloudflare.com/explorer"
title="Cloudflare GraphQL explorer"
style="border: none; position: absolute; top: 0; left: 0; height: 100%; width: 100%;"
referrerpolicy="strict-origin-when-cross-origin"
allowfullscreen
></iframe>
</div>
25 changes: 11 additions & 14 deletions src/content/docs/analytics/graphql-api/getting-started/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,39 @@
---
title: Get started
pcx_content_type: get-started
pcx_content_type: navigation
sidebar:
order: 11

---

import { Render } from "~/components"
import { Render } from "~/components";

Use these articles to get started with the Cloudflare GraphQL API:

* [Authentication][1] - walks you through the options and the steps required to
- [GraphQL Explorer][7]
- [Authentication][1] - walks you through the options and the steps required to
set up your access to Cloudflare API successfully,
* [Querying basics][2] - brings simple query examples for you to start exploring
- [Querying basics][2] - brings simple query examples for you to start exploring
the GraphQL API,
* [Introspect the GraphQL schema][3] - explains how-to surf the schema with
- [Introspect the GraphQL schema][3] - explains how-to surf the schema with
GraphQL client,
* [Create a query in a GraphQL client][4] - describes how to build and run a
- [Create a query in a GraphQL client][4] - describes how to build and run a
query against the Cloudflare GraphQL API in the GraphQL clients,
* [Use curl to query the GraphQL API][5] - walks you through running a query
- [Use curl to query the GraphQL API][5] - walks you through running a query
against the Cloudflare GraphQL API from the command line.

For examples of how to build your own GraphQL Analytics dashboard and query
specific information, such as Firewall and Workers events, please refer to
[Tutorials][6].

:::note[Data unavailability: Customer Metadata Boundary configuration]
<Render file="customer_metadata_boundary_error" />

<Render file="customer_metadata_boundary_error" />
:::

[1]: /analytics/graphql-api/getting-started/authentication/

[2]: /analytics/graphql-api/getting-started/querying-basics/

[3]: /analytics/graphql-api/getting-started/explore-graphql-schema/

[4]: /analytics/graphql-api/getting-started/compose-graphql-query/

[5]: /analytics/graphql-api/getting-started/execute-graphql-query/

[6]: /analytics/graphql-api/tutorials/
[7]: /analytics/graphql-api/getting-started/explorer/
Loading