lib/webVitals/types

Interfaces

GetWebVitalsData

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:111

Interface representing the data structure for web vitals.

Properties

raw

raw: Omit<WebVitalsResponseItem, "rating_end" | "quartile" | "quartile_end">[];

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:115

Array of raw web vitals data items, excluding ‘rating_end’, ‘quartile’, and ‘quartile_end’ properties.

routeSummary

routeSummary: WebVitalsRouteSummary[];

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:120

Summary of web vitals data for different routes.

sevenDays

sevenDays: {
  routeSummary: WebVitalsRouteSummary[];
  summary: WebVitalsSummary;
};

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:145

Web vitals data for the last 7 days.

routeSummary

routeSummary: WebVitalsRouteSummary[];

Summary of web vitals data for different routes in the last 7 days.

summary

summary: WebVitalsSummary;

Summary of web vitals data for the last 7 days.

summary

summary: WebVitalsSummary;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:125

Overall summary of web vitals data.

thirtyDays

thirtyDays: {
  routeSummary: WebVitalsRouteSummary[];
  summary: WebVitalsSummary;
};

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:160

Web vitals data for the last 30 days.

routeSummary

routeSummary: WebVitalsRouteSummary[];

Summary of web vitals data for different routes in the last 30 days.

summary

summary: WebVitalsSummary;

Summary of web vitals data for the last 30 days.

twentyFourHours

twentyFourHours: {
  routeSummary: WebVitalsRouteSummary[];
  summary: WebVitalsSummary;
};

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:130

Web vitals data for the last 24 hours.

routeSummary

routeSummary: WebVitalsRouteSummary[];

Summary of web vitals data for different routes in the last 24 hours.

summary

summary: WebVitalsSummary;

Summary of web vitals data for the last 24 hours.

---

IntermediateWebVitalsRouteSummary

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:75

Represents a summary of web vitals for a specific route.

Extended by

• WebVitalsRouteSummary

Properties

metrics

metrics: Partial<Record<"CLS" | "INP" | "LCP", MetricStats>>;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:89

A partial record of core web vitals metrics and their statistics.

passingCoreWebVitals

passingCoreWebVitals: boolean;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:84

Indicates whether the core web vitals for the route are passing.

route

route: string;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:79

The route for which the web vitals are summarized.

score

score: number;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:91

---

MetricStats

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:66

Represents the statistics of a web vital metric.

Properties

rating

rating: "good" | "needs-improvement" | "poor";

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:68

sampleSize

sampleSize: number;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:69

value

value: number;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:67

---

WebVitalsMetricSummary

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:30

Represents a summary of web vitals metrics.

Properties

histogram

histogram: Record<"good" | "needs-improvement" | "poor", number>;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:31

A histogram that maps each web vitals rating to a number.

percentiles

percentiles: Partial<Record<"p75", {
  rating: "good" | "needs-improvement" | "poor";
  value: number;
}>>;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:32

An object containing percentiles, specifically the 75th percentile (p75), with its value and corresponding web vitals rating.

sampleSize

sampleSize: number;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:33

The size of the sample used to calculate the metrics.

---

WebVitalsRouteSummary

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:104

Represents a summary of web vitals metrics for a specific route. Extends the IntermediateWebVitalsRouteSummary interface.

WebVitalsRouteSummary

Extends

• IntermediateWebVitalsRouteSummary

Properties

metrics

metrics: Record<"CLS" | "INP" | "LCP", MetricStats>;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:105

A record of core web vitals metrics and their corresponding statistics.

Overrides

IntermediateWebVitalsRouteSummary.metrics

passingCoreWebVitals

passingCoreWebVitals: boolean;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:84

Indicates whether the core web vitals for the route are passing.

Inherited from

IntermediateWebVitalsRouteSummary.passingCoreWebVitals

route

route: string;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:79

The route for which the web vitals are summarized.

Inherited from

IntermediateWebVitalsRouteSummary.route

score

score: number;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:91

Inherited from

IntermediateWebVitalsRouteSummary.score

Type Aliases

WebVitalsResponseItem

type WebVitalsResponseItem = {
  id: string;
  name: string;
  pathname: string;
  quartile: number;
  quartile_end: boolean;
  rating: "good" | "needs-improvement" | "poor";
  rating_end: boolean;
  route: string;
  timestamp: Date;
  value: number;
};

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:17

Represents a single web vitals response item.

Properties

id

id: string;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:18

The unique identifier for the web vitals response item.

name

name: string;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:21

The name of the web vital metric.

pathname

pathname: string;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:19

The pathname of the web page.

quartile?

optional quartile: number;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:26

Optional quartile value of the web vital metric.

quartile_end?

optional quartile_end: boolean;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:27

Optional flag indicating if the quartile value is final.

rating

rating: "good" | "needs-improvement" | "poor";

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:23

The rating of the web vital metric.

rating_end?

optional rating_end: boolean;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:25

Optional flag indicating if the rating is final.

route

route: string;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:20

The route of the web page.

timestamp

timestamp: Date;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:24

The timestamp when the web vital metric was recorded.

value

value: number;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:22

The value of the web vital metric.

---

WebVitalsSummary

type WebVitalsSummary = Record<string, WebVitalsMetricSummary>;

Defined in: studiocms/packages/studiocms/src/lib/webVitals/types.ts:61

This type is a record where the keys are strings representing the names of the metrics, and the values are WebVitalsMetricSummary objects containing the summary details for each metric.