> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IGranularitiesQuery

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/base/granularityRegistry.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Query describing which granularities to return.

**Signature:**

```typescript
export interface IGranularitiesQuery 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [calendars](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.igranularitiesquery/index.md#igranularitiesquerycalendars) |  | [CalendarContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.calendarcontext/index.md)[] | **_(ALPHA)_** The calendar(s) to resolve granularities for. Pass a single-element array for one calendar, or several to get their merged, de-duplicated union in canonical order — e.g. `standard` + `fiscal` for a "supported/available" superset. A single custom calendar preserves its own `enabledGranularities` order; a merge always uses the canonical registry order. |
| [families?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.igranularitiesquery/index.md#igranularitiesqueryfamilies) |  | [GranularityFamily](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.granularityfamily/index.md)[] | **_(ALPHA)_** _(Optional)_ Structural families to include. Defaults to `["chronological"]`; pass `["generic"]` for generic-only. |
| [includeNonDefault?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.igranularitiesquery/index.md#igranularitiesqueryincludenondefault) |  | boolean | **_(ALPHA)_** _(Optional)_ Include granularities that are not offered by default (`GDC.time.week`, EU-week variants). Defaults to `false`. |
| [includeShared?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.igranularitiesquery/index.md#igranularitiesqueryincludeshared) |  | boolean | **_(ALPHA)_** _(Optional)_ For a fiscal/custom calendar, also include shared granularities (week/date/time/…). Defaults to `true`. |
| [includeTime?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.igranularitiesquery/index.md#igranularitiesqueryincludetime) |  | boolean | **_(ALPHA)_** _(Optional)_ Include time-scale granularities (hour/minute/second and their generic forms). Defaults to `true`. |

## Property details

### IGranularitiesQuery.calendars

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The calendar(s) to resolve granularities for. Pass a single-element array for one calendar, or several to get their merged, de-duplicated union in canonical order — e.g. `standard` + `fiscal` for a "supported/available" superset. A single custom calendar preserves its own `enabledGranularities` order; a merge always uses the canonical registry order.

**Signature:**

```typescript
calendars: CalendarContext[];
```

### IGranularitiesQuery.families

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Structural families to include. Defaults to `["chronological"]`; pass `["generic"]` for generic-only.

**Signature:**

```typescript
families?: GranularityFamily[];
```

### IGranularitiesQuery.includeNonDefault

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Include granularities that are not offered by default (`GDC.time.week`, EU-week variants). Defaults to `false`.

**Signature:**

```typescript
includeNonDefault?: boolean;
```

### IGranularitiesQuery.includeShared

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

For a fiscal/custom calendar, also include shared granularities (week/date/time/…). Defaults to `true`.

**Signature:**

```typescript
includeShared?: boolean;
```

### IGranularitiesQuery.includeTime

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Include time-scale granularities (hour/minute/second and their generic forms). Defaults to `true`.

**Signature:**

```typescript
includeTime?: boolean;
```