One Logo Pool Ball
System · IOS API REFERENCE

MetricKit

Measure your app’s performance using daily metric and diagnostic reports from real users.

120 types

427 callable entries

7 skipped

98% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

AppLaunchDiagnostic

struct · iOS 27.0+

ApplicationResumeTimeMetric

struct · iOS 27.0+

AveragePixelLuminance

class · iOS 27.0+

AverageStatistics

struct · iOS 27.0+

BackgroundTerminationMetric

struct · iOS 27.0+

CallStackFrame

struct · iOS 27.0+

CallStackThread

struct · iOS 27.0+

CallStackTree

struct · iOS 27.0+

CallStackTree.BinaryInfo

struct · iOS 27.0+

CellularConditionTimeMetric

struct · iOS 27.0+

CPUExceptionDiagnostic

struct · iOS 27.0+

CPUInstructionsCountMetric

struct · iOS 27.0+

CPUTimeMetric

struct · iOS 27.0+

CrashDiagnostic

struct · iOS 27.0+

CrashDiagnostic.ObjectiveCExceptionReason

struct · iOS 27.0+

CrashDiagnostic.TerminationCategory

struct · iOS 27.0+

CrashDiagnostic.TerminationCategory.RawValue

typealias · iOS 27.0+

CrashDiagnostic.TerminationReason

struct · iOS 27.0+

CrashDiagnostic.TerminationReason.RawValue

typealias · iOS 27.0+

DiagnosticReport

struct · iOS 27.0+

DiagnosticReport.Environment

struct · iOS 27.0+

DiagnosticResult

enum · iOS 27.0+

DiskWriteExceptionDiagnostic

struct · iOS 27.0+

ExtendedLaunchMetric

struct · iOS 27.0+

ForegroundTerminationMetric

struct · iOS 27.0+

GPUTimeMetric

struct · iOS 27.0+

HangDiagnostic

struct · iOS 27.0+

HangTimeMetric

struct · iOS 27.0+

Histogram

struct · iOS 27.0+

Histogram.Bucket

struct · iOS 27.0+

HitchTimeMetric

struct · iOS 27.0+

HitchTimeRatio

class · iOS 27.0+

LaunchTaskID

struct · iOS 27.0+

LaunchTaskID.ExtendedGraphemeClusterLiteralType

typealias · iOS 27.0+

LaunchTaskID.RawValue

typealias · iOS 27.0+

LaunchTaskID.StringLiteralType

typealias · iOS 27.0+

LaunchTaskID.UnicodeScalarLiteralType

typealias · iOS 27.0+

LocationActivityTimeMetric

struct · iOS 27.0+

LogicalDiskWritesMetric

struct · iOS 27.0+

MemoryExceptionDiagnostic

struct · iOS 27.0+

MetalFrameRateMetric

struct · iOS 27.0+

MetricGroup

struct · iOS 27.0+

MetricGroup.RawValue

typealias · iOS 27.0+

MetricManager

class · iOS 27.0+

MetricManager.LaunchTaskError

struct · iOS 27.0+

MetricManager.LaunchTaskError.Reason

enum · iOS 27.0+

MetricManager.LaunchTaskError.Reason.RawValue

typealias · iOS 27.0+

MetricManager.ReportedState

struct · iOS 27.0+

MetricReport

struct · iOS 27.0+

MetricReport.EncodingFormat

enum · iOS 27.0+

MetricReport.Environment

struct · iOS 27.0+

MetricReport.IntervalEntry

struct · iOS 27.0+

MetricReport.StateEntry

struct · iOS 27.0+

MetricResult

enum · iOS 27.0+

MXAnimationMetric

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXAppExitMetric

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXAppLaunchDiagnostic

class · iOS 16.0+ · Deprecated in iOS 100000.0

MXAppLaunchMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXAppResponsivenessMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXAppRunTimeMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXAverage

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXBackgroundExitData

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXCallStackTree

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXCellularConditionMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXCPUExceptionDiagnostic

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXCPUMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXCrashDiagnostic

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXCrashDiagnosticObjectiveCExceptionReason

class · iOS 17.0+ · Deprecated in iOS 100000.0

