Index query formats
- Last UpdatedApr 16, 2026
- 2 minute read
Use these formats when specifying index values in stream and data view query parameters.
Index format (single-field indexes)
Use index format when querying stream data and data views. For datetime-indexed streams and time-indexed data views, provide ISO 8601-compatible timestamps. For numeric-indexed streams and data views, provide numeric index values. Data View Management also supports some other single-field index types, depending on whether you are retrieving interpolated or stored data.
Applies to services
|
Service |
Applies |
Notes |
|---|---|---|
|
Stream Store (SDS) |
Yes |
Core index model for stream reads on datetime-indexed streams. |
|
Data View Management |
Yes |
Data view queries use a single index value whose type must match the data view's configured index type. |
|
Virtual Table Management |
No |
Virtual table endpoints use time-bound parameters rather than stream index parameters. |
|
Event Management |
No |
Event endpoints use explicit datetime fields such as startTime and endTime rather than stream index parameters. |
Format
startIndex=<ISO 8601 datetime> and endIndex=<ISO 8601 datetime>
For datetime-indexed streams and time-indexed data views, startIndex and endIndex use ISO 8601-compatible datetime values.
For datetime indexes, the timestamp itself acts as the index:
-
2024-01-15T00:00:00Z: Index pointing to specific datetime
-
Numeric indexes also supported (see below)
For numeric indexes (for example, elapsed time in milliseconds), use simple numeric values:
-
1000: Numeric index value
-
50000: Another numeric index point
For other single-field stored-data indexes in Data View Management, use values that match the configured index type. Supported stored-data-only examples include Guid, Boolean, String, and Char index values.
Compound indexes
Use compound index format when your stream has multiple index fields. A compound index combines two or more individual index values into a single index reference. Each field value is separated by a pipe character (|).
Applies to services
|
Service |
Applies |
Notes |
|---|---|---|
|
Stream Store (SDS) |
Yes |
Compound indexes are fully supported for streams with multiple key properties. |
|
Data View Management |
No |
Data views require a single eligible index field. Compound indexes are not supported for data view retrieval. |
|
Virtual Table Management |
No |
Virtual table endpoints use time-bound parameters rather than stream index parameters. |
|
Event Management |
No |
Event endpoints use explicit datetime fields rather than stream index parameters. Compound indexes are not applicable. |
Format
value1|value2|value3
The format depends on the data types of each index field. Combine all index field values in order, separated by pipe characters. Each field value uses the appropriate format for its type (ISO 8601 for datetime fields, numeric for numeric fields, strings for string fields).
Common patterns
Compounds indexes typically combine datetime with numeric or string fields, but any combination of supported types is valid:
-
Datetime + numeric: 2024-01-15T00:00:00Z|42
-
Datetime + datetime: 2024-01-15T00:00:00Z|2024-01-16T00:00:00Z
-
Numeric + numeric: 100|200
-
String + datetime: DeviceA|2024-01-15T00:00:00Z
-
Three fields: 2024-01-15T00:00:00Z|1|LocationX
Examples
These examples show compound indexes with different field combinations:
-
2024-01-15T12:30:00Z|SensorId_001: Timestamp with sensor identifier
-
2024-01-15T12:30:00Z|5|Building_A: Timestamp, level, and location
-
1000|50000: Two numeric values for non-temporal streams
-
Device_01|2024-06-20T10:15:00Z: Device identifier with timestamp
Usage in API request
When using compound indexes in API requests, pass the entire compound index value as a single parameter:
GET /api/account/{accountId}/sds/{instanceId}/v2/Streams/{streamId}/Data/Window?startIndex=2024-01-15T00:00:00Z|sensor1&endIndex=2024-01-15T23:59:59Z|sensor1