Skip to content

Clickhouse Org Analytics

POST
/clickhouse/org-analytics

Per-org visitor + intent analytics from ch3.

The database name is always derived from the authenticated user’s organization.id (lower-cased) — the request body never carries an org_id. The agent cannot reach another org’s data even if it tries.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
aggregation

‘raw’ returns the matching rows (capped). ‘daily_counts’ returns {day, count}. ‘top_n’ returns {value, count} grouped by the dataset’s primary group key (contact_id, company_id, keyword_id).

string
default: raw
Allowed values: raw daily_counts top_n
dataset
required

Which per-org table to read.

string
Allowed values: people_visitors company_visitors 5x5_visitors intent_resolved
filters

Optional equality filters. Keys must match dataset columns; unknown columns are silently dropped so an LLM guess can’t produce a SQL error.

object
key
additional properties
any
limit
integer
default: 1000 >= 1 <= 1000
since
required

ISO date or datetime (inclusive lower bound).

string
until
Any of:
string

Responses

200

Successful Response

object
data
required
object
aggregation
required
string
dataset
required
string
rows
Array<object>
default:
object
key
additional properties
any
total
integer
window
object
key
additional properties
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string