---
metadata:
  - name: generator
    content: Diplodoc Platform v5.54.2
alternate:
  - https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/swift/AppMetricaConfiguration.md
  - https://appmetrica.yandex.by/docs/ru/sdk/ios/analytics/swift/AppMetricaConfiguration.md
  - href: en/sdk/ios/analytics/swift/AppMetricaConfiguration.md
    type: text/markdown
    title: Markdown version
  - href: ../../../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://appmetrica.yandex.by/docs/en/llms.txt

# AppMetricaConfiguration class

This class contains the extended startup configuration for the library.

The parameters of the extended configuration are applied from the time of library initialization.

## Instance methods {#instance_summary}

#|
|| [init?(apiKey:)](#method_initWithApiKey) | Initializes the instance of the `AppMetricaConfiguration` class with the specified API key. ||
|#

## Properties {#property_summary}

#|
|| [accurateLocationTracking](#property_accurateLocationTracking) | Enable/disable accurate location search for the internal location manager. ||
|| [allowsBackgroundLocationUpdates](#property_allowsBackgroundLocationUpdates) | Enable/disable background tracking of location updates. ||
|| [apiKey](#property_APIKey) | The API key of the app. ||
|| [appBuildNumber](#property_appBuildNumber) | Set an app build number for the AppMetrica report. ||
|| [appEnvironment](#property_appEnvironment) | Sets the app environment for all events from the moment of activation. ||
|| [appOpenTrackingEnabled](#property_appOpenTrackingEnabled) | Enables/disables the automatic collection and sending of data about app launches via a deeplink. ||
|| [appVersion](#property_appVersion) | App version. ||
|| [areLogsEnabled](#property_areLogsEnabled) | Enables/disables logging the activity of the library. ||
|| [customHosts](#property_customHosts) | Set proxy URLs for AppMetrica that will be used for startup queries. ||
|| [customLocation](#property_customLocation) | Sets custom location of the device. ||
|| [dataSendingEnabled](#property_dataSendingEnabled) | Enables/disables sending statistics to the AppMetrica server. ||
|| [dispatchPeriod](#property_dispatchPeriod) | Set a custom sending period. Interval in seconds between sending events to the server. ||
|| [handleActivationAsSessionStart](#property_handleActivationAsSessionStart) | Defines the AppMetrica SDK initialization as the beginning of a user session. This option is disabled by default. ||
|| [handleFirstActivationAsUpdate](#property_handleFirstActivationAsUpdate) | Defines the first launch of the app as an update. ||
|| [locationTracking](#property_locationTracking) | Enables/disables sending location of the device. ||
|| [maxReportsCount](#property_maxReportsCount) | Set the maximum number of stored events. ||
|| [maxReportsInDatabaseCount](#property_maxReportsInDatabaseCount) | The maximum number of error reports stored in the internal DB. ||
|| [preloadInfo](#property_preloadInfo) | Sets the instance of the [AppMetricaPreloadInfo](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/swift/AppMetricaPreloadInfo.md) class for tracking pre-installed apps. ||
|| [revenueAutoTrackingEnabled](#property_revenueAutoTrackingEnabled) | Enables/disables the automatic collection of information about in-app purchases. ||
|| [sessionTimeout](#property_sessionTimeout) | Sets the session timeout in seconds. ||
|| [sessionsAutoTracking](#property_sessionsAutoTracking) | Enables/disables automatic tracking of the app lifecycle. ||
|| [userProfileID](#property_userProfileID) | Sets the ID of the user profile (`ProfileID`) when activated. ||
|#

## Method descriptions {#method_detail}

### init?(apiKey:) {#method_initWithApiKey}

```swift translate=no
public init?(apiKey: String)
```

Initializes the instance of the `AppMetricaConfiguration` class with the specified API key.

**Parameters:**

#|
|| `apiKey` | The API key of the application. ||
|#

**Returns:**

The `AppMetricaConfiguration` class instance.

## Property descriptions {#property_detail}

### accurateLocationTracking {#property_accurateLocationTracking}

```swift translate=no
var accurateLocationTracking: Bool { get; set; }
```

Enable/disable accurate location search for the internal location manager. Disabled by default.

Active only if location tracking has been set to `true`, and the location isn't set manually.

### allowsBackgroundLocationUpdates {#property_allowsBackgroundLocationUpdates}

```swift translate=no
var allowsBackgroundLocationUpdates: Bool { get; set; }
```

Enable/disable background tracking of location updates. Disabled by default.

To enable background tracking of location updates, set the property to `true`.

### apiKey {#property_APIKey}

```swift translate=no
var apiKey: String { get; }
```

The API key of the application.

### appBuildNumber {#property_appBuildNumber}

```swift translate=no
var appBuildNumber: String? { get; set; }
```

Set an app build number for the AppMetrica report.

If not set, AppMetrica will use the app build number specified in the app configuration file `Info.plist` (`CFBundleVersion`).
The app build number must be a numeric string that can be converted to a positive integer.

### appEnvironment {#property_appEnvironment}

```swift translate=no
var appEnvironment: [String : String]? { get; set; }
```

Sets the app environment for all events from the moment of activation.

### appOpenTrackingEnabled {#property_appOpenTrackingEnabled}

```swift translate=no
var appOpenTrackingEnabled: Bool { get; set; }
```

Enables/disables the automatic collection and sending of data about app launches via a deeplink.

{% note alert %}

Starting with version 4.0 of the AppMetrica SDK for iOS, app openings via deeplinks are tracked automatically. For other versions, set up tracking manually:

- iOS AppMetrica SDK version below 4.0. [Setting up](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/ios-operations.md#ui-app-delegate) deeplink tracking for UIApplicationDelegate.
- [Setting up](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/ios-operations.md#ui-scene-delegate) deeplink tracking for UISceneDelegate (AppMetrica doesn't track such app openings automatically).

Automatic tracking captures only those deeplinks that resulted in app launches. To track deeplinks inside the running app, also set up [tracking](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/ios-operations.md).

{% endnote %}

The option is enabled by default.

Possible values:

- `true`: The mode of automatic collection and sending of data about the app launch via a deeplink is enabled.
- `false`: The mode of automatic collection and sending of data about the app launch via a deeplink is disabled.

### appVersion {#property_appVersion}

```swift translate=no
var appVersion: String? { get; set; }
```

App version.

### areLogsEnabled {#property_areLogsEnabled}

```swift translate=no
var areLogsEnabled: Bool { get; set; }
```

Enables/disables logging the activity of the library.

Logging is disabled by default.

### customHosts {#property_customHosts}

```swift translate=no
var customHosts: [Any]? { get; set; }
```

Set proxy URLs for AppMetrica that will be used for startup queries.

### customLocation {#property_customLocation}

```swift translate=no
var customLocation: CLLocation? { get; set; }
```

### dataSendingEnabled {#property_dataSendingEnabled}

```swift translate=no
var dataSendingEnabled: Bool { get; set; }
```

Sets custom location of the device.

### dispatchPeriod {#property_dispatchPeriod}

```swift translate=no
var dispatchPeriod: UInt { get; set; }
```

Set a custom sending period. Interval in seconds between sending events to the server.

By default, this is 90 seconds. Setting the value to 0 seconds prevents the library from automatically sending events using the timer.

### handleActivationAsSessionStart {#property_handleActivationAsSessionStart}

```swift translate=no
vat handleActivationAsSessionStart: Bool { get; set; }
```

Defines the AppMetrica SDK initialization as the beginning of a user session.

This option is disabled by default.

Possible values:

- `true`: The user session is created when the library is initialized.
- `false`: The background session is created when the library is initialized, and the user session is created after the [UIApplicationDidBecomeActiveNotification](https://developer.apple.com/documentation/uikit/uiapplicationdidbecomeactivenotification) system event.


### handleFirstActivationAsUpdate {#property_handleFirstActivationAsUpdate}

```swift translate=no
var handleFirstActivationAsUpdate: Bool { get; set; }
```

Defines the first launch of the app as an update.

{% note info %}

If the first launch of the app is defined as an update, the install is not shown as a new install in reports and is not attributed to partners.

{% endnote %}

Possible values:

- `true`: The first launch is defined as an update.
- `false`: The first launch is defined as a new install.

### locationTracking {#property_locationTracking}

```swift translate=no
var locationTracking: Bool { get; set; }
```

Enables/disables sending location of the device.

By default, sending is enabled.

### maxReportsCount {#property_maxReportsCount}

```swift translate=no
var maxReportsCount: UInt { get; set; }
```

Set the maximum number of stored events. The minimum number of cached events that causes reports to be sent automatically.

By default, events are sent automatically when there are at least 7 items in the storage.

Setting the value to 0 seconds prevents the library from automatically sending events upon reaching the set number of events in the storage.

### maxReportsInDatabaseCount {#property_maxReportsInDatabaseCount}

```swift translate=no
var maxReportsInDatabaseCount: UInt { get; set; }
```

The maximum number of error reports stored in the internal DB.

The allowed range of values is [100; 10,000]. Values outside this range are automatically replaced with values from the nearest range limits.

Default value: 1000.

{% note info %}

Separate databases are used for various `apiKeys` and independent limits on the number of events can be set for them. This parameter only affects the limitation for the corresponding `apiKey`. To change the maximum allowed number of events for other `apiKeys`, use [ReporterConfiguration.maxReportsInDatabaseCount](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/swift/ReporterConfiguration.md#property_maxReportsInDatabaseCount).

{% endnote %}

### preloadInfo {#property_preloadInfo}

```swift translate=no
var preloadInfo: AppMetricaPreloadInfo? { get; set; }
```

Sets the instance of the [AppMetricaPreloadInfo](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/swift/AppMetricaPreloadInfo.md) class for tracking pre-installed apps.

For more information, see [Tracking pre-installed apps](https://appmetrica.yandex.by/docs/en/mobile-tracking/preinstalled-app-attr.md).

### revenueAutoTrackingEnabled {#property_revenueAutoTrackingEnabled}

```swift translate=no
var revenueAutoTrackingEnabled: Bool { get; set; }
```

Enables/disables the automatic collection of information about In-App purchases.

The option is enabled by default.

Possible values:

- `true`: Automatic collection and sending of information about In-App purchases is enabled.
- `false`: Automatic collection and sending of information about In-App purchases is disabled.

### sessionTimeout {#property_sessionTimeout}

```swift translate=no
var sessionTimeout: UInt
```

Sets the session timeout in seconds.
The default value is `10` (minimum allowed value).

For more information about sessions, see [Tracking user activity](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/ios-listen.md).

### sessionsAutoTracking {#property_sessionsAutoTracking}

```swift translate=no
var sessionsAutoTracking: Bool { get; set; }
```

Enables/disables automatic tracking of the app lifecycle.

The option is enabled by default.

If the option is disabled, you need to manually set up session duration control using the [pauseSession()](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/swift/AppMetrica.md#method_pauseSession) and [resumeSession()](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/swift/AppMetrica.md#method_resumeSession) methods. For more information, see [Manual session tracking](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/ios-listen.md).

AppMetrica uses [UIApplicationDidBecomeActiveNotification](https://developer.apple.com/documentation/uikit/uiapplicationdidbecomeactivenotification) and [UIApplicationWillResignActiveNotification](https://developer.apple.com/documentation/uikit/uiapplicationwillresignactivenotification) to track sessions. The maximum session length is 24 hours. To extend the session after 24 hours, invoke the [resumeSession()](https://appmetrica.yandex.by/docs/en/sdk/ios/analytics/swift/AppMetrica.md#method_resumeSession) method manually.

### userProfileID {#property_userProfileID}

```swift translate=no
var userProfileID: String? { get; set; }
```

Sets the ID of the user profile (`ProfileID`) when activated.

{% note alert %}

The maximum length of the `ProfileID` string is 200 characters.

{% endnote %}