@grafana/runtime on Grafana Labs

AngularComponent

Sat, 04 Apr 2026 12:26:57 +0000

AngularComponent interface

Used to enable rendering of Angular components within a React component without losing proper typings.

Signature

export interface AngularComponent

Import

import { AngularComponent } from '@grafana/runtime';

Example

class Component extends PureComponent<Props> {
  element: HTMLElement;
  angularComponent: AngularComponent;

  componentDidMount() {
    const template = '<angular-component />' // angular template here;
    const scopeProps = { ctrl: angularController }; // angular scope properties here
    const loader = getAngularLoader();
    this.angularComponent = loader.load(this.element, scopeProps, template);
  }

  componentWillUnmount() {
    if (this.angularComponent) {
      this.angularComponent.destroy();
    }
  }

  render() {
    return (
      <div ref={element => (this.element = element)} />
    );
  }
}

Methods

Method	Description
destroy()	Should be called when the React component will unmount.
digest()	Can be used to trigger a re-render of the Angular component.
getScope()	Used to access the Angular scope from the React component.

destroy method

Should be called when the React component will unmount.

Signature

destroy(): void;

Returns:

void

digest method

Can be used to trigger a re-render of the Angular component.

Signature

digest(): void;

Returns:

void

getScope method

Used to access the Angular scope from the React component.

Signature

getScope(): any;

Returns:

any

AngularLoader

Sat, 04 Apr 2026 12:26:57 +0000

AngularLoader interface

Used to load an Angular component from the context of a React component. Please see the AngularComponent for a proper example.

Signature

export interface AngularLoader

Import

import { AngularLoader } from '@grafana/runtime';

Methods

Method	Description
load(elem, scopeProps, template)

load method

Signature

load(elem: any, scopeProps: any, template: string): AngularComponent;

Parameters

Parameter	Type	Description
elem	`any`	the element that the Angular component will be loaded into.
scopeProps	`any`	values that will be accessed via the Angular scope.
template	`string`	template used by the Angular component.

Returns:

AngularComponent

AzureSettings

Sat, 04 Apr 2026 12:26:57 +0000

AzureSettings interface

Signature

export interface AzureSettings

Import

import { AzureSettings } from '@grafana/runtime';

Properties

Property	Type	Description
cloud	`string`
managedIdentityEnabled	`boolean`

cloud property

Signature

cloud?: string;

managedIdentityEnabled property

Signature

managedIdentityEnabled: boolean;

BackendSrv

Sat, 04 Apr 2026 12:26:57 +0000

BackendSrv interface

Used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. The BackendSrv is using the Fetch API under the hood to handle all the communication.

The request function can be used to perform a remote call by specifying a BackendSrvRequest. To make the BackendSrv a bit easier to use we have added a couple of shorthand functions that will use default values executing the request.

Signature

export interface BackendSrv

Import

import { BackendSrv } from '@grafana/runtime';

Remarks

By default, Grafana displays an error message alert if the remote call fails. To prevent this from happening showErrorAlert = true on the options object.

Methods

Method	Description
datasourceRequest(options)	Special function used to communicate with datasources that will emit core events that the Grafana QueryInspector and QueryEditor is listening for to be able to display datasource query information. Can be skipped by adding `option.silent` when initializing the request.
delete(url, data)
fetch(options)	Observable http request interface
get(url, params, requestId)
patch(url, data)
post(url, data)
put(url, data)
request(options)

datasourceRequest method

Special function used to communicate with datasources that will emit core events that the Grafana QueryInspector and QueryEditor is listening for to be able to display datasource query information. Can be skipped by adding option.silent when initializing the request.

Signature

datasourceRequest<T = any>(options: BackendSrvRequest): Promise<FetchResponse<T>>;

Parameters

Parameter	Type	Description
options	`BackendSrvRequest`

Returns:

Promise<FetchResponse<T>>

delete method

Signature

delete(url: string, data?: any): Promise<any>;

Parameters

Parameter	Type	Description
url	`string`
data	`any`

Returns:

Promise<any>

fetch method

Observable http request interface

Signature

fetch<T>(options: BackendSrvRequest): Observable<FetchResponse<T>>;

Parameters

Parameter	Type	Description
options	`BackendSrvRequest`

Returns:

Observable<FetchResponse<T>>

get method

Signature

get(url: string, params?: any, requestId?: string): Promise<any>;

Parameters

Parameter	Type	Description
url	`string`
params	`any`
requestId	`string`

Returns:

Promise<any>

patch method

Signature

patch(url: string, data?: any): Promise<any>;

Parameters

Parameter	Type	Description
url	`string`
data	`any`

Returns:

Promise<any>

post method

Signature

post(url: string, data?: any): Promise<any>;

Parameters

Parameter	Type	Description
url	`string`
data	`any`

Returns:

Promise<any>

put method

Signature

put(url: string, data?: any): Promise<any>;

Parameters

Parameter	Type	Description
url	`string`
data	`any`

Returns:

Promise<any>

request method

Signature

request(options: BackendSrvRequest): Promise<any>;

Parameters

Parameter	Type	Description
options	`BackendSrvRequest`

Returns:

Promise<any>

BackendSrvRequest

Sat, 04 Apr 2026 12:26:57 +0000

BackendSrvRequest type

Used to initiate a remote call via the BackendSrv

Signature

export declare type BackendSrvRequest = {
    url: string;
    retry?: number;
    headers?: Record<string, any>;
    method?: string;
    showSuccessAlert?: boolean;
    showErrorAlert?: boolean;
    requestId?: string;
    hideFromInspector?: boolean;
    data?: any;
    params?: Record<string, any>;
    responseType?: 'json' | 'text' | 'arraybuffer' | 'blob';
    credentials?: RequestCredentials;
    withCredentials?: boolean;
};

Import

import { BackendSrvRequest } from '@grafana/runtime';

config

Sat, 04 Apr 2026 12:26:57 +0000

config variable

Use this to access the GrafanaBootConfig for the current running Grafana instance.

Signature

config: GrafanaBootConfig

Import

import { config } from '@grafana/runtime';

CopyPanelEvent

Sat, 04 Apr 2026 12:26:57 +0000

CopyPanelEvent class

Called to copy a panel JSON into local storage

Signature

export declare class CopyPanelEvent extends BusEventWithPayload<PanelModel>

