Interface RestRequestPagination

Base Type

This is generally not meant to be used directly by SDK users, they are used to augment interfaces with common parameters & documentation.

Any combination of start, end, limit are valid, but certain values take precedence over others. For example,

  • if start and end ARE specified and NOT limit:
    • the response will include objects starting at start and ending either at end or the maximum limit of 1,000 objects.
  • If end is specified alone:
    • returns 50 objects closest to, but EARLIER (older) than end.
  • Specifying NONE of the pagination parameters returns the 50 most recent objects.

Response data is returned in ascending time order, with oldest objects first and newest objects last.

See

related RestRequestPaginationWithFromId

interface RestRequestPagination {
    start?: number;
    end?: number;
    limit?: number;
}

Hierarchy (view full)

Properties

start? end? limit?

Properties

Optional start

start?: number

If provided, indicates the earliest (oldest) timestamp of an object to include in the response.

  • This value is inclusive, meaning objects with timestamps that exactly match start are included in the response.
  • start MUST be earlier than end if provided.

Optional end

end?: number

If provided, indicates the latest (newest) timestamp of an object to include the response.

  • This value is inclusive, meaning objects with timestamps that exactly match end are included in the response.
  • end MUST be a later timestamp than start.

Optional limit

limit?: number

Maximum number to return of the requested type.

Settings

Member Visibility

Theme

On This Page

startendlimit