wedance-shared 1.0.172 → 1.0.174

package/dist/types/analytics.d.ts

@@ -31,3 +31,105 @@ export type DailyAnalyticsReport = {
         startDate: string;
     };
 };
+/** Query params for GET /analytics/overview. */
+export interface AnalyticsOverviewQuery {
+    /** UTC day to report on, `YYYY-MM-DD`. Defaults to today (UTC). */
+    date?: string;
+}
+/** Per-day platform counts, computed over a UTC day. */
+export interface AnalyticsDailyStats {
+    activeUsers: number;
+    newUsers: number;
+    purchasedTickets: number;
+    newEvents: number;
+}
+/** All-time platform counts. */
+export interface AnalyticsTotals {
+    users: number;
+    tickets: number;
+    events: number;
+}
+export interface AnalyticsOverviewResponse {
+    /** The reported UTC day, `YYYY-MM-DD`. */
+    date: string;
+    daily: AnalyticsDailyStats;
+    totals: AnalyticsTotals;
+}
+/**
+ * Inclusive day range, `YYYY-MM-DD`. Both params are optional: omitting
+ * `endDate` uses today, omitting `startDate` goes back 28 days (today
+ * included). The range must not exceed 90 days.
+ */
+export interface AnalyticsDateRangeQuery {
+    startDate?: string;
+    endDate?: string;
+}
+export type AnalyticsDailyStatsQuery = AnalyticsDateRangeQuery;
+/** One UTC day of platform counts. */
+export interface AnalyticsDailyStatsPoint extends AnalyticsDailyStats {
+    /** `YYYY-MM-DD`. */
+    date: string;
+}
+export interface AnalyticsDailyStatsResponse {
+    startDate: string;
+    endDate: string;
+    /**
+     * Oldest snapshotted day, or null when nothing has been captured yet. Days in
+     * the requested range before it read as zeroes because no data was recorded,
+     * not because nobody connected.
+     */
+    firstSnapshotDate: string | null;
+    /** Ascending, one entry per day in the range — missing days are zeroes. */
+    byDate: AnalyticsDailyStatsPoint[];
+}
+export interface TopEventViewsQuery extends AnalyticsDateRangeQuery {
+    /** Integer between 1 and 100. Defaults to 20. */
+    limit?: number;
+}
+export interface TopEventViewsItem {
+    eventId: string;
+    /** Null when the id no longer resolves to an event (deleted, or a stale client build). */
+    title: string | null;
+    /** Counts presses of `press_event`, not unique viewers. */
+    views: number;
+    users: number;
+}
+export interface TopEventViewsResponse {
+    startDate: string;
+    endDate: string;
+    events: TopEventViewsItem[];
+    /** GA's `(other)` bucket, or null when it did not bucket anything. */
+    otherViews: number | null;
+}
+export type EventViewsQuery = AnalyticsDateRangeQuery;
+export interface EventViewsTotals {
+    /** Counts presses of `press_event`, not unique viewers. */
+    views: number;
+    users: number;
+}
+export interface EventViewsByEntryPoint {
+    /** `"unknown"` when the client omitted `entry_point`. */
+    entryPoint: string;
+    views: number;
+    users: number;
+}
+export interface EventViewsByDate {
+    /** `YYYY-MM-DD`. */
+    date: string;
+    views: number;
+    users: number;
+}
+export interface EventViewsResponse {
+    eventId: string;
+    eventTitle: string;
+    startDate: string;
+    endDate: string;
+    totals: EventViewsTotals;
+    byEntryPoint: EventViewsByEntryPoint[];
+    /** Ascending, one entry per day in the range — days with no data are zeroes. */
+    byDate: EventViewsByDate[];
+}
+/** Error body shape returned by the analytics endpoints (400/403/404/5xx). */
+export interface AnalyticsErrorResponse {
+    error: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wedance-shared",
-  "version": "1.0.172",
+  "version": "1.0.174",
   "description": "This repository contains shared TypeScript types and interfaces used across multiple WeDance applications:",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",