> For the complete documentation index, see [llms.txt](https://knowledgebase.fabricdata.com/studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.fabricdata.com/studio/integrations-and-apis/origin-studio-production-api/utilization.md).

# Utilization

This API provides a way to view and manage utilization data for a Tenant. Utilization tracks resource usage including user counts, record counts, API calls, delivery records, and media storage. Monthly snapshots are created to preserve historical usage data for billing and analytics purposes.

## Get current utilization for a tenant

> Returns the current utilization data for a tenant including current counts, peak values for the current month, and plan information if set. The tenant ID is extracted from the authorization token.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2264"},"tags":[{"name":"Utilization","description":"This API provides a way to view and manage utilization data for a Tenant. Utilization tracks resource usage including user counts, record counts, API calls, delivery records, and media storage. Monthly snapshots are created to preserve historical usage data for billing and analytics purposes."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"UtilizationFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationFindOneResponse","description":"Response for getting current utilization","type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Utilization ID"},"type":{"type":"string","enum":["utilization"]},"attributes":{"$ref":"#/components/schemas/UtilizationAttributes"}}}}},"UtilizationAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationAttributes","description":"Attributes for current utilization data","type":"object","additionalProperties":false,"required":["userCount","recordCount","apiCallCount","deliveryRecordCount","mediaStorageBytes","currentMonthKey","peakUserCount","peakRecordCount","peakApiCallCount","peakDeliveryRecordCount","peakMediaStorageBytes"],"properties":{"currentMonthKey":{"type":"string","description":"Current month key in YYYY-MM format","pattern":"^\\d{4}-\\d{2}$"},"userCount":{"type":"integer","description":"Current number of users"},"recordCount":{"type":"integer","description":"Current number of records"},"apiCallCount":{"type":"integer","description":"Current number of API calls this month"},"deliveryRecordCount":{"type":"integer","description":"Current number of delivery records"},"mediaStorageBytes":{"type":"integer","description":"Current media storage usage in bytes"},"peakUserCount":{"type":"integer","description":"Peak user count for the current month"},"peakRecordCount":{"type":"integer","description":"Peak record count for the current month"},"peakApiCallCount":{"type":"integer","description":"Peak API call count for the current month"},"peakDeliveryRecordCount":{"type":"integer","description":"Peak delivery record count for the current month"},"peakMediaStorageBytes":{"type":"integer","description":"Peak media storage bytes for the current month"},"lastReconciledAt":{"type":"string","format":"date-time","description":"Last time utilization was reconciled"},"updated":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"Standard JSON:API error response returned when a request fails. Contains an `errors` array with one or more error objects (status, title, and optional detail).","type":"object","required":["errors"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"A single JSON:API error object. `status` is the HTTP status code as a string. `title` is a short, human-readable summary. `detail` provides optional context. `meta` may include structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error (e.g. `/data/attributes/title`).","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"Error stack trace. Only present in non-production environments."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/utilization":{"get":{"summary":"Get current utilization for a tenant","description":"Returns the current utilization data for a tenant including current counts, peak values for the current month, and plan information if set. The tenant ID is extracted from the authorization token.","operationId":"utilizationFindOne","tags":["Utilization"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtilizationFindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## List utilization snapshots for a tenant

> Returns a list of monthly utilization snapshots for a tenant, sorted by month in descending order (most recent first). The tenant ID is extracted from the authorization token.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2264"},"tags":[{"name":"Utilization","description":"This API provides a way to view and manage utilization data for a Tenant. Utilization tracks resource usage including user counts, record counts, API calls, delivery records, and media storage. Monthly snapshots are created to preserve historical usage data for billing and analytics purposes."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"UtilizationSnapshotFindManyResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotFindManyResponse","description":"Response for listing utilization snapshots","type":"object","additionalProperties":false,"required":["data","meta","links"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","attributes","links"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Snapshot ID"},"type":{"type":"string","enum":["utilizationSnapshots"]},"attributes":{"$ref":"#/components/schemas/UtilizationSnapshotAttributes"},"links":{"type":"object","required":["self"],"additionalProperties":false,"properties":{"self":{"type":"string","description":"Link to this snapshot"}}}}}},"meta":{"type":"object","required":["total"],"additionalProperties":false,"properties":{"total":{"type":"integer","description":"Total number of snapshots available"}}},"links":{"type":"object","required":["self"],"additionalProperties":false,"properties":{"self":{"type":"string","description":"Link to this resource"}}}}},"UtilizationSnapshotAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotAttributes","description":"Attributes for a utilization snapshot","type":"object","additionalProperties":false,"required":["tenantId","yearMonth","peakUserCount","peakRecordCount","peakApiCallCount","peakDeliveryRecordCount","peakMediaStorageBytes"],"properties":{"yearMonth":{"type":"string","description":"Month in YYYY-MM format","pattern":"^\\d{4}-\\d{2}$"},"plan":{"type":"string","description":"Plan name at the time of the snapshot"},"peakUserCount":{"type":"integer","description":"Peak user count for the month"},"peakRecordCount":{"type":"integer","description":"Peak record count for the month"},"peakApiCallCount":{"type":"integer","description":"Peak API call count for the month"},"peakDeliveryRecordCount":{"type":"integer","description":"Peak delivery record count for the month"},"peakMediaStorageBytes":{"type":"integer","description":"Peak media storage bytes for the month"},"endOfMonthUserCount":{"type":"integer","description":"User count at the end of the month"},"endOfMonthRecordCount":{"type":"integer","description":"Record count at the end of the month"},"endOfMonthDeliveryRecordCount":{"type":"integer","description":"Delivery record count at the end of the month"},"endOfMonthMediaStorageBytes":{"type":"integer","description":"Media storage bytes at the end of the month"},"created":{"type":"string","format":"date-time","description":"Snapshot creation timestamp"}}},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"Standard JSON:API error response returned when a request fails. Contains an `errors` array with one or more error objects (status, title, and optional detail).","type":"object","required":["errors"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"A single JSON:API error object. `status` is the HTTP status code as a string. `title` is a short, human-readable summary. `detail` provides optional context. `meta` may include structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error (e.g. `/data/attributes/title`).","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"Error stack trace. Only present in non-production environments."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/utilization/snapshots":{"get":{"summary":"List utilization snapshots for a tenant","description":"Returns a list of monthly utilization snapshots for a tenant, sorted by month in descending order (most recent first). The tenant ID is extracted from the authorization token.","operationId":"utilizationSnapshotFindMany","tags":["Utilization"],"parameters":[{"name":"page.limit","in":"query","description":"Maximum number of snapshots to return (default: 12)","schema":{"type":"integer","minimum":1,"maximum":100,"default":12}},{"name":"page.cursor","in":"query","description":"Cursor for pagination","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtilizationSnapshotFindManyResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Get a specific utilization snapshot

> Returns a single utilization snapshot by its ID. The tenant ID is extracted from the authorization token.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2264"},"tags":[{"name":"Utilization","description":"This API provides a way to view and manage utilization data for a Tenant. Utilization tracks resource usage including user counts, record counts, API calls, delivery records, and media storage. Monthly snapshots are created to preserve historical usage data for billing and analytics purposes."}],"servers":[{"url":"{protocol}://{domain}/{basePath}","variables":{"protocol":{"enum":["http","https"],"default":"https"},"domain":{"default":"api.studio.fabricdata.com"},"basePath":{"default":"v1"}}}],"security":[{"jwt-apikey-authorizer":[]}],"components":{"securitySchemes":{"jwt-apikey-authorizer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"UtilizationSnapshotFindOneResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotFindOneResponse","description":"Response for getting a single utilization snapshot","type":"object","additionalProperties":false,"required":["data","links"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"Snapshot ID"},"type":{"type":"string","enum":["utilizationSnapshots"]},"attributes":{"$ref":"#/components/schemas/UtilizationSnapshotAttributes"}}},"links":{"type":"object","required":["self"],"additionalProperties":false,"properties":{"self":{"type":"string","description":"Link to this snapshot"}}}}},"UtilizationSnapshotAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotAttributes","description":"Attributes for a utilization snapshot","type":"object","additionalProperties":false,"required":["tenantId","yearMonth","peakUserCount","peakRecordCount","peakApiCallCount","peakDeliveryRecordCount","peakMediaStorageBytes"],"properties":{"yearMonth":{"type":"string","description":"Month in YYYY-MM format","pattern":"^\\d{4}-\\d{2}$"},"plan":{"type":"string","description":"Plan name at the time of the snapshot"},"peakUserCount":{"type":"integer","description":"Peak user count for the month"},"peakRecordCount":{"type":"integer","description":"Peak record count for the month"},"peakApiCallCount":{"type":"integer","description":"Peak API call count for the month"},"peakDeliveryRecordCount":{"type":"integer","description":"Peak delivery record count for the month"},"peakMediaStorageBytes":{"type":"integer","description":"Peak media storage bytes for the month"},"endOfMonthUserCount":{"type":"integer","description":"User count at the end of the month"},"endOfMonthRecordCount":{"type":"integer","description":"Record count at the end of the month"},"endOfMonthDeliveryRecordCount":{"type":"integer","description":"Delivery record count at the end of the month"},"endOfMonthMediaStorageBytes":{"type":"integer","description":"Media storage bytes at the end of the month"},"created":{"type":"string","format":"date-time","description":"Snapshot creation timestamp"}}},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"Standard JSON:API error response returned when a request fails. Contains an `errors` array with one or more error objects (status, title, and optional detail).","type":"object","required":["errors"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"A single JSON:API error object. `status` is the HTTP status code as a string. `title` is a short, human-readable summary. `detail` provides optional context. `meta` may include structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error (e.g. `/data/attributes/title`).","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"Error stack trace. Only present in non-production environments."},"conflictItems":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"unauthorizedItems":{"type":"array","items":{"type":"string"}}}}}}}},"paths":{"/utilization/snapshots/{snapshotId}":{"get":{"summary":"Get a specific utilization snapshot","description":"Returns a single utilization snapshot by its ID. The tenant ID is extracted from the authorization token.","operationId":"utilizationSnapshotFindOne","tags":["Utilization"],"parameters":[{"name":"snapshotId","in":"path","required":true,"description":"The snapshot ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UtilizationSnapshotFindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```