Factset · Schema

CursorBasedPaginationOutputObject

Pagination attributes for the cursor-based pagination strategy.

FinancialFinancial DataInvestment AnalyticsMarket DataPortfolio AnalyticsResearch

Properties

Name Type Description
total number Total number of entries in the result set.
isEstimatedTotal boolean Flag indicating that the value of `total` is estimated.
next string The next cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination, otherwise `null`.
previous string The previous cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination. If a previous cursor position is not supported or available, `previous`
View JSON Schema on GitHub

JSON Schema

factset-real-time-time-series-cursor-based-pagination-output-object-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CursorBasedPaginationOutputObject",
  "type": "object",
  "description": "Pagination attributes for the cursor-based pagination strategy.",
  "properties": {
    "total": {
      "type": "number",
      "description": "Total number of entries in the result set."
    },
    "isEstimatedTotal": {
      "type": "boolean",
      "description": "Flag indicating that the value of `total` is estimated."
    },
    "next": {
      "type": "string",
      "description": "The next cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination, otherwise `null`."
    },
    "previous": {
      "type": "string",
      "description": "The previous cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination. If a previous cursor position is not supported or available, `previous` is `null`."
    }
  }
}