Geovisualization Developer's Guide

Datasets

The datasets response body is a JSON object returned by the Geo-visualization REST API in response to requests for the following:

  • Create an empty dataset
  • Upload data to a dataset (by file or by external source)
  • Fetch dataset metadata
  • Reset dataset
  • Modify a dataset schema
Table 1. Dataset Response Elements
Element Data Type Description
created_at ISO Datetime Date and time the dataset was created, in ISO 8601 format with the Z indicating that the time is in UTC
description String Description of the dataset, based on the value provided when the dataset was created
files Array Empty if no content has been uploaded.

Contains the following fields if content has been uploaded:

  • size – the size of the file in bytes
  • uploaded_at – date and time when the file was uploaded, in ISO 8601 format with the Z indicating the time is in UTC
  • filename – name of the file that was the source of the dataset

For example:

files: [
  {
size: 18072285,
uploaded_at: "2014-10-10T12:34:32Z",
filename: "rain_prcp.csv"
  }
]
id String Unique ID for the database
kind String Type of response: the value is datalens#dataset when the request is successful
name String Name of the dataset
origin String Source of the dataset; possible values include:
  • user - the dataset was uploaded by a user logged into Geovisualization
  • starter_pack - the dataset was part of the standard set of datasets preloaded into user accounts for demonstration purposes
  • geocoding - the dataset was generated by a geocoding job
row_count Integer Number of rows in the database
schema Object Schema of the dataset if present:
  • delimiter – data delimiter: comma, semicolon or tab
  • type – type of file: currently, only CSV is supported
  • columns – a list of lists with each list representing a column in the data and containing the following elements:
    • index – integer representing index number of column
    • type – field type: number, string, or date
    • name – column name
    • alias – alternative name for the column
  • Note that columns auto-generated by geocoding requests have origin set to geocoding, and they also include the following attributes:
    • input_constants – list of defined input constants in original request
    • source_columns – list of columns used for geocoding
  • encoding – always UTF-8
updated_at ISO Datetime Last modified date and time, in ISO 8601 format with the Z indicating that the time is in UTC

The code example below illustrates a typical response to a successful request.

{
  "files": [
    {
      "size": 34,
      "uploaded_at": "2015-06-23T15:48:45Z",
      "filename": "test.csv"
    }
  ],
  "row_count": 2,
  "kind": "datalens#dataset",
  "name": "test dataset two",
  "updated_at": "2015-06-23T15:48:51Z",
  "created_at": "2015-06-23T15:38:06Z",
  "schema": {
    "delimiter": ";",
    "type": "CSV",
    "columns": [
      {
        "alias": "ALTERNATIVE NAME",
        "type": "string",
        "name": "STRING",
        "index": 0
      },
      {
        "alias": "ALTERNATIVE NAME",
        "type": "number",
        "name": "INTEGER",
        "index": 1
      }
    ],
    "encoding": "utf-8"
  },
  "id": "7238af9870754323bbe6fbed6796c3d9",
  "origin": "user",
  "description": "this is a test dataset"
}

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.