bankgraph.app

{
  "type": "object",
  "properties": {
    "blockId": {
      "type": "string",
      "maxLength": 64,
      "description": "Existing block ID from read_research_board; consult its configurationAffordances entry before choosing fields.",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,63}$"
    },
    "title": {
      "type": "string",
      "maxLength": 160,
      "description": "Visible, natural-language view title."
    },
    "width": {
      "type": "string",
      "maxLength": 13,
      "enum": [
        "auto",
        "quarter",
        "half",
        "three_quarter",
        "full"
      ],
      "description": "Valid for every view."
    },
    "height": {
      "type": "string",
      "maxLength": 8,
      "enum": [
        "standard",
        "tall"
      ],
      "description": "Valid for every view."
    },
    "role": {
      "type": "string",
      "maxLength": 13,
      "enum": [
        "auto",
        "lead",
        "support",
        "contrast",
        "reference",
        "multiples",
        "context",
        "investigation"
      ],
      "description": "Valid for every view."
    },
    "focus": {
      "type": "boolean",
      "description": "Use true to focus this view. Use false to clear focus when this view is focused."
    },
    "presentation": {
      "type": "string",
      "maxLength": 9,
      "enum": [
        "auto",
        "primary",
        "multiples"
      ],
      "description": "Source-bound history views only; chooses one primary measure or small multiples."
    },
    "followWorkspace": {
      "type": "boolean",
      "description": "Compatibility shorthand for all anchors. true reconnects banks, measures, and periods and cannot be combined with fixed values; false fixes all three at their current effective values and may include replacement values."
    },
    "bankSource": {
      "type": "string",
      "maxLength": 9,
      "enum": [
        "workspace",
        "fixed"
      ],
      "description": "workspace applies current and future workspace banks to this view; fixed keeps its current effective banks unless certs is also supplied."
    },
    "metricSource": {
      "type": "string",
      "maxLength": 9,
      "enum": [
        "workspace",
        "fixed"
      ],
      "description": "workspace follows workspace measures; fixed keeps the current effective measures unless metrics is also supplied."
    },
    "periodSource": {
      "type": "string",
      "maxLength": 9,
      "enum": [
        "workspace",
        "fixed"
      ],
      "description": "workspace follows workspace periods; fixed keeps current effective periods unless date fields are also supplied."
    },
    "certs": {
      "type": "array",
      "items": {
        "type": "integer",
        "minimum": 1,
        "maximum": 99999999
      },
      "maxItems": 25,
      "description": "Fix only the bank anchor for a data-bearing view. Do not send with bankSource=workspace."
    },
    "metrics": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 10,
        "enum": [
          "asset",
          "lnlsnet",
          "eq",
          "roa",
          "roe",
          "nimy",
          "eeffr",
          "netinc",
          "dep",
          "loanGrowth",
          "lnlsdepr",
          "othbfhlb",
          "nclnlsr",
          "nco_ratio",
          "lnatresr",
          "rbc1rwaj",
          "rbcrwaj",
          "rbc1aaj",
          "eqv",
          "numemp",
          "offdom"
        ]
      },
      "maxItems": 6,
      "description": "Fix only the measure anchor for a data-bearing view. Do not send with metricSource=workspace."
    },
    "asOf": {
      "type": "string",
      "maxLength": 8,
      "description": "Fix the point-in-time reporting period without changing bank or measure sources. Do not send with periodSource=workspace."
    },
    "compareWith": {
      "type": "string",
      "maxLength": 8,
      "description": "Fix the comparison period without changing bank or measure sources. Do not send with periodSource=workspace."
    },
    "historyFrom": {
      "type": "string",
      "maxLength": 8,
      "description": "Source-bound history views only."
    },
    "historyTo": {
      "type": "string",
      "maxLength": 8,
      "description": "Source-bound history views only."
    },
    "chartKind": {
      "type": "string",
      "maxLength": 4,
      "enum": [
        "line",
        "area"
      ],
      "description": "Source-bound history views only."
    },
    "scale": {
      "type": "string",
      "maxLength": 5,
      "enum": [
        "value",
        "index"
      ],
      "description": "Source-bound history views only."
    },
    "view": {
      "type": "string",
      "maxLength": 19,
      "enum": [
        "summary",
        "breadth",
        "distribution",
        "movers",
        "waterfall",
        "matched_banks",
        "small_multiples",
        "timeline",
        "stacked_composition",
        "change_waterfall",
        "both",
        "event_study",
        "analogues",
        "event_trajectories",
        "analogue_table",
        "exact_table"
      ],
      "description": "Stored analysis views only. Use that block's configurationAffordances.viewValues; compatible values depend on result kind."
    },
    "sortMetric": {
      "type": "string",
      "maxLength": 10,
      "enum": [
        "asset",
        "lnlsnet",
        "eq",
        "roa",
        "roe",
        "nimy",
        "eeffr",
        "netinc",
        "dep",
        "loanGrowth",
        "lnlsdepr",
        "othbfhlb",
        "nclnlsr",
        "nco_ratio",
        "lnatresr",
        "rbc1rwaj",
        "rbcrwaj",
        "rbc1aaj",
        "eqv",
        "numemp",
        "offdom"
      ],
      "description": "Source-bound exact-table views only."
    },
    "sortBasis": {
      "type": "string",
      "maxLength": 6,
      "enum": [
        "level",
        "change"
      ],
      "description": "Source-bound exact-table views only."
    },
    "sortDirection": {
      "type": "string",
      "maxLength": 4,
      "enum": [
        "asc",
        "desc"
      ],
      "description": "Source-bound exact-table views only."
    },
    "series": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 19,
        "enum": [
          "UST10Y2Y",
          "BLS_UNRATE",
          "FRB_FEDFUNDS",
          "UST2Y",
          "UST10Y",
          "BLS_CPI_YOY",
          "FRB_H8_BANK_CREDIT",
          "FRB_H8_LOANS_LEASES",
          "FRB_H8_DEPOSITS",
          "FRB_H8_REAL_ESTATE",
          "FRB_H8_CI_LOANS",
          "FRB_H8_CRE",
          "FRB_H8_CONSUMER"
        ]
      },
      "maxItems": 3,
      "minItems": 1,
      "description": "Live economic_context workspace views only."
    },
    "xMetric": {
      "type": "string",
      "maxLength": 10,
      "enum": [
        "asset",
        "lnlsnet",
        "eq",
        "roa",
        "roe",
        "nimy",
        "eeffr",
        "netinc",
        "dep",
        "loanGrowth",
        "lnlsdepr",
        "othbfhlb",
        "nclnlsr",
        "nco_ratio",
        "lnatresr",
        "rbc1rwaj",
        "rbcrwaj",
        "rbc1aaj",
        "eqv",
        "numemp",
        "offdom"
      ],
      "description": "Live metric_relationship workspace views only."
    },
    "yMetric": {
      "type": "string",
      "maxLength": 10,
      "enum": [
        "asset",
        "lnlsnet",
        "eq",
        "roa",
        "roe",
        "nimy",
        "eeffr",
        "netinc",
        "dep",
        "loanGrowth",
        "lnlsdepr",
        "othbfhlb",
        "nclnlsr",
        "nco_ratio",
        "lnatresr",
        "rbc1rwaj",
        "rbcrwaj",
        "rbc1aaj",
        "eqv",
        "numemp",
        "offdom"
      ],
      "description": "Live metric_relationship workspace views only."
    },
    "geographyMode": {
      "type": "string",
      "maxLength": 6,
      "enum": [
        "count",
        "assets",
        "median"
      ],
      "description": "Live headquarters_geography workspace views only."
    },
    "attributionMode": {
      "type": "string",
      "maxLength": 18,
      "enum": [
        "assets",
        "funding",
        "quarterlyNetIncome",
        "loanToDeposit"
      ],
      "description": "Live change_attribution workspace views only."
    },
    "ifRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991,
      "description": "Workspace revision from bankgraph.get_context."
    },
    "ifPresentationRevision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991,
      "description": "Board presentation revision from bankgraph.read_research_board."
    }
  },
  "additionalProperties": false,
  "required": [
    "blockId"
  ],
  "minProperties": 2
}