Skip to main content
GET
Get a time series export by ID

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Path Parameters

exportID
string
required

ID of the export (format tse-<number>)

Response

Time series export descriptor.

exportID
string
required

Export ID (format tse-<number>)

Example:

"tse-123456"

status
enum<string>
required

Lifecycle status of a time series export. running while it is generated, completed once every file is stored, failed when generation was aborted (deadline, error, disconnect), expired once the files were removed after the retention period. pending is reserved for queued exports.

Available options:
pending,
running,
completed,
failed,
expired
createdMs
integer<int64>
required

Unix timestamp in milliseconds elapsed since January 1, 1970, 00:00:00 UTC

Example:

1752738240000

fromDate
string
required

UTC range start without a timezone suffix.

toDate
string
required

Exclusive UTC range end without a timezone suffix.

interval
enum<string>
required

Aggregation interval for the time series

Available options:
hourly,
daily,
monthly
format
enum<string>
required

File format of a time series export

Available options:
csv,
parquet
timeZone
string
required

IANA timezone of the project at export time; the files' timeLocal column renders bucket starts in it.

Example:

"Europe/Berlin"

timeSeries
object[]
required
completedMs
integer<int64>

Unix timestamp in milliseconds elapsed since January 1, 1970, 00:00:00 UTC

Example:

1752738240000

expiresAtMs
integer<int64>

Unix timestamp in milliseconds elapsed since January 1, 1970, 00:00:00 UTC

Example:

1752738240000

sizeBytes
integer<int64>

Total size of all files in bytes

error
string

Failure reason for failed exports