STsteep
targets

POST /v1/targets/query

Query time-series target data for a metric and target series.

Request

  • Base URL
    https://help.steep.app (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Request body

metricIdentifierstring required

The metric.identifier to query targets for. Must match the metricIdentifier value returned when listing targets.

targetSeriesstring required

The target series to query. Must match the targetSeries value returned when listing targets.

breakdownDimensionIdentifiersstring[]

Dimension identifiers to break down by. Use keys from a dimensionValues object returned when listing targets ({ dimensionIdentifier: dimensionValue }). Every combination of values becomes a separate data point carrying each value under its identifier; a dimensionFilters entry for a dimension narrows it to the listed values.

breakdownDimensionIdentifierstring

Deprecated, use breakdownDimensionIdentifiers with one entry. One dimension identifier to break down by; each data point also repeats the value under the deprecated breakdown.

dimensionFiltersobject

Dimension filters to apply. Keys are dimension identifiers; values are allowed values. Derive both from dimensionValues returned when listing targets — e.g. { "country": "US" } → { "country": ["US"] }.

limitinteger

Maximum number of rows to return. When the row limit is reached, response hasMore is true. For a more complete result, increase limit or apply stricter filters.

Response

Response for status 200

timeGrain'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' required
cacheTtlInSecondsunknown required
limitnumber required

The effective row limit applied to this query.

hasMoreboolean required

Indicates there is more data beyond the row limit.

Changes

No recorded changes to this operation across all 1 revision of this API.