Import

import { CopyPanelEvent } from '@grafana/runtime';

Properties

Property	Modifiers	Type	Description
type	`static`	`string`

type property

Signature

static type: string;

DashboardInfo

Sat, 04 Apr 2026 12:26:57 +0000

DashboardInfo interface

Describes the basic dashboard information that can be passed as the meta analytics payload.

Signature

export interface DashboardInfo

Import

import { DashboardInfo } from '@grafana/runtime';

Properties

Property	Type	Description
dashboardId	`number`
dashboardName	`string`
dashboardUid	`string`
folderName	`string`

dashboardId property

Signature

dashboardId: number;

dashboardName property

Signature

dashboardName: string;

dashboardUid property

Signature

dashboardUid: string;

folderName property

Signature

folderName?: string;

DashboardViewEventPayload

Sat, 04 Apr 2026 12:26:57 +0000

DashboardViewEventPayload interface

Describes the payload of a dashboard view event.

Signature

export interface DashboardViewEventPayload extends DashboardInfo

Import

import { DashboardViewEventPayload } from '@grafana/runtime';

Properties

Property	Type	Description
eventName	`MetaAnalyticsEventName.DashboardView`

eventName property

Signature

eventName: MetaAnalyticsEventName.DashboardView;

DataRequestEventPayload

Sat, 04 Apr 2026 12:26:57 +0000

DataRequestEventPayload interface

Describes the payload of a data request event.

Signature

export interface DataRequestEventPayload extends DataRequestInfo

Import

import { DataRequestEventPayload } from '@grafana/runtime';

Properties

Property	Type	Description
eventName	`MetaAnalyticsEventName.DataRequest`

eventName property

Signature

eventName: MetaAnalyticsEventName.DataRequest;

DataRequestInfo

Sat, 04 Apr 2026 12:26:57 +0000

DataRequestInfo interface

Describes the data request information passed as the meta analytics payload.

Signature

export interface DataRequestInfo extends Partial<DashboardInfo>

Import

import { DataRequestInfo } from '@grafana/runtime';

Properties

Property	Type	Description
dataSize	`number`
datasourceId	`number`
datasourceName	`string`
datasourceType	`string`
duration	`number`
error	`string`
panelId	`number`
panelName	`string`

dataSize property

Signature

dataSize?: number;

datasourceId property

Signature

datasourceId: number;

datasourceName property

Signature

datasourceName: string;

datasourceType property

Signature

datasourceType: string;

duration property

Signature

duration: number;

error property

Signature

error?: string;

panelId property

Signature

panelId?: number;

panelName property

Signature

panelName?: string;

DataSourceSrv

Sat, 04 Apr 2026 12:26:57 +0000

DataSourceSrv interface

This is the entry point for communicating with a datasource that is added as a plugin (both external and internal). Via this service you will get access to the DataSourceApi that have a rich API for communicating with the datasource.

Signature

export interface DataSourceSrv

Import

import { DataSourceSrv } from '@grafana/runtime';

Methods

Method	Description
get(ref, scopedVars)	Returns the requested dataSource. If it cannot be found it rejects the promise.
getInstanceSettings(ref, scopedVars)	Get settings and plugin metadata by name or uid
getList(filters)	Get a list of data sources
reload()	Reloads the DataSourceSrv

get method

Returns the requested dataSource. If it cannot be found it rejects the promise.

Signature

get(ref?: DataSourceRef | string | null, scopedVars?: ScopedVars): Promise<DataSourceApi>;

Parameters

Parameter	Type	Description
ref	`DataSourceRef \| string \| null`	The datasource identifier, typically an object with UID and type,
scopedVars	`ScopedVars`	variables used to interpolate a templated passed as name.

Returns:

Promise<DataSourceApi>

getInstanceSettings method

Get settings and plugin metadata by name or uid

Signature

getInstanceSettings(ref?: DataSourceRef | string | null, scopedVars?: ScopedVars): DataSourceInstanceSettings | undefined;

Parameters

Parameter	Type	Description
ref	`DataSourceRef \| string \| null`
scopedVars	`ScopedVars`

Returns:

DataSourceInstanceSettings | undefined

getList method

Get a list of data sources

Signature

getList(filters?: GetDataSourceListFilters): DataSourceInstanceSettings[];

Parameters

Parameter	Type	Description
filters	`GetDataSourceListFilters`

Returns:

DataSourceInstanceSettings[]

reload method

Reloads the DataSourceSrv

Signature

reload(): void;

Returns:

void

DataSourceWithBackend

Sat, 04 Apr 2026 12:26:57 +0000

DataSourceWithBackend class

Extend this class to implement a data source plugin that is depending on the Grafana backend API.

Signature

declare class DataSourceWithBackend<TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> extends DataSourceApi<TQuery, TOptions>

Import

import { DataSourceWithBackend } from '@grafana/runtime';

Constructors

Constructor	Modifiers	Description
constructor(instanceSettings)		Constructs a new instance of the `DataSourceWithBackend` class

Properties

Property	Modifiers	Type	Description
streamOptionsProvider		`StreamOptionsProvider<TQuery>`	Optionally override the streaming behavior

Methods

Method	Modifiers	Description
applyTemplateVariables(query, scopedVars)		Override to apply template variables. The result is usually also `TQuery`, but sometimes this can be used to modify the query structure before sending to the backend.NOTE: if you do modify the structure or use template variables, alerting queries may not work as expected
callHealthCheck()		Run the datasource healthcheck
getResource(path, params)		Make a GET request to the datasource resource path
interpolateVariablesInQueries(queries, scopedVars)		Apply template variables for explore
postResource(path, body)		Send a POST request to the datasource resource path
query(request)		Ideally final – any other implementation may not work as expected
testDatasource()		Checks the plugin health see public/app/features/datasources/state/actions.ts for what needs to be returned here

constructor(instanceSettings)

Constructs a new instance of the DataSourceWithBackend class

Signature

constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);

Parameters

Parameter	Type	Description
instanceSettings	`DataSourceInstanceSettings<TOptions>`

streamOptionsProvider property

Optionally override the streaming behavior

Signature

streamOptionsProvider: StreamOptionsProvider<TQuery>;

applyTemplateVariables method

Override to apply template variables. The result is usually also TQuery, but sometimes this can be used to modify the query structure before sending to the backend.

