Geovisualization Developer's Guide

substring

When you use this function in a query, it extracts a substring from the strings in the specified column in the specified dataset starting from the integer count in from the left specified in the parameter params to the end of the string.

For more information on using query functions and operators in a REST API request, see Queries. For an end-to-end description of how to create a query, see Creating a Query.

The example below extracts a substring from the strings in the Region column of the earthquake dataset, whose {DATASET_ID} is 90af668484394fa782cc103409cafe39, starting with the fifth character.

{
  "version": 0.3,
  "dataset": "90af668484394fa782cc103409cafe39",
  "namespace": {
    "substring": {
      "source": ["Region"],
      "apply": [{
        "fn": "substring",
        "type": "transform",
        "params": [5],
      }]
    }
  },
  "metrics": ["substring"],
}

When you submit the above request, the response includes an HTTP status code and a JSON response body.

For more information on the HTTP status codes, see HTTP Status Codes.

For more information on the elements in the JSON structure in the response body, see Query.