--- category: [Administration & Integrations, Platform and Product Extensions, Platform and Product Extensions/Integration, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions/Workday Extend] keyword: [Extend, Workday Graph API, Graph API, GraphQL] nav: wcp_docs parent_url: /wcp_docs/ title: Graph API Explorer layout: subsection --- The Graph API Explorer is an interactive tool that enables you to: - Build and run Graph API queries and mutations in the Query panel. You can manually construct queries and mutations, or use the Generate Query tool with the Query panel. - Inspect the query or mutation response in the Data panel. - Explore the Graph API schema. Use the Documentation Explorer to find available queries and mutations. - Upload file attachments with mutations in the Multipart Attachments panel. - Analyze query or mutation performance with metrics. ## Accessing the Graph API Explorer To access the Graph API Explorer from the Developer Site menu, select Graph API Explorer in the APIs section. By default, Graph API Explorer opens in offline mode, which: - Enables you to view the Graph API Schema in the Documentation Explorer. Click the Show Documentation Explorer icon on the left sidebar. - Displays the v1 version of the Graph API schema. To switch to other versions of the schema, you must connect to a tenant. See [Connect API Explorers to a Tenant](/wcp_docs/GUID-49bcc9b8-b3d6-453b-b3da-5f5024effc44-enHYPHENus.html). - Uses mock data when you run queries and mutations. To read or write data in a tenant, you must connect to a tenant. See [Connect API Explorers to a Tenant](/wcp_docs/GUID-49bcc9b8-b3d6-453b-b3da-5f5024effc44-enHYPHENus.html). Ensure that you've setup the proper security policy configurations for Graph API and the data sources in your queries and mutations. See the Security section in [Workday Graph API Fundamentals](/wcp_docs/uiy1557767007800.html). ## Query Panel On the Query panel, you can: - Construct your query or mutation. While you type your query, you'll see type-ahead drop-down lists of available fields from the schema. - Define query variables. If your query has input variables, define them in a JSON map in the Variables section below the query. - Run the query or mutation. Press Ctrl+Enter or click the Execute query (PLAY) icon on the toolbar. - Add query tabs. To add a tab, click the plus (+) icon on the top right. Subsequently, you can add more tabs with the plus icon on top of the Query panel. ![](GUID-6e8f49ea-2b9d-4ca4-8e3d-0842d51ea0c3.png) You can use these keyboard shortcuts in the query panel:
 macOSWindows
Display a drop-down list of available schema fields.Press Option+Space.Press Ctrl+Space.
Display a schema link on the query panel. The link opens the corresponding page on the Documentation Explorer.Hover the mouse on a schema element in the query panel.Press Ctrl as you hover the mouse on a schema element in the query panel.

Note: The default queries in the Query panel use the `indexedAllWorkers` data source. Ensure that you've enabled and configured the Indexed Data Source: Workers security policy. ## Data Panel The Data panel displays the query or mutation results in a JSON data map, whose root field is the root query or mutation field. The data structure under the root field follows the same data structure that you requested in the query or mutation. If the query or mutation encountered errors, the Data panel displays the error response. ## Documentation Explorer To open the Documentation Explorer panel, click the Show Documentation Explorer icon on the left sidebar. The Documentation Explorer displays the Graph API schema, which includes the root query and mutation fields, their types, arguments, and response fields. Searching the schema from the Documentation Explorer default page returns a combined list of queries, mutations, and types. To search both queries and mutations, click the Search icon on the Documentation Explorer default page. To search only queries, click Query on the list of Root Types. Then browse the list of root query fields or click Search. To search only mutations, click Mutation on the list of Root Types. Then browse the list of root query fields or click Search. ![](GUID-0c1804b3-9551-4a39-bfd1-03c7191295cb.png) ## Selecting the Graph API Version By default, the Graph API Explorer displays the latest Graph API version, which includes both the Graph API endpoint and schema. The current version displays on the Graph API Explorer header. The Graph API Explorer uses the currently selected version when you: - Execute queries or mutations. - View the Documentation Explorer. To use an earlier Graph API version, select it from the version dropdown list. ## History To open the History panel, click the Show History icon on the left sidebar. On the History panel, you can: - View previously executed query or mutation during the Graph API Explorer session. - Select a query or mutation and run it. Note: If you select a previously executed mutation with file attachments, open the Multipart Attachments panel to specify the file attachments for the mutation. The History panel doesn’t save file attachments from previous executions. - Label a query or mutation. - Mark (star) successful queries or mutations as favorites. - Delete a query or mutation. - Click Clear to remove unstarred queries. ## Multipart Attachments To open the Multipart Attachments panel, click the Show Multipart Attachments icon on the left sidebar. On the Multipart Attachments panel, you can: - Add file attachment parts to use with a mutation. Note: The mutation must have input fields of the `File` type. The name of the parts in the Multipart Attachments panel must correspond to the attachment field values in the mutation input. Example: The input of the `createQuickExpense` mutation includes `attachments`, which is a list of `attachmentContent` fields. The `attachmentContent` field is of the `File` type. If the value of the `attachmentContent` field is file1, specify file1 as the name of the part in the Multipart Attachments panel. - Delete or modify file attachments. ![](GUID-36049191-d547-44fa-a1a9-0b364cf1f38c.png) ## Generate Query To open the Generate Query panel, click the Show Generate Query icon on the left sidebar. Select the query generation options before clicking a query or mutation from the filtered list. The Query panel displays the generated query or mutation. If you change an option, you must click the query or mutation again from the filtered list to regenerate. A new tab displays the regenerated query or mutation. ![](GUID-a621ba5a-67d9-46f3-8b7a-e2948cbeac9d.png) For details, see [Generate Queries on Graph API Explorer](/wcp_docs/uip1679531855079.html). ## Copy Tools To open the Copy Tool panel, click the Show Copy Tool icon on the left sidebar. On the Copy Tool panel, you can copy: - Host: The Graph API endpoint URL. You can copy the URL and paste it into an Extend app (as a data provider in the Application Metadata), orchestration, or an API tool like Bruno. - Auth: The Graph API access token. You can copy the access token into an API tool like Bruno. You can paste the content into the Authorization Bearer Token field. - Query: Content of the active tab in the Query panel, preserving multiple lines. Use the Copy Query button when adding the Graph API endpoint to a PMD page of an Extend app. Paste the copied query into either: - The `query` property of the `graphQuery` attribute of the endpoint. - A Graph Query component, which the `graphQuery` attribute can reference with the`queryId`. Note: If your query or mutation uses variables, manually copy the JSON map from the Variables section into the `variables` property of the endpoint - JSON: A JSON map representing the content of the active tab in the Query panel. The JSON map contains the `query` and `variables` fields. Use the Copy JSON button when building the request body of the Graph API endpoint in Orchestration Builder or other API tools like Bruno. Paste the copied JSON into the body of the API request. ## Metrics To run the query or mutation with metrics, click the Metrics icon on the right of the Query panel and select the query or mutation. After the query or mutation executes, the Query panel displays the metrics above each of the requested fields as multiline comments that begin with `#_`. ![](GUID-b1b2cfc2-493f-4759-b45e-a4ff0544ad1a.png) For details, see [Reference: Graph API Metrics](/wcp_docs/GUID-6b0a41b2-3b34-4887-9ea2-84f322fe7bba-enHYPHENus.html). ### Related Information [Generate Queries on Graph API Explorer](/wcp_docs/uip1679531855079.html)