REST Resource: userQueries

Resource: Query

Returned when you request a list of queries or a specific query. Also, used by customer to create and update a query.

JSON representation
{
  "queryName": string,
  "queryText": string,
  "parameterTypes": {
    string: {
      object(ParameterType)
    },
    ...
  },
  "mergeSpec": {
    object (MergeSpec)
  },
  "isGlobal": boolean,
  "queryState": enum (QueryState),
  "queryVersion": enum (QueryVersion),
  "lastUpdatedMillis": string,
  "lastUpdateEmail": string,
  "creatorEmail": string
}
Fields
queryName

string

Query's unique name.

queryText

string

Query text.

parameterTypes

map (key: string, value: object (ParameterType))

Any additional parameters expected by the query. Maps each argument name to its argument type.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

mergeSpec

object (MergeSpec)

Instructions for row merging. If present, then any rows that would have been dropped for privacy will be combined into one. This will be included in the result if the merged row meets privacy restrictions.

isGlobal

boolean

True if the query is defined as global; otherwise the query can be used only by a particular customer (or set of customers).

queryState

enum (QueryState)

This field defines whether a query is still in development. If it is in development, it should not be executable except by admin user.

queryVersion

enum (QueryVersion)

Define what version of the api query must be run in.

lastUpdatedMillis

string (int64 format)

Timestamp for when query was last updated.

lastUpdateEmail

string

Email address of who last updated the query.

creatorEmail

string

Email address of who created the query.

Methods

create

Creates and stores a user query for later execution.

delete

Deletes a stored user query.

list

Retrieves every user query that a customer has access to.

patch

Updates an existing user query.

populateUserList

Starts execution for a stored user list query.

rename

Renames an existing user query.