Exploring the platform¶
Obelisk bundles an Explorer Web application that gives each user a personalized view on the platform. Features of the Explorer include:
- List accessible Scopes and their respective Things and Metrics metadata
- Display graphs or geographical views of selectable data time ranges
- Open streams for specific data sources to view incoming events in real-time
- Gain insight in the spreading of the values and how long its been since the last retrieved records
The Swagger UI application has a double purpose. First and foremost it acts as the complete documentation for all available versions of the Obelisk HTTP API. All methods are described, arguments explained, output formats shown, etc...
However it also acts as an online HTTP client where you can immediately Try out the APIs you have access to. (after you logged in).
This makes it an invaluable tool for developers as it reduces a lot of overhead (figuring out the parameters, copying Auth Tokens, ...) compared to e.g. trying out the API with Postman.
With the release of v2.0, Obelisk also offers a GraphQL interface as an alternative to the traditional HTTP API. GraphQL enables an expressive, self-describing Query Language on top of Obelisk and can be tried out in the browser using GraphiQL (after logging in).
Obelisk has been evolving rapidly and there might be some confusion regarding the various versions, APIs and additional interfaces that can be used for integrating with the system. Visit the Release Overview page for more information on this subject.