Query Service API 1.0.0

Server

/api/v1.0/

https://query-qa.adara.com/api/v1.0/

https://query-prod.adara.com/api/v1.0/

Authentication

oauth2 oauth2

FlowClient Credentials

Token URL/core/v1.0/oauth/token

Queries

Get complete query details from the registry

Auth

Required Scopes:get:queries

Path Params

id string

GET /queries/{id}

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//queries/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully returned complete query details

object object

404

Failed to fetch complete query details since it was not found in the registry

Response

xxxxxxxxxx
 
{}
Copy

Update an existing query in the registry

Auth

Required Scopes:put:queries

Path Params

id string

Request Body

object	object	complete details of the query
summary	string	summary for an audience that helps understanding what it does
description	string	detailed description that helps understanding the results to expect
query	string	sql query statement
parameters	array[object]	list of dictionary objects referred in the query statement
name	string	name of the parameter
type	string	Valid BQ data type of the parameter Enum: `INT64`,`NUMERIC`,`FLOAT64`,`BOOL`,`STRING`,`BYTES`,`DATE`,`DATETIME`,`GEOGRAPHY`,`TIME`,`TIMESTAMP`

PUT /queries/{id}

xxxxxxxxxx
 
curl --request PUT \ --url '/api/v1.0//queries/%7Bid%7D' \ --header 'Authorization: Bearer {token}' \ --data '{  "summary": "Get pixel request timestamp data",  "description": "Get id and request timestamp data of the pixel requests from the BQ table 'test_pixel_request' in dataset 'query' in project 'dot-sandbox'",  "query": "SELECT id, request_ts as timestamp FROM `dot-sandbox.query.test_pixel_request` WHERE remote_addr = @remote_addr LIMIT @limit;",  "parameters": {    "name": "remote_addr",    "type": "INT64",    "sample": 1145275707  }}'
Copy

Responses

200

Successfully updated the query in the registry

object object

404

Failed to update the query since it was not found in the registry

Response

xxxxxxxxxx
 
{}
Copy

De-activate a query in the registry

Auth

Required Scopes:delete:queries

Path Params

id string

DELETE /queries/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url '/api/v1.0//queries/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully de-activated the query in the registry

object object

404

Failed to de-activate the query since it was not found in the registry

Response

xxxxxxxxxx
 
{}
Copy

Get the paginated list of details of all the queries stored in the registry

Auth

Required Scopes:get:queries

Query String

page

integer

Default: 1

GET /queries

xxxxxxxxxx
 
curl --get \ --url '/api/v1.0//queries' \ --header 'Authorization: Bearer {token}' \ --data page=1
Copy

Responses

200

Successfully returned the paginated list of details of all the queries stored in the registry

object object

400

Failed to fetch the paginated list of details of all the queries stored in the registry

Response

xxxxxxxxxx
 
{}
Copy

Add a new query to the registry

Auth

Required Scopes:post:queries

Request Body

object	object	complete details of the query
summary	string	summary for an audience that helps understanding what it does
description	string	detailed description that helps understanding the results to expect
query	string	sql query statement
parameters	array[object]	list of dictionary objects referred in the query statement
name	string	name of the parameter
type	string	Valid BQ data type of the parameter Enum: `INT64`,`NUMERIC`,`FLOAT64`,`BOOL`,`STRING`,`BYTES`,`DATE`,`DATETIME`,`GEOGRAPHY`,`TIME`,`TIMESTAMP`

POST /queries

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//queries' \ --header 'Authorization: Bearer {token}' \ --data '{  "summary": "Get pixel request timestamp data",  "description": "Get id and request timestamp data of the pixel requests from the BQ table 'test_pixel_request' in dataset 'query' in project 'dot-sandbox'",  "query": "SELECT id, request_ts as timestamp FROM `dot-sandbox.query.test_pixel_request` WHERE remote_addr = @remote_addr LIMIT @limit;",  "parameters": {    "name": "remote_addr",    "type": "INT64",    "sample": 1145275707  }}'
Copy

Responses

200

Successfully added query to the registry

object object

400

Failed to add query to the registry

Response

xxxxxxxxxx
 
{}
Copy

Run

POST

/run

Execute a query segment from the registry

Auth

Required Scopes:post:run

Query String

id	string
trace_id	string

Request Body

object	object
parameters	object	Parameter values referred in the query statement

POST /run

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1.0//run' \ --header 'Authorization: Bearer {token}' \ --data id={id} \ --data trace_id={trace_id} \ --data '{  "parameters": {    "remote_addr": 1145275707  }}'
Copy

Responses

200

job id for the query execeution request is returned

object object

Response

xxxxxxxxxx
 
{}
Copy