GraphQL API for Telematics Guru
A more flexible way to integrate telematics guru into your application
Table of Contents
What is GraphQL?
If you’re used to REST APIs, think of GraphQL as a more flexible way for apps to ask for information. With REST, you often have many different endpoints, and each one gives you a fixed set of data - sometimes more than you need, sometimes not enough. GraphQL changes this by giving you one endpoint where the client can simply ask for the exact pieces of data it wants, nothing extra. One way of describing it is like having a safe way to query the Telematics Guru database directly.
Why Would I Use the GraphQL Endpoint?
-
Filtering - Our existing REST endpoints return complete records even when you only need a small subset. With GraphQL, you can ask for exactly the assets that match your criteria. For example, only assets in department X or those with fewer than Y kilometres on the odometer.
-
Response Size - GraphQL lets you select the exact fields you want returned in the response, whereas our REST APIs give you a standard set of fields. Think of it as the difference between visiting a buffet on your own and selecting only your favourite foods versus having your grandmother fill the plate with every single item the buffet because she loves you.
-
Frequency - GraphQL is not rate-limited by number of calls alone like a traditional endpoint. Instead, limits are based on how complex your query is. Simple queries cost less, so you can check in with the server more often without hitting a limit.
-
Simpler Integrations - With REST, gathering all of the information you need might means making multiple calls (one for the asset, another for its latest telemetry, another for its status, etc). GraphQL allows you to bundle all these into a single request. This reduces complexity in your code and makes integrations cleaner and easier to maintain.
- Future-Proofing - As our platform evolves, GraphQL makes it easier to add new fields or relationships without breaking existing integrations. Clients only ask for what they need, so changes to the API are less disruptive. This means fewer surprises and smoother upgrades over time.
Documentation
To view documentation, first find your instance and then insert it into the url below:
https://api-<yourinstance>.telematics.guru/graphql/This will take you to our hosted “Chilli Cream” GraphQL site, where you can actively experiment with GraphQL.