withCorrelation()
Home > @gooddata/sdk-backend-spi > IAnalyticalBackend > withCorrelation
IAnalyticalBackend.withCorrelation() method
Sets request correlation metadata that will be included in HTTP requests to the backend. If the IAnalyticalBackend instance already has correlation metadata set, the new metadata will be merged with the existing one. This method provides more flexibility than withTelemetry by allowing arbitrary key-value pairs to be sent.
Signature:
withCorrelation(correlationMetadata: IRequestCorrelationMetadata): IAnalyticalBackend;
Parameters
| Parameter | Type | Description |
|---|---|---|
| correlationMetadata | IRequestCorrelationMetadata | key-value pairs to include as correlation metadata |
Returns:
a new instance of backend configured with the merged correlation metadata