Read Query

This API allows for anyone to read the sql text, parameters, name, tags, and state of a query. For private queries, only the API key generated under the context of the owner of that query will work.

To access Query endpoints, a Plus plan or higher is required.

Headers

X-DUNE-API-KEY

string

required

API Key for the service

Path Parameters

queryId

integer

required

unique identifier of the query

Query Parameters

api_key

string

API Key for the service, alternative to using the HTTP header X-DUNE-API-KEY.

Response

200 - application/json

query_id

integer

Unique identifier of the query.

name

string

Name of the query.

description

string

Description of the query.

tags

string[]

Tags associated with the query.

version

integer

Version of the query.

parameters

object[]

Show child attributes

query_engine

string

The query engine used to execute the query.

query_sql

string

The SQL query text.

is_private

boolean

Indicates if the query is private.

is_archived

boolean

Indicates if the query is archived.

is_unsaved

boolean

Indicates if the query is unsaved.

owner

string

The owner of the query.