Contentful Personalization & Analytics
    Preparing search index...

    Interface ApiClientConfig

    Configuration for the high-level ApiClient.

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

    Hierarchy

    Index

    Properties

    clientId environment? experience? fetchOptions? insights?

    Properties

    clientId: string

    Client identifier used for authentication or tracking.

    environment?: string

    Contentful environment identifier.

    'main'

    experience?: Omit<ExperienceApiClientConfig, GlobalApiConfigProperties>

    Configuration for the Experience API client.

    Shared fields (clientId, environment, fetchOptions) are inherited from top-level config; this object is for Experience-specific options.

    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.

    insights?: Omit<InsightsApiClientConfig, GlobalApiConfigProperties>

    Configuration for the Insights API client.

    Shared fields (clientId, environment, fetchOptions) are inherited from top-level config; this object is for Insights-specific options.

    Settings

    Member Visibility

    On This Page

    Properties