Overview

Overview of a few of the key concepts in Clarify which is useful when working with the API.

Overview of integrations, signals & items.Overview of integrations, signals & items.

Overview of integrations, signals & items.

Before you can start using the API you'll need to create an Integration (requires admin access to your organization).

Integration

An integration is a container for one or many signals. It also holds the client credentials which you need to download and use to obtain an access token.

Example
You have a Raspberry Pi connected to a few temperature sensors which collectively have data you want to send to Clarify. You name the integration e.g. My RPi Sensors.

Signal

A signal holds timeseries data and metadata related to this data.

Example
You have a temperature and humidity sensor connected to your Raspberry Pi and would like to visualize timeseries data from the temperature readings.
You create a signal in Clarify in the My RPi Sensors integration with the sensor data and name it e.g. RPi Temperature #1.

Check out Writing data to Clarify for more information about how to create or update signals and add data.

Item

An item contains metadata and points to a signal as its source. Items can be added to timelines to visualize the actual data.

Example
You'd like to create a timeline with data from the RPi Temperature #1 signal in the My RPi Sensors integration. You find the signal in Clarify and publish it, which automatically creates an Item you can add to timelines. You update metadata of the Item with the engineering unit °C.

In the screenshot below you can see how the timeseries data might look in Clarify.

A timeline in Clarify with Items and timeseries data.A timeline in Clarify with Items and timeseries data.

A timeline in Clarify with Items and timeseries data.


What’s Next

Create an integration and download client credentials.

Did this page help you?