Admin only (an Admin API key or the account owner). Returns how the account’s nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.
One row per active API key (customer) on the account.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"NestAPI Documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/dev-nestapi/UAxgnvyRVTOip4yc/images/logo-light.svg?fit=max\u0026auto=format\u0026n=UAxgnvyRVTOip4yc\u0026q=85\u0026s=570d4e4a3fdf3b7f0ba2c4034ec4d91d","dark":"https://mintcdn.com/dev-nestapi/UAxgnvyRVTOip4yc/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=UAxgnvyRVTOip4yc\u0026q=85\u0026s=af74b596120cc6670cf3eb61fc8a0308"},"favicon":"https://mintcdn.com/dev-nestapi/UAxgnvyRVTOip4yc/images/favicon.svg?fit=max\u0026auto=format\u0026n=UAxgnvyRVTOip4yc\u0026q=85\u0026s=3cba8c02399d1d5f6404e423bfbeb50b","navbar":{"links":[{"href":"https://app.nestapi.com/","label":"Sign Up for Trial"}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dev-nestapi","hasAudioNarration":false,"actualSubdomain":"dev-nestapi","customDomains":["dev-docs.nestapi.com"],"gitSource":{"type":"github","owner":"efficientsoftwareltd","repo":"efficient.nestapi.docs","deployBranch":"development","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"3297fa10-1420-4d22-8ecf-27bc4484dabe","liveDeploymentHistoryId":"6ae8cdd7744d76616a182d9a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae8cdd7744d76616a182d9a"},"entitlements":{},"buildId":"6ae8cdd7744d76616a182d9a","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Account \u0026 keys","count":12},{"language":"default","tag":"Nesting","count":7},{"language":"default","tag":"Results \u0026 exports","count":6},{"language":"default","tag":"Concepts","count":5},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Run \u0026 track","count":5},{"language":"default","tag":"Fairness","count":4},{"language":"default","tag":"Account","count":3},{"language":"default","tag":"Getting Started","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/fairness/per-customer-nesting-minutes-usage-breakdown","slug":"/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown","pageMetadata":{"title":"Per-customer nesting-minutes usage breakdown","description":"Admin only (an Admin API key or the account owner). Returns how the account's nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.","deprecated":false,"version":null,"openapi":"/openapi.json get /usage/fairness","href":"/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Admin only (an Admin API key or the account owner). Returns how the account’s nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Per-customer nesting-minutes usage breakdown","description":"Admin only (an Admin API key or the account owner). Returns how the account's nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.","deprecated":false,"version":null,"openapi":"/openapi.json get /usage/fairness","href":"/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["fairness"],"summary":"Per-customer nesting-minutes usage breakdown","description":"Admin only (an Admin API key or the account owner). Returns how the account's nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.","operationId":"GetFairnessUsage","responses":{"200":"e98e9e41-0e9a-459d-9114-b71297d3ce9a","401":"cf4f4bd6-91ea-4e83-8e1f-2794273070b4","403":"70b340b3-208f-424d-ad14-1cbbc7d2eb82"},"deprecated":false,"security":["3f9f3e41-ede7-46ef-b79f-aab3658d61d0"],"method":"get","type":"path","servers":["c175ddad-c41d-4997-b792-998af09e95a1"],"path":"/usage/fairness","baseUrlOptions":["https://dev.api.nestapi.com"],"title":"Per-customer nesting-minutes usage breakdown","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8d0cb11d-6ecf-4576-821f-484cfb4f20d6":{"name":"Accept","in":"header","description":"Accept Header","required":true,"schema":{"type":"string","enum":["application/json"],"isRequired":true,"description":"Accept Header","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"e98e9e41-0e9a-459d-9114-b71297d3ce9a":{"description":"The per-customer usage breakdown for the current period.","content":{"application/json":{"schema":{"title":"FairnessUsageResponse","properties":{"FairnessEnabled":{"description":"Whether the second (per-customer) admission gate is active for this account.","type":"boolean","nullable":false,"uniqueKey":"FairnessEnabled","typeLabel":"boolean"},"OverageEnabled":{"description":"Whether over-share nests spill into overage rather than being rejected.","type":"boolean","nullable":false,"uniqueKey":"OverageEnabled","typeLabel":"boolean"},"IncludedMinutes":{"description":"The account's included nesting minutes for the current period.","type":"number","format":"double","nullable":false,"uniqueKey":"IncludedMinutes","typeLabel":"number\u003cdouble>"},"SharedBurstMinutes":{"description":"The shared, first-come burst pool (a fixed fraction of the included minutes) any key may draw from once over its own floor.","type":"number","format":"double","nullable":false,"uniqueKey":"SharedBurstMinutes","typeLabel":"number\u003cdouble>"},"Keys":{"description":"One row per active API key (customer) on the account.","type":"array","items":{"title":"FairnessKeyUsage","properties":{"ApiKeyId":{"description":"Your API key id — the customer this row is for. (The internal lineage id is never exposed.)","type":"string","uniqueKey":"Keys.items.[INDEX].ApiKeyId","typeLabel":"string"},"Weight":{"description":"Fairness weight applied to this key (per-key override, else the plan default).","type":"integer","format":"int32","nullable":false,"uniqueKey":"Keys.items.[INDEX].Weight","typeLabel":"integer\u003cint32>"},"ConsumedMinutes":{"description":"Minutes settled within the account's included budget this period.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].ConsumedMinutes","typeLabel":"number\u003cdouble>"},"ReservedMinutes":{"description":"Minutes currently reserved for in-flight nests this period.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].ReservedMinutes","typeLabel":"number\u003cdouble>"},"OverageMinutes":{"description":"Minutes this key ran beyond the account's included budget (overage), attributed to it.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].OverageMinutes","typeLabel":"number\u003cdouble>"},"EffectiveFloorMinutes":{"description":"This key's guaranteed, reserved floor (weight / Σweights × the reserved floor pool). It can also draw from the shared burst pool on top of this.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].EffectiveFloorMinutes","typeLabel":"number\u003cdouble>"},"Sizing":{"description":"Right-sizing hint: \"undersized\" (hitting overage — needs more), \"oversized\" (chronic forfeiture — has too much), or \"balanced\".","type":"string","uniqueKey":"Keys.items.[INDEX].Sizing","typeLabel":"string"}},"description":"FairnessKeyUsage","type":"object","uniqueKey":"Keys.items.[INDEX]","typeLabel":"FairnessKeyUsage · object"},"uniqueKey":"Keys","typeLabel":"FairnessKeyUsage · object[]"}},"description":"FairnessUsageResponse","type":"object","uniqueKey":"","typeLabel":"FairnessUsageResponse · object"},"examples":{"Example":{"title":"Example","value":{"FairnessEnabled":true,"OverageEnabled":true,"IncludedMinutes":123,"SharedBurstMinutes":123,"Keys":[{"ApiKeyId":"\u003cstring>","Weight":123,"ConsumedMinutes":123,"ReservedMinutes":123,"OverageMinutes":123,"EffectiveFloorMinutes":123,"Sizing":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"cf4f4bd6-91ea-4e83-8e1f-2794273070b4":{"description":"API key is missing or invalid.","content":{"application/json":{"schema":{"title":"FairnessUsageResponse","properties":{"FairnessEnabled":{"description":"Whether the second (per-customer) admission gate is active for this account.","type":"boolean","nullable":false,"uniqueKey":"FairnessEnabled","typeLabel":"boolean"},"OverageEnabled":{"description":"Whether over-share nests spill into overage rather than being rejected.","type":"boolean","nullable":false,"uniqueKey":"OverageEnabled","typeLabel":"boolean"},"IncludedMinutes":{"description":"The account's included nesting minutes for the current period.","type":"number","format":"double","nullable":false,"uniqueKey":"IncludedMinutes","typeLabel":"number\u003cdouble>"},"SharedBurstMinutes":{"description":"The shared, first-come burst pool (a fixed fraction of the included minutes) any key may draw from once over its own floor.","type":"number","format":"double","nullable":false,"uniqueKey":"SharedBurstMinutes","typeLabel":"number\u003cdouble>"},"Keys":{"description":"One row per active API key (customer) on the account.","type":"array","items":{"title":"FairnessKeyUsage","properties":{"ApiKeyId":{"description":"Your API key id — the customer this row is for. (The internal lineage id is never exposed.)","type":"string","uniqueKey":"Keys.items.[INDEX].ApiKeyId","typeLabel":"string"},"Weight":{"description":"Fairness weight applied to this key (per-key override, else the plan default).","type":"integer","format":"int32","nullable":false,"uniqueKey":"Keys.items.[INDEX].Weight","typeLabel":"integer\u003cint32>"},"ConsumedMinutes":{"description":"Minutes settled within the account's included budget this period.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].ConsumedMinutes","typeLabel":"number\u003cdouble>"},"ReservedMinutes":{"description":"Minutes currently reserved for in-flight nests this period.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].ReservedMinutes","typeLabel":"number\u003cdouble>"},"OverageMinutes":{"description":"Minutes this key ran beyond the account's included budget (overage), attributed to it.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].OverageMinutes","typeLabel":"number\u003cdouble>"},"EffectiveFloorMinutes":{"description":"This key's guaranteed, reserved floor (weight / Σweights × the reserved floor pool). It can also draw from the shared burst pool on top of this.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].EffectiveFloorMinutes","typeLabel":"number\u003cdouble>"},"Sizing":{"description":"Right-sizing hint: \"undersized\" (hitting overage — needs more), \"oversized\" (chronic forfeiture — has too much), or \"balanced\".","type":"string","uniqueKey":"Keys.items.[INDEX].Sizing","typeLabel":"string"}},"description":"FairnessKeyUsage","type":"object","uniqueKey":"Keys.items.[INDEX]","typeLabel":"FairnessKeyUsage · object"},"uniqueKey":"Keys","typeLabel":"FairnessKeyUsage · object[]"}},"description":"FairnessUsageResponse","type":"object","uniqueKey":"","typeLabel":"FairnessUsageResponse · object"},"examples":{"Example":{"title":"Example","value":{"FairnessEnabled":true,"OverageEnabled":true,"IncludedMinutes":123,"SharedBurstMinutes":123,"Keys":[{"ApiKeyId":"\u003cstring>","Weight":123,"ConsumedMinutes":123,"ReservedMinutes":123,"OverageMinutes":123,"EffectiveFloorMinutes":123,"Sizing":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"70b340b3-208f-424d-ad14-1cbbc7d2eb82":{"description":"The calling key is not an Admin key.","content":{"application/json":{"schema":{"title":"FairnessUsageResponse","properties":{"FairnessEnabled":{"description":"Whether the second (per-customer) admission gate is active for this account.","type":"boolean","nullable":false,"uniqueKey":"FairnessEnabled","typeLabel":"boolean"},"OverageEnabled":{"description":"Whether over-share nests spill into overage rather than being rejected.","type":"boolean","nullable":false,"uniqueKey":"OverageEnabled","typeLabel":"boolean"},"IncludedMinutes":{"description":"The account's included nesting minutes for the current period.","type":"number","format":"double","nullable":false,"uniqueKey":"IncludedMinutes","typeLabel":"number\u003cdouble>"},"SharedBurstMinutes":{"description":"The shared, first-come burst pool (a fixed fraction of the included minutes) any key may draw from once over its own floor.","type":"number","format":"double","nullable":false,"uniqueKey":"SharedBurstMinutes","typeLabel":"number\u003cdouble>"},"Keys":{"description":"One row per active API key (customer) on the account.","type":"array","items":{"title":"FairnessKeyUsage","properties":{"ApiKeyId":{"description":"Your API key id — the customer this row is for. (The internal lineage id is never exposed.)","type":"string","uniqueKey":"Keys.items.[INDEX].ApiKeyId","typeLabel":"string"},"Weight":{"description":"Fairness weight applied to this key (per-key override, else the plan default).","type":"integer","format":"int32","nullable":false,"uniqueKey":"Keys.items.[INDEX].Weight","typeLabel":"integer\u003cint32>"},"ConsumedMinutes":{"description":"Minutes settled within the account's included budget this period.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].ConsumedMinutes","typeLabel":"number\u003cdouble>"},"ReservedMinutes":{"description":"Minutes currently reserved for in-flight nests this period.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].ReservedMinutes","typeLabel":"number\u003cdouble>"},"OverageMinutes":{"description":"Minutes this key ran beyond the account's included budget (overage), attributed to it.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].OverageMinutes","typeLabel":"number\u003cdouble>"},"EffectiveFloorMinutes":{"description":"This key's guaranteed, reserved floor (weight / Σweights × the reserved floor pool). It can also draw from the shared burst pool on top of this.","type":"number","format":"double","nullable":false,"uniqueKey":"Keys.items.[INDEX].EffectiveFloorMinutes","typeLabel":"number\u003cdouble>"},"Sizing":{"description":"Right-sizing hint: \"undersized\" (hitting overage — needs more), \"oversized\" (chronic forfeiture — has too much), or \"balanced\".","type":"string","uniqueKey":"Keys.items.[INDEX].Sizing","typeLabel":"string"}},"description":"FairnessKeyUsage","type":"object","uniqueKey":"Keys.items.[INDEX]","typeLabel":"FairnessKeyUsage · object"},"uniqueKey":"Keys","typeLabel":"FairnessKeyUsage · object[]"}},"description":"FairnessUsageResponse","type":"object","uniqueKey":"","typeLabel":"FairnessUsageResponse · object"},"examples":{"Example":{"title":"Example","value":{"FairnessEnabled":true,"OverageEnabled":true,"IncludedMinutes":123,"SharedBurstMinutes":123,"Keys":[{"ApiKeyId":"\u003cstring>","Weight":123,"ConsumedMinutes":123,"ReservedMinutes":123,"OverageMinutes":123,"EffectiveFloorMinutes":123,"Sizing":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3f9f3e41-ede7-46ef-b79f-aab3658d61d0":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header","scopes":[],"schemeName":"Bearer"}}},"servers":{"c175ddad-c41d-4997-b792-998af09e95a1":{"url":"https://dev.api.nestapi.com","description":"Staging"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Authorization","in":"header","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"dev-nestapi","siteName":"NestAPI Documentation","title":"Per-customer nesting-minutes usage breakdown - NestAPI Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T17:52:28.499Z","originalFileLocation":"api-reference/fairness/per-customer-nesting-minutes-usage-breakdown.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Admin only (an Admin API key or the account owner). Returns how the account\u0026#x27;s nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.\">\u003cmeta data-mint-head name=\"application-name\" content=\"NestAPI Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Per-customer nesting-minutes usage breakdown - NestAPI Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Admin only (an Admin API key or the account owner). Returns how the account\u0026#x27;s nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"NestAPI Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dev-nestapi.mintlify.app/_mintlify/api/og/v2?division=Fairness\u0026amp;title=Per-customer+nesting-minutes+usage+breakdown\u0026amp;description=Admin+only+%28an+Admin+API+key+or+the+account+owner%29.+Returns+how+the+account%27s+nesting+minutes+are+being+shared+across+your+API+keys+for+the+current+period.+Each\u0026amp;theme=73f7472777e17440bdf0549e\u0026amp;signature=1dc4ede0f4858425b80d85e504ec3087194f87c431f6b414801e9a991259230f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Per-customer nesting-minutes usage breakdown - NestAPI Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Admin only (an Admin API key or the account owner). Returns how the account\u0026#x27;s nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dev-nestapi.mintlify.app/_mintlify/api/og/v2?division=Fairness\u0026amp;title=Per-customer+nesting-minutes+usage+breakdown\u0026amp;description=Admin+only+%28an+Admin+API+key+or+the+account+owner%29.+Returns+how+the+account%27s+nesting+minutes+are+being+shared+across+your+API+keys+for+the+current+period.+Each\u0026amp;theme=73f7472777e17440bdf0549e\u0026amp;signature=1dc4ede0f4858425b80d85e504ec3087194f87c431f6b414801e9a991259230f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/dev-nestapi/B0iKdJqwikgQNLws/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"NestAPI Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dev-docs.nestapi.com/#organization\",\"name\":\"NestAPI Documentation\",\"url\":\"https://dev-docs.nestapi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dev-nestapi/UAxgnvyRVTOip4yc/images/logo-light.svg?fit=max\u0026auto=format\u0026n=UAxgnvyRVTOip4yc\u0026q=85\u0026s=570d4e4a3fdf3b7f0ba2c4034ec4d91d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dev-docs.nestapi.com#website\",\"name\":\"NestAPI Documentation\",\"url\":\"https://dev-docs.nestapi.com\",\"publisher\":{\"@id\":\"https://dev-docs.nestapi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown#webpage\",\"url\":\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown\",\"name\":\"Per-customer nesting-minutes usage breakdown\",\"description\":\"Admin only (an Admin API key or the account owner). Returns how the account's nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.\",\"dateModified\":\"2026-11-02T17:52:28.499Z\",\"isPartOf\":{\"@id\":\"https://dev-docs.nestapi.com#website\"},\"breadcrumb\":{\"@id\":\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://dev-docs.nestapi.com/api-reference/nesting/nest-from-dxf-files\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Fairness\",\"item\":\"https://dev-docs.nestapi.com/api-reference/fairness/get-the-accounts-per-customer-fairness-configuration\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Per-customer nesting-minutes usage breakdown\",\"item\":\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown#apireference\",\"headline\":\"Per-customer nesting-minutes usage breakdown\",\"name\":\"Per-customer nesting-minutes usage breakdown\",\"description\":\"Admin only (an Admin API key or the account owner). Returns how the account's nesting minutes are being shared across your API keys for the current period. Each row is one of your keys (i.e. one of your customers): the minutes it has consumed, its guaranteed fair-share floor, any overage it incurred, and a sizing signal to help you right-size weights. When fairness is not enabled on the plan the rows are informational only.\",\"url\":\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown\",\"mainEntityOfPage\":{\"@id\":\"https://dev-docs.nestapi.com/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown#webpage\"},\"dateModified\":\"2026-11-02T17:52:28.499Z\",\"publisher\":{\"@id\":\"https://dev-docs.nestapi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://dev-docs.nestapi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"NestAPI Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"NestAPI Documentation","nav":{"global":null,"groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Authentication","href":"/authentication"},{"title":"Quickstart","href":"/quickstart"}]},{"group":"Guides","pages":[{"title":"Nesting workflow","href":"/guides/nesting-workflow"},{"title":"Webhooks","href":"/guides/webhooks"},{"title":"Geometry types","href":"/guides/geometry-types"},{"title":"Quote nesting","href":"/guides/quote-nesting"},{"title":"1D nesting","href":"/guides/1d-nesting"}]},{"group":"Concepts","pages":[{"title":"Parts and sheets","href":"/concepts/parts-and-sheets"},{"title":"SimpleGeometry","href":"/concepts/simple-geometry"},{"title":"Nesting settings","href":"/concepts/nesting-settings"},{"title":"Common cutting","href":"/concepts/common-cutting"},{"title":"Export types","href":"/concepts/export-types"}]},{"group":"Account","pages":[{"title":"API keys","href":"/account/api-keys"},{"title":"Fairness","href":"/account/fairness"},{"title":"Identity \u0026 account status","href":"/account/profile"}]},{"group":"API Reference","pages":[{"group":"Nesting","pages":[{"title":"Nest from DXF files","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting","href":"/api-reference/nesting/nest-from-dxf-files"},{"title":"Nest from encoded geometry","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/geometry","href":"/api-reference/nesting/nest-from-encoded-geometry"},{"title":"Nest from parametric parts","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/parametric","href":"/api-reference/nesting/nest-from-parametric-parts"},{"title":"Nest from MyNesting XML","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/mynesting","href":"/api-reference/nesting/nest-from-mynesting-xml"},{"title":"Quote nest from DXF files","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/quotenesting","href":"/api-reference/nesting/quote-nest-from-dxf-files"},{"title":"Quote nest from encoded geometry","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/geometryquotenesting","href":"/api-reference/nesting/quote-nest-from-encoded-geometry"},{"title":"Nest 1D / linear stock","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/1D","href":"/api-reference/nesting/nest-1d-linear-stock"}]},{"group":"Run \u0026 track","pages":[{"title":"Start a delayed nest (after connecting to SignalR)","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/delayedstart","href":"/api-reference/nesting/start-a-delayed-nest-after-connecting-to-signalr"},{"title":"Continue a quote nest to the next sub-nest","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/continue","href":"/api-reference/nesting/continue-a-quote-nest-to-the-next-sub-nest"},{"title":"Get the status of a nesting request","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/nesting/status","href":"/api-reference/nesting/get-the-status-of-a-nesting-request"},{"title":"Recent successful nests (last 24 hours)","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/nesting/successes","href":"/api-reference/nesting/recent-successful-nests-last-24-hours"},{"title":"Recent failed nests (last 24 hours)","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/nesting/failures","href":"/api-reference/nesting/recent-failed-nests-last-24-hours"}]},{"group":"Results \u0026 exports","pages":[{"title":"Fetch the report-source result for a completed nest","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/result/","href":"/api-reference/nesting/fetch-the-report-source-result-for-a-completed-nest"},{"title":"Fetch a 1D nesting result","deprecated":false,"version":null,"openapi":"/openapi.json post /v1/nesting/1D/result","href":"/api-reference/nesting/fetch-a-1d-nesting-result"},{"title":"Render a completed nest","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/nesting/render/","href":"/api-reference/nesting/render-a-completed-nest"},{"title":"Generate a production export for a completed nest","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/nesting/export","href":"/api-reference/nesting/generate-a-production-export-for-a-completed-nest"},{"title":"Generate an export for a completed quote nest","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/nesting/exportquotenest","href":"/api-reference/nesting/generate-an-export-for-a-completed-quote-nest"},{"title":"Fetch a cached export (SignalR result generation)","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/nesting/export/cached","href":"/api-reference/nesting/fetch-a-cached-export-signalr-result-generation"}]},{"group":"Account \u0026 keys","pages":[{"title":"Get your account profile","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/user/profile","href":"/api-reference/account/get-your-account-profile"},{"title":"Get your account's subscription status","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/status","href":"/api-reference/account/get-your-accounts-subscription-status"},{"title":"Validate your API key","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/auth/validate","href":"/api-reference/account/validate-your-api-key"},{"title":"Check when your API key expires","deprecated":false,"version":null,"openapi":"/openapi.json get /v1/apiKey/validUntil","href":"/api-reference/account/check-when-your-api-key-expires"},{"title":"List the account's API keys","deprecated":false,"version":null,"openapi":"/openapi.json get /admin/keys","href":"/api-reference/account/list-the-accounts-api-keys"},{"title":"Create an API key","deprecated":false,"version":null,"openapi":"/openapi.json post /admin/keys","href":"/api-reference/account/create-an-api-key"},{"title":"Regenerate an API key","deprecated":false,"version":null,"openapi":"/openapi.json post /admin/keys/{ApiKeyId}/regenerate","href":"/api-reference/account/regenerate-an-api-key"},{"title":"Set a key's Admin/Usage type","deprecated":false,"version":null,"openapi":"/openapi.json patch /admin/keys/{ApiKeyId}/type","href":"/api-reference/account/set-a-keys-adminusage-type"},{"title":"Revoke an API key","deprecated":false,"version":null,"openapi":"/openapi.json delete /admin/keys/{ApiKeyId}","href":"/api-reference/account/revoke-an-api-key"},{"title":"List allowed origins for an API key","deprecated":false,"version":null,"openapi":"/openapi.json get /apikeys/{KeyId}/origins","href":"/api-reference/account/list-allowed-origins-for-an-api-key"},{"title":"Add an allowed origin to an API key","deprecated":false,"version":null,"openapi":"/openapi.json post /apikeys/{KeyId}/origins","href":"/api-reference/account/add-an-allowed-origin-to-an-api-key"},{"title":"Remove an allowed origin from an API key","deprecated":false,"version":null,"openapi":"/openapi.json delete /apikeys/{KeyId}/origins","href":"/api-reference/account/remove-an-allowed-origin-from-an-api-key"}]},{"group":"Fairness","pages":[{"title":"Get the account's per-customer fairness configuration","deprecated":false,"version":null,"openapi":"/openapi.json get /admin/fairness/config","href":"/api-reference/fairness/get-the-accounts-per-customer-fairness-configuration"},{"title":"Update the account's per-customer fairness configuration","deprecated":false,"version":null,"openapi":"/openapi.json patch /admin/fairness/config","href":"/api-reference/fairness/update-the-accounts-per-customer-fairness-configuration"},{"title":"Set a key's fairness weight","description":"Admin only. Sets the per-customer fairness weight for one of your keys.\n\n**Path \u0026 body**\n\n- `ApiKeyId` (path) — the key to weight.\n- `LineageWeight` (body) — the weight to apply; omit (null) to clear the override and fall back to the plan default.","deprecated":false,"version":null,"openapi":"/openapi.json patch /admin/keys/{ApiKeyId}/weight","href":"/api-reference/fairness/set-a-keys-fairness-weight"},{"title":"Per-customer nesting-minutes usage breakdown","deprecated":false,"version":null,"openapi":"/openapi.json get /usage/fairness","href":"/api-reference/fairness/per-customer-nesting-minutes-usage-breakdown"}]},{"group":"Service","pages":[{"title":"Endpoint to check if the api is alive","description":"Endpoint to check if the api is alive","deprecated":false,"version":null,"openapi":"/openapi.json get /public/alive","href":"/api-reference/public/endpoint-to-check-if-the-api-is-alive"}]}]}]},"basePath":"","title":"Per-customer nesting-minutes usage breakdown - NestAPI Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}