Interface ExperimentsApiListMetricsRequest

Hierarchy

  • ExperimentsApiListMetricsRequest

Properties

include?: string[]

Optional fields to include. Repeat this parameter to request several fields. counts adds experiment_count on each metric, which costs an extra aggregate query.

pageLimit?: number

Maximum number of results to return. Defaults to 25 when omitted, and is capped at 50 (larger values are clamped to 50). The response includes meta.page (with total) and pagination links.

pageOffset?: number

Number of results to skip for pagination. Defaults to 0 when omitted.

search?: string

Find metrics whose names contain the search text, regardless of case.

sort?: string

Sort field: name, created_at, or updated_at. Prefix with - for descending (for example, -created_at). A single field only; a comma-separated list is rejected. Defaults to created_at descending.

Generated using TypeDoc