MXDiagnostic

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXDiagnosticPayload

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXDiskIOMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXDiskSpaceUsageMetric

class · iOS 26.0+ · Deprecated in iOS 100000.0

MXDiskWriteExceptionDiagnostic

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXDisplayMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXError

struct · iOS 16.0+ · Deprecated in iOS 100000.0

MXError.Code

enum · iOS 16.0+ · Deprecated in iOS 100000.0

MXForegroundExitData

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXGPUMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXHangDiagnostic

class · iOS 14.0+ · Deprecated in iOS 100000.0

MXHistogram

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXHistogramBucket

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXLaunchTaskID

struct · iOS 16.0+ · Deprecated in iOS 100000.0

MXLocationActivityMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXMemoryMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXMetaData

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXMetricManager

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXMetricManagerSubscriber

protocol · iOS 13.0+ · Deprecated in iOS 100000.0

MXMetricPayload

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXNetworkTransferMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXSignpostIntervalData

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXSignpostMetric

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXSignpostRecord

class · iOS 17.0+ · Deprecated in iOS 100000.0

MXUnitAveragePixelLuminance

class · iOS 13.0+ · Deprecated in iOS 100000.0

MXUnitSignalBars

class · iOS 13.0+ · Deprecated in iOS 100000.0

OptimizedTimeToFirstDrawMetric

struct · iOS 27.0+

OSVersion

struct · iOS 27.0+

PeakMemoryMetric

struct · iOS 27.0+

PixelLuminanceMetric

struct · iOS 27.0+

SignalBars

class · iOS 27.0+

SignpostIntervalMetric

struct · iOS 27.0+

SignpostRecord

struct · iOS 27.0+

StateReportingDomain

struct · iOS 27.0+

StateReportingDomain.ExtendedGraphemeClusterLiteralType

typealias · iOS 27.0+

StateReportingDomain.RawValue

typealias · iOS 27.0+

StateReportingDomain.StringLiteralType

typealias · iOS 27.0+

StateReportingDomain.UnicodeScalarLiteralType

typealias · iOS 27.0+

SuspendedMemoryMetric

struct · iOS 27.0+

TimeToFirstDrawMetric

struct · iOS 27.0+

TotalBackgroundAudioTimeMetric

struct · iOS 27.0+

TotalBackgroundLocationTimeMetric

struct · iOS 27.0+

TotalBackgroundTimeMetric

struct · iOS 27.0+

TotalCellularDownloadMetric

struct · iOS 27.0+

TotalCellularUploadMetric

struct · iOS 27.0+

TotalDiskSpaceCapacityMetric

struct · iOS 27.0+

TotalFileCountMetric

struct · iOS 27.0+

TotalFileSizeMetric

struct · iOS 27.0+

TotalForegroundTimeMetric

struct · iOS 27.0+

TotalWiFiDownloadMetric

struct · iOS 27.0+

TotalWiFiUploadMetric

struct · iOS 27.0+

Functions and constants

get · iOS 16.0+ · Deprecated in iOS 100000.0

MXErrorDomain

TypeScript
const MXErrorDomain: string
Swift declaration
let MXErrorDomain: String
init

init

TypeScript
static init(): MXAverage<_Foundation_Unit>
Swift declaration
init()
get · iOS 13.0+ · Deprecated in iOS 100000.0

averageMeasurement

TypeScript
get averageMeasurement(): _Foundation_Measurement<_Foundation_Unit>
Swift declaration
var averageMeasurement: Measurement<UnitType> { get }
get · iOS 13.0+ · Deprecated in iOS 100000.0

sampleCount

TypeScript
get sampleCount(): number
Swift declaration
var sampleCount: Int { get }
get · iOS 13.0+ · Deprecated in iOS 100000.0

standardDeviation

TypeScript
get standardDeviation(): number
Swift declaration
var standardDeviation: Double { get }
init

init

TypeScript
static init(): MXHistogram<_Foundation_Unit>
Swift declaration
init()
get · iOS 13.0+ · Deprecated in iOS 100000.0

bucketEnumerator

