Skip to content
Capell CMS

GA4 Reports

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

Field Value
Composer package capell-app/ga4-reports
Package slug ga4-reports
Product group Capell Marketing & Growth
Tier premium
Bundle marketing-growth
Runtime contexts admin, console
Capell version ^1.0
Catalogue role extension
Release channel Labs
Source repository capell-app/packages
Source path packages/ga4-reports
Docs source packages/ga4-reports/docs
Manifest capell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

GA4 Reports is an Available, Schema-owning Capell package in the Capell Marketing & Growth product group. It ships as capell-app/ga4-reports and extends these surfaces: admin, console.

GA4 Reports synchronizes Google Analytics 4 metrics into local daily, page, and sync-run records for cached admin reporting.

Administrators configure the property and credentials, then review overview metrics, traffic trends, top pages, setup state, and sync freshness from the admin page and widgets.

Evidence: capell.json, src/Models/GA4ReportsDailyMetric.php, src/Models/GA4ReportsPageMetric.php, src/Actions/SyncGA4ReportsMetricsAction.php, docs/overview.admin.md, docs/screenshots.json, src/Filament/Pages/GA4ReportsPage.php, tests/Feature/Filament/GA4ReportsFilamentTest.php.

Status details:

  • Status: Available
  • Tier: premium
  • Bundle: marketing-growth
  • Composer package: capell-app/ga4-reports
  • Namespace: Capell\GA4Reports
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: A replaceable data-client contract and focused sync and report Actions keep external API calls off the admin render path.

For teams: Content and marketing teams can read recent traffic and page performance beside their CMS work and use sync history to judge whether the snapshot is current.

Evidence: src/Contracts/GA4ReportsDataClientInterface.php, src/Actions/SyncGA4ReportsMetricsAction.php, src/Actions/BuildGA4ReportsOverviewAction.php, tests/Feature/Actions/GA4ReportsActionsTest.php, docs/admin-guide.md, src/Actions/BuildTopGA4ReportsPagesAction.php, src/Models/GA4ReportsSyncRun.php, docs/screenshots.json.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

GA4 Reports dashboard page

GA4 Reports setup status widget

  • GA4 Reports dashboard page (admin, required).
  • GA4 Reports setup status widget (admin, required).
  • GA4 Reports settings (admin, required).
  • GA4 Reports sync history (admin, optional).
  • GA4 Reports top pages detail (admin, optional).

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\GA4Reports\Providers\GA4ReportsServiceProvider, Capell\GA4Reports\Providers\AdminServiceProvider.
  • Config files: packages/ga4-reports/config/capell-ga4-reports.php.
  • Migrations: packages/ga4-reports/database/migrations/2026_05_10_190852_01_create_ga4_reports_daily_metrics_table.php, packages/ga4-reports/database/migrations/2026_05_10_190852_02_create_ga4_reports_page_metrics_table.php, packages/ga4-reports/database/migrations/2026_05_10_190852_03_create_ga4_reports_sync_runs_table.php.
  • Settings migrations: packages/ga4-reports/database/settings/2026_05_10_190853_01_create_ga4_reports_settings.php.
  • Settings classes: GA4ReportsSettings, GA4ReportsSettingsMigrationProvider.
  • Models: GA4ReportsDailyMetric, GA4ReportsPageMetric, GA4ReportsSyncRun.
  • Filament classes: GA4ReportsPage, GA4ReportsDashboardSettingsContributor, GA4ReportsSettingsSchema, BuildsGA4ReportsDashboardWindow, GA4ReportsOverviewStatsFilamentWidget, GA4ReportsSetupStatusFilamentWidget, GA4ReportsTopPagesFilamentWidget, GA4ReportsTopPagesTableFilamentWidget, GA4ReportsTrafficTrendFilamentWidget.
  • Extension contracts: GA4ReportsDataClientInterface.
  • Actions: BuildGA4ReportsDigestAction, BuildGA4ReportsOverviewAction, BuildGA4ReportsTrendAction, BuildGA4ReportsWindowAction, BuildTopGA4ReportsPagesAction, CheckGA4ReportsCredentialsPathAction, ExportGA4ReportsDigestCsvAction, PersistGA4ReportsDailyMetricAction, PersistGA4ReportsPageMetricAction, PruneGA4ReportsSyncRunsAction, RedactGA4ReportsSyncErrorMessageAction, ResolveGA4ReportsConfigAction, and 1 more.
  • Data objects: GA4ReportsConfigData, GA4ReportsCredentialsStatusData, GA4ReportsDailyMetricData, GA4ReportsDigestData, GA4ReportsOverviewData, GA4ReportsPageMetricData, GA4ReportsSyncResultData, GA4ReportsTopPageData, GA4ReportsTrendPointData, GA4ReportsWindowData.
  • Command signatures: capell:ga4-reports-prune, capell:ga4-reports-sync.
  • Scheduled commands: capell:ga4-reports-prune (daily), capell:ga4-reports-sync.
  • Console command classes: PruneGA4ReportsSyncRunsCommand, SyncGA4ReportsCommand.
  • Manifest contributions: admin-page: Capell\GA4Reports\Manifest\GA4ReportsAdminPageContribution, console-command: Capell\GA4Reports\Manifest\GA4ReportsConsoleCommandsContribution, dashboard-widget: Capell\GA4Reports\Manifest\GA4ReportsDashboardFilamentWidgetsContribution, health-check: Capell\GA4Reports\Manifest\GA4ReportsHealthContribution, model: Capell\GA4Reports\Manifest\GA4ReportsModelsContribution, overview-stat: Capell\GA4Reports\Manifest\GA4ReportsOverviewStatsContribution, scheduled-job: Capell\GA4Reports\Manifest\GA4ReportsRetentionScheduleContribution, scheduled-job: Capell\GA4Reports\Manifest\GA4ReportsScheduledSyncContribution, setting: Capell\GA4Reports\Manifest\GA4ReportsSettingsContribution.
  • Health checks: Capell\GA4Reports\Health\Ga4ReportsHealthCheck.
  • Blade views: packages/ga4-reports/resources/views/filament/pages/ga4-reports.blade.php.
  • Cache tags: ga4-reports.

