Class TelemetryService

Index

Constructors

Methods

getTelemetry getTelemetryLevel postTelemetryLevel

Constructors

constructor

new TelemetryService(): TelemetryService
Returns TelemetryService

Methods

`Static`getTelemetry

getTelemetry<ThrowOnError extends boolean = true>(
    options?: Options<GetTelemetryData, ThrowOnError>,
): RequestResult<
    GetTelemetryResponses,
    GetTelemetryErrors,
    ThrowOnError,
    "fields",
>
Gets telemetry data.

Gets telemetry data and statistics for the Umbraco installation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTelemetryData, ThrowOnError>
Returns RequestResult<GetTelemetryResponses, GetTelemetryErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7090

`Static`getTelemetryLevel

getTelemetryLevel<ThrowOnError extends boolean = true>(
    options?: Options<GetTelemetryLevelData, ThrowOnError>,
): RequestResult<
    GetTelemetryLevelResponses,
    GetTelemetryLevelErrors,
    ThrowOnError,
    "fields",
>
Gets telemetry information.

Gets the current telemetry configuration and consent level.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTelemetryLevelData, ThrowOnError>
Returns RequestResult<
    GetTelemetryLevelResponses,
    GetTelemetryLevelErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7108

`Static`postTelemetryLevel

postTelemetryLevel<ThrowOnError extends boolean = true>(
    options?: Options<PostTelemetryLevelData, ThrowOnError>,
): RequestResult<
    PostTelemetryLevelResponses,
    PostTelemetryLevelErrors,
    ThrowOnError,
    "fields",
>
Sets telemetry consent level.

Sets the telemetry consent level for anonymous usage data collection.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostTelemetryLevelData, ThrowOnError>
Returns RequestResult<
    PostTelemetryLevelResponses,
    PostTelemetryLevelErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7126