Insites Docs GraphQL GraphQL Overview

GraphQL Overview

Published on August 15, 2022, updated on September 06, 2023

Insites data is grouped into three main types:

  • User
  • User Profiles
  • Records

Knowing what data type you are handling is critical as it affects how you will build your forms, GraphQL queries, and other considerations.

To interact with the data, Insites uses GraphQL, a query language (not dissimilar to SQL) designed to give clients exactly the data they request, nothing more, nothing less. This allows developers to build APIs that are scalable, flexible, and maintainable. The retrieved information is then made available in Liquid.

Note that due to the way databases are implemented on Insites, you do not have the ability to build your own schemas, nor manage database connections. In addition, you cannot define your own fields apart from the ones that are already available, nor define other database functions. You can build front-end queries and mutations whose functionalities are defined by Insites.

Operations in GraphQL are divided into two main types:

  • GraphQL Queries for retrieving data with options of filtering and sorting.
  • GraphQL Mutations to update your database.

Focus on GraphQL before anything else; it is the key to Insites. This investment will enable you to craft complex queries in GraphQL and send back only the data you need. Later, discover fragment queries, a favourite feature of seasoned Insites developers.

You may also refer to the following resources to help you get started on GraphQL:

Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.