This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Gets the results of a query. The results of the query are returned in the Apache Arrow format.
This endpoint implements long polling and requests will time out after one minute. They can be safely retried while the query is still running.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:sql-queries-read.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/sqlQueries/OikKBfqBaWRjOGQ3YTJkNzMtYjhiZi00ZDMzLTlkOWMtOGQzOW/getResults?preview=true"| Error Name | ||
|---|---|---|
Query | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The query was canceled. | |
| Parameters | queryId | |
Query | Error Code | INTERNAL |
| Status Code | 500 | |
| Description | The query failed. | |
| Parameters | queryId, errorMessage | |
Query | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The query cannot be parsed. | |
| Parameters | errorMessage | |
Query | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The query is running. | |
| Parameters | queryId | |
Read | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to access the inputs to the query. | |
| Parameters | rids | |
Query | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The provided token does not have permission to access the given query. | |
| Parameters | queryId | |
Get | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not getResults the SqlQuery. | |
| Parameters | sqlQueryId | |
See Errors for a general overview of errors in the platform.