Skip to main content
GET
Aggregate variation order value 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). Permitted: category, subcategory, tier3, supplier, owner, org, status, month, quarter, year.

measures
string

Comma-separated measures (defaults per role if omitted): rate, original_rate, sales_rate, variation_order_count.

date_dimension
enum<string>
default:created_at

Date column used for month/quarter/year buckets.

Available options:
created_at,
submitted_at,
approved_at,
accepted_at,
sent_at,
due_on
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[status]=accepted, plus projects-backed drill-down filter[supplier]=88 / filter[category]=42 (comma for multiple).

cf_project[<key>]
object

Filter by the parent Project's tenant-defined custom-field values. Same operator grammar as cf: cf_project[cost_center]=CC-001, cf_project[department][in]=a,b, cf_project[po][exists]=.

Response

Variation order value summary grouped by the requested dimensions and currency

The response is of type object.