Interactive API explorer

The ION UI application has a built-in API explorer to help you navigate the API

The ION UI application has a built-in API explorer to help you navigate the API. Click the API icon or go to https://app.firstresonance.io/graphiql .

GraphiQL Explorer in ion

From the interactive explorer, you can explore the data in your ION workspace, test queries, see the API function documentation, and even update data using the API mutations.

The right column of the GraphiQL Explorer can be used to navigate the ION API

What Query or Mutation do you need?

As you scroll through the API explorer, you will notice that there are hundreds and thousands of API calls to choose from. ION is an API first platform, which is why there is a robust list of queries and mutations to pick from. This is incredibly powerful but can make it difficult to determine how to craft your API call.

Some amount of this you can start to intuitively understand as you play around with ION. For example, loading a run using the Run query, or creating inventory uses the createInventory mutation. Below are a few recommendations on how to help you determine what mutations and queries you need.

Examples

A few example queries are provided in the GraphiQL Explorer to get you started. For additional functionality and API methods, you can navigate the API using the explorer in the right column of the GraphiQL Explorer. In addition, see our Examplesfor more details.

Inspecting the Application

Using the network tab, you can see how ION uses API calls to surface and manipulate the data. If you right click, hit inspect, and navigate to the Network tab, you can click around in ION and see how our engineering team has used queries, mutations, filters, and more and that is perfect place to determine what queries and mutations you may need. Below is an example.

API Glossary

Finally, check out the Full Glossary of ION Permissionsto see even more details.