Skip to content

facets

POST
/logs/v2/facets
curl --request POST \
--url https://api.siteqwality.com/logs/v2/facets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "query": { "v": 1, "signal": "logs", "text": "example", "filters": [ "example" ], "range": { "from": "example", "to": "example" }, "tz": "example", "analytics": { "group_by": [ "example" ], "measure": { "op": "count", "field": "example" }, "interval": "example", "limit": 1, "display": "timeseries" } }, "fields": [ "example" ] }'
Media type application/json
object
query
required

A log, span or trace query: the explorer URL, a saved view, a widget, an alert rule and an MCP call all carry this. text and filters are AND-combined.

object
v
required
integer format: int32
signal
required

The signal of an [EventQuery].

string
Allowed values: logs spans traces
text

The text grammar (6.5.2).

string
filters

The f grammar (6.5.1), parsed for the signal’s scope.

Array<string>
range
required

A window of T2 tokens (now, now-2h) or instants (ISO 8601, epoch milliseconds), resolved when the query is compiled, so a stored view stays rolling.

object
from
required
string
to
required
string
tz
string | null
analytics
One of:

Group-by analytics over an [EventQuery]: a time series or a top list.

object
group_by

Up to three fields, in the f field syntax (service, @http.route).

Array<string>
measure
object
op
required
string
Allowed values: count sum avg min max p50 p75 p90 p95 p99
field

A numeric field (duration, @db.rows); none for count.

string | null
interval

A T2 bucket interval or auto; absent means auto.

string | null
limit

Groups returned, 1 to 100; absent means 10.

integer | null format: int32
display
string
Allowed values: timeseries toplist
fields
required
Array<string>

OK

Media type application/json
object
data
required
Array<object>
object
field
required
string
value
string | null
count
required
integer format: int64
meta
required
object
from
required
string
to
required
string
clamped_from
string | null
partial
required
boolean
slow_terms
required
Array<string>
Example generated
{
"data": [
{
"field": "example",
"value": "example",
"count": 1
}
],
"meta": {
"from": "example",
"to": "example",
"clamped_from": "example",
"partial": true,
"slow_terms": [
"example"
]
}
}