v3.0
Query Service API
Servers
Choose a server to use:
/api/v1.0/
https://query-qa.adara.com/api/v1.0/
https://query-prod.adara.com/api/v1.0/
Queries
Get complete query details from the registry
GET /queries/{id}
Auth
Path Params
| id | string | required |
Example Request
x
curl --request GET \ --url /api/v1.0//queries/{id}Responses
200 404
| object | object |
Example Response
200 Successfully returned complete query details
404 Failed to fetch complete query details since it was not found in the registry
xxxxxxxxxx{}Update an existing query in the registry
PUT /queries/{id}
Auth
Path Params
| id | string | required |
Request Body
| object | object | complete details of the query | |
| summary | string | summary for an audience that helps understanding what it does | optional |
| description | string | detailed description that helps understanding the results to expect | optional |
| query | string | sql query statement | optional |
| parameters | array[object] | list of dictionary objects referred in the query statement | optional |
| name | string | name of the parameter | required |
| type | string | Valid BQ data type of the parameter Enum: | required |
Example Request
xxxxxxxxxxcurl --request PUT \ --url /api/v1.0//queries/{id} \ --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 }}'Responses
200 404
| object | object |
Example Response
200 Successfully updated the query in the registry
404 Failed to update the query since it was not found in the registry
xxxxxxxxxx{}De-activate a query in the registry
DELETE /queries/{id}
Auth
Path Params
| id | string | required |
Example Request
xxxxxxxxxxcurl --request DELETE \ --url /api/v1.0//queries/{id}Responses
200 404
| object | object |
Example Response
200 Successfully de-activated the query in the registry
404 Failed to de-activate the query since it was not found in the registry
xxxxxxxxxx{}Get the paginated list of details of all the queries stored in the registry
GET /queries
Auth
Query String
| page | integer | Default: 1 | required |
Example Request
xxxxxxxxxxcurl --request GET \ --url /api/v1.0//queries?page=1Responses
200 400
| object | object |
Example Response
200 Successfully returned the paginated list of details of all the queries stored in the registry
400 Failed to fetch the paginated list of details of all the queries stored in the registry
xxxxxxxxxx{}Add a new query to the registry
POST /queries
Auth
Request Body
| object | object | complete details of the query | required |
| summary | string | summary for an audience that helps understanding what it does | required |
| description | string | detailed description that helps understanding the results to expect | required |
| query | string | sql query statement | required |
| parameters | array[object] | list of dictionary objects referred in the query statement | optional |
| name | string | name of the parameter | required |
| type | string | Valid BQ data type of the parameter Enum: | required |
Example Request
xxxxxxxxxxcurl --request POST \ --url /api/v1.0//queries \ --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 }}'Responses
200 400
| object | object |
Example Response
200 Successfully added query to the registry
400 Failed to add query to the registry
xxxxxxxxxx{}Run
Execute a query segment from the registry
POST /run
Auth
Query String
| id | string | required | |
| trace_id | string | optional |
Request Body
| object | object | ||
| parameters | object | Parameter values referred in the query statement | optional |
Example Request
xxxxxxxxxxcurl --request POST \ --url /api/v1.0//run?id={id}&trace_id={trace_id} \ --data '{ "parameters": { "remote_addr": 1145275707 }}'Responses
200
| object | object |
Example Response
200 job id for the query execeution request is returned
xxxxxxxxxx{}