{"_id":"5b0e13ffc4664e0003c75bb3","__v":0,"user":"554340dfb7f4540d00fcef1d","parentDoc":null,"project":"5b0e13ffc4664e0003c75a66","category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T19:41:37.128Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":10,"body":"This call returns a breakdown of spending per-project for the billing group specified by `billing_group`.\n\nFor each project that the billing group is associated with, information is shown on each task run, including its initiating user (the `runner_username`), start and end times, and cost.\n\nTo find the `billing_group`, use the [call to list all your billing groups](doc:list-a-users-billing-groups).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https:// f4c-api.sbgenomics.com/v2/billing/groups/{billing_group}/breakdown\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/billing/groups/8ccc6222-ef6f-4526-99d7-9f56b716d43a/breakdown HTTP/1.1\\nHost: f4c-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 \\\"https://f4c-api.sbgenomics.com/v2/billing/groups/eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7/breakdown\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\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 Platform [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\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/billing/groups/eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7/breakdown\\\",\\n  \\\"project_breakdown\\\": [\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/my_project\\\",\\n      \\\"analysis_spending\\\": {\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"amount\\\": \\\"0.23\\\"\\n      },\\n      \\\"task_breakdown\\\": [\\n        {\\n          \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/39bc3e8c-6cf6-4f8f-b550-21e9633c1f4b\\\",\\n          \\\"runner_username\\\": \\\"Kate\\\",\\n          \\\"time_started\\\": \\\"2015-12-11T11:03:08Z\\\",\\n          \\\"time_finished\\\": \\\"2015-12-11T11:08:49Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        }\\n      ]\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/test\\\",\\n      \\\"analysis_spending\\\": {\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"amount\\\": \\\"0.92\\\"\\n      },\\n      \\\"task_breakdown\\\": [\\n        {\\n          \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/f586a3fb-c9e4-4415-b22b-648a66969a37\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-26T14:15:18Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-26T14:20:30Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/98c8dc8b-e1e0-4410-8448-d857a9c2cf16\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T16:26:23Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T16:30:46Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/6961273b-0f6a-45a3-95c1-d5d895fc6ea0\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-26T12:11:58Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-26T12:16:33Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n      ]\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/projects/Kate/my-project\\\",\\n      \\\"analysis_spending\\\": {\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"amount\\\": \\\"0.46\\\"\\n      },\\n      \\\"task_breakdown\\\": [\\n        {\\n          \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/a466e8b9-6f48-4cf9-b903-50fc4701bb2e\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T14:02:13Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T14:07:06Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/b0bbeda6-153b-4801-92ad-82bc0e58bdb6\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-24T19:19:52Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-24T19:24:45Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n      ]\\n    },\\n    {\\n      \\\"analysis_spending\\\": {\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"amount\\\": \\\"0.69\\\"\\n      },\\n      \\\"task_breakdown\\\": [\\n        {\\n          \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/468dca93-7e90-4625-bcef-a080151d0687\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T14:30:45Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T14:35:31Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/dc0e6559-a706-4e30-a040-72e5bfb3c077\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T14:37:59Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T14:47:10Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        },\\n        {\\n          \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/tasks/a8364b07-f1f9-4548-864a-045a3a2c41a1\\\",\\n          \\\"runner_username\\\": \\\"RFranklin\\\",\\n          \\\"time_started\\\": \\\"2015-11-25T14:43:02Z\\\",\\n          \\\"time_finished\\\": \\\"2015-11-25T14:48:18Z\\\",\\n          \\\"task_cost\\\": {\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"amount\\\": \\\"0.23\\\"\\n          }\\n        }\\n      ]\\n    }\\n  ],\\n  \\\"total_spending\\\": {\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"amount\\\": \\\"2.00\\\"\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/billing/groups/{billing_group}/breakdown","slug":"get-breakdown-for-a-billing-group","type":"endpoint","title":"Get breakdown for a billing group"}

getGet breakdown for a billing group

/billing/groups/{billing_group}/breakdown

