Document Control
Scope
This document explains how to use Beeks Analytics REST API documentation and provides some useful examples of tasks that are commonly performed via the Beeks Analytics REST API. The examples are high-level; we summarize which requests to use in each example, but refer you to the API Guide for the calls. If you would like other examples added to this guide, please send details to documentation@beeksgroup.com.
The document is intended to help developers understand how to use the API.
For an overview of Beeks Analytics, please see the Beeks Analytics Concept Guide.
Audience
The intended audience for this document is a technical user who is responsible for building an integration via Beeks Analytics REST API.
Styling Conventions used in this Document
Key concepts are indicated using this formatting.
Further reading or asides are indicated using this formatting. Skip over these if you are pressed for time.
Feedback
We welcome feedback on our documentation. Please report suggestions, omissions and errors to documentation@beeksgroup.com
Related documents
Document name | Beeks document reference | Description |
|---|---|---|
BKDA001 | An overview of Beeks Analytics. | |
BKDA004 | A user guide for the VMX Explorer Grafana tool that provides visualisations of the results of API queries. This is useful as it provides worked examples of further manipulating the data within Beeks Analytics to provide powerful insights. |
Documents that do not have hyperlinks can be obtained by contacting your Beeks account representative.