# GetUsageAnalyticsRequest

## Example Usage

```typescript
import { GetUsageAnalyticsRequest } from "@flexprice/sdk/sdk/models";

let value: GetUsageAnalyticsRequest = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                | Type                                                                                                                                                                                                                                                                                                 | Required                                                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                                                                                          |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `breakdownBucket`                                                                                                                                                                                                                                                                                    | *boolean*                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | BreakdownBucket when true augments each time-series point with BucketID/PriceID<br/>and appends a BucketSummaries rollup to each item. Requires WindowSize to be set<br/>and the item to be linked to a subscription line item that has CommitmentTimeBuckets.<br/>Default: false (opt-in, backward compatible). |
| `endTime`                                                                                                                                                                                                                                                                                            | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                                                  |
| `expand`                                                                                                                                                                                                                                                                                             | *string*[]                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | allowed values: "price", "meter", "feature", "subscription_line_item","plan","addon"                                                                                                                                                                                                                 |
| `externalCustomerId`                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | ExternalCustomerID is the single external customer ID.<br/>Optional when ExternalCustomerIDs is provided; required otherwise.                                                                                                                                                                        |
| `featureIds`                                                                                                                                                                                                                                                                                         | *string*[]                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                                                  |
| `groupBy`                                                                                                                                                                                                                                                                                            | *string*[]                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | allowed values: "source", "feature_id", "properties.<field_name>"                                                                                                                                                                                                                                    |
| `includeChildren`                                                                                                                                                                                                                                                                                    | *boolean*                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | IncludeChildren when true folds child customers' usage into the single aggregated total.<br/>Default: false.                                                                                                                                                                                         |
| `propertyFilters`                                                                                                                                                                                                                                                                                    | Record<string, *string*[]>                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | Property filters to filter the events by the keys in `properties` field of the event                                                                                                                                                                                                                 |
| `sources`                                                                                                                                                                                                                                                                                            | *string*[]                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                                                  |
| `startTime`                                                                                                                                                                                                                                                                                          | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                                                  |
| `windowSize`                                                                                                                                                                                                                                                                                         | [models.WindowSize](../../sdk/models/window-size.md)                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                   | N/A                                                                                                                                                                                                                                                                                                  |