interface IEnvelope {
    aiDataContract: any;
    data: any;
    iKey: string;
    name: string;
    sampleRate: number;
    seq: string;
    tags: {
        [name: string]: any;
    };
    time: string;
    ver: number;
}

Hierarchy (view full)

Implemented by

Properties

aiDataContract: any

The set of fields for a serializable object. This defines the serialization order and a value of true/false for each field defines whether the field is required or not.

data: any

Telemetry data item.

iKey: string

The application's instrumentation key. The key is typically represented as a GUID, but there are cases when it is not a guid. No code should rely on iKey being a GUID. Instrumentation key is case insensitive.

name: string

Type name of telemetry data item.

sampleRate: number

Sampling rate used in application. This telemetry item represents 1 / sampleRate actual telemetry items.

seq: string

Sequence field used to track absolute order of uploaded events.

tags: {
    [name: string]: any;
}

Key/value collection of context properties. See ContextTagKeys for information on available properties.

time: string

Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z.

ver: number

Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1.