NOTE: if you do modify the structure or use template variables, alerting queries may not work as expected

Signature

/** @virtual */
applyTemplateVariables(query: TQuery, scopedVars: ScopedVars): Record<string, any>;

Parameters

Parameter	Type	Description
query	`TQuery`
scopedVars	`ScopedVars`

Returns:

Record<string, any>

callHealthCheck method

Run the datasource healthcheck

Signature

callHealthCheck(): Promise<HealthCheckResult>;

Returns:

Promise<HealthCheckResult>

getResource method

Make a GET request to the datasource resource path

Signature

getResource(path: string, params?: any): Promise<any>;

Parameters

Parameter	Type	Description
path	`string`
params	`any`

Returns:

Promise<any>

interpolateVariablesInQueries method

Apply template variables for explore

Signature

interpolateVariablesInQueries(queries: TQuery[], scopedVars: ScopedVars | {}): TQuery[];

Parameters

Parameter	Type	Description
queries	`TQuery[]`
scopedVars	`ScopedVars \| {}`

Returns:

TQuery[]

postResource method

Send a POST request to the datasource resource path

Signature

postResource(path: string, body?: any): Promise<any>;

Parameters

Parameter	Type	Description
path	`string`
body	`any`

Returns:

Promise<any>

query method

Ideally final – any other implementation may not work as expected

Signature

query(request: DataQueryRequest<TQuery>): Observable<DataQueryResponse>;

Parameters

Parameter	Type	Description
request	`DataQueryRequest<TQuery>`

Returns:

Observable<DataQueryResponse>

testDatasource method

Checks the plugin health see public/app/features/datasources/state/actions.ts for what needs to be returned here

Signature

testDatasource(): Promise<any>;

Returns:

Promise<any>

EchoBackend

Sat, 04 Apr 2026 12:26:57 +0000

EchoBackend interface

Describes echo backends that can be registered to receive of events.

Signature

export interface EchoBackend<T extends EchoEvent = any, O = any>

Import

import { EchoBackend } from '@grafana/runtime';

Properties

Property	Type	Description
addEvent	`(event: T) => void`
flush	`() => void`
options	`O`
supportedEvents	`EchoEventType[]`

addEvent property

Signature

addEvent: (event: T) => void;

flush property

Signature

flush: () => void;

options property

Signature

options: O;

supportedEvents property

Signature

supportedEvents: EchoEventType[];

EchoEvent

Sat, 04 Apr 2026 12:26:57 +0000

EchoEvent interface

Describes an echo event.

Signature

export interface EchoEvent<T extends EchoEventType = any, P = any>

Import

import { EchoEvent } from '@grafana/runtime';

Properties

Property	Type	Description
meta	`EchoMeta`
payload	`P`	Event payload containing event specific data.
type	`EchoEventType`

meta property

Signature

meta: EchoMeta;

payload property

Event payload containing event specific data.

Signature

payload: P;

type property

Signature

type: EchoEventType;

EchoEventType

Sat, 04 Apr 2026 12:26:57 +0000

EchoEventType enum

Supported echo event types that can be sent via the EchoSrv.

Signature

export declare enum EchoEventType

Import

import { EchoEventType } from '@grafana/runtime';

Enumeration Members

Member	Value	Description
ExperimentView	`"experimentview"`
Interaction	`"interaction"`
MetaAnalytics	`"meta-analytics"`
Pageview	`"pageview"`
Performance	`"performance"`
Sentry	`"sentry"`

EchoMeta

Sat, 04 Apr 2026 12:26:57 +0000

EchoMeta interface

Describes the meta information that are sent together with each event.

Signature

export interface EchoMeta

Import

import { EchoMeta } from '@grafana/runtime';

Properties

Property	Type	Description
screenSize	`SizeMeta`
sessionId	`string`	A unique browser session
timeSinceNavigationStart	`number`	A highres timestamp since navigation start
ts	`number`	A millisecond epoch
url	`string`
userAgent	`string`
userId	`number`	The current users unique identifier.
userLogin	`string`	The current users username used to login into Grafana e.g. email.
userSignedIn	`boolean`	True when user is logged in into Grafana.
windowSize	`SizeMeta`

screenSize property

Signature

screenSize: SizeMeta;

sessionId property

A unique browser session

Signature

sessionId: string;

timeSinceNavigationStart property

A highres timestamp since navigation start

Signature

timeSinceNavigationStart: number;

ts property

A millisecond epoch

Signature

ts: number;

url property

Signature

url?: string;

userAgent property

Signature

userAgent: string;

userId property

The current users unique identifier.

Signature

userId: number;

userLogin property

The current users username used to login into Grafana e.g. email.

Signature

userLogin: string;

userSignedIn property

True when user is logged in into Grafana.

Signature

userSignedIn: boolean;

windowSize property

Signature

windowSize: SizeMeta;

EchoSrv

Sat, 04 Apr 2026 12:26:57 +0000

EchoSrv interface

Used to send events to all the registered backends. This should be accessed via the getEchoSrv() function. Will, by default, flush events to the backends every 10s or when the flush function is triggered.

Signature

export interface EchoSrv

Import

import { EchoSrv } from '@grafana/runtime';

Methods

Method	Description
addBackend(backend)	Add a new echo backend to the list of backends that will receive events.
addEvent(event, meta)	Call this to add event that will be sent to the echo backends upon next flush.
flush()	Call this to flush current events to the echo backends.

addBackend method

Add a new echo backend to the list of backends that will receive events.

Signature

addBackend(backend: EchoBackend): void;

Parameters

Parameter	Type	Description
backend	`EchoBackend`

Returns:

void

addEvent method

Call this to add event that will be sent to the echo backends upon next flush.

Signature

addEvent<T extends EchoEvent>(event: Omit<T, 'meta'>, meta?: {}): void;

Parameters

Parameter	Type	Description
event	`Omit<T, ‘meta’>`	Object containing event information.
meta	`{}`	Object that will extend/override the default meta object.

Returns:

void

flush method

Call this to flush current events to the echo backends.

Signature

flush(): void;

Returns:

void

ExperimentViewEchoEvent

Sat, 04 Apr 2026 12:26:57 +0000

ExperimentViewEchoEvent type

Describes experimentview event with predefined type.

Signature

