Cost

Showback by tag

Spend per value of one tag or virtual-tag key with shared costs split by the key’s split rules: direct spend, the shared spend each value receives (negative on a shared pool, whose spend moves to its targets), their total, the previous period’s total and the change. Each day uses the newest rule that has started by that day; the previous period is split under the rules in force on the last day of the selected period, so the change reflects spend rather than a rule change. Spend with no value for the key is reported as unallocated. Amounts are gross (credits and refunds left out), in the reporting currency, rounded to the cent so values add up exactly to the totals. Spend in a currency with no exchange rate is left out and listed under unconverted. Showback figures are recomputed on every read, so a closed month can still change when its bill is restated. With format=csv or format=xlsx the response is a file with one row per value, the unallocated row and a total row.

GET

api

tenant

cost

showback

Showback by tag

curl --request GET \
  --url https://api.costgraph.ai/api/v1/tenant/cost/showback \
  --header 'Authorization: <api-key>' \
  --header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/cost/showback"

headers = {
    "X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>', Authorization: '<api-key>'}
};

fetch('https://api.costgraph.ai/api/v1/tenant/cost/showback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.costgraph.ai/api/v1/tenant/cost/showback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.costgraph.ai/api/v1/tenant/cost/showback"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.costgraph.ai/api/v1/tenant/cost/showback")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/cost/showback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "some message",
  "status": "success",
  "data": {
    "basis": "<string>",
    "byCurrency": [
      {
        "convertedTotal": 123,
        "currency": "<string>",
        "effectiveRate": 123,
        "latestRateDate": "<string>",
        "nativeTotal": 123,
        "nearestRateUsed": true
      }
    ],
    "layer": "<string>",
    "previousComparable": true,
    "reportingCurrency": "<string>",
    "tagKey": "<string>",
    "totals": {
      "changeAmount": 123,
      "changePct": 123,
      "direct": 123,
      "previous": 123,
      "share": 123,
      "shared": 123,
      "total": 123
    },
    "unallocated": {
      "changeAmount": 123,
      "changePct": 123,
      "direct": 123,
      "previous": 123,
      "share": 123,
      "shared": 123,
      "total": 123
    },
    "unconverted": [
      {
        "currency": "<string>",
        "nativeTotal": 123
      }
    ],
    "values": [
      {
        "changeAmount": 123,
        "changePct": 123,
        "direct": 123,
        "previous": 123,
        "share": 123,
        "shared": 123,
        "total": 123,
        "value": "<string>"
      }
    ]
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Authorizations

Authorization

string

header

required

Enter "Bearer {token}"

Headers

X-CostGraph-Tenant-ID

string

required

Tenant ID

Query Parameters

tag_key

string

required

Tag or virtual-tag key to show back by

layer

enum<string>

Cost layer; defaults to billed. allocation splits Kubernetes clusters into namespaces and workloads; the two are never mixed

Available options:

billed,

allocation

period

enum<string>

Cost period; defaults to month_to_date

Available options:

month_to_date,

last_7d,

last_30d,

calendar_month,

custom

month

string

Closed calendar month in YYYY-MM format; required when period=calendar_month

start

string

Window start in RFC3339 format; required when period=custom

end

string

Window end in RFC3339 format; required when period=custom

reporting_currency

string

ISO 4217 code to express every amount in; defaults to the currency most of the period's spend was billed in

filter

string[]

Repeated key:value dimension filter, the same vocabulary as the cost query filter

format

enum<string>

Response format; defaults to json

Available options:

json,

csv,

xlsx

Response

message

string

required

Example:

"some message"

status

string

required

Example:

"success"

data

object

Show child attributes

Showback by tag

curl --request GET \
  --url https://api.costgraph.ai/api/v1/tenant/cost/showback \
  --header 'Authorization: <api-key>' \
  --header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/cost/showback"

headers = {
    "X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>', Authorization: '<api-key>'}
};

fetch('https://api.costgraph.ai/api/v1/tenant/cost/showback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.costgraph.ai/api/v1/tenant/cost/showback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.costgraph.ai/api/v1/tenant/cost/showback"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.costgraph.ai/api/v1/tenant/cost/showback")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/cost/showback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "some message",
  "status": "success",
  "data": {
    "basis": "<string>",
    "byCurrency": [
      {
        "convertedTotal": 123,
        "currency": "<string>",
        "effectiveRate": 123,
        "latestRateDate": "<string>",
        "nativeTotal": 123,
        "nearestRateUsed": true
      }
    ],
    "layer": "<string>",
    "previousComparable": true,
    "reportingCurrency": "<string>",
    "tagKey": "<string>",
    "totals": {
      "changeAmount": 123,
      "changePct": 123,
      "direct": 123,
      "previous": 123,
      "share": 123,
      "shared": 123,
      "total": 123
    },
    "unallocated": {
      "changeAmount": 123,
      "changePct": 123,
      "direct": 123,
      "previous": 123,
      "share": 123,
      "shared": 123,
      "total": 123
    },
    "unconverted": [
      {
        "currency": "<string>",
        "nativeTotal": 123
      }
    ],
    "values": [
      {
        "changeAmount": 123,
        "changePct": 123,
        "direct": 123,
        "previous": 123,
        "share": 123,
        "shared": 123,
        "total": 123,
        "value": "<string>"
      }
    ]
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Getting started

Endpoints

Showback by tag

Authorizations

Headers

Query Parameters

Response