{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Get storage breakdown for a billing group","type":"basic","slug":"get-storage-breakdown-for-a-billing-group","excerpt":"","body":"This call returns a storage breakdown for a billing group.\n\n\nTo find the `billing_group`, use the call [list billing groups](ref:list-your-billing-groups) to list all your billing groups. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/billing/groups/{billing_group}/breakdown/storage\",\n      \"language\": \"text\",\n      \"name\": \"Path \"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/billing/groups/8ccc6222-ef6f-4526-99d7-9f56b716d43a/breakdown/storage HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -s -H \\\"X-SBG-Auth-Token: 8ccc6222-ef6f-4526-99d7-9f56b716d43a\\\" -H \\\"content-type: application/json\\\" - X GET \\\"\\nhttps://cavatica-api.sbgenomics.com/v2/billing/groups/eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7/breakdown/storage\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    },\n    {\n      \"code\": \"from sevenbridges import Api\\n\\napi = Api(url='https://cavatica-api.sbgenomics.com/v2',\\n          token='3259c50e1ac5426ea8f1273259740f74')\\n\\nbilling_group = api.billing_groups.get(\\n    id='8ccc6222-ef6f-4526-99d7-9f56b716d43a'\\n)\\n\\n# send GET request to SB API\\nbreakdown = billing_group.breakdown()\\n\\nprint(breakdown.total_spending.currency, breakdown.total_spending.amount)\\nfor project_breakdown in breakdown.project_breakdown:\\n    print(project_breakdown.analysis_spending.currency,\\n          project_breakdown.analysis_spending.amount)\\n    print(len(project_breakdown.task_breakdown))\",\n      \"language\": \"python\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your Cavatica [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`billing_group`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the billing group.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`limit`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The maximum number of collection items to return for a single request.\\n\\nThe default value is 50, while the maximum value is 100.\\n\\nThis is a pagination-specific attribute.\",\n    \"4-0\": \"`date_to`\",\n    \"4-1\": \"string\",\n    \"4-2\": \"Specify the ending date for retrieving storage analysis in the following format: mm-dd-yyyy.\",\n    \"1-0\": \"`offset`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"The zero-based starting index in the entire collection of the first item to return.\\n\\nThe default value is 0. This is a pagination-specific attribute.\",\n    \"2-0\": \"`fields`\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Selector specifying a subset of fields to include in the response.\",\n    \"3-0\": \"`date_from`\",\n    \"3-1\": \"string\",\n    \"3-2\": \"Specify the starting date for retrieving storage analysis in the following format: mm-dd-yyyy.\",\n    \"5-0\": \"`invoice_id`\",\n    \"5-1\": \"string\",\n    \"5-2\": \"Specify Invoice ID to show a breakdown for the specific invoice.\\n\\nIf omitted, the current spending breakdown is returned.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\n[See the list of specific response codes that may be contained in the body of the response.](ref:api-status-codes) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example response body\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n   \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/billing/groups/123-e3433-43434-434343/breakdown/storage?offset=0&limit=2\\\",\\n   \\\"items\\\": [\\n     {\\n        \\\"project_name\\\": \\\"my project\\\",\\n        \\\"project_locked\\\": false,\\n        \\\"project_created_by\\\":\\\"voluptatem-quasi-iusto-pariatu/rfranklin\\\",\\n        \\\"active\\\": {\\n            \\\"size\\\": \\\"0.032300\\\",\\n            \\\"unit\\\": \\\"GB/Month\\\"\\n        },\\n        \\\"archived\\\": {\\n            \\\"size\\\": \\\"0.000000\\\",\\n            \\\"unit\\\": \\\"GB/Month\\\"\\n        }\\n        \\\"location\\\": \\\"aws:us-east-1\\\"\\n      },\\n      {\\n         \\\"project_name\\\": \\\"my project\\\",\\n         \\\"project_locked\\\": false\\n         \\\"project_created_by\\\": \\\"div/rfranklin\\\",\\n         \\\"active\\\": {\\n             \\\"size\\\": \\\"0.032300\\\",\\n             \\\"unit\\\": \\\"GB/Month\\\"\\n          },\\n         \\\"archived\\\": {\\n             \\\"size\\\": \\\"0.000000\\\"\\n              \\\"unit\\\": \\\"GB/Month\\\"\\n         },\\n        \\\"location\\\": \\\"aws:us-east-1\\\"\\n     }\\n   ],\\n \\\"links\\\": [\\n     {\\n         \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/billing/groups/123-e3433-43434-434343/breakdown/storage?offset=2&limit=2\\\",\\n         \\\"rel\\\": \\\"next\\\",\\n         \\\"method\\\": \\\"GET\\\"\\n     }\\n   ]\\n}\",\n      \"language\": \"python\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Example of a response for a locked project\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/billing/groups/f9fd8fa0-e570-48a0-be00-335957f5ed2c/breakdown/storage?offset=0&limit=5\\\",\\n    \\\"items\\\": [\\n        {\\n            \\\"active\\\": {\\n                \\\"size\\\": \\\"0.032300\\\",\\n                \\\"unit\\\": \\\"GB/Month\\\"\\n            },\\n            \\\"archived\\\": {\\n                \\\"size\\\": \\\"0.000000\\\",\\n                \\\"unit\\\": \\\"GB/Month\\\"\\n            },\\n            \\\"project_locked\\\": true\\n        }\\n    ],\\n    \\\"links\\\": []\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":17,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6025440832479c00794e2620","createdAt":"2021-02-11T14:49:44.355Z","user":"566590c83889610d0008a253","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cavatica API","slug":"api","order":19,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d"},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9","6024033e2b2f6f004dfe994c"],"_id":"5773dcfc255e820e00e1cd50","__v":36,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"project":"5773dcfc255e820e00e1cd4d","__v":0,"parentDoc":null}

