Type Alias CmcdReporterConfig<C>

CmcdReporterConfig: CmcdRequestReportConfig<C> & {
    cid?: string;
    eventTargets?: CmcdEventReportConfig<C>[];
    sessionRetention?: number;
    sid?: string;
}

Configuration for a CMCD reporting component.

C = Record<string, unknown>
The shape of the player's customData on the requests this reporter sees. Annotating a single transform is enough for the rest of the configuration to infer it. Defaults to Record<string, unknown>.

Optionalcid?: string
The content ID.

Default Value
undefined
OptionaleventTargets?: CmcdEventReportConfig<C>[]
The event configurations. If not provided, no events will be reported.

Default Value
undefined
OptionalsessionRetention?: number
The number of ended sessions the reporter retains state for, in addition to the current one. Retained sessions let a response that completes after a sid change report under the session that issued its request, with that session's data snapshot and sequence numbers. 0 retains nothing, so stale responses are dropped. Infinity never evicts, which also retains every session's unsent report queues. Numbers are floored; every other input falls back to the default.

Default Value
2
Optionalsid?: string
The session ID. If not provided, a new random session ID will be generated.

Default Value
undefined