Engine

Covers Engine 2.0.0

rapid/dataframes/list

Lists managed test dataframes. Pages are ordered by start time, then ID. Overview mode covers the full requested range without returning full frame records.

  • Category: Channels and Persistence

Request payload

FieldTypeRequirementDescription
modestringOptionalUse overview for complete range presence; omit for metadata pages or the legacy full list.
from_nsintegerOptionalInclude frames overlapping this UTC nanosecond lower bound; omit for all history.
to_nsintegerOptionalInclude frames overlapping this UTC nanosecond upper bound; omit for all history.
offsetintegerOptionalZero-based page offset; supplying any paging or range argument enables paging.
seek_nsintegerOptionalWhen offset is omitted, center the first page near this UTC nanosecond time.
limitintegerOptionalPage size from 1 to 200; defaults to 100 when paging is enabled.
querystringOptionalCase-insensitive dataframe name or explicitly selected channel filter for paged results.
bucket_countintegerOptionalOverview fallback resolution from 1 to 1000; defaults to 500.
detail_limitintegerOptionalMaximum overview entries with individual IDs and names from 1 to 2000; defaults to 1000.

Response payload

FieldTypeDescription
framesarray<object>Full frame records for pages, or compact ID/name/time summaries in overview mode up to detail_limit; empty for bucket fallback.
bucketsarray<object>Overview occupancy intervals with from_ns, to_ns and count when the match count exceeds detail_limit.
from_nsintegerRequested overview start in UTC nanoseconds.
to_nsintegerRequested overview end in UTC nanoseconds.
totalintegerMatching frame count for a paged request.
offsetintegerFirst returned frame’s index among matches.
has_previousbooleanWhether an earlier page exists.
has_morebooleanWhether the paged result has another page.
next_offsetintegerOffset for the next page.
complete_from_nsintegerLower display boundary for this page’s loaded-time indicator.
complete_through_nsintegerUpper display boundary before the next page’s first start, or the requested end; this is a display hint, not proof that earlier overlapping frames were loaded.