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

description

string

Description of the query.

is_archived

boolean

Indicates if the query is archived.

is_private

boolean

Indicates if the query is private.

is_unsaved

boolean

Indicates if the query is unsaved.

name

string

Name of the query.

owner

string

The owner of the query.

parameters

object[]

Show child attributes

parameters.key

string

required

The key name of the parameter.

parameters.description

string

A brief description of the parameter.

parameters.enumFromResults

object

Show child attributes

parameters.enumFromResults.columnName

string

The column name to use from the query results.

parameters.enumFromResults.queryId

integer

The ID of the query to fetch results from.

parameters.EnumValues

string[]

List of valid options for 'enum' type parameters.

parameters.isFreeformAllowed

boolean

Indicates if freeform input is allowed for this parameter.

parameters.isMultiselect

boolean

Indicates if multiple selections are allowed for this parameter.

parameters.type

enum<string>

The type of the parameter, determines the format of 'value(s)'. 'number': Numeric parameters, the value must be a number (e.g., '20'). 'text': String parameters, value can be any text including hex 0x-prefixed values (e.g., '0xae2fc...'), an empty value defaults to an empty string. 'datetime': Date and time parameters, value must be in 'YYYY-MM-DD hh:mm:ss' format (e.g., '2021-12-31 23:59:59'). 'enum': Parameters with a specific list of values, 'EnumValues' field is mandatory, providing a JSON list of strings representing valid options, the 'value' must be one of these options (e.g., 'Option1').

Available options:

number,

text,

datetime,

enum

parameters.value

string

The default value used by this parameter during execution, format depends on the type.

parameters.values

string[]

An array of string values, used when multiple selections are allowed.

query_engine

string

The query engine used to execute the query.

query_id

integer

Unique identifier of the query.

query_sql

string

The SQL query text.

tags

string[]

Tags associated with the query.

version

integer

Version of the query.