Schemaless Ingestion

Send JSON to Sift over REST without pre-registering an ingestion config

Credentials

Before starting this section be sure to retrieve your API key and the appropriate Sift URL for your provisioned environment. Instructions on how to retrieve the API key and URL and can be found in the authentication section of the documentation.

You can ingest data without pre-registering an ingestion config by sending a JSON payload to the /api/v1/ingest endpoint.

Example

curl -H "Authorization: Bearer $API_KEY" \
    -H "Content-Type: application/json" \
    -X POST "$SIFT_REST_URL/api/v1/ingest" \
    --data-raw '{
      "asset_name": "test_asset_post_data_0001",
      "data": [
        {
          "timestamp": "2024-11-06T10:27:20-07:00",
          "values": [
            {
              "component": "",
              "channel": "numeric_channel",
              "value": 29.18
            },
            {
              "component": "component_1",
              "channel": "boolean_channel",
              "value": true
            },
            {
              "component": "component_1",
              "channel": "string_channel",
              "value": "Example Schemaless String"
            }
          ]
        }
      ]
    }'

Request description

asset_name

The name of data's asset. If the asset does not exist, it will be created. Required.

run_id

The run_id returned from a previous CreateRun call. Optional.

organization_id

The organization id of the organization that owns the asset. Only required if you are a member of multiple organizations. Optional otherwise.

data

The array of data objects to ingest.

data[].timestamp

The timestamp used for every value in the sibling "values" array. Must be in RFC3339 format. Required.

data[].values

The array of values. Every value is assigned the timestamp from the sibling timestamp field.

data[].values[].channel

The name of the channel. Required.

data[].values[].component

The name of the channel's component. Optional.

data[].values[].value

Supported types are string, boolean, and number. Required.

On this page