Query

Get
Any query resource returned by a get request will contain the following properties:
1
{
2
    "kind": "query",
3
    "uri": string,
4
    "id": string,
5
    "status": string("queued","running","completed","failed"),
6
    "errorMessage": string,
7
    "outputNumRows": integer,
8
    "outputNumBytes": integer,
9
    "outputSchema": [
10
        { 
11
            "name": string,
12
            "type": string("string", "float", "integer", "boolean", "date", "dateTime", "time")
13
        }   
14
    ],
15
}
Copied!
Documentation
field
​
Get
​
kind
string
The resource type. Will always be "query".
uri
string
The fully qualified reference to this query, for use in generating calls to this API. 
For example, /queries/1234
id
integer
The unique identifier for the query
status
string
The current status of the query. Will be one of "queued", "running", "completed", "failed"
errorMessage
string
If status == "failed", will provide additional information about what cause the query failure.
outputNumRows
integer
The number of rows in the query result. Will be null until the query status is completed
outputNumBytes
integer
The number of bytes in the query result. Will be null until the query status is completed
outputSchema[]
array(object)
Information about the schema (columns) of the query result. Will be null until the query status is completed
outputSchema[].name
string
The name of the column
outputSchema[].type
string
The type of the column. Will be one of:
"string", "float", "integer", "boolean", "date", "dateTime", "time"
​

Resource definitions - Previous

Member

Next - Resource definitions

Table

Last modified 6mo ago

Copy link

Contents

Get

Documentation