Skip to main content
POST
Get metric observations (batch)

Authorizations

Authorization
string
header
required

Authenticate using one of two formats:

  • Organization/user token: Token <your-token>
  • Stytch JWT: Bearer <your-jwt>

Body

company_id
string

Filter by a single company ID.

company_domain
string

Filter by a single company domain (e.g. stripe.com).

company_ids
string[]

List of company IDs.

company_domains
string[]

List of company domains.

metric_base
string

Comma-separated metric_definition.base values (e.g. revenue,arr).

metric_view
string

Comma-separated metric_definition.view values (e.g. value,growth).

measurement_scenario
string

Comma-separated measurement.scenario values (e.g. historical,projection).

base_period
string

Comma-separated metric_definition.base_period values.

growth_period
string

Comma-separated metric_definition.growth_period values.

measurement_end_date_gte
string<date-time>

Filter where measurement.end_date >= this value (ISO 8601).

measurement_end_date_lte
string<date-time>

Filter where measurement.end_date <= this value (ISO 8601).

comparison_window_end_date_gte
string<date-time>

Filter where measurement.comparison_window_end_date >= this value (ISO 8601).

comparison_window_end_date_lte
string<date-time>

Filter where measurement.comparison_window_end_date <= this value (ISO 8601).

created_at_gte
string<date-time>

Filter metrics created on or after this datetime (ISO 8601).

created_at_lte
string<date-time>

Filter metrics created on or before this datetime (ISO 8601).

updated_at_gte
string<date-time>

Filter metrics updated on or after this datetime (ISO 8601).

updated_at_lte
string<date-time>

Filter metrics updated on or before this datetime (ISO 8601).

include_all_signal_evidence
boolean
default:false

When true, include all SignalEvidence rows. Default: false.

page_size
integer

Results per page. Default: 30, max: 100.

page_after
string

Cursor for the next page.

page_before
string

Cursor for the previous page.

Response

Paginated list of metric observations with citations. Same shape as GET.

metrics
object[]
required
pagination
object
required
meta
object
required