Reference

Tag allocation coverage

Returns showback coverage for a tag key: total, tagged, untagged, coverage percentage, and a per-value breakdown.

GET
/api/v1/costs/allocation

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

provider?Provider
tag_key?|

Tag key to compute allocation coverage for. Google Cloud may omit it for any-label coverage.

start?string|null
end?string|null
credits?Credits

Cost basis for Google Cloud: after credits (default) or before them. AWS stays on its invoiced basis.

exclude_system?Exclude System

Google Cloud only: ignore goog- and k8s- labels

include_project_labels?Include Project Labels

Google Cloud only: count labels set on the project

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/costs/allocation"
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": {
    "tag_key": "string",
    "total": 0,
    "tagged": 0,
    "untagged": 0,
    "coverage_pct": 0,
    "by_value": [
      {
        "value": "string",
        "cost": 0,
        "pct": 0
      }
    ],
    "by_key": [
      {
        "key": "string",
        "cost": 0,
        "coverage_pct": 0,
        "sources": [
          "string"
        ]
      }
    ],
    "credits": "before"
  }
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
Ask the FinOps Agent about your cloud spend