export declare type ExperimentViewEchoEvent = EchoEvent<EchoEventType.ExperimentView, ExperimentViewEchoEventPayload>;

Import

import { ExperimentViewEchoEvent } from '@grafana/runtime';

ExperimentViewEchoEventPayload

Sat, 04 Apr 2026 12:26:57 +0000

ExperimentViewEchoEventPayload interface

Describes the payload of an experimentview event.

Signature

export interface ExperimentViewEchoEventPayload

Import

import { ExperimentViewEchoEventPayload } from '@grafana/runtime';

Properties

Property	Type	Description
experimentGroup	`string`
experimentId	`string`
experimentVariant	`string`

experimentGroup property

Signature

experimentGroup: string;

experimentId property

Signature

experimentId: string;

experimentVariant property

Signature

experimentVariant: string;

featureEnabled

Sat, 04 Apr 2026 12:26:57 +0000

featureEnabled variable

Signature

featureEnabled: (feature: string) => boolean

Import

import { featureEnabled } from '@grafana/runtime';

FetchError

Sat, 04 Apr 2026 12:26:57 +0000

FetchError interface

Error type for fetch function in BackendSrv

Signature

export interface FetchError<T = any>

Import

import { FetchError } from '@grafana/runtime';

Properties

Property	Type	Description
cancelled	`boolean`
config	`BackendSrvRequest`
data	`T`
isHandled	`boolean`
status	`number`
statusText	`string`

cancelled property

Signature

cancelled?: boolean;

config property

Signature

config: BackendSrvRequest;

data property

Signature

data: T;

isHandled property

Signature

isHandled?: boolean;

status property

Signature

status: number;

statusText property

Signature

statusText?: string;

FetchErrorDataProps

Sat, 04 Apr 2026 12:26:57 +0000

FetchErrorDataProps interface

Error type for fetch function in BackendSrv

Signature

export interface FetchErrorDataProps

Import

import { FetchErrorDataProps } from '@grafana/runtime';

Properties

Property	Type	Description
error	`string \| any`
message	`string`
status	`string`

error property

Signature

error?: string | any;

message property

Signature

message?: string;

status property

Signature

status?: string;

FetchResponse

Sat, 04 Apr 2026 12:26:57 +0000

FetchResponse interface

Response for fetch function in BackendSrv

Signature

export interface FetchResponse<T = any>

Import

import { FetchResponse } from '@grafana/runtime';

Properties

Property	Type	Description
config	`BackendSrvRequest`
data	`T`
headers	`Headers`
ok	`boolean`
redirected	`boolean`
status	`number`
statusText	`string`
type	`ResponseType`
url	`string`

config property

Signature

readonly config: BackendSrvRequest;

data property

Signature

data: T;

headers property

Signature

readonly headers: Headers;

ok property

Signature

readonly ok: boolean;

redirected property

Signature

readonly redirected: boolean;

status property

Signature

readonly status: number;

statusText property

Signature

readonly statusText: string;

type property

Signature

readonly type: ResponseType;

url property

Signature

readonly url: string;

frameToMetricFindValue

Sat, 04 Apr 2026 12:26:57 +0000

frameToMetricFindValue() function

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

frameToMetricFindValue() function

Return the first string or non-time field as the value

Signature

export declare function frameToMetricFindValue(frame: DataFrame): MetricFindValue[];

Import

import { frameToMetricFindValue } from '@grafana/runtime';

Parameters

Parameter	Type	Description
frame	`DataFrame`

Returns:

MetricFindValue[]

getAngularLoader

Sat, 04 Apr 2026 12:26:57 +0000

getAngularLoader() function

Used to retrieve the AngularLoader that enables the use of Angular components within a React component.

Please see the AngularComponent for a proper example.

Signature

export declare function getAngularLoader(): AngularLoader;

Import

import { getAngularLoader } from '@grafana/runtime';

Returns:

AngularLoader

getAppEvents

Sat, 04 Apr 2026 12:26:57 +0000

getAppEvents() function

Used to retrieve an event bus that manages application level events

Signature

export declare function getAppEvents(): EventBus;

Import

import { getAppEvents } from '@grafana/runtime';

Returns:

EventBus

getBackendSrv

Sat, 04 Apr 2026 12:26:57 +0000

getBackendSrv variable

Used to retrieve the BackendSrv that can be used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc.

Signature

getBackendSrv: () => BackendSrv

Import

import { getBackendSrv } from '@grafana/runtime';

GetDataSourceListFilters

Sat, 04 Apr 2026 12:26:57 +0000

GetDataSourceListFilters interface

Signature

export interface GetDataSourceListFilters

Import

import { GetDataSourceListFilters } from '@grafana/runtime';

Properties

Property	Type	Description
alerting	`boolean`	Only filter data sources that support alerting
all	`boolean`	By default only data sources that can be queried will be returned. Meaning they have tracing, metrics, logs or annotations flag set in plugin.json file
annotations	`boolean`	Only return data sources that support annotations
dashboard	`boolean`	Set to true to return dashboard data source
filter	`(dataSource: DataSourceInstanceSettings) => boolean`	apply a function to filter
metrics	`boolean`	Only return data sources that support metrics response
mixed	`boolean`	Include mixed data source by setting this to true
pluginId	`string`	filter list by plugin
tracing	`boolean`	Only return data sources that support tracing response
type	`string \| string[]`	Only returns datasources matching the specified types (ie. Loki, Prometheus)
variables	`boolean`	Set to true to return data source variables

alerting property

Only filter data sources that support alerting

Signature

alerting?: boolean;

all property

By default only data sources that can be queried will be returned. Meaning they have tracing, metrics, logs or annotations flag set in plugin.json file

Signature

all?: boolean;

annotations property

Only return data sources that support annotations

Signature

annotations?: boolean;

dashboard property

Set to true to return dashboard data source

Signature

dashboard?: boolean;

filter property

apply a function to filter

Signature

filter?: (dataSource: DataSourceInstanceSettings) => boolean;

metrics property

Only return data sources that support metrics response

Signature

metrics?: boolean;

mixed property

Include mixed data source by setting this to true

Signature

mixed?: boolean;

pluginId property

filter list by plugin

Signature

pluginId?: string;

tracing property

Only return data sources that support tracing response

Signature

tracing?: boolean;

type property

Only returns datasources matching the specified types (ie. Loki, Prometheus)

Signature

type?: string | string[];

variables property

Set to true to return data source variables

Signature

variables?: boolean;

getDataSourceSrv

Sat, 04 Apr 2026 12:26:57 +0000

getDataSourceSrv() function

Used to retrieve the DataSourceSrv that is the entry point for communicating with a datasource that is added as a plugin (both external and internal).

Signature

export declare function getDataSourceSrv(): DataSourceSrv;

Import

import { getDataSourceSrv } from '@grafana/runtime';

Returns:

DataSourceSrv

getEchoSrv

Sat, 04 Apr 2026 12:26:57 +0000

getEchoSrv() function

Used to retrieve the EchoSrv that can be used to report events to registered echo backends.

Signature

export declare function getEchoSrv(): EchoSrv;

Import

import { getEchoSrv } from '@grafana/runtime';

Returns:

EchoSrv

getLegacyAngularInjector

Sat, 04 Apr 2026 12:26:57 +0000

getLegacyAngularInjector variable

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

getLegacyAngularInjector variable

WARNING: this function provides a temporary way for plugins to access anything in the angular injector. While the migration from angular to react continues, there are a few options that do not yet have good alternatives. Note that use of this function will be removed in the future.

Signature

getLegacyAngularInjector: () => auto.IInjectorService

Import

import { getLegacyAngularInjector } from '@grafana/runtime';

getLocationSrv

Sat, 04 Apr 2026 12:26:57 +0000

getLocationSrv() function

Used to retrieve the LocationSrv that can be used to automatically navigate the user to a new place in Grafana.

Signature

export declare function getLocationSrv(): LocationSrv;

Import

import { getLocationSrv } from '@grafana/runtime';

Returns:

LocationSrv

getTemplateSrv

Sat, 04 Apr 2026 12:26:57 +0000

getTemplateSrv variable

Used to retrieve the TemplateSrv that can be used to fetch available template variables.

Signature

getTemplateSrv: () => TemplateSrv

Import

import { getTemplateSrv } from '@grafana/runtime';

GrafanaBootConfig

Sat, 04 Apr 2026 12:26:57 +0000

GrafanaBootConfig class

Signature

export declare class GrafanaBootConfig implements GrafanaConfig

Import

import { GrafanaBootConfig } from '@grafana/runtime';

Constructors

Constructor	Modifiers	Description
constructor(options)		Constructs a new instance of the `GrafanaBootConfig` class

Properties

Property	Modifiers	Type	Description
alertingEnabled		`boolean`
alertingErrorOrTimeout		`string`
alertingMinInterval		`number`
alertingNoDataOrNullValues		`string`
allowOrgCreate		`boolean`
applicationInsightsConnectionString		`string`
applicationInsightsEndpointUrl		`string`
appSubUrl		`string`
appUrl		`string`
authProxyEnabled		`boolean`
autoAssignOrg		`boolean`
awsAllowedAuthProviders		`string[]`
awsAssumeRoleEnabled		`boolean`
azure		`AzureSettings`
bootData		`any`
buildInfo		`BuildInfo`
caching		`{` `enabled: boolean;` `}`
customTheme		`any`
datasources		`{` `[str: string]: DataSourceInstanceSettings;` `}`
dateFormats		`SystemDateFormatSettings`
defaultDatasource		`string`
disableLoginForm		`boolean`
disableSanitizeHtml		`boolean`
disableUserSignUp		`boolean`
editorsCanAdmin		`boolean`
exploreEnabled		`boolean`
expressionsEnabled		`boolean`
externalUserMngInfo		`string`
externalUserMngLinkName		`string`
externalUserMngLinkUrl		`string`
featureHighlights		`{` `enabled: boolean;` `}`
featureToggles		`FeatureToggles`
geomapDefaultBaseLayerConfig		`MapLayerOptions`
geomapDisableCustomBaseLayer		`boolean`
http2Enabled		`boolean`
ldapEnabled		`boolean`
licenseInfo		`LicenseInfo`
liveEnabled		`boolean`
loginError		`any`
loginHint		`any`
minRefreshInterval		`string`
navTree		`any`
newPanelTitle		`string`
oauth		`any`
panels		`{` `[key: string]: PanelPluginMeta;` `}`
passwordHint		`any`
pluginAdminEnabled		`boolean`
pluginAdminExternalManageEnabled		`boolean`
pluginCatalogHiddenPlugins		`string[]`
pluginCatalogURL		`string`
pluginsToPreload		`PreloadPlugin[]`
recordedQueries		`{` `enabled: boolean;` `}`
rendererAvailable		`boolean`
rendererVersion		`string`
reporting		`{` `enabled: boolean;` `}`
samlEnabled		`boolean`
samlName		`string`
sentry		`{` `enabled: boolean;` `dsn: string;` `customEndpoint: string;` `sampleRate: number;` `}`
sigV4AuthEnabled		`boolean`
theme		`GrafanaTheme`
theme2		`GrafanaTheme2`
unifiedAlertingEnabled		`boolean`
verifyEmailEnabled		`boolean`
viewersCanEdit		`boolean`
windowTitlePrefix		`string`

constructor(options)

Constructs a new instance of the GrafanaBootConfig class

Signature

constructor(options: GrafanaBootConfig);

Parameters

Parameter	Type	Description
options	`GrafanaBootConfig`

alertingEnabled property

Signature

alertingEnabled: boolean;

alertingErrorOrTimeout property

Signature

alertingErrorOrTimeout: string;

alertingMinInterval property

Signature

alertingMinInterval: number;

alertingNoDataOrNullValues property

Signature

alertingNoDataOrNullValues: string;

allowOrgCreate property

Signature

allowOrgCreate: boolean;

applicationInsightsConnectionString property

Signature

applicationInsightsConnectionString?: string;

applicationInsightsEndpointUrl property

Signature

applicationInsightsEndpointUrl?: string;

appSubUrl property

Signature

appSubUrl: string;

appUrl property

Signature

appUrl: string;

authProxyEnabled property

Signature

authProxyEnabled: boolean;

autoAssignOrg property

Signature

autoAssignOrg: boolean;

awsAllowedAuthProviders property

Signature

awsAllowedAuthProviders: string[];

awsAssumeRoleEnabled property

Signature

awsAssumeRoleEnabled: boolean;

