Factset · Schema

paginationOne

List of pagination objects

FinancialFinancial DataInvestment AnalyticsMarket DataPortfolio AnalyticsResearch

Properties

Name Type Description
total integer Total number of files the API returns for a particular query
isEstimatedTotal boolean Boolean value that represents whether the total count of files returned is exact or an estimate. This is defaulted to False as the API should always return the exact count
limit integer Number of results returned per page
offset integer The flag indicating the position in the results array if additional results are available beyond the default value or the value in paginationLimit parameter (if used). This value is passed in the _pag
View JSON Schema on GitHub

JSON Schema

factset-streetaccount-news-pagination-one-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "paginationOne",
  "type": "object",
  "description": "List of pagination objects",
  "properties": {
    "total": {
      "type": "integer",
      "description": "Total number of files the API returns for a particular query"
    },
    "isEstimatedTotal": {
      "type": "boolean",
      "description": "Boolean value that represents whether the total count of files returned is exact or an estimate. This is defaulted to False as the API should always return the exact count"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results returned per page"
    },
    "offset": {
      "type": "integer",
      "description": "The flag indicating the position in the results array if additional results are available beyond the default value or the value in paginationLimit parameter (if used). This value is passed in the _paginationOffset parameter to retreieve subsequent results"
    }
  }
}