Services
RPC methods exposed by this API.ExportService
| Method | Request | Response | Description |
|---|---|---|---|
| ExportData | ExportDataRequest | ExportDataResponse | |
| GetDownloadUrl | GetDownloadUrlRequest | GetDownloadUrlResponse |
Messages
Data models used across requests/responses.AssetsAndTimeRange
| Field | Type | Label | Description |
|---|---|---|---|
| asset_ids | string | repeated | |
| start_time | google.protobuf.Timestamp | ||
| stop_time | google.protobuf.Timestamp |
CalculatedChannelConfig
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| expression | string | ||
| channel_references | sift.calculated_channels.v2.CalculatedChannelAbstractChannelReference | repeated | |
| units | string | optional |
ExportDataRequest
| Field | Type | Label | Description |
|---|---|---|---|
| oneof time_selection. time_range | TimeRange | If time_range used, channel_ids or calculated_chanel_configs must be provided to scope data. | |
| oneof time_selection. runs_and_time_range | RunsAndTimeRange | Runs used to perform time selection and scope data. Times can optionally be provided to further scope within runs. If channel_ids or calculated_channel_configs not provided, all channels from Run Assets are added to scope. | |
| oneof time_selection. assets_and_time_range | AssetsAndTimeRange | Assets and times provided to scope data. If channel_ids or calculated_channel_configs not provided, all channels from Assets are added to scope. | |
| channel_ids | string | repeated | |
| calculated_channel_configs | CalculatedChannelConfig | repeated | |
| output_format | ExportOutputFormat | ||
| export_options | ExportOptions |
ExportDataResponse
| Field | Type | Label | Description |
|---|---|---|---|
| presigned_url | string | Pre-signed URL of exported zip containing export files. This will be blank if the job is processed as a background job, in which case job_id will be non-empty. | |
| job_id | string | This will be non-empty if the export is being processed asynchronously in a background job. | |
| service_message | string | Optional message for the client to display in success or error notification (e.g. exclusions or 403 reason). |
ExportOptions
| Field | Type | Label | Description |
|---|---|---|---|
| use_legacy_format | bool | Whether to use legacy format string for channel headers which contains key-value metadata. | |
| simplify_channel_names | bool | Whether to simplify channel names by removing the component part of the name if name is unique in export file | |
| combine_runs | bool | Whether to combine runs. e.g. channels from the same asset in different runs will be combined into a single column of data. | |
| split_export_by_asset | bool | Split each asset into their own export file | |
| split_export_by_run | bool | Split each run into their own export file |
GetDownloadUrlRequest
| Field | Type | Label | Description |
|---|---|---|---|
| job_id | string |
GetDownloadUrlResponse
| Field | Type | Label | Description |
|---|---|---|---|
| presigned_url | string | ||
| service_message | string | Optional message for the client to display in success or error notification. |
RunsAndTimeRange
| Field | Type | Label | Description |
|---|---|---|---|
| run_ids | string | repeated | |
| start_time | google.protobuf.Timestamp | ||
| stop_time | google.protobuf.Timestamp |
TimeRange
| Field | Type | Label | Description |
|---|---|---|---|
| start_time | google.protobuf.Timestamp | ||
| stop_time | google.protobuf.Timestamp |
Enums
Allowed constant values used in message fields.ExportOutputFormat
| Name | Number | Description |
|---|---|---|
| EXPORT_OUTPUT_FORMAT_UNSPECIFIED | 0 | |
| EXPORT_OUTPUT_FORMAT_CSV | 1 | |
| EXPORT_OUTPUT_FORMAT_SUN | 2 | |
| EXPORT_OUTPUT_FORMAT_PARQUET | 3 |