Databricks SDK for JavaScript
    Preparing search index...

    Interface ListQueriesRequest

    Fetches a list of queries conforming to the provided set of query filters.

    If the number of queries to return takes > 10 seconds, the request will timeout. In that case, please reduce the time range to ensure ListQueries conforms to the 10 second max query time limit.

    interface ListQueriesRequest {
        filterBy?: QueryFilter;
        includeMetrics?: boolean;
        maxResults?: number;
        pageToken?: string;
    }
    Index

    Properties

    filterBy? includeMetrics? maxResults? pageToken?

    Properties

    filterBy?: QueryFilter

    An optional filter object to limit query history results. Accepts parameters such as user IDs, endpoint IDs, and statuses to narrow the returned data. In a URL, the parameters of this filter are specified with dot notation. For example: filter_by.statement_ids.

    includeMetrics?: boolean

    Whether to include the query metrics with each query. Only use this for a small subset of queries (max_results). Defaults to false.

    maxResults?: number

    Limit the number of results returned in one page. Must be less than 1000 and the default is 100.

    pageToken?: string

    A token that can be used to get the next page of results. The token can contains characters that need to be encoded before using it in a URL. For example, the character '+' needs to be replaced by %2B. This field is optional.

    Settings

    Member Visibility

    On This Page

    Properties