{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Get analysis breakdown for a billing group","type":"basic","slug":"get-analysis-breakdown-for-a-billing-group","excerpt":"","body":"This call returns an analysis breakdown for a billing group which contains information on both the tasks and Cruncher analysis. \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://cgc-api.sbgenomics.com/v2/billing/groups/{billing_group}/breakdown/analysis\",\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/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7/breakdown/analysis HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74\",\n \"language\": \"http\",\n \"name\": null\n },\n {\n \"code\": \"curl -s -H \\\"X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74\\\" -H \\\"content-type: application/json\\\" - X GET \\\"https://cgc-api.sbgenomics.com/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7/breakdown/analysis\\\"\",\n \"language\": \"curl\",\n \"name\": \"cURL\"\n },\n {\n \"code\": \"from sevenbridges import Api\\n\\napi = Api(url='https://cgc-api.sbgenomics.com/v2',\\n token='3210a98c1db9318fa9d9273156740f74')\\n\\nbilling_group = api.billing_groups.get(\\n id='ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7'\\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 CGC [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\": \"integer\",\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 transactions analysis in the following format: mm-dd-yyyy.\",\n \"1-0\": \"`offset`\",\n \"1-1\": \"integer\",\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 transactions 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\\nTo find the particular 'invoice_id' use the [List invoices](doc:list-invoices) call.\"\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://cgc-api.sbgenomics.com/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7/breakdown/analysis?offset=0&limit=2&date_from=11-04-2020\\\",\\n \\\"items\\\": [\\n {\\n \\\"analysis_type\\\": \\\"TASK\\\",\\n \\\"analysis_id\\\": \\\"2ddafbe4-c305-4123-85dc-8bec448ab96b\\\",\\n \\\"project_locked\\\": false,\\n \\\"project_name\\\": \\\"my project\\\",\\n \\\"analysis_app_name\\\": \\\"Alignment Metrics QC\\\",\\n \\\"analysis_name\\\": \\\"Alignment Metrics QC run - 01-18-21 16:08:24\\\",\\n \\\"ran_by\\\": \\\"div/rfranklin\\\",\\n \\\"analysis_status\\\": \\\"COMPLETED\\\",\\n \\\"analysis_cost\\\": {\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"amount\\\": \\\"0.024162\\\",\\n \\\"breakdown\\\": {\\n \\\"storage\\\": \\\"0.002312\\\",\\n \\\"computation\\\": \\\"0.021850\\\",\\n \\\"data_transfer_in\\\": \\\"0.000000\\\"\\n }\\n },\\n \\\"refunded_amount\\\": \\\"0.000000\\\",\\n \\\"time_started\\\": \\\"2021-01-18T16:08:26Z\\\",\\n \\\"time_finished\\\": \\\"2021-01-18T16:12:08Z\\\"\\n },\\n {\\n \\\"analysis_type\\\": \\\"CRUNCHER_ANALYSIS\\\",\\n \\\"analysis_id\\\": \\\"a1675d65-f2e9-4c5b-b1e0-48019384d4ee\\\",\\n \\\"project_locked\\\": false,\\n \\\"project_name\\\": \\\"my project\\\",\\n \\\"analysis_app_name\\\": \\\"\\\",\\n \\\"analysis_name\\\": \\\"an-1\\\",\\n \\\"ran_by\\\": \\\"div/rfranklin\\\",\\n \\\"analysis_status\\\": \\\"STOPPED\\\",\\n \\\"analysis_cost\\\": {\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"amount\\\": \\\"0.256994\\\",\\n \\\"breakdown\\\": {\\n \\\"storage\\\": \\\"0.074055\\\",\\n \\\"computation\\\": \\\"0.182939\\\",\\n \\\"data_transfer_in\\\": \\\"0.000000\\\"\\n }\\n },\\n \\\"refunded_amount\\\": \\\"0.000000\\\",\\n \\\"time_started\\\": \\\"2021-01-18T16:00:27Z\\\",\\n \\\"time_finished\\\": \\\"2021-01-18T16:32:52Z\\\"\\n },\\n \\n \\\"links\\\": [\\n {\\n \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7/breakdown/analysis?offset=2&limit=2&date_from=11-04-2020\\\",\\n \\\"rel\\\": \\\"next\\\",\\n \\\"method\\\": \\\"GET\\\"\\n }\\n ]\\n}\",\n \"language\": \"json\"\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://cgc-api.sbgenomics.com/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7/breakdown/analysis?offset=0&limit=1\\\",\\n \\\"items\\\": [\\n {\\n \\\"analysis_type\\\": \\\"TASK\\\",\\n \\\"analysis_id\\\": \\\"470cbe61-6e27-1e0e-98ad-9b51d5292177\\\",\\n \\\"project_locked\\\": true,\\n \\\"analysis_cost\\\": {\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"amount\\\": \\\"0.016491\\\",\\n \\\"breakdown\\\": {\\n \\\"storage\\\": \\\"0.007302\\\",\\n \\\"computation\\\": \\\"0.009189\\\",\\n \\\"data_transfer_in\\\": \\\"0.000000\\\"\\n }\\n },\\n \\\"refunded_amount\\\": \\\"0.000000\\\"\\n }\\n ],\\n \\\"links\\\": [\\n {\\n \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7/breakdown/analysis?offset=1&limit=1\\\",\\n \\\"rel\\\": \\\"next\\\",\\n \\\"method\\\": \\\"GET\\\"\\n }\\n ]\\n}\",\n \"language\": \"json\"\n }\n ]\n}\n[/block]","updates":[],"order":11,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60253cd59b14160018ee8981","createdAt":"2021-02-11T14:19:01.320Z","user":"566590c83889610d0008a253","category":{"sync":{"isSync":false,"url":""},"pages":["56312d239ead230d00a188f2","56312e0d82d96a0d00b0fb08","56315777fc94aa0d00e9b553","56315b779ead230d00a1894a","5631657c9c25801700dac34f","56317884fc94aa0d00e9b586","56318386c3b04b0d00ba9bb9","563240ccdcc27a170082363b","563240dfbddb091700ad5e82","563240edfe9acd1900cc1d10","56324504fa40240d007c8d5f","56324b30c3b04b0d00ba9c96","563273ae45f2cb0d006be3fa","563273c08c9cda0d0025266d","563273cc38f8aa0d00d30f55","563273d838f8aa0d00d30f59","5632740945f2cb0d006be3fc","56327411df556c0d00cd0905","5632741b8c9cda0d0025266f","563274ea10b6040d008793d8","5632757cdf556c0d00cd0908","563275b710b6040d008793da","563275f938f8aa0d00d30f60","5632762fb904a10d0032f6fc","5632767110b6040d008793dd","563276c0b904a10d0032f700","5632770162c48a0d00334d53","5632843d8c9cda0d00252698","5632846e62c48a0d00334d78","56328a7e49e16d0d00122420","56328aaf49e16d0d00122425","56328b2238f8aa0d00d30f88","56328b6c8c9cda0d002526a2","56328c0710b6040d008793ff","56328c3710b6040d00879401","56328c5938f8aa0d00d30f8c","56328c90b904a10d0032f722","56328cc449e16d0d0012242a","56328ce68c9cda0d002526a8","56328d1338f8aa0d00d30f8e","56328d5810b6040d00879407","56328d7cdf556c0d00cd092f","56328d9a10b6040d00879409","56328db438f8aa0d00d30f92","56328dd762c48a0d00334d8b","56328df649e16d0d0012242d","56328e1edf556c0d00cd0931","56328e4662c48a0d00334d8e","56328e5edf556c0d00cd0933","56328e8f8c9cda0d002526ab","56328eb3b904a10d0032f72a","56328edb38f8aa0d00d30f95","56328ef210b6040d0087940d","56328f148c9cda0d002526ad","56328f2962c48a0d00334d90","56328f54b904a10d0032f72c","56328f6c38f8aa0d00d30f98","56328f858c9cda0d002526af","56328fae62c48a0d00334d95","56328fd838f8aa0d00d30f9c","5637f069ee0ee60d0024ec18","5641ffaa9417b40d00c0fc35","564355240d9748190079dea9","5644cfeb2c74cf1900da4831","56450f856b0ca50d00f6bd8f","56706537cbb2fb0d00f7c7dd","567065bc3d29830d00376213","56706fc2cbb2fb0d00f7c87e","568bf5a1e662f40d00eee866","568c0699e662f40d00eee881","568cff0274c77f2d00d56d51","568d10f58602880d001ce277","568d2abc37b636250036b904","568d343413c5ad0d00b34efb","568d593a8602880d001ce2d3","568e64135e12fb0d00325160","568e66f05e12fb0d00325162","568e78aa5e12fb0d0032517a","569433cfd8c04d1700e5ae0c","56943723d8c04d1700e5ae14","5694393b3e9d080d00f0655d","5694e6cf953b810d008f91bc","5694f301c5c5ce0d00058e68","569502ef9797fa1900f704e7","5695063bcaa32519009c40b3","569511cccaa32519009c40d9","569557e2fcb1032d0089dfe2","569562fefcb1032d0089dfee","56956428fe18811700c9c058","569639b87596a90d0014e5a3","56a90197e590350d004b5103","56a9021e9ec7660d002e08c2"],"title":"API Reference","slug":"api","order":33,"from_sync":false,"reference":true,"_id":"55faf9aa17b9d00d00969f49","project":"55faf11ba62ba1170021a9a7","createdAt":"2015-09-17T17:34:34.937Z","version":"55faf11ba62ba1170021a9aa","__v":92},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4","5f894c7d3b0894006477ca01","6176d5bf8f59c6001038c2f7"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":48},"project":"55faf11ba62ba1170021a9a7","__v":0,"parentDoc":null}