Skip to content
GET/api/v1/chargeback

Get chargeback report

Returns cost allocation for a project from `cost_entries` (the table the gateway writes on every priced call), computed server-side via the `chargeback_report_agg` RPC and falling back to a paged raw read (1000/page, 100,000-row ceiling, `truncated:true` when hit). `projectId` is required; `groupBy` defaults to `team` and must be one of team, cost_center, owner, environment, user, model, provider, project, api_key, end_customer, tag (anything else is 400 `INVALID_GROUP_BY`); `period` is a granularity label only and is echoed back, never used as a filter. When `allocation_rules` exist for the project, raw rows are additionally run through the core ChargebackManager and returned as `allocated` (null otherwise). Response also carries `unallocatedCost` and `attributedPct`.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Parameters

projectId in queryrequired
string
period in query

Granularity label (e.g. monthly/quarterly) — not a YYYY-MM key.

string
groupBy in query
string

Response

200 example

{
  "success": true
}

All status codes

200Chargeback report.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
404Not Found — PROJECT_NOT_FOUND.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X GET \
  https://evalguard.ai/api/v1/chargeback \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/chargeback", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}

response = requests.request("GET", "https://evalguard.ai/api/v1/chargeback", headers=headers)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "GET", "https://evalguard.ai/api/v1/chargeback", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403404429500

Other Cost & FinOps endpoints