Interface IExtendedTelemetryItem

An interface used to create an event, along with its name, properties, type, timestamp, and priority.

Hierarchy

Properties

baseData?: {
    [key: string]: string | number | boolean | string[] | number[] | boolean[] | IEventProperty | object;
}

Telemetry properties pertaining to domain about which data is being captured. Example, duration, referrerUri for browser page. These are alternatively referred to as Part B properties for a Common Schema event.

Type declaration

  • [key: string]: string | number | boolean | string[] | number[] | boolean[] | IEventProperty | object
baseType?: string

Telemetry type used for part B

data?: {
    [key: string]: string | number | boolean | string[] | number[] | boolean[] | IEventProperty | object;
}

Properties to be captured about the telemetry item. Custom properties (alternatively referred to as Part C properties for a Common Schema event) can be directly added under data.

Type declaration

  • [key: string]: string | number | boolean | string[] | number[] | boolean[] | IEventProperty | object
ext?: {
    [key: string]: any;
}

System context properties of the telemetry item, example: ip address, city etc

Type declaration

  • [key: string]: any
iKey?: string

Identifier of the resource that uniquely identifies which resource data is sent to

latency?: number

An EventLatency value, that specifies the latency for the event.The EventLatency constant should be used to specify the different latency values.

name: string

Unique name of the telemetry item

persistence?: number

[Optional] An EventPersistence value, that specifies the persistence for the event. The EventPersistence constant should be used to specify the different persistence values.

sync?: boolean | EventSendType

[Optional] A boolean that specifies whether the event should be sent as a sync request.

tags?: Tags

System context property extensions that are not global (not in ctx)

time?: string

Timestamp when item was sent

timings?: IEventTiming

[Optional] A timings object.

ver?: string

CommonSchema Version of this SDK

Generated using TypeDoc