Contentful Personalization & Analytics
    Preparing search index...

    Interface ApiClientConfig

    Configuration for the high-level ApiClient.

    interface ApiClientConfig {
        analytics?: Omit<InsightsApiClientConfig, GlobalApiConfigProperties>;
        clientId: string;
        environment?: string;
        fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">;
        personalization?: Omit<
            ExperienceApiClientConfig,
            GlobalApiConfigProperties,
        >;
    }

    Hierarchy

    Index

    Properties

    analytics? clientId environment? fetchOptions? personalization?

    Properties

    analytics?: Omit<InsightsApiClientConfig, GlobalApiConfigProperties>

    Configuration for the analytics (Insights) API client.

    Any properties shared with ApiConfig are taken from the top-level config and overridden by this object when specified.

    clientId: string

    Client identifier used for authentication or tracking.

    environment?: string

    Contentful environment identifier.

    Defaults to main when not provided.

    fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">

    Options used to configure the underlying protected fetch method.

    apiName is derived from the client name and must not be provided here.

    personalization?: Omit<ExperienceApiClientConfig, GlobalApiConfigProperties>

    Configuration for the personalization (Experience) API client.

    Any properties shared with ApiConfig are taken from the top-level config and overridden by this object when specified.

    Settings

    Member Visibility

    On This Page

    Properties