Get started

Cavatica Projects

Find apps

Bring data to Cavatica

Set metadata associated with a file

Collaborate securely

BRING YOUR TOOLS

Docker

Developer tools

EDIT AN APP

Tool wrapping tips and tricks

Describe your tool (Legacy)

Browse public datasets

Run an analysis

Task Execution

Review a task

Kids First studies

Cavatica Datasets

Cavatica API

Connect cloud storage

SBFS (Beta)

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WES API

CAVATICA DATASETS API (Advanced Access)

Data Cruncher

SBFS (Beta)

SBFS Command reference

Get storage breakdown for a billing group

This call returns a storage breakdown for a billing group. To find the `billing_group`, use the call [list billing groups](ref:list-your-billing-groups) to list all your billing groups. [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/billing/groups/{billing_group}/breakdown/storage", "language": "text", "name": "Path " } ] } [/block] [block:api-header] { "type": "basic", "title": "Example request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "GET /v2/billing/groups/8ccc6222-ef6f-4526-99d7-9f56b716d43a/breakdown/storage HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 8ccc6222-ef6f-4526-99d7-9f56b716d43a\" -H \"content-type: application/json\" - X GET \"\nhttps://cavatica-api.sbgenomics.com/v2/billing/groups/eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7/breakdown/storage\"", "language": "curl", "name": "cURL" }, { "code": "from sevenbridges import Api\n\napi = Api(url='https://cavatica-api.sbgenomics.com/v2',\n token='3259c50e1ac5426ea8f1273259740f74')\n\nbilling_group = api.billing_groups.get(\n id='8ccc6222-ef6f-4526-99d7-9f56b716d43a'\n)\n\n# send GET request to SB API\nbreakdown = billing_group.breakdown()\n\nprint(breakdown.total_spending.currency, breakdown.total_spending.amount)\nfor project_breakdown in breakdown.project_breakdown:\n print(project_breakdown.analysis_spending.currency,\n project_breakdown.analysis_spending.amount)\n print(len(project_breakdown.task_breakdown))", "language": "python" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your Cavatica [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`billing_group`", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the billing group." }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`limit`", "0-1": "string", "0-2": "The maximum number of collection items to return for a single request.\n\nThe default value is 50, while the maximum value is 100.\n\nThis is a pagination-specific attribute.", "4-0": "`date_to`", "4-1": "string", "4-2": "Specify the ending date for retrieving storage analysis in the following format: mm-dd-yyyy.", "1-0": "`offset`", "1-1": "string", "1-2": "The zero-based starting index in the entire collection of the first item to return.\n\nThe default value is 0. This is a pagination-specific attribute.", "2-0": "`fields`", "2-1": "string", "2-2": "Selector specifying a subset of fields to include in the response.", "3-0": "`date_from`", "3-1": "string", "3-2": "Specify the starting date for retrieving storage analysis in the following format: mm-dd-yyyy.", "5-0": "`invoice_id`", "5-1": "string", "5-2": "Specify Invoice ID to show a breakdown for the specific invoice.\n\nIf omitted, the current spending breakdown is returned." }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] [See the list of specific response codes that may be contained in the body of the response.](ref:api-status-codes) [block:api-header] { "type": "basic", "title": "Example response body", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/billing/groups/123-e3433-43434-434343/breakdown/storage?offset=0&limit=2\",\n \"items\": [\n {\n \"project_name\": \"my project\",\n \"project_locked\": false,\n \"project_created_by\":\"voluptatem-quasi-iusto-pariatu/rfranklin\",\n \"active\": {\n \"size\": \"0.032300\",\n \"unit\": \"GB/Month\"\n },\n \"archived\": {\n \"size\": \"0.000000\",\n \"unit\": \"GB/Month\"\n }\n \"location\": \"aws:us-east-1\"\n },\n {\n \"project_name\": \"my project\",\n \"project_locked\": false\n \"project_created_by\": \"div/rfranklin\",\n \"active\": {\n \"size\": \"0.032300\",\n \"unit\": \"GB/Month\"\n },\n \"archived\": {\n \"size\": \"0.000000\"\n \"unit\": \"GB/Month\"\n },\n \"location\": \"aws:us-east-1\"\n }\n ],\n \"links\": [\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/billing/groups/123-e3433-43434-434343/breakdown/storage?offset=2&limit=2\",\n \"rel\": \"next\",\n \"method\": \"GET\"\n }\n ]\n}", "language": "python" } ], "sidebar": true } [/block] ###Example of a response for a locked project [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/billing/groups/f9fd8fa0-e570-48a0-be00-335957f5ed2c/breakdown/storage?offset=0&limit=5\",\n \"items\": [\n {\n \"active\": {\n \"size\": \"0.032300\",\n \"unit\": \"GB/Month\"\n },\n \"archived\": {\n \"size\": \"0.000000\",\n \"unit\": \"GB/Month\"\n },\n \"project_locked\": true\n }\n ],\n \"links\": []\n}", "language": "json" } ] } [/block]