PostHog iOS SDK

Use this method to track user behavior or other occurrences in your application.

Use this method to track user behavior or other occurrences, including additional context about the event and the user.

The SDK normally flushes events automatically based on and configuration. Call this method to force an immediate dispatch of events.

This is a convenience method for without additional properties.

Use this method to manually track screen changes in your application, especially for SwiftUI apps where automatic screen view tracking might not provide meaningful names.

Enable debug mode to see detailed logs about event capture, feature flag evaluation, surveys, and other internal workings of the SDK. This is useful for troubleshooting during development.

Use this method to track user activity within a particular group (e.g., a company or team).

This method allows you to track user activity within a group while simultaneously setting or updating properties associated with that group.

The value of the feature flag (e.g., , ), or if the flag is not found.

The payload of the feature flag, or if no payload is associated or the flag is not found.

if the feature flag is enabled, otherwise.

Feature flag values are cached. Call this method to refetch the latest flag values from the server if something has changed with your user (e.g., properties updated).

Use this method to refetch the latest flag values and perform actions immediately after the flags have been successfully reloaded.

Clears all group properties for feature flag evaluation.

Clears group properties for feature flag evaluation for a specific group type.

After calling this method, feature flag evaluation will only use server-side person properties and will not include any locally overridden properties.

Sets properties for a specific group type to include when evaluating feature flags. These properties supplement the standard group information sent to PostHog for flag evaluation, providing additional context that can be used in flag targeting conditions.

Sets properties for a specific group type to include when evaluating feature flags. These properties supplement the standard group information sent to PostHog for flag evaluation, providing additional context that can be used in flag targeting conditions.

This method allows you to override server-side person properties for immediate feature flag evaluation, solving the race condition where person properties from calls may not have been processed by the server yet. Properties are merged additively with existing properties. Feature flags are automatically reloaded after setting properties.

This method allows you to override server-side person properties for immediate feature flag evaluation, solving the race condition where person properties from calls may not have been processed by the server yet. Properties are merged additively with existing properties.

Use this method when you want to associate multiple distinct IDs with a single user, for example, if a distinct ID used on the frontend is not available in your backend.

The current user’s distinct ID.

This is a convenience method for without additional properties. You should call this method as soon as you are able to identify your user, typically after they log in.

Use this method to gain insights into how your users interact with your product across sessions, devices, and platforms. All previously tracked anonymous events will be linked to this user.

if the user is opted out, otherwise.

This method allows a previously opted-out user to resume data capture.

When a user is opted out, no events, session replays, or other data will be captured.

This method is typically called after a user logs out to disassociate their activity from previous sessions and prepare for a new, potentially anonymous, user journey.

Optional appearance configuration for customizing the survey’s look and feel

Optional date indicating when the survey should stop being shown

Unique identifier for the survey

Name of the survey

Array of questions to be presented in the survey

Optional date indicating when the survey should start being shown

The URL that will be opened when the link is clicked

The list of options for the user to choose from

Whether the question includes an “other” option for users to input free-form text

Whether the user can select multiple options

Whether the options should be shuffled to randomize the order

Whether all questions have been answered and the survey is complete Depending on the survey appearance configuration, you may want to show the “Thank you” message or dismiss the survey at this point

The index of the next question to be displayed (0-based)

Whether a link was clicked (for link questions)

The numeric rating value (for rating questions)

The selected options (for multiple or single choice questions)

The text response (for open questions)

The type of response (link, rating, text, or multiple choice)

Creates a response for a link question

Creates a response for a multiple-choice question

Creates a response for an open-ended question

Creates a response for a rating question

Creates a response for a single-choice question

Optional custom text for the question’s action button

The question ID, empty if none

Whether the question can be skipped

The main question text to display

Optional additional description or context for the question

Content type for the question description (HTML or plain text)

Defaults to which provides a standard survey UI.

The label for the lower bound of the rating scale

The type of rating scale (numbers, emoji)

The lower bound of the rating scale

The upper bound of the rating scale

The label for the upper bound of the rating scale

Optional background color as web color (e.g. “#FFFFFF” or “white”)

Optional border color as web color

Optional color for description text as web color

Whether to show a thank you message after survey completion

Optional font family to use throughout the survey

Optional placeholder text for input fields

Optional color for active/selected rating buttons as web color