{"text-token-function-list": {
  "source": [
    {
      "name": "{=areasWithinBand}",
      "syntax": "areasWithinBand?metricType[&area][&period][&valueType][&number]",
      "requiredParameters": "{=areasWithinBand?metricType=}",
      "description": "The number of areas within a selected band",
      "examples": [
        "{=areasWithinBand?metricType=1&area=AllLaInCountry_England&period=latest&valueType=[band][4]&number=1}"
      ]
    },
    {
      "name": "{=compare}",
      "syntax": "compare?metricType[&area][&withArea][&withSummaryType][&period][&withPeriod][&greater][&equal][&less][&summaryType]",
      "requiredParameters": "{=compare?metricType=}",
      "description": "Text describing if one value is greater than, equal to or less than another",
      "examples": [
        "{=compare?metricType=523&area={main-area-identifier}&withArea={ancestor-1-identifier}&period=latest}"
      ]
    },
    {
      "name": "{=countAreas}",
      "syntax": "countAreas[area]",
      "requiredParameters": "{=countAreas}",
      "description": "A count of the areas in a given bounding area",
      "examples": [
        "{=countAreas?area={ancestor-2-identifier}:{ancestor-1-type-identifier}}",
        "{=countAreas?area={main-area-identifier}:{child-area-type}}"
      ]
    },
    {
      "name": "{=derived}",
      "syntax": "derived?metricType[&area][&withArea][&period][&withPeriod][&valueType][&returnValue][&decimalPlaces]",
      "requiredParameters": "{=derived?metricType=}",
      "description": "The derived value for a chosen value type for a particular metric type, area and period",
      "examples": [
        "{=derived?metricType=1}"
      ]
    },
    {
      "name": "{=equivalent}",
      "syntax": "equivalent?metricDimension[&area][&period][&rank][&for][&returnValue]",
      "requiredParameters": "{=equivalent?metricDimension=}",
      "description": "The predominant metric type for an area expressed as a value for a different area",
      "examples": [
        "{=equivalent?metricDimension=[218][218_PerCent][Gender]&period=cal_2010}"
      ]
    },
    {
      "name": "{=metricTypeMetadata}",
      "syntax": "metricTypeMetadata?metricType[&returnValue][&showLabel]",
      "requiredParameters": "{=metricTypeMetadata?metricType=}",
      "description": "A metadata property for a selected metric type",
      "examples": [
        "{=metricTypeMetadata?metricType=198}",
        "{=metricTypeMetadata?metricType=198&returnValue=shortLabel}",
        "{=metricTypeMetadata?metricType=198&returnValue=collection}"
      ]
    },
    {
      "name": "{=percent}",
      "syntax": "percent?metricType[&area][&withArea][&period][&withPeriod][&returnValue]",
      "requiredParameters": "{=percent?metricType=}",
      "description": "The percentage of one value over another for a metric type for two areas",
      "examples": [
        "{=percent?metricType=3167&withArea={main-area-identifier}&area={child-area-identifier}}"
      ]
    },
    {
      "name": "{=rankedArea}",
      "syntax": "rankedArea?metricType[&area][&period][&rank][&returnValue][&labelType]",
      "requiredParameters": "{=rankedArea?metricType=}",
      "description": "The nth ranked area within a bounding area for a specified metric type",
      "examples": [
        "{=rankedArea?metricType=442}"
      ]
    },
    {
      "name": "{=rankedMetricType}",
      "syntax": "rankedMetricType?metricDimension[&area][&period][&rank][&returnValue]",
      "requiredParameters": "{=rankedMetricType?metricDimension=}",
      "description": "The label or value of the predominant metric type within a dimension for an area",
      "examples": [
        "{=rankedMetricType?metricDimension=[218][218_PerCent][Gender]}"
      ]
    },
    {
      "name": "{=rankedPeriod}",
      "syntax": "rankedPeriod?metricType[&area][&period][&rank][&returnValue]",
      "requiredParameters": "{=rankedPeriod?metricType=}",
      "description": "The label of the ranked period for a specified metric type",
      "examples": [
        "{=rankedPeriod?metricType=1}"
      ]
    },
    {
      "name": "{=rank}",
      "syntax": "rank?metricType[&area][&period][&within][&returnValue]",
      "requiredParameters": "{=rank?metricType=}",
      "description": "The rank of an area within a bounding area for a specified metric type",
      "examples": [
        "{=rank?metricType=3285&area={child-area-identifier}&period=latest&within={main-area-identifier}:{child-area-type-identifier}}"
      ]
    },
    {
      "name": "{=summary}",
      "syntax": "summary?metricType[&area][&period][&summaryType][&returnValue][&decimalPlaces]",
      "requiredParameters": "{=summary?metricType=}",
      "description": "The summary value of the metric type",
      "examples": [
        "{=summary?metricType=442}"
      ]
    },
    {
      "name": "{=value}",
      "syntax": "value?metricType[&area][&period][&returnValue]",
      "requiredParameters": "{=value?metricType=}",
      "description": "A token to insert the value of a metric. You must specify the metric type and can also define a time period and area.",
      "examples": [
        "{=value?metricType=198}",
        "{=value?metricType=198&area={main-area-identifier}&period=latest}"
      ]
    }
  ]
}}