azure property

Signature

azure: AzureSettings;

bootData property

Signature

bootData: any;

buildInfo property

Signature

buildInfo: BuildInfo;

caching property

Signature

caching: {
        enabled: boolean;
    };

customTheme property

Signature

customTheme?: any;

datasources property

Signature

datasources: {
        [str: string]: DataSourceInstanceSettings;
    };

dateFormats property

Signature

dateFormats?: SystemDateFormatSettings;

defaultDatasource property

Signature

defaultDatasource: string;

disableLoginForm property

Signature

disableLoginForm: boolean;

disableSanitizeHtml property

Signature

disableSanitizeHtml: boolean;

disableUserSignUp property

Signature

disableUserSignUp: boolean;

editorsCanAdmin property

Signature

editorsCanAdmin: boolean;

exploreEnabled property

Signature

exploreEnabled: boolean;

expressionsEnabled property

Signature

expressionsEnabled: boolean;

externalUserMngInfo property

Signature

externalUserMngInfo: string;

externalUserMngLinkName property

Signature

externalUserMngLinkName: string;

externalUserMngLinkUrl property

Signature

externalUserMngLinkUrl: string;

featureHighlights property

Signature

featureHighlights: {
        enabled: boolean;
    };

featureToggles property

Signature

featureToggles: FeatureToggles;

geomapDefaultBaseLayerConfig property

Signature

geomapDefaultBaseLayerConfig?: MapLayerOptions;

geomapDisableCustomBaseLayer property

Signature

geomapDisableCustomBaseLayer?: boolean;

http2Enabled property

Signature

http2Enabled: boolean;

ldapEnabled property

Signature

ldapEnabled: boolean;

licenseInfo property

Signature

licenseInfo: LicenseInfo;

liveEnabled property

Signature

liveEnabled: boolean;

loginError property

Signature

loginError: any;

loginHint property

Signature

loginHint: any;

minRefreshInterval property

Signature

minRefreshInterval: string;

navTree property

Signature

navTree: any;

newPanelTitle property

Signature

newPanelTitle: string;

oauth property

Signature

oauth: any;

panels property

Signature

panels: {
        [key: string]: PanelPluginMeta;
    };

passwordHint property

Signature

passwordHint: any;

pluginAdminEnabled property

Signature

pluginAdminEnabled: boolean;

pluginAdminExternalManageEnabled property

Signature

pluginAdminExternalManageEnabled: boolean;

pluginCatalogHiddenPlugins property

Signature

pluginCatalogHiddenPlugins: string[];

pluginCatalogURL property

Signature

pluginCatalogURL: string;

pluginsToPreload property

Signature

pluginsToPreload: PreloadPlugin[];

recordedQueries property

Signature

recordedQueries: {
        enabled: boolean;
    };

rendererAvailable property

Signature

rendererAvailable: boolean;

rendererVersion property

Signature

rendererVersion: string;

reporting property

Signature

reporting: {
        enabled: boolean;
    };

samlEnabled property

Signature

samlEnabled: boolean;

samlName property

Signature

samlName: string;

sentry property

Signature

sentry: {
        enabled: boolean;
        dsn: string;
        customEndpoint: string;
        sampleRate: number;
    };

sigV4AuthEnabled property

Signature

sigV4AuthEnabled: boolean;

theme property

Signature

theme: GrafanaTheme;

theme2 property

Signature

theme2: GrafanaTheme2;

unifiedAlertingEnabled property

Signature

unifiedAlertingEnabled: boolean;

verifyEmailEnabled property

Signature

verifyEmailEnabled: boolean;

viewersCanEdit property

Signature

viewersCanEdit: boolean;

windowTitlePrefix property

Signature

windowTitlePrefix: string;

HealthCheckResult

Sat, 04 Apr 2026 12:26:57 +0000

HealthCheckResult interface

Describes the payload returned when checking the health of a data source plugin.

Signature

export interface HealthCheckResult

Import

import { HealthCheckResult } from '@grafana/runtime';

Properties

Property	Type	Description
details	`HealthCheckResultDetails`
message	`string`
status	`HealthStatus`

details property

Signature

details: HealthCheckResultDetails;

message property

Signature

message: string;

status property

Signature

status: HealthStatus;

HealthCheckResultDetails

Sat, 04 Apr 2026 12:26:57 +0000

HealthCheckResultDetails type

Describes the details in the payload returned when checking the health of a data source plugin.

If the ‘message’ key exists, this will be displayed in the error message in DataSourceSettingsPage If the ‘verboseMessage’ key exists, this will be displayed in the expandable details in the error message in DataSourceSettingsPage

Signature

export declare type HealthCheckResultDetails = Record<string, any> | undefined;

Import

import { HealthCheckResultDetails } from '@grafana/runtime';

HealthStatus

Sat, 04 Apr 2026 12:26:57 +0000

HealthStatus enum

Describes the current health status of a data source plugin.

Signature

export declare enum HealthStatus

Import

import { HealthStatus } from '@grafana/runtime';

Enumeration Members

Member	Value	Description
Error	`"ERROR"`
OK	`"OK"`
Unknown	`"UNKNOWN"`

InteractionEchoEvent

Sat, 04 Apr 2026 12:26:57 +0000

InteractionEchoEvent type

Describes interaction event with predefined type.

Signature

export declare type InteractionEchoEvent = EchoEvent<EchoEventType.Interaction, InteractionEchoEventPayload>;

Import

import { InteractionEchoEvent } from '@grafana/runtime';

InteractionEchoEventPayload

Sat, 04 Apr 2026 12:26:57 +0000

InteractionEchoEventPayload interface

Describes the payload of a user interaction event.

Signature

export interface InteractionEchoEventPayload

Import

import { InteractionEchoEventPayload } from '@grafana/runtime';

Properties

Property	Type	Description
interactionName	`string`
properties	`Record<string, any>`

interactionName property

Signature

interactionName: string;

properties property

Signature

properties?: Record<string, any>;

isExperimentViewEvent

Sat, 04 Apr 2026 12:26:57 +0000

isExperimentViewEvent variable

Experimentview event typeguard.

Signature

isExperimentViewEvent: (event: EchoEvent) => event is ExperimentViewEchoEvent

Import

import { isExperimentViewEvent } from '@grafana/runtime';

isInteractionEvent

Sat, 04 Apr 2026 12:26:57 +0000

isInteractionEvent variable

Interaction event typeguard.

Signature

isInteractionEvent: (event: EchoEvent) => event is InteractionEchoEvent

Import

import { isInteractionEvent } from '@grafana/runtime';

isPageviewEvent

Sat, 04 Apr 2026 12:26:57 +0000

isPageviewEvent variable

Pageview event typeguard.

Signature

isPageviewEvent: (event: EchoEvent) => event is PageviewEchoEvent

Import

import { isPageviewEvent } from '@grafana/runtime';

loadPluginCss

Sat, 04 Apr 2026 12:26:57 +0000

loadPluginCss() function

Use this to load css for a Grafana plugin by specifying a PluginCssOptions containing styling for the dark and the light theme.

Signature

export declare function loadPluginCss(options: PluginCssOptions): Promise<any>;

Import

import { loadPluginCss } from '@grafana/runtime';

Parameters

Parameter	Type	Description
options	`PluginCssOptions`	plugin styling for light and dark theme.

Returns:

Promise<any>

locationSearchToObject

Sat, 04 Apr 2026 12:26:57 +0000

locationSearchToObject() function

Parses a location search string to an object

Signature

export declare function locationSearchToObject(search: string | number): UrlQueryMap;

Import

import { locationSearchToObject } from '@grafana/runtime';

Parameters

Parameter	Type	Description
search	`string \| number`

Returns:

UrlQueryMap

locationService

Sat, 04 Apr 2026 12:26:57 +0000

locationService variable

Signature

locationService: LocationService

Import

import { locationService } from '@grafana/runtime';

LocationSrv

Sat, 04 Apr 2026 12:26:57 +0000

LocationSrv interface

If you need to automatically navigate the user to a new place in the application this should be done via the LocationSrv and it will make sure to update the application state accordingly.

Signature

export interface LocationSrv

Import

import { LocationSrv } from '@grafana/runtime';

Methods

Method	Description
update(options)

update method

Signature

update(options: LocationUpdate): void;

Parameters

Parameter	Type	Description
options	`LocationUpdate`

Returns:

void

LocationUpdate

Sat, 04 Apr 2026 12:26:57 +0000

LocationUpdate interface

Signature

export interface LocationUpdate

Import

import { LocationUpdate } from '@grafana/runtime';

Properties

Property	Type	Description
partial	`boolean`	If set to true, the query argument will be added to the existing URL.
path	`string`	Target path where you automatically wants to navigate the user.
query	`UrlQueryMap`	Specify this value if you want to add values to the query string of the URL.
replace	`boolean`

partial property

If set to true, the query argument will be added to the existing URL.

Signature

partial?: boolean;

path property

Target path where you automatically wants to navigate the user.

Signature

path?: string;

query property

Specify this value if you want to add values to the query string of the URL.

Signature

query?: UrlQueryMap;

replace property

Signature

replace?: boolean;

logDebug

Sat, 04 Apr 2026 12:26:57 +0000

logDebug() function

Log a message at DEBUG level. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry

Signature

export declare function logDebug(message: string, contexts?: Contexts): void;

Import

import { logDebug } from '@grafana/runtime';

Parameters

Parameter	Type	Description
message	`string`
contexts	`Contexts`

Returns:

void

logError

Sat, 04 Apr 2026 12:26:57 +0000

logError() function

Log an error. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry

Signature

export declare function logError(err: Error, contexts?: Contexts): void;

Import

import { logError } from '@grafana/runtime';

Parameters

Parameter	Type	Description
err	`Error`
contexts	`Contexts`

Returns:

void

logInfo

Sat, 04 Apr 2026 12:26:57 +0000

logInfo() function

Log a message at INFO level. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry

Signature

export declare function logInfo(message: string, contexts?: Contexts): void;

Import

import { logInfo } from '@grafana/runtime';

Parameters

Parameter	Type	Description
message	`string`
contexts	`Contexts`

Returns:

void

logWarning

Sat, 04 Apr 2026 12:26:57 +0000

logWarning() function

Log a message at WARNING level. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry

Signature

export declare function logWarning(message: string, contexts?: Contexts): void;

Import

import { logWarning } from '@grafana/runtime';

Parameters

Parameter	Type	Description
message	`string`
contexts	`Contexts`

Returns:

void

MetaAnalyticsEvent

Sat, 04 Apr 2026 12:26:57 +0000

MetaAnalyticsEvent interface

Describes meta analytics event with predefined type.

Signature

export interface MetaAnalyticsEvent extends EchoEvent<EchoEventType.MetaAnalytics, MetaAnalyticsEventPayload>

Import

import { MetaAnalyticsEvent } from '@grafana/runtime';

MetaAnalyticsEventName

Sat, 04 Apr 2026 12:26:57 +0000

MetaAnalyticsEventName enum

The meta analytics events that can be added to the echo service.

Signature

export declare enum MetaAnalyticsEventName

Import

import { MetaAnalyticsEventName } from '@grafana/runtime';

Enumeration Members

Member	Value	Description
DashboardView	`"dashboard-view"`
DataRequest	`"data-request"`

MetaAnalyticsEventPayload

Sat, 04 Apr 2026 12:26:57 +0000

MetaAnalyticsEventPayload type

Describes the meta analytics payload passed with the MetaAnalyticsEvent

Signature

export declare type MetaAnalyticsEventPayload = DashboardViewEventPayload | DataRequestEventPayload;

Import

import { MetaAnalyticsEventPayload } from '@grafana/runtime';

PageviewEchoEvent

Sat, 04 Apr 2026 12:26:57 +0000

PageviewEchoEvent type

Describes pageview event with predefined type.

Signature

export declare type PageviewEchoEvent = EchoEvent<EchoEventType.Pageview, PageviewEchoEventPayload>;

Import

import { PageviewEchoEvent } from '@grafana/runtime';

PageviewEchoEventPayload

Sat, 04 Apr 2026 12:26:57 +0000

PageviewEchoEventPayload interface

Describes the payload of a pageview event.

Signature

export interface PageviewEchoEventPayload

Import

import { PageviewEchoEventPayload } from '@grafana/runtime';

Properties

Property	Type	Description
page	`string`

page property

Signature

page: string;

PluginCssOptions

Sat, 04 Apr 2026 12:26:57 +0000

PluginCssOptions interface

Option to specify a plugin css that should be applied for the dark and the light theme.

Signature

export interface PluginCssOptions

Import

import { PluginCssOptions } from '@grafana/runtime';

Properties

Property	Type	Description
dark	`string`
light	`string`

dark property

Signature

dark: string;

light property

Signature

light: string;

RefreshEvent

Sat, 04 Apr 2026 12:26:57 +0000

RefreshEvent class

Called when a dashboard is refreshed

Signature

export declare class RefreshEvent extends BusEventBase

Import

import { RefreshEvent } from '@grafana/runtime';

Properties

Property	Modifiers	Type	Description
type	`static`	`string`

type property

Signature

static type: string;

registerEchoBackend

Sat, 04 Apr 2026 12:26:57 +0000

registerEchoBackend variable

Used to register echo backends that will receive Grafana echo events during application runtime.

Signature

registerEchoBackend: (backend: EchoBackend) => void

Import

import { registerEchoBackend } from '@grafana/runtime';

reportExperimentView

Sat, 04 Apr 2026 12:26:57 +0000

reportExperimentView variable

Helper function to report experimentview events to the EchoSrv.

Signature

reportExperimentView: (id: string, group: string, variant: string) => void

Import

import { reportExperimentView } from '@grafana/runtime';

reportInteraction

Sat, 04 Apr 2026 12:26:57 +0000

reportInteraction variable

Helper function to report interaction events to the EchoSrv.

Signature

reportInteraction: (interactionName: string, properties?: Record<string, any> | undefined) => void

Import

import { reportInteraction } from '@grafana/runtime';

reportMetaAnalytics

Sat, 04 Apr 2026 12:26:57 +0000

reportMetaAnalytics variable

Helper function to report meta analytics to the EchoSrv.

Signature

reportMetaAnalytics: (payload: MetaAnalyticsEventPayload) => void

Import

import { reportMetaAnalytics } from '@grafana/runtime';

reportPageview

Sat, 04 Apr 2026 12:26:57 +0000

reportPageview variable

Helper function to report pageview events to the EchoSrv.

Signature

reportPageview: () => void

Import

import { reportPageview } from '@grafana/runtime';

SizeMeta

Sat, 04 Apr 2026 12:26:57 +0000

SizeMeta interface

Describes a size with width/height

Signature

export interface SizeMeta

Import

import { SizeMeta } from '@grafana/runtime';

Properties

Property	Type	Description
height	`number`
width	`number`

height property

Signature

height: number;

width property

Signature

width: number;

StreamOptionsProvider

Sat, 04 Apr 2026 12:26:57 +0000

StreamOptionsProvider type

This allows data sources to customize the streaming connection query

Signature

export declare type StreamOptionsProvider<TQuery extends DataQuery = DataQuery> = (request: DataQueryRequest<TQuery>, frame: DataFrame) => Partial<StreamingFrameOptions>;

Import

import { StreamOptionsProvider } from '@grafana/runtime';

TemplateSrv

Sat, 04 Apr 2026 12:26:57 +0000

TemplateSrv interface

Via the TemplateSrv consumers get access to all the available template variables that can be used within the current active dashboard.

For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating

Signature

export interface TemplateSrv

Import

import { TemplateSrv } from '@grafana/runtime';

Methods

Method	Description
getVariables()	List the dashboard variables
replace(target, scopedVars, format)	Replace the values within the target string. See also
updateTimeRange(timeRange)	Update the current time range to be used when interpolating __from / __to variables.

getVariables method

List the dashboard variables

Signature

getVariables(): VariableModel[];

Returns:

VariableModel[]

replace method

Replace the values within the target string. See also

Signature

replace(target?: string, scopedVars?: ScopedVars, format?: string | Function): string;

Parameters

Parameter	Type	Description
target	`string`
scopedVars	`ScopedVars`
format	`string \| Function`

Returns:

string

updateTimeRange method

Update the current time range to be used when interpolating __from / __to variables.

Signature

updateTimeRange(timeRange: TimeRange): void;

Parameters

Parameter	Type	Description
timeRange	`TimeRange`

Returns:

void

ThemeChangedEvent

Sat, 04 Apr 2026 12:26:57 +0000

ThemeChangedEvent class

Called when the theme settings change

Signature

export declare class ThemeChangedEvent extends BusEventWithPayload<GrafanaTheme2>

Import

import { ThemeChangedEvent } from '@grafana/runtime';

Properties

Property	Modifiers	Type	Description
type	`static`	`string`

type property

Signature

static type: string;

TimeRangeUpdatedEvent

Sat, 04 Apr 2026 12:26:57 +0000

TimeRangeUpdatedEvent class

Called when time range is updated

Signature

export declare class TimeRangeUpdatedEvent extends BusEventWithPayload<TimeRange>

Import

import { TimeRangeUpdatedEvent } from '@grafana/runtime';

Properties

Property	Modifiers	Type	Description
type	`static`	`string`

type property

Signature

static type: string;

toDataQueryError

Sat, 04 Apr 2026 12:26:57 +0000

toDataQueryError() function

Convert an object into a DataQueryError – if this is an HTTP response, it will put the correct values in the error field

Signature

export declare function toDataQueryError(err: DataQueryError | string | Object): DataQueryError;

Import

import { toDataQueryError } from '@grafana/runtime';

Parameters

Parameter	Type	Description
err	`DataQueryError \| string \| Object`

Returns:

DataQueryError

toDataQueryResponse

Sat, 04 Apr 2026 12:26:57 +0000

toDataQueryResponse() function

Parse the results from /api/ds/query into a DataQueryResponse

Signature

export declare function toDataQueryResponse(res: {
    data: BackendDataSourceResponse | undefined;
} | FetchResponse<BackendDataSourceResponse | undefined> | DataQueryError, queries?: DataQuery[]): DataQueryResponse;

Import

import { toDataQueryResponse } from '@grafana/runtime';

Parameters

Parameter	Type	Description
res	`{` `data: BackendDataSourceResponse \| undefined;` `} \| FetchResponse<BackendDataSourceResponse \| undefined> \| DataQueryError`	the HTTP response data.
queries	`DataQuery[]`	optional DataQuery array that will order the response based on the order of query refId’s.

Returns:

DataQueryResponse