Skip to main content
POST
Ten metrics over a set of companies, with full statistics.

Authorizations

Authorization
string
header
required

Org-scoped WorkOS API key (sk_...), sent as Authorization: Bearer <key>. Admins create and revoke keys in the Syrto dashboard: https://dashboard.syrto.ai/api-keys

Body

application/json

Omitting both filters and seedId, or sending filters: {}, aggregates every company with a statement for year (the whole of Italy), at the same price. Several geographic codes in filters.anagraphic.nuts are summed into one set, never split.

year
integer
required

Always required.

Required range: 2015 <= x <= 2100
filters
object

Defines a set of companies: /companies/search returns it row by row, /market aggregates it. Every section is optional; everything is ANDed.

seedId
string

A companyId or tax id to derive the set from: its NACE class, its macro area (Italy for size L) and its size class. filters override any part.

Required string length: 1 - 100
breakdown
enum<string>

One axis per call (default none): macro area (5 NUTS 1 groups) or size class (4 groups: XS, S, M, L) - never both. macro fails with 422 when the set already has a geography: a nuts or lau filter, or a seed below size L. size fails with 422 when the set already has a size: a financial.size filter, or any seed. There is no regional breakdown: for one region or macro area, filter on it, one call per area.

Available options:
none,
macro,
size
language
enum<string>

Language of metric names, labels and descriptions (never of field names or slugs). Omitted: the account's default.

Available options:
it,
en

Response

Ten metrics over a set of companies, with full statistics.

data
object
required

Ten metrics over the set with full statistics; company count, employees and radar come free.

meta
object
required