PostHogConfig - DotNetDocs

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models.Integrations Inheritance: System.Object

Syntax

Mintlify.Core.Models.Integrations.PostHogConfig

Summary

Represents the configuration for PostHog analytics integration.

Remarks

PostHog is an open-source product analytics platform that provides session recording, feature flags, and product analytics. This configuration enables automatic tracking of documentation events to your PostHog instance.

Constructors

.ctor

Syntax

public PostHogConfig()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

ApiHost

Gets or sets the PostHog API host URL.

Syntax

public string ApiHost { get; set; }

Property Value

Type: string?

Remarks

This is optional and only needed if you are self-hosting PostHog. If not specified, events will be sent to the default PostHog cloud service at https://app.posthog.com. If you are self-hosting, specify the full URL to your PostHog instance.

ApiKey

Gets or sets the PostHog project API key.

Syntax

public string ApiKey { get; set; }

Property Value

Type: string?

Remarks

This is your PostHog project’s API key, which typically starts with “phc_”. You can find this key in your PostHog project settings. All documentation events will be sent to the PostHog project associated with this API key.

SessionRecording

Gets or sets whether to enable PostHog session recording.

Syntax

public System.Nullable<bool> SessionRecording { get; set; }

Property Value

Type: System.Nullable<bool>?

Remarks

Session recordings are enabled by default when PostHog is configured. Set to false to disable session recordings while keeping analytics enabled. You need to add the URL for your docs website to PostHog’s “Authorized domains for recordings” before you can receive session recordings.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​ .ctor Inherited

​Syntax

​Properties

​ ApiHost

​Syntax

​Property Value

​Remarks

​ ApiKey

​Syntax

​Property Value

​Remarks

​ SessionRecording

​Syntax

​Property Value

​Remarks

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

.ctor Inherited

Syntax

Properties

ApiHost

Syntax

Property Value

Remarks

ApiKey

Syntax

Property Value

Remarks

SessionRecording

Syntax

Property Value

Remarks

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns