Skip to main content

API reference

The Fyma API aims to be as RESTful as possible, meaning it:

  • Consumes and produces JSON.
  • Uses predictable URLs, such as /insights, /insights/live, etc.

In example snippets we use the httpie CLI:



Our API reference follows TypeScript conventions:

  • Primitive types refer to TypeScript types (e.g., number, boolean, string etc).
  • Optional properties are denoted with a ?.