<!--
{
  "availability" : [
    "iOS: 12.0.0 -",
    "iPadOS: 12.0.0 -",
    "macCatalyst: 13.0.0 -",
    "macOS: 13.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 5.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "HealthKit",
  "identifier" : "/documentation/HealthKit/HKQuantitySeriesSampleBuilder",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "HealthKit"
    ],
    "preciseIdentifier" : "c:objc(cs)HKQuantitySeriesSampleBuilder"
  },
  "title" : "HKQuantitySeriesSampleBuilder"
}
-->

# HKQuantitySeriesSampleBuilder

A builder object for incrementally building a sample that contains multiple quantities.

```
class HKQuantitySeriesSampleBuilder
```

## Topics

### Creating a Quantity Series Builder

[`init(healthStore: HKHealthStore, quantityType: HKQuantityType, startDate: Date, device: HKDevice?)`](/documentation/HealthKit/HKQuantitySeriesSampleBuilder/init(healthStore:quantityType:startDate:device:))

Creates a new quantity series builder.

[`var quantityType: HKQuantityType`](/documentation/HealthKit/HKQuantitySeriesSampleBuilder/quantityType)

The quantity type for the series.

[`var startDate: Date`](/documentation/HealthKit/HKQuantitySeriesSampleBuilder/startDate)

The starting date and time for the sample.

[`var device: HKDevice?`](/documentation/HealthKit/HKQuantitySeriesSampleBuilder/device)

The device providing the data.

### Adding Values

[`func insert(HKQuantity, at: Date) throws`](/documentation/HealthKit/HKQuantitySeriesSampleBuilder/insert(_:at:))

Adds a new quantity to the series at the provided date and time.

[`func insert(HKQuantity, for: DateInterval) throws`](/documentation/HealthKit/HKQuantitySeriesSampleBuilder/insert(_:for:))

Adds a new quantity to the series with the provided date interval.

### Ending the Collection

[`func discard()`](/documentation/HealthKit/HKQuantitySeriesSampleBuilder/discard())

Discards all previously collected data and invalidates the builder.

[`func finishSeries(metadata: [String : Any]?, completion: ([HKQuantitySample]?, (any Error)?) -> Void)`](/documentation/HealthKit/HKQuantitySeriesSampleBuilder/finishSeries(metadata:completion:))

Finalizes the series and returns the resulting quantity samples.

[`func finishSeries(metadata: [String : Any]?, endDate: Date?, completion: ([HKQuantitySample]?, (any Error)?) -> Void)`](/documentation/HealthKit/HKQuantitySeriesSampleBuilder/finishSeries(metadata:endDate:completion:))

Finalizes the series with the provided end date, and returns the resulting quantity samples.

## Relationships

### Conforms To

[`NSObjectProtocol`](/documentation/ObjectiveC/NSObjectProtocol)

[`CustomStringConvertible`](/documentation/Swift/CustomStringConvertible)

[`CustomDebugStringConvertible`](/documentation/Swift/CustomDebugStringConvertible)

[`Hashable`](/documentation/Swift/Hashable)

[`SendableMetatype`](/documentation/Swift/SendableMetatype)

[`Equatable`](/documentation/Swift/Equatable)

[`CVarArg`](/documentation/Swift/CVarArg)

[`Sendable`](/documentation/Swift/Sendable)

### Inherits From

[`NSObject-swift.class`](/documentation/ObjectiveC/NSObject-swift.class)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)