Skip to main content
GET
Get corpus stats

Authorizations

Authorization
string
header
required

API key, not necessarily a JWT. Server derives Organization, permitted actions and Corpus scope; every resource access is authorized.

Path Parameters

corpus_id
string
required
Minimum string length: 1

Query Parameters

include
string

Comma-separated histogram and/or sources; omit for totals only.

resolution
enum<string>
default:day

Histogram grouping. Requires include=histogram.

Available options:
day,
hour
accepted_after
string<date-time>

Inclusive histogram bound, RFC 3339 at a UTC-hour boundary.

accepted_before
string<date-time>

Exclusive histogram bound, RFC 3339 at a UTC-hour boundary.

histogram_cursor
string
Minimum string length: 1
sources_cursor
string
Minimum string length: 1
source_limit
integer
default:100
Required range: 1 <= x <= 1000

Response

Totals and any requested series.

corpus_id
string
required
total
integer<int64>
required
Required range: x >= 0
catalog_total
integer<int64>
required
Required range: x >= 0
undated_total
integer<int64>
required
Required range: x >= 0
catalog_undated_total
integer<int64>
required
Required range: x >= 0
observed_at
string<date-time>
required
approximate
boolean
required
complete
boolean
required
first_catalog_hour
string<date-time>

First occupied catalog UTC hour; not the exact first acceptance time. Absent for an undated or empty corpus.

last_catalog_hour
string<date-time>

Last occupied catalog UTC hour; not the exact last acceptance time.

histogram
object
sources
object