Data Model

Section titled “Data Model”
  • Required tables: ga4_reports_sync_runs, ga4_reports_daily_metrics, ga4_reports_page_metrics.
  • Models: GA4ReportsDailyMetric, GA4ReportsPageMetric, GA4ReportsSyncRun.
  • Migration files: 2026_05_10_190852_01_create_ga4_reports_daily_metrics_table.php, 2026_05_10_190852_02_create_ga4_reports_page_metrics_table.php, 2026_05_10_190852_03_create_ga4_reports_sync_runs_table.php.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: retention is scheduled through capell:ga4-reports-prune (daily).

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core.
  • Admin navigation: declares admin-page: GA4ReportsAdminPageContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: dashboard-widget: GA4ReportsDashboardFilamentWidgetsContribution, overview-stat: GA4ReportsOverviewStatsContribution.
  • Permissions: View:GA4ReportsPage.
  • Public routes: none declared.
  • Database changes: package migrations are declared.
  • Config: config/capell-ga4-reports.php.
  • Settings: Capell\GA4Reports\Settings\GA4ReportsSettings.
  • Queues or schedules: scheduled commands capell:ga4-reports-prune (daily), capell:ga4-reports-sync.
  • Cache tags: ga4-reports.
  • Commands: capell:ga4-reports-prune, capell:ga4-reports-sync.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/capell-ga4-reports.php, Capell\GA4Reports\Settings\GA4ReportsSettings.
  • Register the host scheduler so these declared commands run at their documented frequencies: capell:ga4-reports-prune (daily), capell:ga4-reports-sync.
  • Custom write integrations must preserve invalidation for ga4-reports cache tags.

Troubleshooting

Section titled “Troubleshooting”
Symptom Likely cause Check Fix
Package surface is missing after install Provider or manifest is not loaded Confirm capell.json, package composer.json, and provider registration Reinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing table Package migrations have not run Check the tables listed in Data Model Run host migrations and rerun the focused package test
Background work does not run Queue worker or declared schedule is not active Check the jobs and scheduled commands listed in Technical Shape Start the queue worker or host scheduler, then run the focused command or package test

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/ga4-reports.
  2. Run the required setup: php artisan migrate.
  3. Open the GA4 Reports dashboard page and confirm the admin workflow loads.

Next Steps

Section titled “Next Steps”