Skip to main content
GET
Aggregate project spend grouped by one or more dimensions

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.

zivio-tenant-id
string
header
required

Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.

Query Parameters

group_by
string
required

One or more dimensions, comma-separated (max 4), combined into a composite grouping. Permitted: category, subcategory, tier3, supplier, owner, org, status, month, quarter, year.

measures
string

Comma-separated measures (defaults per role if omitted): rate, budget, target_cost, original_rate, original_budget, sales_rate, sales_budget, estimated_savings, projected_recognized_savings, project_count.

date_dimension
enum<string>
default:created_at

Date column used for month/quarter/year buckets.

Available options:
created_at,
submitted_at,
approved_at,
hired_at,
start_date,
due_on,
ended_at,
closed_at
convert_to
string

Optional ISO currency code for an indicative converted roll-up (per-currency subtotals remain exact).

filter[<attribute>]
object

Standard filter grammar, e.g. filter[state]=in_progress&filter[created_at][gte]=2025-01-01.

Response

Spend summary grouped by the requested dimensions and currency

The response is of type object.