Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana documentation API Reference @grafana/data QueryResultMeta

QueryResultMeta interface

Signature

typescript Copy

export interface QueryResultMeta 

Import

typescript Copy

import { QueryResultMeta } from '@grafana/data';

Properties

alignmentPeriod property

Signature

typescript Copy

alignmentPeriod?: number;

custom property

DatasSource Specific Values

Signature

typescript Copy

custom?: Record<string, any>;

dataTopic property

Optionally identify which topic the frame should be assigned to. A value specified in the response will override what the request asked for.

Signature

typescript Copy

dataTopic?: DataTopic;

executedQueryString property

This is the raw query sent to the underlying system. All macros and templating as been applied. When metadata contains this value, it will be shown in the query inspector

Signature

typescript Copy

executedQueryString?: string;

gmdMeta property

Legacy data source specific, should be moved to custom

Signature

typescript Copy

gmdMeta?: any[];

instant property

Signature

typescript Copy

instant?: boolean;

json property

Signature

typescript Copy

json?: boolean;

limit property

Signature

typescript Copy

limit?: number;

notices property

Meta Notices

Signature

typescript Copy

notices?: QueryResultMetaNotice[];

preferredVisualisationType property

Currently used to show results in Explore only in preferred visualisation option

Signature

typescript Copy

preferredVisualisationType?: PreferredVisualisationType;

searchWords property

Signature

typescript Copy

searchWords?: string[];

stats property

Stats

Signature

typescript Copy

stats?: QueryResultMetaStat[];

transformations property

Used to track transformation ids that where part of the processing

Signature

typescript Copy

transformations?: string[];