Data Sinks

Overview

Data Sinks allow you to "push" engineering data into Rollup with full visual traceability in cases where Rollup does not have a "Live Integration" or the data is coming from some in-house-built system.

Creating a Data Sink

1. Navigate over to the Data Connections tab in the bottom-left of the navigation sidebar

2. Follow the prompts by clicking "Create new Data Source" and selecting "Data Sink"

3. Be sure to add tags, a name for the data source, and key value pairs for each data sink item.

How to Update Data Sink values

We are upating this endpoint to be able to reference data sinks from the "Human-Readable" id -> see tracking ticket here: https://roadmap.rollup.ai/p/update-data-sinks-via-the-human-readable-id

1. Get a List of Data Sinks

GET api.rollup.ai/v1/workspace/<WORKSPACE_ID>/data-sink/list

This endpoint returns an array of data sinks for a given workspace

Headers

Name	Value
Content-Type	application/json
x-api-key	<API KEY>

Response

200

[
  {
    "id": "a56d69b3-3e96-4175-9fca-bae83f5f8522",
    "workspaceId": "",
    "label": "Local JS instance",
    "description": "This is a local javascript instance.",
    "icon": {
      "name": "javascript",
      "color": "Gold",
      "source": "DevIcon"
    }
    ...
  }
]

400

{
  "error": "Invalid request"
}

2. Update the Data Sink Value

POST /v1/workspace/<WORKSPACE_ID>/data-sink/<SINK_ID>/mass

Updates a data sink given an ID

Headers

Name	Value
Content-Type	application/json
x-api-key	<API KEY>

Body

Name	Type	Description
value	string	Value of the new data sink
key	string	Key of the data sink

Response

200

{
  "id": "...",
  "dataSinkId": "...",
  "key": "mass",
  "value": "15 kg",
  "dataType": "scalar",
  "updatedAt": "...",
  "updatedBy": "...e",
  "createdAt": "...",
  "createdBy": "..."
}

400

{
  "error": "Invalid request"
}