Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
Summary
Represents the integrations configuration for third-party services in the Mintlify documentation site.Remarks
This configuration enables integration with various analytics, feedback, and other third-party services. Each integration has specific configuration requirements defined in their respective configuration classes. These integrations allow automatic tracking of documentation engagement and user behavior to your preferred analytics platforms.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
Adobe
Gets or sets the Adobe Analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.AdobeConfig?
Remarks
Adobe Analytics provides enterprise-level analytics and reporting capabilities. When configured, documentation events are tracked via your Adobe Analytics launch URL.Amplitude
Gets or sets the Amplitude analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.AmplitudeConfig?
Remarks
Amplitude provides product analytics to understand user behavior and engagement. When configured, all documentation events are automatically sent to your Amplitude project.Clarity
Gets or sets the Microsoft Clarity integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.ClarityConfig?
Remarks
Microsoft Clarity provides session recordings and heatmaps for understanding user behavior on your documentation site.Clearbit
Gets or sets the Clearbit data enrichment integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.ClearbitConfig?
Remarks
Clearbit enriches your analytics data with company and demographic information. When configured, visitor data is enhanced with business intelligence.Cookies
Gets or sets the cookie configuration for the documentation site.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.CookiesConfig?
Remarks
Configures custom cookie settings for the documentation site.Fathom
Gets or sets the Fathom analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.FathomConfig?
Remarks
Fathom provides simple, privacy-focused analytics that is GDPR compliant and doesn’t use cookies. When configured, page views and events are tracked in your Fathom dashboard.FrontChat
Gets or sets the Front chat widget integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.FrontChatConfig?
Remarks
Front provides a chat widget for customer communication. When configured, a chat widget appears on your documentation pages for real-time support.GoogleAnalytics4
Gets or sets the Google Analytics 4 integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.GoogleAnalytics4Config?
Remarks
Google Analytics 4 (GA4) is Google’s next-generation analytics platform. When configured, all documentation events are sent to your GA4 property. Note that GA4 data may take 2-3 days to appear after initial setup.Gtm
Gets or sets the Google Tag Manager integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.GtmConfig?
Remarks
Google Tag Manager (GTM) allows flexible tag management for analytics and marketing. When configured, you can manage all tracking tags through the GTM interface.Heap
Gets or sets the Heap analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.HeapConfig?
Remarks
Heap automatically captures all user interactions without manual event tracking. When configured, every user interaction on your documentation is automatically tracked.Hightouch
Gets or sets the Hightouch data activation integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.HightouchConfig?
Remarks
Hightouch syncs data from your warehouse to business tools. When configured, documentation events can be synchronized to your data warehouse and downstream tools.Hotjar
Gets or sets the Hotjar behavior analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.HotjarConfig?
Remarks
Hotjar provides heatmaps, session recordings, and user feedback tools. When configured, you can visualize how users interact with your documentation.Intercom
Gets or sets the Intercom integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.IntercomConfig?
Remarks
Intercom provides customer messaging and support tools. When configured, the Intercom widget is embedded in your documentation pages.Koala
Gets or sets the Koala analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.KoalaConfig?
Remarks
Koala provides product-led growth analytics. When configured, documentation engagement data is sent to your Koala account.LogRocket
Gets or sets the LogRocket session replay integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.LogRocketConfig?
Remarks
LogRocket records user sessions including console logs and network activity. When configured, you can replay user sessions to understand issues and behavior.Mixpanel
Gets or sets the Mixpanel product analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.MixpanelConfig?
Remarks
Mixpanel provides detailed product analytics and user behavior tracking. When configured, all documentation events are sent to your Mixpanel project.Pirsch
Gets or sets the Pirsch analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.PirschConfig?
Remarks
Pirsch is a privacy-friendly, GDPR-compliant analytics platform. When configured, page views and events are tracked without cookies.Plausible
Gets or sets the Plausible analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.PlausibleConfig?
Remarks
Plausible is a lightweight, open-source, privacy-focused analytics platform. When configured, documentation engagement is tracked without cookies.PostHog
Gets or sets the PostHog product analytics integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.PostHogConfig?
Remarks
PostHog provides session recording, feature flags, and product analytics. When configured, all documentation events are sent to your PostHog instance.Segment
Gets or sets the Segment customer data platform integration configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.SegmentConfig?
Remarks
Segment collects, transforms, and routes analytics data to various destinations. When configured, documentation events are sent to Segment and forwarded to your configured downstream tools.Telemetry
Gets or sets the telemetry and feedback configuration.Syntax
Property Value
Type:Mintlify.Core.Models.Integrations.TelemetryConfig?
Remarks
Controls whether telemetry and feedback collection is enabled on the documentation site.Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?