Skip to content

Variable: RuleHits ​

ts
const RuleHits: z.ZodObject<{
  backtest: z.ZodNullable<z.ZodObject<{
     daily: z.ZodArray<z.ZodObject<{
        day: z.ZodString;
        evaluated: z.ZodNumber;
        recordedHits: z.ZodNumber;
        versionHits: z.ZodNumber;
     }, z.core.$strip>>;
     finishedAt: z.ZodOptional<z.ZodNullable<z.ZodCoercedDate<unknown>>>;
     id: z.ZodGUID;
     version: z.ZodNumber;
  }, z.core.$strip>>;
  days: z.ZodNumber;
  key: z.ZodString;
  recorded: z.ZodArray<z.ZodObject<{
     day: z.ZodString;
     evaluated: z.ZodNumber;
     hits: z.ZodNumber;
  }, z.core.$strip>>;
  timeZone: z.ZodString;
}, z.core.$strip>;

GET /stats/rules/:key/hits: the rule's recorded results per UTC day (every day of the window, oldest first, zero when idle) and, with compareVersion, the per-day series of that version's latest completed backtest: on the same sampled evaluations, the recorded hits against the version's (null when it has no completed backtest).

Released under the Apache-2.0 License.