Time syntax use cases by service

This section shows how each CONNECT service uses time syntax to accomplish specific tasks. Each subsection includes practical examples and REST API calls that demonstrate the patterns and parameters you'll use when working with that service. Choose the service that matches your use case to see detailed examples and implementation guidance.

Stream Store (SDS)

Use time syntax to retrieve data from streams using window, range, and interpolation query patterns.

Example 1: retrieve data for a time window

Use this example to retrieve all events within a specific time range.

Friendly example

startIndex: 2024-01-01T00:00:00Z

endIndex: 2024-12-31T23:59:59Z

Request path

GET /api/account/{accountId}/sds/{instanceId}/v2/Streams/{streamId}/Data/Window?startIndex=2024-01-01T00:00:00Z&endIndex=2024-12-31T23:59:59Z

Example 2: retrieve evenly spaced points

Use this example to retrieve data points every 15 minutes for one day.

Friendly example

startIndex: 2024-12-31T00:00:00Z

endIndex: 2025-01-01T00:00:00Z

Count: 96 data points (24 hours × 60 minutes ÷ 15 minutes)

Request path

GET /api/account/{accountId}/sds/{instanceId}/v2/Streams/{streamId}/Data/Interpolated/Interval?startIndex=2024-12-31T00:00:00Z&endIndex=2025-01-01T00:00:00Z&count=96

Index types vary by stream type

Different streams may use different index types. Before constructing your query, confirm whether your stream uses datetime or numeric indexes.

• Datetime-indexed streams: ISO 8601 format timestamps

• Numeric-indexed streams: Numeric values

Data View Management

Use time syntax to query data from your data views by specifying time boundaries and intervals.

Use this example to retrieve interpolated data view data from the past 24 hours.

Parameter formats

This request uses two different time formats:

• startIndex and endIndex: ISO 8601 datetime format (for example, 2024-12-31T00:00:00Z)

• interval: .NET TimeSpan format (for example, 01:00:00 for one hour, 1.00:00:00 for one day)

Friendly example

startIndex: [current time minus 1 day]

endIndex: [current time]

interval: 01:00:00 (hourly data points)

Example values

• startIndex: 2024-12-31T00:00:00Z

• endIndex: 2025-01-01T00:00:00Z

• interval: 01:00:00

Request path

GET /api/account/{accountId}/dataViewMgmt/{instanceId}/v2-preview/dataViews/{id}/data/interpolated?startIndex=2024-12-31T00:00:00Z&endIndex=2025-01-01T00:00:00Z&interval=01:00:00

Use the data/stored endpoint when you need stored rows instead of interpolated values. Stored retrieval uses startIndex and endIndex, but it does not use an interval parameter.

Virtual Table Management

Use time syntax when filtering materialization job history by time range and duration.

Use this example to retrieve all materialization jobs that ran during January 2024 and lasted more than one hour.

Parameter formats

This request uses two different time formats:

• startTime and endTime: ISO 8601 datetime format (for example, 2024-01-01T00:00:00Z)

• duration: ISO 8601 duration with a comparison operator (for example, PT1H GT for jobs longer than one hour)

Friendly example

startTime: 2024-01-01T00:00:00Z

endTime: 2024-01-31T23:59:59Z

duration: PT1H GT (jobs longer than one hour)

Request path

GET /api/account/{accountId}/virtualtablemgmt/{instanceId}/v1/virtualtablejobs?startTime=2024-01-01T00:00:00Z&endTime=2024-01-31T23:59:59Z&duration=PT1H GT

Event Management

Use time syntax to create events with explicit start and end boundaries and to query events within a time window.

Example 1: create an event with start and end time

Use this example to create a closed event with explicit start and end timestamps.

Parameter formats

• startTime and endTime: ISO 8601 datetime format in the request body.

Friendly example

id: wind-turbine-maintenance-001

startTime: 2025-05-08T08:00:00Z

endTime: 2025-05-08T16:00:00Z

Request path

POST /api/account/{accountId}/eventMgmt/{instanceId}/v1/events

Request body

{

"id": "wind-turbine-maintenance-001",

"startTime": "2025-05-08T08:00:00Z",

"endTime": "2025-05-08T16:00:00Z"

}

Example 2: query events in a time window

Use this example to return events that start within a specific UTC time window.

Parameter formats

• startsAfter and startsBefore: ISO 8601 datetime format in query parameters.

Friendly example

startsAfter: 2025-05-01T00:00:00Z

startsBefore: 2025-05-31T23:59:59Z

Request path

GET /api/account/{accountId}/eventMgmt/{instanceId}/v1/events?startsAfter=2025-05-01T00:00:00Z&startsBefore=2025-05-31T23:59:59Z