Geovisualization Developer's Guide

Queries Summary

A JSON object returned by the Geovisualization REST API in response to a request for a list of existing queries.

Table 1. Queries Summary Response Elements
Element Data Type Description
kind String Type of response: the value is datalens#queries_summary when the request is successful
queries Object Nested set of queries, empty if no queries are present. Each query summary contains the following fields:
  • created_at – Date and time the query was created, in ISO 8601 format with the Z indicating that the time is in UTC
  • dataset – Unique ID of the dataset associated with the query
  • description – Description of the query, based on the value provided when the query was created
  • estimated_rows – Estimated number of rows in the dataset when the query is applied
  • id – Unique ID of the query
  • origin – Source of the query: examples of possible values include user - indicating that the query was created by the person logged into Geovisualization - and starter_pack - indicating that the query was included as part of the standard set of queries and datasets preloaded into accounts for demonstration purposes.
  • tags – A list of labels used for searching for groups of queries; they can be added when the query is created or with a POST on the .../queries/{QUERY_ID}/tags endpoint
  • updated_at – Date and time the query was updated, in ISO 8601 format with the Z indicating that the time is in UTC
  • visibility – The publication status of the query (public or private)

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

{
  "kind": "datalens#queries_summary",
  "queries":
  {
    "origin": "user",
    "description": "Earthquake data from 2012 - Absolute value of depths",
    "tags": [
      "depths",
      "earthquakes"
    ],
    "created_at": "2016-01-15T09:34:09Z",
    "dataset": "90af668484394fa782cc103409cafe39",
    "estimated_rows": 1076,
    "id": "f943d8f5f4e247df8b53e318ee4ee60b",
    "visibility": "private",
    "updated_at": "2016-01-15T09:34:09Z"
  }
}