Contentful Personalization & Analytics
    Preparing search index...

    Interface CoreSharedApiConfig

    Shared API configuration for all Core runtimes.

    interface CoreSharedApiConfig {
        enabledFeatures?: Feature[];
        experienceBaseUrl?: string;
        insightsBaseUrl?: string;
        location?: {
            city?: string;
            continent?: string;
            coordinates?: { latitude: number; longitude: number };
            country?: string;
            countryCode?: string;
            postalCode?: string;
            region?: string;
            regionCode?: string;
            timezone?: string;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    enabledFeatures? experienceBaseUrl? insightsBaseUrl? location?

    Properties

    enabledFeatures?: Feature[]

    Experience API features enabled for outgoing requests.

    experienceBaseUrl?: string

    Base URL override for Experience API requests.

    insightsBaseUrl?: string

    Base URL override for Insights API requests.

    location?: {
        city?: string;
        continent?: string;
        coordinates?: { latitude: number; longitude: number };
        country?: string;
        countryCode?: string;
        postalCode?: string;
        region?: string;
        regionCode?: string;
        timezone?: string;
    }

    Default request location for singular Experience API calls. Request-bound location options replace this whole object; {} supplies an empty default. Each event's context location remains independent and takes precedence at the API.

    Type Declaration

    • Optionalcity?: string

      City name associated with the location.

    • Optionalcontinent?: string

      Continent name associated with the location.

    • Optionalcoordinates?: { latitude: number; longitude: number }

      Geographical coordinates for the location.

      • latitude: number

        Latitude component of the coordinates.

      • longitude: number

        Longitude component of the coordinates.

    • Optionalcountry?: string

      Country name associated with the location.

    • OptionalcountryCode?: string

      Country code associated with the location.

      Validated to exactly COUNTRY_CODE_LENGTH characters, typically an ISO 3166-1 alpha-2 code.

    • OptionalpostalCode?: string

      Postal or ZIP code associated with the location.

    • Optionalregion?: string

      Region or state name associated with the location.

    • OptionalregionCode?: string

      Region or state code associated with the location.

    • Optionaltimezone?: string

      Time zone identifier associated with the location.

      Typically an IANA time zone string (e.g., "Europe/Berlin").

    Settings

    Member Visibility

    On This Page

    Properties