> 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

View your tenant's usage: users, records, API calls, delivered records and media storage, with monthly snapshots of past usage.

## Get current utilization

> Returns your tenant's current usage: current counts and peaks for the current month. The API takes the tenant from your token.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Utilization","description":"View your tenant's usage: users, records, API calls, delivered records and media storage, with monthly snapshots of past usage."}],"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":"Your tenant's current utilization","type":"object","additionalProperties":false,"required":["data","jsonapi"],"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"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"UtilizationAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationAttributes","description":"Your tenant's current usage","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":"When utilization was last reconciled"},"updated":{"type":"string","format":"date-time","description":"Last update timestamp"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"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","description":"Returns your tenant's current usage: current counts and peaks for the current month. The API takes the tenant from your 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

> Lists your tenant's monthly utilization snapshots, most recent month first. The API takes the tenant from your token.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Utilization","description":"View your tenant's usage: users, records, API calls, delivered records and media storage, with monthly snapshots of past usage."}],"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":"A page of utilization snapshots","type":"object","additionalProperties":false,"required":["data","meta","links","jsonapi"],"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"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"UtilizationSnapshotAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotAttributes","description":"Usage for one month","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":"When the snapshot was taken"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"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","description":"Lists your tenant's monthly utilization snapshots, most recent month first. The API takes the tenant from your token.","operationId":"utilizationSnapshotFindMany","tags":["Utilization"],"parameters":[{"name":"page.limit","in":"query","description":"Maximum snapshots to return. Defaults to 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 utilization snapshot

> Returns one utilization snapshot by ID. The API takes the tenant from your token.

```json
{"openapi":"3.0.3","info":{"title":"Fabric API - Audit","version":"0.9.2817"},"tags":[{"name":"Utilization","description":"View your tenant's usage: users, records, API calls, delivered records and media storage, with monthly snapshots of past usage."}],"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":"A single utilization snapshot","type":"object","additionalProperties":false,"required":["data","links","jsonapi"],"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"}}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"UtilizationSnapshotAttributes":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IUtilizationSnapshotAttributes","description":"Usage for one month","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":"When the snapshot was taken"}}},"JsonApiVersion":{"type":"object","description":"The JSON:API version this document conforms to.","properties":{"version":{"type":"string"}},"required":["version"],"additionalProperties":false},"ErrorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IErrorResponse","description":"The body of a failed request: an `errors` array with one or more error objects.","type":"object","required":["errors","jsonapi"],"additionalProperties":false,"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"jsonapi":{"$ref":"#/components/schemas/JsonApiVersion"}}},"Error":{"$schema":"http://json-schema.org/draft-07/schema#","title":"IError","description":"One JSON:API error object. `status` is the HTTP status code as a string, `title` a short summary and `detail` optional context. `meta` can carry structured conflict or authorization details.","type":"object","additionalProperties":false,"required":["status","title"],"properties":{"status":{"type":"string"},"title":{"type":"string"},"code":{"type":"string","description":"A stable code for the problem that you can act on, when the operation documents one."},"detail":{"type":"string"},"source":{"type":"object","description":"A JSON Pointer to the request field that caused the error, such as `/data/attributes/title`.","properties":{"pointer":{"type":"string"}}},"meta":{"type":"object","additionalProperties":true,"properties":{"stack":{"type":"string","description":"The error's stack trace. Non-production environments only."},"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 utilization snapshot","description":"Returns one utilization snapshot by ID. The API takes the tenant from your 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"}}}}}}}}}
```