TypeScript
get bucketEnumerator(): _Foundation_NSEnumerator
Swift declaration
var bucketEnumerator: NSEnumerator { get }
get · iOS 13.0+ · Deprecated in iOS 100000.0

totalBucketCount

TypeScript
get totalBucketCount(): number
Swift declaration
var totalBucketCount: Int { get }
init

init

TypeScript
static init(): MXHistogramBucket<_Foundation_Unit>
Swift declaration
init()
get · iOS 13.0+ · Deprecated in iOS 100000.0

bucketCount

TypeScript
get bucketCount(): number
Swift declaration
var bucketCount: Int { get }
get · iOS 13.0+ · Deprecated in iOS 100000.0

bucketEnd

TypeScript
get bucketEnd(): _Foundation_Measurement<_Foundation_Unit>
Swift declaration
var bucketEnd: Measurement<UnitType> { get }
get · iOS 13.0+ · Deprecated in iOS 100000.0

bucketStart

TypeScript
get bucketStart(): _Foundation_Measurement<_Foundation_Unit>
Swift declaration
var bucketStart: Measurement<UnitType> { get }
function · iOS 13.0+

mxSignpost

TypeScript
mxSignpost(type: SDKHandle, log: SDKHandle, name: SDKHandle, signpostID?: SDKHandle, format?: SDKHandle, arguments_?: Array<SDKHandle>): void
Swift declaration
func mxSignpost(_ type: OSSignpostType, dso: UnsafeRawPointer = #dsohandle, log: OSLog, name: StaticString, signpostID: OSSignpostID = .exclusive, _ format: StaticString = "%{public}s", _ arguments: [any CVarArg] = ["NO_METRICS"])
get · iOS 27.0+

standardDeviation

TypeScript
get standardDeviation(): (number) | null
Swift declaration
let standardDeviation: Double?

The standard deviation of the distribution of values used to calculate the average. This value is `nil` when the standard deviation is not available.

get · iOS 27.0+

count

TypeScript
get count(): number
Swift declaration
let count: Int

The number of samples used to calculate the average.

get · iOS 27.0+

average

TypeScript
get average(): _Foundation_Measurement<_Foundation_Dimension>
Swift declaration
let average: Measurement<DimensionType>

The average measurement value.

function · iOS 15.0+

mxSignpostAnimationIntervalBegin

TypeScript
mxSignpostAnimationIntervalBegin(log: SDKHandle, name: SDKHandle, signpostID?: SDKHandle, format?: SDKHandle, arguments_?: Array<SDKHandle>): void
Swift declaration
func mxSignpostAnimationIntervalBegin(dso: UnsafeRawPointer = #dsohandle, log: OSLog, name: StaticString, signpostID: OSSignpostID = .exclusive, _ format: StaticString = "%{public}s", _ arguments: [any CVarArg] = ["NO_METRICS"])
get · iOS 27.0+

lowerBound

TypeScript
get lowerBound(): _Foundation_Measurement<_Foundation_Dimension>
Swift declaration
let lowerBound: Measurement<DimensionType>
get · iOS 27.0+

upperBound

TypeScript
get upperBound(): _Foundation_Measurement<_Foundation_Dimension>
Swift declaration
let upperBound: Measurement<DimensionType>
get · iOS 27.0+

count

TypeScript
get count(): number
Swift declaration
let count: Int
get · iOS 27.0+

buckets

TypeScript
get buckets(): Array<Histogram_Bucket<_Foundation_Dimension>>
Swift declaration
let buckets: [Histogram<DimensionType>.Bucket]

Skipped declarations

7 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

Array.byStateReportingDomain

The containing type is outside the generated SDK type index.

Array.fullDayEntry

The containing type is outside the generated SDK type index.

Array.byStateReportingDomain

The containing type is outside the generated SDK type index.

MetricManager.trackLaunchTask(id:onTrackingError:_:)

synchronous callback requires a nonescaping JS-thread call

StateReportingDomain.init(codingKey:)

This declaration needs Swift generic type arguments. (no canonical witness for T)

MXUnitAveragePixelLuminance.init()

inherited init: clang: 'init' is unavailable

MXUnitSignalBars.init()

inherited init: clang: 'init' is unavailable