API ReferenceNominal Channel Writer

Write Nominal Batches

Synchronously writes a Nominal Write Request to a Nominal data source using the NominalWrite Protobuf schema. The request must be Protobuf-encoded and accompanied by the appropriate content encoding headers if compressed.

The request should follow this Protobuf schema:

1message WriteRequestNominal {
2  repeated Series series = 1;
3}
4
5message Series {
6  Channel channel = 1;            
7  map<string, string> tags = 2;   // Key-value pairs for series tags
8  Points points = 3;              // Contains either double or string points
9}
10
11message Channel {
12  string name = 1;
13} 
14
15message Points {
16  oneof points_type {
17    DoublePoints double_points = 1;
18    StringPoints string_points = 2;
19  }
20}
21
22message DoublePoints {
23  repeated DoublePoint points = 1;
24}
25
26message StringPoints {
27  repeated StringPoint points = 1;
28}
29
30message DoublePoint {
31  google.protobuf.Timestamp timestamp = 1;
32  double value = 2;
33}
34
35message StringPoint {
36  google.protobuf.Timestamp timestamp = 1;
37  string value = 2;
38}

Each request can contain multiple series, where each series consists of:

  • A channel name
  • A map of tags (key-value pairs)
  • A collection of points, which can be either double or string values
  • Each point includes a timestamp (using google.protobuf.Timestamp) and its value

The endpoint requires the Content-Type header to be set to “application/x-protobuf”. If the payload is compressed, the appropriate Content-Encoding header must be included.

Path parameters

dataSourceRidstringRequired

Unique resource identifier for a NominalDataSource. Though named similarly to a DataSourceRid, a NominalDataSourceRid specifically refers To a NominalDataSource, which is a nominal hosted database for streaming writes.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects binary data.