GraphQL

Akumen includes a set of GraphQL endpoints for some of the APIs. GraphQL is a query language for APIs which allows you, the user, to request only the information that you need.

For more information on GraphQL, visit: https://graphql.org/.

To access the GraphQL Sandbox and test queries:

  • Click on the Settings cog at the top-right of the screen.
  • Go to Help -> GraphQL Sandbox as shown in the screenshot below.

GraphQL Settings Access GraphQL Settings Access

This link will take you to an external page that documents all of the available queries, and provides an application in which to test them.

Note: All of the APIs adhere to standard Akumen security policies and will require authentication in the form of a JSON Web Token (JWT) or Authorisation Token Header.

Depending on your usage, GraphQL queries can be sent as a POST request with the body containing the query:

URL: https://production.akumen-cloud.com/graphql 

Body: {"query":"{models { name type }}"}

Or, as a GET request with the query as a parameter:

URL: http://production.akumen-cloud.com/graphql?query={models{name,type}}