API reference

API reference · API

This key's shadow tests

GET/v1/shadowAPI key

Read scope. A 404 at every path while the operator has not turned shadow testing on.

Answer 200

The key's tests.

Fields of the 200 answer
FieldTypeWhat it is
object"list"
dataarray of object
data[].idstringshd_ and 24 hex digits.
data[].object"shadow.test"
data[].namestring
data[].modelstring
data[].scopestringOne of "key", "account".
data[].key_idinteger or null
data[].statusstringOne of "active", "stopped".
data[].stopped_reasonstring or null
data[].held_untilinteger or nullUnix seconds: the month's ceiling is reached, nothing runs before this.
data[].sample_ratenumber
data[].daily_capinteger
data[].sampled_todayinteger
data[].monthly_ceiling_microsinteger
data[].month_spent_microsinteger
data[].month_reserved_microsinteger
data[].spent_microsinteger
data[].compareobject
data[].thresholdnumber
data[].min_samplesinteger
data[].candidatesarray of object
data[].candidates[].modelstring
data[].candidates[].suggestedboolean
data[].switchobject or nullThe switch standing, if any: the candidate and the keys it routes.
data[].switch.tostring
data[].switch.key_idsarray of integer
data[].switch.switched_atinteger
data[].switch.autobooleanMade by the gateway under auto savings.
data[].autoobjectAuto savings: whether the gateway may switch this test itself once a candidate is ready.
data[].auto.enabledboolean
data[].auto.enabled_atinteger or null
data[].auto.switched_atinteger or null
data[].auto.switched_tostring or null
data[].auto.off_reasonstring or nullWhy it is off when it was on: turned off, reverted, or why a switch failed.
data[].savingsarray of objectThe newest weekly reports (Monday to Monday, UTC) of what a standing switch saved: the requests it moved, read from their usage rows, what they were billed, and what they would have cost on the original at the report's measured cost ratio.
data[].savings[].week_startinteger
data[].savings[].fromstring
data[].savings[].tostring
data[].savings[].autoboolean
data[].savings[].requestsinteger
data[].savings[].cost_microsinteger
data[].savings[].baseline_microsinteger
data[].savings[].saved_microsinteger
data[].savings[].rationumber
data[].created_atinteger
data[].updated_atinteger

Errors

  • 401OpenAI shaped error.
  • 404OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter