grafana/docs/sources/packages_api/runtime/echometa.md
Marcus Andersson cc3fc18076
Docs: enable packages reference docs for 7-beta (#23953)
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
2020-04-28 09:53:58 +02:00

2.6 KiB

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "EchoMeta" keywords = ["grafana","documentation","sdk","@grafana/runtime"] type = "docs" +++

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;