@ingenx-io/valets-schema-mcp-server 0.1.3 → 0.1.5

package/data/docs/models/analytics-daily.md

@@ -0,0 +1,351 @@
+---
+title: "AnalyticsDaily"
+sidebar_label: "AnalyticsDaily"
+sidebar_position: 3
+---
+
+# AnalyticsDaily
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+{
+  "totalEvents": 0,
+  "pageViews": 0,
+  "sessions": 0,
+  "uniqueUsers": 0,
+  "anonymousSessions": 0,
+  "orders": 0,
+  "paymentsCompleted": 0,
+  "paymentsFailed": 0,
+  "errors": 0,
+  "eventCounts": {},
+  "id": null,
+  "companyId": "comp_xyz789",
+  "siteId": "sit_ref123",
+  "date": "2026-02-15",
+  "computedAt": "computedAt",
+  "sourceEventCount": null
+}
+```
+
+</details>
+
+
+- [1. Property `totalEvents`](#totalEvents)
+- [2. Property `pageViews`](#pageViews)
+- [3. Property `sessions`](#sessions)
+- [4. Property `uniqueUsers`](#uniqueUsers)
+- [5. Property `anonymousSessions`](#anonymousSessions)
+- [6. Property `orders`](#orders)
+- [7. Property `paymentsCompleted`](#paymentsCompleted)
+- [8. Property `paymentsFailed`](#paymentsFailed)
+- [9. Property `errors`](#errors)
+- [10. Property `eventCounts`](#eventCounts)
+  - [10.1. Property `additionalProperties`](#eventCounts_additionalProperties)
+- [11. Property `id`](#id)
+- [12. Property `companyId`](#companyId)
+- [13. Property `siteId`](#siteId)
+- [14. Property `date`](#date)
+- [15. Property `computedAt`](#computedAt)
+  - [15.1. Property `_seconds`](#computedAt__seconds)
+  - [15.2. Property `_nanoseconds`](#computedAt__nanoseconds)
+- [16. Property `sourceEventCount`](#sourceEventCount)
+
+|                           |                               |
+| ------------------------- | ----------------------------- |
+| **Type**                  | `object`                      |
+| **Required**              | No                            |
+| **Additional properties** | Not allowed                   |
+| **Defined in**            | #/definitions/analytics-daily |
+
+**Description:** AnalyticsDaily rollup (D42 / ING-304). Collection: companies/\{companyId\}/sites/\{siteId\}/analytics_daily/\{YYYY-MM-DD\}. Idempotent set/merge — reruns overwrite. Fall back to raw analytics_events for uncovered slices.
+
+| Property                                   | Pattern | Type            | Deprecated | Definition                           | Title/Description                                                                                          |
+| ------------------------------------------ | ------- | --------------- | ---------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
+| + [totalEvents](#totalEvents )             | No      | integer         | No         | -                                    | Total event count within the bucket.                                                                       |
+| + [pageViews](#pageViews )                 | No      | integer         | No         | -                                    | Count of \`page_view\` + \`screen_view\` events.                                                           |
+| + [sessions](#sessions )                   | No      | integer         | No         | -                                    | Distinct session count within the bucket (by \`sessionId\`).                                               |
+| + [uniqueUsers](#uniqueUsers )             | No      | integer         | No         | -                                    | Distinct identified \`userId\` count. Anonymous sessions (userId=null) are excluded.                       |
+| + [anonymousSessions](#anonymousSessions ) | No      | integer         | No         | -                                    | Distinct session count where \`userId\` was null for the entire session.                                   |
+| + [orders](#orders )                       | No      | integer         | No         | -                                    | Count of \`order_submitted\` events (or Order documents scoped to this site, D43) within the bucket.       |
+| + [paymentsCompleted](#paymentsCompleted ) | No      | integer         | No         | -                                    | Count of \`payment_completed\` events within the bucket.                                                   |
+| + [paymentsFailed](#paymentsFailed )       | No      | integer         | No         | -                                    | Count of \`payment_failed\` events within the bucket.                                                      |
+| + [errors](#errors )                       | No      | integer         | No         | -                                    | Count of \`error_occurred\` + \`exception_caught\` events within the bucket.                               |
+| + [eventCounts](#eventCounts )             | No      | object          | No         | -                                    | Per-event-name counts — key is the event name (canonical or custom), value is the count within the bucket. |
+| - [id](#id )                               | No      | string or null  | No         | -                                    | (Read-only) Firestore document ID = \`YYYY-MM-DD\`.                                                        |
+| + [companyId](#companyId )                 | No      | string          | No         | -                                    | (Immutable) FK → Company document ID.                                                                      |
+| + [siteId](#siteId )                       | No      | string          | No         | -                                    | (Immutable) FK → Site document ID (D40).                                                                   |
+| + [date](#date )                           | No      | string          | No         | -                                    | (Immutable) \`YYYY-MM-DD\` UTC — matches document ID.                                                      |
+| + [computedAt](#computedAt )               | No      | object          | No         | In #/definitions/firestore-timestamp | (Read-only) When this rollup was last (re)computed. Updated on every set/merge.                            |
+| - [sourceEventCount](#sourceEventCount )   | No      | integer or null | No         | -                                    | (Read-only, Optional) Total source events scanned when producing this rollup. Useful for dry-run diffing.  |
+
+## <a name="totalEvents"></a>1. Property `totalEvents`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Total event count within the bucket.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="pageViews"></a>2. Property `pageViews`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Count of `page_view` + `screen_view` events.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="sessions"></a>3. Property `sessions`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Distinct session count within the bucket (by `sessionId`).
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="uniqueUsers"></a>4. Property `uniqueUsers`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Distinct identified `userId` count. Anonymous sessions (userId=null) are excluded.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="anonymousSessions"></a>5. Property `anonymousSessions`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Distinct session count where `userId` was null for the entire session.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="orders"></a>6. Property `orders`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Count of `order_submitted` events (or Order documents scoped to this site, D43) within the bucket.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="paymentsCompleted"></a>7. Property `paymentsCompleted`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Count of `payment_completed` events within the bucket.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="paymentsFailed"></a>8. Property `paymentsFailed`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Count of `payment_failed` events within the bucket.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="errors"></a>9. Property `errors`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+**Description:** Count of `error_occurred` + `exception_caught` events within the bucket.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="eventCounts"></a>10. Property `eventCounts`
+
+|                           |                                                                                          |
+| ------------------------- | ---------------------------------------------------------------------------------------- |
+| **Type**                  | `object`                                                                                 |
+| **Required**              | Yes                                                                                      |
+| **Additional properties** | [Each additional property must conform to the schema](#eventCounts_additionalProperties) |
+
+**Description:** Per-event-name counts — key is the event name (canonical or custom), value is the count within the bucket.
+
+| Property                                 | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ---------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| - [](#eventCounts_additionalProperties ) | No      | integer | No         | -          | -                 |
+
+### <a name="eventCounts_additionalProperties"></a>10.1. Property `additionalProperties`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | No        |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+## <a name="id"></a>11. Property `id`
+
+|              |                  |
+| ------------ | ---------------- |
+| **Type**     | `string or null` |
+| **Required** | No               |
+
+**Description:** (Read-only) Firestore document ID = `YYYY-MM-DD`.
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::
+
+## <a name="companyId"></a>12. Property `companyId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Company document ID.
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="siteId"></a>13. Property `siteId`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) FK → Site document ID (D40).
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="date"></a>14. Property `date`
+
+|              |          |
+| ------------ | -------- |
+| **Type**     | `string` |
+| **Required** | Yes      |
+
+**Description:** (Immutable) `YYYY-MM-DD` UTC — matches document ID.
+
+:::info Immutable
+Set at creation only. This field cannot be modified after the document is created. Include it in CREATE payloads; omit it (or leave unchanged) in UPDATE payloads.
+:::
+
+## <a name="computedAt"></a>15. Property `computedAt`
+
+|                           |                                   |
+| ------------------------- | --------------------------------- |
+| **Type**                  | `object`                          |
+| **Required**              | Yes                               |
+| **Additional properties** | Not allowed                       |
+| **Defined in**            | #/definitions/firestore-timestamp |
+
+**Description:** (Read-only) When this rollup was last (re)computed. Updated on every set/merge.
+
+| Property                                    | Pattern | Type    | Deprecated | Definition | Title/Description |
+| ------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- |
+| + [_seconds](#computedAt__seconds )         | No      | integer | No         | -          | -                 |
+| + [_nanoseconds](#computedAt__nanoseconds ) | No      | integer | No         | -          | -                 |
+
+### <a name="computedAt__seconds"></a>15.1. Property `_seconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+### <a name="computedAt__nanoseconds"></a>15.2. Property `_nanoseconds`
+
+|              |           |
+| ------------ | --------- |
+| **Type**     | `integer` |
+| **Required** | Yes       |
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::
+
+## <a name="sourceEventCount"></a>16. Property `sourceEventCount`
+
+|              |                   |
+| ------------ | ----------------- |
+| **Type**     | `integer or null` |
+| **Required** | No                |
+
+**Description:** (Read-only, Optional) Total source events scanned when producing this rollup. Useful for dry-run diffing.
+
+| Restrictions |                        |
+| ------------ | ---------------------- |
+| **Minimum**  | &ge; -9007199254740991 |
+| **Maximum**  | &le; 9007199254740991  |
+
+----------------------------------------------------------------------------------------------------------------------------
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2026-04-18 at 22:24:54 +0000
+
+:::warning Server-set
+Do not include in write requests. This field is set exclusively by the server (Firestore trigger or Admin SDK). Clients that send it will have the value silently ignored or may receive a validation error.
+:::