Clients
Review
Endpoints & protobuf definitions
DetectConfig
Copy
Ask AI
curl --request POST \
--url https://your-sift-api-url.com/api/v2/data-imports:detect-config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": "aSDinaTvuI8gbWludGxpZnk=",
"type": "DATA_TYPE_KEY_UNSPECIFIED"
}
'Copy
Ask AI
{
"csvConfig": {
"assetName": "<string>",
"runName": "<string>",
"runId": "<string>",
"firstDataRow": 123,
"timeColumn": {
"columnNumber": 123,
"format": "TIME_FORMAT_UNSPECIFIED",
"relativeStartTime": "2023-11-07T05:31:56Z"
},
"dataColumns": {},
"numRows": "<string>"
},
"parquetConfig": {
"assetName": "<string>",
"runName": "<string>",
"runId": "<string>",
"flatDataset": {
"timeColumn": {
"path": "<string>",
"format": "TIME_FORMAT_UNSPECIFIED",
"relativeStartTime": "2023-11-07T05:31:56Z"
},
"dataColumns": [
{
"path": "<string>",
"channelConfig": {
"name": "<string>",
"units": "<string>",
"description": "<string>",
"dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
"enumTypes": [
{
"name": "<string>",
"key": 123,
"isSigned": true
}
],
"bitFieldElements": [
{
"name": "<string>",
"index": 123,
"bitCount": 123
}
],
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}
]
},
"footerOffset": "<string>",
"footerLength": 123,
"complexTypesImportMode": "PARQUET_COMPLEX_TYPES_IMPORT_MODE_UNSPECIFIED"
}
}DataImportService
DetectConfig
Detects the config for a data import.
POST
/
api
/
v2
/
data-imports:detect-config
DetectConfig
Copy
Ask AI
curl --request POST \
--url https://your-sift-api-url.com/api/v2/data-imports:detect-config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": "aSDinaTvuI8gbWludGxpZnk=",
"type": "DATA_TYPE_KEY_UNSPECIFIED"
}
'Copy
Ask AI
{
"csvConfig": {
"assetName": "<string>",
"runName": "<string>",
"runId": "<string>",
"firstDataRow": 123,
"timeColumn": {
"columnNumber": 123,
"format": "TIME_FORMAT_UNSPECIFIED",
"relativeStartTime": "2023-11-07T05:31:56Z"
},
"dataColumns": {},
"numRows": "<string>"
},
"parquetConfig": {
"assetName": "<string>",
"runName": "<string>",
"runId": "<string>",
"flatDataset": {
"timeColumn": {
"path": "<string>",
"format": "TIME_FORMAT_UNSPECIFIED",
"relativeStartTime": "2023-11-07T05:31:56Z"
},
"dataColumns": [
{
"path": "<string>",
"channelConfig": {
"name": "<string>",
"units": "<string>",
"description": "<string>",
"dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
"enumTypes": [
{
"name": "<string>",
"key": 123,
"isSigned": true
}
],
"bitFieldElements": [
{
"name": "<string>",
"index": 123,
"bitCount": 123
}
],
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}
]
},
"footerOffset": "<string>",
"footerLength": 123,
"complexTypesImportMode": "PARQUET_COMPLEX_TYPES_IMPORT_MODE_UNSPECIFIED"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
A successful response.
Show child attributes
Show child attributes
The id of the run to add this data to. If set, run_name is ignored.
The first row to start reading as data. Can be used to skip header rows. The first row in the file is 1.
Show child attributes
Show child attributes
The column number (1-indexed) of the time column.
Available options:
TIME_FORMAT_UNSPECIFIED, TIME_FORMAT_RELATIVE_NANOSECONDS, TIME_FORMAT_RELATIVE_MICROSECONDS, TIME_FORMAT_RELATIVE_MILLISECONDS, TIME_FORMAT_RELATIVE_SECONDS, TIME_FORMAT_RELATIVE_MINUTES, TIME_FORMAT_RELATIVE_HOURS, TIME_FORMAT_ABSOLUTE_RFC3339, TIME_FORMAT_ABSOLUTE_DATETIME, TIME_FORMAT_ABSOLUTE_UNIX_SECONDS, TIME_FORMAT_ABSOLUTE_UNIX_MILLISECONDS, TIME_FORMAT_ABSOLUTE_UNIX_MICROSECONDS, TIME_FORMAT_ABSOLUTE_UNIX_NANOSECONDS A map from column number (1-indexed) to the channel configuration for that column.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
CHANNEL_DATA_TYPE_UNSPECIFIED, CHANNEL_DATA_TYPE_DOUBLE, CHANNEL_DATA_TYPE_STRING, CHANNEL_DATA_TYPE_ENUM, CHANNEL_DATA_TYPE_BIT_FIELD, CHANNEL_DATA_TYPE_BOOL, CHANNEL_DATA_TYPE_FLOAT, CHANNEL_DATA_TYPE_INT_32, CHANNEL_DATA_TYPE_UINT_32, CHANNEL_DATA_TYPE_INT_64, CHANNEL_DATA_TYPE_UINT_64, CHANNEL_DATA_TYPE_BYTES Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
csvConfig.dataColumns.{key}.metadata.key.type
enum<string>
default:METADATA_KEY_TYPE_UNSPECIFIED
required
Metadata key type.
- METADATA_KEY_TYPE_STRING: string
- METADATA_KEY_TYPE_NUMBER: number
- METADATA_KEY_TYPE_BOOLEAN: boolean
Available options:
METADATA_KEY_TYPE_UNSPECIFIED, METADATA_KEY_TYPE_STRING, METADATA_KEY_TYPE_NUMBER, METADATA_KEY_TYPE_BOOLEAN This will be read on upload from the file if not set.
Show child attributes
Show child attributes
The id of the run to add this data to. If set, run_name is ignored.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
TIME_FORMAT_UNSPECIFIED, TIME_FORMAT_RELATIVE_NANOSECONDS, TIME_FORMAT_RELATIVE_MICROSECONDS, TIME_FORMAT_RELATIVE_MILLISECONDS, TIME_FORMAT_RELATIVE_SECONDS, TIME_FORMAT_RELATIVE_MINUTES, TIME_FORMAT_RELATIVE_HOURS, TIME_FORMAT_ABSOLUTE_RFC3339, TIME_FORMAT_ABSOLUTE_DATETIME, TIME_FORMAT_ABSOLUTE_UNIX_SECONDS, TIME_FORMAT_ABSOLUTE_UNIX_MILLISECONDS, TIME_FORMAT_ABSOLUTE_UNIX_MICROSECONDS, TIME_FORMAT_ABSOLUTE_UNIX_NANOSECONDS Show child attributes
Show child attributes
Show child attributes
Show child attributes
parquetConfig.flatDataset.dataColumns.channelConfig.dataType
enum<string>
default:CHANNEL_DATA_TYPE_UNSPECIFIED
Available options:
CHANNEL_DATA_TYPE_UNSPECIFIED, CHANNEL_DATA_TYPE_DOUBLE, CHANNEL_DATA_TYPE_STRING, CHANNEL_DATA_TYPE_ENUM, CHANNEL_DATA_TYPE_BIT_FIELD, CHANNEL_DATA_TYPE_BOOL, CHANNEL_DATA_TYPE_FLOAT, CHANNEL_DATA_TYPE_INT_32, CHANNEL_DATA_TYPE_UINT_32, CHANNEL_DATA_TYPE_INT_64, CHANNEL_DATA_TYPE_UINT_64, CHANNEL_DATA_TYPE_BYTES Show child attributes
Show child attributes
The index of this element's first bit in the logical bit field array.
parquetConfig.flatDataset.dataColumns.channelConfig.bitFieldElements.bitCount
integer<int64>
required
Show child attributes
Show child attributes
Show child attributes
Show child attributes
parquetConfig.flatDataset.dataColumns.channelConfig.metadata.key.type
enum<string>
default:METADATA_KEY_TYPE_UNSPECIFIED
required
Metadata key type.
- METADATA_KEY_TYPE_STRING: string
- METADATA_KEY_TYPE_NUMBER: number
- METADATA_KEY_TYPE_BOOLEAN: boolean
Available options:
METADATA_KEY_TYPE_UNSPECIFIED, METADATA_KEY_TYPE_STRING, METADATA_KEY_TYPE_NUMBER, METADATA_KEY_TYPE_BOOLEAN parquetConfig.complexTypesImportMode
enum<string>
default:PARQUET_COMPLEX_TYPES_IMPORT_MODE_UNSPECIFIED
- PARQUET_COMPLEX_TYPES_IMPORT_MODE_IGNORE: Ignore complex types and do not ingest them.
- PARQUET_COMPLEX_TYPES_IMPORT_MODE_BOTH: Import complex types as both Arrow bytes and JSON strings.
- PARQUET_COMPLEX_TYPES_IMPORT_MODE_STRING: Import complex types as only JSON strings.
- PARQUET_COMPLEX_TYPES_IMPORT_MODE_BYTES: Import complex types as only Arrow bytes.
Available options:
PARQUET_COMPLEX_TYPES_IMPORT_MODE_UNSPECIFIED, PARQUET_COMPLEX_TYPES_IMPORT_MODE_IGNORE, PARQUET_COMPLEX_TYPES_IMPORT_MODE_BOTH, PARQUET_COMPLEX_TYPES_IMPORT_MODE_STRING, PARQUET_COMPLEX_TYPES_IMPORT_MODE_BYTES Was this page helpful?