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

Query ID

Query Parameters

api_key

string

API Key, alternative to using the HTTP header X-Dune-Api-Key

Response

200 - application/json

description

string

The description of the query

is_archived

boolean

Indicates if the query is archived. Archived queries cannot be executed.

is_private

boolean

Indicates if the query is private.

is_unsaved

boolean

Indicates if the query is unsaved.

name

string

The name of the query

owner

string

username or team handle

parameters

object[]

The parameters that can modify the execution of the sql.

Show child attributes

parameters.description

string

parameters.enumFromResults

object

Show child attributes

parameters.enumFromResults.columnName

string

parameters.enumFromResults.queryId

integer

parameters.enumOptions

string[]

parameters.isFreeformAllowed

boolean

parameters.isMultiselect

boolean

parameters.key

string

parameters.type

string

parameters.value

string

parameters.values

string[]

query_engine

string

The query engine used to execute the query.

query_id

integer

The unique ID of the query

query_sql

string

The SQL query text.

tags

string[]

Tags associated with the query.

version

integer

Version of the query, gets incremented every time the query is updated.