Skip to main content
POST
search.datasets.stats

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
products
enum<string>[]

Which search datasets to describe, any of: job postings, companies, people. Default: all three.

Maximum array length: 3
Available options:
jobs,
company,
people
sections
enum<string>[]

Which sections to return, any of: coverage counts, top dimension values, supported filter families. Default: all three.

Maximum array length: 3
Available options:
coverage,
top,
capabilities
limit
number

How many top values to return per dimension, 1 to 25. Default 3.

Required range: x >= 1

Response

The result

products
object[]
required

One entry per product asked for.