This call returns a breakdown of spending per-project for the billing group specified by `billing_group`. For each project that the billing group is associated with, information is shown on each task run, including its initiating user (the `runner_username`), start and end times, and cost. To find the `billing_group`, use the [call to list all your billing groups](doc:list-a-users-billing-groups). [block:code] { "codes": [ { "code": "https:// f4c-api.sbgenomics.com/v2/billing/groups/{billing_group}/breakdown", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/billing/groups/8ccc6222-ef6f-4526-99d7-9f56b716d43a/breakdown HTTP/1.1\nHost: f4c-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 \"https://f4c-api.sbgenomics.com/v2/billing/groups/eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7/breakdown\"", "language": "curl", "name": "cURL" } ], "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 Platform [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": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-api.sbgenomics.com/v2/billing/groups/eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7/breakdown\",\n \"project_breakdown\": [\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/my_project\",\n \"analysis_spending\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n },\n \"task_breakdown\": [\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/39bc3e8c-6cf6-4f8f-b550-21e9633c1f4b\",\n \"runner_username\": \"Kate\",\n \"time_started\": \"2015-12-11T11:03:08Z\",\n \"time_finished\": \"2015-12-11T11:08:49Z\",\n \"task_cost\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n }\n }\n ]\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/test\",\n \"analysis_spending\": {\n \"currency\": \"USD\",\n \"amount\": \"0.92\"\n },\n \"task_breakdown\": [\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/f586a3fb-c9e4-4415-b22b-648a66969a37\",\n \"runner_username\": \"RFranklin\",\n \"time_started\": \"2015-11-26T14:15:18Z\",\n \"time_finished\": \"2015-11-26T14:20:30Z\",\n \"task_cost\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n }\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/98c8dc8b-e1e0-4410-8448-d857a9c2cf16\",\n \"runner_username\": \"RFranklin\",\n \"time_started\": \"2015-11-25T16:26:23Z\",\n \"time_finished\": \"2015-11-25T16:30:46Z\",\n \"task_cost\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n }\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/6961273b-0f6a-45a3-95c1-d5d895fc6ea0\",\n \"runner_username\": \"RFranklin\",\n \"time_started\": \"2015-11-26T12:11:58Z\",\n \"time_finished\": \"2015-11-26T12:16:33Z\",\n \"task_cost\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n }\n },\n ]\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/projects/Kate/my-project\",\n \"analysis_spending\": {\n \"currency\": \"USD\",\n \"amount\": \"0.46\"\n },\n \"task_breakdown\": [\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/a466e8b9-6f48-4cf9-b903-50fc4701bb2e\",\n \"runner_username\": \"RFranklin\",\n \"time_started\": \"2015-11-25T14:02:13Z\",\n \"time_finished\": \"2015-11-25T14:07:06Z\",\n \"task_cost\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n }\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/b0bbeda6-153b-4801-92ad-82bc0e58bdb6\",\n \"runner_username\": \"RFranklin\",\n \"time_started\": \"2015-11-24T19:19:52Z\",\n \"time_finished\": \"2015-11-24T19:24:45Z\",\n \"task_cost\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n }\n },\n ]\n },\n {\n \"analysis_spending\": {\n \"currency\": \"USD\",\n \"amount\": \"0.69\"\n },\n \"task_breakdown\": [\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/468dca93-7e90-4625-bcef-a080151d0687\",\n \"runner_username\": \"RFranklin\",\n \"time_started\": \"2015-11-25T14:30:45Z\",\n \"time_finished\": \"2015-11-25T14:35:31Z\",\n \"task_cost\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n }\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/dc0e6559-a706-4e30-a040-72e5bfb3c077\",\n \"runner_username\": \"RFranklin\",\n \"time_started\": \"2015-11-25T14:37:59Z\",\n \"time_finished\": \"2015-11-25T14:47:10Z\",\n \"task_cost\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n }\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/tasks/a8364b07-f1f9-4548-864a-045a3a2c41a1\",\n \"runner_username\": \"RFranklin\",\n \"time_started\": \"2015-11-25T14:43:02Z\",\n \"time_finished\": \"2015-11-25T14:48:18Z\",\n \"task_cost\": {\n \"currency\": \"USD\",\n \"amount\": \"0.23\"\n }\n }\n ]\n }\n ],\n \"total_spending\": {\n \"currency\": \"USD\",\n \"amount\": \"2.00\"\n }\n}", "language": "json" } ], "sidebar": true } [/block]