Skip to main content
Version: 1.0


This call inserts data for one or more signals. Each signal is uniquely identified by its input ID in combination with the integration ID. If no signal with the given combination exists, an empty signal is created.

An integration can only interact with it's own signals using this call.


# BASIC_AUTH_USERNAME=<Username from Basic Auth credentials>
# BASIC_AUTH_PASSWORD=<Password from Basic Auth credentials>
--request POST \
--url \
--header 'Content-Type: application/json' \
--header 'X-API-Version: 1.0' \
--data \
"jsonrpc" : "2.0",
"method": "integration.Insert",
"id": "1",
"params": {
"integration": "'${INTEGRATION_ID}'",
"times" : ["2021-03-11T21:00:00Z", "2021-03-11T22:00:00Z"],
"series": {
"a": [1.0, 1.2],
"b": [2.0, null]

Method parameters

integrationIntegration IDYesThe ID if the integration to save signal information for.
dataData frameYesThe data to insert accompanied by timestamps.

Result properties

signalsByInputmap of Input ID => Create summarySave operation summary per input.

Rates and limits

API limitations:

  • The API is rate-limited to 1 request/sec.
  • The JSON encoded size of the request MUST not be more than 8MiB.

Data limitations:

  • Signals SHOULD not have an average same rate of more than 1 sample/min.
  • Signals SHOULD not have a burst sample rate of more than 1 sample/sec.
  • Clarify CAN NOT show timestamps with more than one millisecond resolution (ms).
  • Clarify CAN NOT store timestamps with more than microsecond (µs).

Be aware that you are charged per signal you store in Clarify. If you have many signals, be sure to adjust your plan in Clarify.

Schema references

Create summary

type: object


"id": "c9137visahsjsdhrim6g",
"created": true


idstringUnique ID of the saved resource entry.
createdbooleanTrue if a new instance was created.

Integration ID

Integration ID unqily identies a integration resourc entry.

type: string(regex: "^[a-v0-9]{20}$")

Data frame

Data Frame holds data for one or more time-series.

type: object


"times": [
"series": {
"banana-stand-icecream-temperature": [-10.0, 10.0, 20, 55.3, 231, 34],
"banana-stand-cache-reserve": [10000000, null, null, null, null, 0]


timesarray of TimestampYesArray of timestamps to insert.
seriesmap of Input ID => array of (number or null)YesArray of data points to insert by Input ID. The length of each array must match that of the times array. To omit a value for a given timestamp in times, use the value null.


type: string OR number(integer)

Timestamp must either be a RFC 3339 date-time string or an integer containing a UNIX timestamp. A UNIX timestamp is defined as the number of seconds that has elapsed since the "epoch" (1970-01-01T00:00:00:00Z).

When using an RFC 3339 date-time string, Clarify can store a maximum resolution of one microsecond (µs).

Input ID

Input ID routes data to a signal during insert. The input ID must be unique per integration only.

type: string(regex: ^[a-zA-Z0-9-_:.#+/]{1,128}$)