@graph8/sdk 0.251.0 → 0.260.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -2
- package/dist/cli.js +216 -0
- package/dist/index.d.mts +104 -7
- package/dist/index.d.ts +104 -7
- package/dist/index.js +44 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +44 -3
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +102 -7
- package/dist/react.d.ts +102 -7
- package/dist/react.js +62 -11
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +53 -12
- package/dist/react.mjs.map +1 -1
- package/dist/types/README.md +7 -0
- package/dist/types/agency.d.ts +20 -0
- package/dist/types/agentSetup.d.ts +57 -0
- package/dist/types/api.d.ts +127 -0
- package/dist/types/appClient.d.ts +99 -0
- package/dist/types/appPlatform.d.ts +269 -0
- package/dist/types/appTokens.d.ts +125 -0
- package/dist/types/apps.d.ts +130 -0
- package/dist/types/audiences.d.ts +88 -0
- package/dist/types/calendar.d.ts +55 -0
- package/dist/types/campaigns.d.ts +61 -0
- package/dist/types/chat.d.ts +35 -0
- package/dist/types/cli.d.ts +14 -0
- package/dist/types/companies.d.ts +123 -0
- package/dist/types/contacts.d.ts +200 -0
- package/dist/types/copilot.d.ts +31 -0
- package/dist/types/core.d.ts +1052 -0
- package/dist/types/deals.d.ts +215 -0
- package/dist/types/enrich.d.ts +51 -0
- package/dist/types/fields.d.ts +84 -0
- package/dist/types/forms.d.ts +16 -0
- package/dist/types/http.d.ts +141 -0
- package/dist/types/inbox.d.ts +123 -0
- package/dist/types/index.d.ts +63 -0
- package/dist/types/intent.d.ts +196 -0
- package/dist/types/lists.d.ts +44 -0
- package/dist/types/mailboxes.d.ts +240 -0
- package/dist/types/marketplace.d.ts +62 -0
- package/dist/types/meetings.d.ts +70 -0
- package/dist/types/newsletter.d.ts +212 -0
- package/dist/types/notes.d.ts +57 -0
- package/dist/types/objects.d.ts +281 -0
- package/dist/types/pipelines.d.ts +135 -0
- package/dist/types/quotes.d.ts +143 -0
- package/dist/types/react.d.ts +978 -0
- package/dist/types/search.d.ts +99 -0
- package/dist/types/sequences.d.ts +255 -0
- package/dist/types/signals.d.ts +28 -0
- package/dist/types/skills.d.ts +176 -0
- package/dist/types/snippet.d.ts +24 -0
- package/dist/types/studio.d.ts +161 -0
- package/dist/types/tasks.d.ts +101 -0
- package/dist/types/types.d.ts +45 -0
- package/dist/types/utils.d.ts +21 -0
- package/dist/types/version.d.ts +10 -0
- package/dist/types/visitors.d.ts +29 -0
- package/dist/types/voice.d.ts +304 -0
- package/dist/types/webhooks.d.ts +71 -0
- package/dist/types/workflows.d.ts +229 -0
- package/docs/agents.md +748 -0
- package/docs/api/README.md +165 -0
- package/docs/api/accounts.d.ts +396 -0
- package/docs/api/accounts.md +644 -0
- package/docs/api/adCampaigns.d.ts +707 -0
- package/docs/api/adCampaigns.md +1091 -0
- package/docs/api/adCreatives.d.ts +996 -0
- package/docs/api/adCreatives.md +1708 -0
- package/docs/api/agency.d.ts +556 -0
- package/docs/api/agency.md +845 -0
- package/docs/api/agent.d.ts +330 -0
- package/docs/api/agent.md +514 -0
- package/docs/api/agents.d.ts +1622 -0
- package/docs/api/agents.md +2860 -0
- package/docs/api/aiInbox.d.ts +1984 -0
- package/docs/api/aiInbox.md +3490 -0
- package/docs/api/analytics.d.ts +1273 -0
- package/docs/api/analytics.md +2095 -0
- package/docs/api/apiKeys.d.ts +252 -0
- package/docs/api/apiKeys.md +318 -0
- package/docs/api/appDeployments.d.ts +236 -0
- package/docs/api/appDeployments.md +471 -0
- package/docs/api/appDomains.d.ts +171 -0
- package/docs/api/appDomains.md +281 -0
- package/docs/api/appLogs.d.ts +120 -0
- package/docs/api/appLogs.md +159 -0
- package/docs/api/appObjects.d.ts +415 -0
- package/docs/api/appObjects.md +568 -0
- package/docs/api/appPages.d.ts +557 -0
- package/docs/api/appPages.md +796 -0
- package/docs/api/appPlatformTokens.d.ts +123 -0
- package/docs/api/appPlatformTokens.md +172 -0
- package/docs/api/appointments.d.ts +2361 -0
- package/docs/api/appointments.md +3917 -0
- package/docs/api/apps.d.ts +822 -0
- package/docs/api/apps.md +1342 -0
- package/docs/api/assertUpsert.d.ts +286 -0
- package/docs/api/assertUpsert.md +370 -0
- package/docs/api/audienceSyncs.d.ts +259 -0
- package/docs/api/audienceSyncs.md +395 -0
- package/docs/api/brandKit.d.ts +686 -0
- package/docs/api/brandKit.md +1133 -0
- package/docs/api/bugReports.d.ts +181 -0
- package/docs/api/bugReports.md +268 -0
- package/docs/api/by-path.md +3260 -0
- package/docs/api/calendarInvites.d.ts +117 -0
- package/docs/api/calendarInvites.md +148 -0
- package/docs/api/campaignWorkflows.d.ts +152 -0
- package/docs/api/campaignWorkflows.md +200 -0
- package/docs/api/campaigns.d.ts +721 -0
- package/docs/api/campaigns.md +1236 -0
- package/docs/api/channels.d.ts +171 -0
- package/docs/api/channels.md +235 -0
- package/docs/api/cliCampaigns.d.ts +205 -0
- package/docs/api/cliCampaigns.md +256 -0
- package/docs/api/cliPipelines.d.ts +324 -0
- package/docs/api/cliPipelines.md +562 -0
- package/docs/api/clickHouse.d.ts +115 -0
- package/docs/api/clickHouse.md +138 -0
- package/docs/api/companies.d.ts +1636 -0
- package/docs/api/companies.md +2211 -0
- package/docs/api/companyIntelligence.d.ts +299 -0
- package/docs/api/companyIntelligence.md +488 -0
- package/docs/api/contacts.d.ts +2173 -0
- package/docs/api/contacts.md +3143 -0
- package/docs/api/content.d.ts +968 -0
- package/docs/api/content.md +1667 -0
- package/docs/api/contentGridSkills.d.ts +177 -0
- package/docs/api/contentGridSkills.md +271 -0
- package/docs/api/copilot.d.ts +1017 -0
- package/docs/api/copilot.md +1765 -0
- package/docs/api/crmSyncs.d.ts +215 -0
- package/docs/api/crmSyncs.md +301 -0
- package/docs/api/customerSuccess.d.ts +491 -0
- package/docs/api/customerSuccess.md +776 -0
- package/docs/api/deals.d.ts +1696 -0
- package/docs/api/deals.md +2432 -0
- package/docs/api/deliverability.d.ts +418 -0
- package/docs/api/deliverability.md +677 -0
- package/docs/api/desk.d.ts +1765 -0
- package/docs/api/desk.md +3007 -0
- package/docs/api/dialer.d.ts +1185 -0
- package/docs/api/dialer.md +2166 -0
- package/docs/api/dialerAnalytics.d.ts +187 -0
- package/docs/api/dialerAnalytics.md +257 -0
- package/docs/api/documents.d.ts +895 -0
- package/docs/api/documents.md +1440 -0
- package/docs/api/duplicates.d.ts +195 -0
- package/docs/api/duplicates.md +315 -0
- package/docs/api/eSign.d.ts +38 -0
- package/docs/api/eSign.md +54 -0
- package/docs/api/eSignature.d.ts +242 -0
- package/docs/api/eSignature.md +341 -0
- package/docs/api/enrichment.d.ts +3207 -0
- package/docs/api/enrichment.md +5225 -0
- package/docs/api/events.d.ts +115 -0
- package/docs/api/events.md +105 -0
- package/docs/api/fields.d.ts +482 -0
- package/docs/api/fields.md +566 -0
- package/docs/api/forms.d.ts +1012 -0
- package/docs/api/forms.md +1542 -0
- package/docs/api/gtmCampaigns.d.ts +662 -0
- package/docs/api/gtmCampaigns.md +1044 -0
- package/docs/api/gtmContext.d.ts +1187 -0
- package/docs/api/gtmContext.md +2112 -0
- package/docs/api/gtmDeliverability.d.ts +60 -0
- package/docs/api/gtmDeliverability.md +63 -0
- package/docs/api/gtmKnowledgeBase.d.ts +76 -0
- package/docs/api/gtmKnowledgeBase.md +91 -0
- package/docs/api/gtmLaunchHelpers.d.ts +123 -0
- package/docs/api/gtmLaunchHelpers.md +148 -0
- package/docs/api/gtmLibrary.d.ts +448 -0
- package/docs/api/gtmLibrary.md +780 -0
- package/docs/api/health.d.ts +39 -0
- package/docs/api/health.md +58 -0
- package/docs/api/imageLibrary.d.ts +341 -0
- package/docs/api/imageLibrary.md +569 -0
- package/docs/api/imports.d.ts +157 -0
- package/docs/api/imports.md +174 -0
- package/docs/api/inbox.d.ts +709 -0
- package/docs/api/inbox.md +1067 -0
- package/docs/api/install.d.ts +213 -0
- package/docs/api/install.md +317 -0
- package/docs/api/installedApps.d.ts +131 -0
- package/docs/api/installedApps.md +241 -0
- package/docs/api/integrationStatus.d.ts +142 -0
- package/docs/api/integrationStatus.md +205 -0
- package/docs/api/integrations.d.ts +2327 -0
- package/docs/api/integrations.md +3791 -0
- package/docs/api/intent.d.ts +482 -0
- package/docs/api/intent.md +858 -0
- package/docs/api/knowledge.d.ts +501 -0
- package/docs/api/knowledge.md +843 -0
- package/docs/api/knowledgeBase.d.ts +84 -0
- package/docs/api/knowledgeBase.md +96 -0
- package/docs/api/landingPages.d.ts +1411 -0
- package/docs/api/landingPages.md +2488 -0
- package/docs/api/leads.d.ts +133 -0
- package/docs/api/leads.md +180 -0
- package/docs/api/library.d.ts +217 -0
- package/docs/api/library.md +338 -0
- package/docs/api/linkedIn.d.ts +227 -0
- package/docs/api/linkedIn.md +289 -0
- package/docs/api/linkedInOutreach.d.ts +727 -0
- package/docs/api/linkedInOutreach.md +990 -0
- package/docs/api/lists.d.ts +1106 -0
- package/docs/api/lists.md +1609 -0
- package/docs/api/logs.d.ts +71 -0
- package/docs/api/logs.md +70 -0
- package/docs/api/mailboxes.d.ts +1050 -0
- package/docs/api/mailboxes.md +1690 -0
- package/docs/api/marketingIntelligence.d.ts +256 -0
- package/docs/api/marketingIntelligence.md +454 -0
- package/docs/api/marketplace.d.ts +3173 -0
- package/docs/api/marketplace.md +5953 -0
- package/docs/api/mcp.d.ts +69 -0
- package/docs/api/mcp.md +69 -0
- package/docs/api/me.d.ts +54 -0
- package/docs/api/me.md +56 -0
- package/docs/api/meetings.d.ts +539 -0
- package/docs/api/meetings.md +747 -0
- package/docs/api/newsletter.d.ts +1613 -0
- package/docs/api/newsletter.md +2746 -0
- package/docs/api/notes.d.ts +517 -0
- package/docs/api/notes.md +888 -0
- package/docs/api/notifications.d.ts +94 -0
- package/docs/api/notifications.md +105 -0
- package/docs/api/objects.d.ts +621 -0
- package/docs/api/objects.md +1098 -0
- package/docs/api/openSearch.d.ts +234 -0
- package/docs/api/openSearch.md +297 -0
- package/docs/api/ops.d.ts +299 -0
- package/docs/api/ops.md +339 -0
- package/docs/api/orgGovernance.d.ts +393 -0
- package/docs/api/orgGovernance.md +623 -0
- package/docs/api/orgVideos.d.ts +184 -0
- package/docs/api/orgVideos.md +252 -0
- package/docs/api/organizationSettings.d.ts +626 -0
- package/docs/api/organizationSettings.md +911 -0
- package/docs/api/phoneNumbers.d.ts +484 -0
- package/docs/api/phoneNumbers.md +777 -0
- package/docs/api/profile.d.ts +329 -0
- package/docs/api/profile.md +540 -0
- package/docs/api/programmaticPages.d.ts +400 -0
- package/docs/api/programmaticPages.md +626 -0
- package/docs/api/providerDomains.d.ts +866 -0
- package/docs/api/providerDomains.md +1446 -0
- package/docs/api/providerUsage.d.ts +129 -0
- package/docs/api/providerUsage.md +186 -0
- package/docs/api/public.d.ts +69 -0
- package/docs/api/public.md +78 -0
- package/docs/api/publicCopilot.d.ts +67 -0
- package/docs/api/publicCopilot.md +80 -0
- package/docs/api/publicSignals.d.ts +66 -0
- package/docs/api/publicSignals.md +71 -0
- package/docs/api/publicVisitors.d.ts +97 -0
- package/docs/api/publicVisitors.md +118 -0
- package/docs/api/quotes.d.ts +1564 -0
- package/docs/api/quotes.md +2553 -0
- package/docs/api/radar.d.ts +808 -0
- package/docs/api/radar.md +1431 -0
- package/docs/api/radarReports.d.ts +208 -0
- package/docs/api/radarReports.md +306 -0
- package/docs/api/recordRoles.d.ts +143 -0
- package/docs/api/recordRoles.md +175 -0
- package/docs/api/repos.d.ts +146 -0
- package/docs/api/repos.md +211 -0
- package/docs/api/research.d.ts +295 -0
- package/docs/api/research.md +534 -0
- package/docs/api/revenue.d.ts +402 -0
- package/docs/api/revenue.md +608 -0
- package/docs/api/revenueAnalytics.d.ts +147 -0
- package/docs/api/revenueAnalytics.md +212 -0
- package/docs/api/revenueLifecycle.d.ts +207 -0
- package/docs/api/revenueLifecycle.md +274 -0
- package/docs/api/revenueRecords.d.ts +372 -0
- package/docs/api/revenueRecords.md +563 -0
- package/docs/api/roles.d.ts +431 -0
- package/docs/api/roles.md +812 -0
- package/docs/api/salesCoach.d.ts +877 -0
- package/docs/api/salesCoach.md +1540 -0
- package/docs/api/sandbox.d.ts +210 -0
- package/docs/api/sandbox.md +380 -0
- package/docs/api/scans.d.ts +104 -0
- package/docs/api/scans.md +136 -0
- package/docs/api/scheduleBuy.d.ts +293 -0
- package/docs/api/scheduleBuy.md +431 -0
- package/docs/api/scraping.d.ts +266 -0
- package/docs/api/scraping.md +383 -0
- package/docs/api/sdrAnalytics.d.ts +138 -0
- package/docs/api/sdrAnalytics.md +246 -0
- package/docs/api/search.d.ts +598 -0
- package/docs/api/search.md +866 -0
- package/docs/api/seo.d.ts +447 -0
- package/docs/api/seo.md +660 -0
- package/docs/api/sequenceLifecycle.d.ts +439 -0
- package/docs/api/sequenceLifecycle.md +513 -0
- package/docs/api/sequences.d.ts +1936 -0
- package/docs/api/sequences.md +3232 -0
- package/docs/api/settings.d.ts +448 -0
- package/docs/api/settings.md +731 -0
- package/docs/api/signals.d.ts +1441 -0
- package/docs/api/signals.md +2526 -0
- package/docs/api/signatures.d.ts +719 -0
- package/docs/api/signatures.md +1247 -0
- package/docs/api/skills.d.ts +230 -0
- package/docs/api/skills.md +466 -0
- package/docs/api/snippet.d.ts +85 -0
- package/docs/api/snippet.md +106 -0
- package/docs/api/socialPublishing.d.ts +824 -0
- package/docs/api/socialPublishing.md +1245 -0
- package/docs/api/studioDocuments.d.ts +244 -0
- package/docs/api/studioDocuments.md +348 -0
- package/docs/api/support.d.ts +90 -0
- package/docs/api/support.md +76 -0
- package/docs/api/suppressions.d.ts +241 -0
- package/docs/api/suppressions.md +343 -0
- package/docs/api/surveys.d.ts +847 -0
- package/docs/api/surveys.md +1223 -0
- package/docs/api/tasks.d.ts +813 -0
- package/docs/api/tasks.md +1344 -0
- package/docs/api/teamMembers.d.ts +668 -0
- package/docs/api/teamMembers.md +1040 -0
- package/docs/api/teams.d.ts +784 -0
- package/docs/api/teams.md +1395 -0
- package/docs/api/usage.d.ts +277 -0
- package/docs/api/usage.md +389 -0
- package/docs/api/visitors.d.ts +690 -0
- package/docs/api/visitors.md +1075 -0
- package/docs/api/voice.d.ts +4661 -0
- package/docs/api/voice.md +7905 -0
- package/docs/api/webAnalytics.d.ts +964 -0
- package/docs/api/webAnalytics.md +1452 -0
- package/docs/api/webChat.d.ts +1704 -0
- package/docs/api/webChat.md +2048 -0
- package/docs/api/webhooks.d.ts +251 -0
- package/docs/api/webhooks.md +386 -0
- package/docs/api/websiteEditor.d.ts +324 -0
- package/docs/api/websiteEditor.md +517 -0
- package/docs/api/work.d.ts +2298 -0
- package/docs/api/work.md +3096 -0
- package/docs/api/workbench.d.ts +2962 -0
- package/docs/api/workbench.md +4884 -0
- package/docs/api/workflows.d.ts +1218 -0
- package/docs/api/workflows.md +2302 -0
- package/docs/sdk-clients.md +4339 -0
- package/package.json +10 -3
|
@@ -0,0 +1,1452 @@
|
|
|
1
|
+
<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
|
|
2
|
+
|
|
3
|
+
# `g8.api.webAnalytics`: Web Analytics
|
|
4
|
+
|
|
5
|
+
38 operations (38 read).
|
|
6
|
+
|
|
7
|
+
No hand-written client covers this area. Call it through `g8.api.webAnalytics.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
|
|
8
|
+
|
|
9
|
+
Every example below assumes this setup (server-side, API key):
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import { g8 } from "@graph8/sdk";
|
|
13
|
+
|
|
14
|
+
g8.init({ apiKey: process.env.G8_API_KEY! });
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
|
|
18
|
+
|
|
19
|
+
Exact TypeScript types for every operation on this page, and every schema they use: [webAnalytics.d.ts](webAnalytics.d.ts).
|
|
20
|
+
|
|
21
|
+
## Operations
|
|
22
|
+
|
|
23
|
+
| Call | HTTP | Tier | Scope | Summary |
|
|
24
|
+
|---|---|---|---|---|
|
|
25
|
+
| [`getAcquisitionCampaigns`](#op-getacquisitioncampaigns) | `GET /api/v1/analytics/acquisition/campaigns` | read | `analytics:read` | Get Acquisition Campaigns |
|
|
26
|
+
| [`getAcquisitionChannels`](#op-getacquisitionchannels) | `GET /api/v1/analytics/acquisition/channels` | read | `analytics:read` | Get Acquisition Channels |
|
|
27
|
+
| [`getAcquisitionChannelsTrend`](#op-getacquisitionchannelstrend) | `GET /api/v1/analytics/acquisition/channels/trend` | read | `analytics:read` | Get Acquisition Channels Trend |
|
|
28
|
+
| [`getAcquisitionReferrals`](#op-getacquisitionreferrals) | `GET /api/v1/analytics/acquisition/referrals` | read | `analytics:read` | Get Acquisition Referrals |
|
|
29
|
+
| [`getAcquisitionSearch`](#op-getacquisitionsearch) | `GET /api/v1/analytics/acquisition/search` | read | `analytics:read` | Get Acquisition Search |
|
|
30
|
+
| [`getAcquisitionSocial`](#op-getacquisitionsocial) | `GET /api/v1/analytics/acquisition/social` | read | `analytics:read` | Get Acquisition Social |
|
|
31
|
+
| [`getAcquisitionSources`](#op-getacquisitionsources) | `GET /api/v1/analytics/acquisition/sources` | read | `analytics:read` | Get Acquisition Sources |
|
|
32
|
+
| [`getAudienceBehavior`](#op-getaudiencebehavior) | `GET /api/v1/analytics/audience/behavior` | read | `analytics:read` | Get Audience Behavior |
|
|
33
|
+
| [`getAudienceDemographics`](#op-getaudiencedemographics) | `GET /api/v1/analytics/audience/demographics` | read | `analytics:read` | Get Audience Demographics |
|
|
34
|
+
| [`getAudienceLanguages`](#op-getaudiencelanguages) | `GET /api/v1/analytics/audience/languages` | read | `analytics:read` | Get Audience Languages |
|
|
35
|
+
| [`getAudienceOverview`](#op-getaudienceoverview) | `GET /api/v1/analytics/audience/overview` | read | `analytics:read` | Get Audience Overview |
|
|
36
|
+
| [`getAudienceTrend`](#op-getaudiencetrend) | `GET /api/v1/analytics/audience/trend` | read | `analytics:read` | Get Audience Trend |
|
|
37
|
+
| [`getConversionRate`](#op-getconversionrate) | `GET /api/v1/analytics/conversions/rate` | read | `analytics:read` | Get Conversion Rate |
|
|
38
|
+
| [`getEngagementByCampaign`](#op-getengagementbycampaign) | `GET /api/v1/analytics/engagement/by-campaign` | read | `analytics:read` | Get Engagement By Campaign |
|
|
39
|
+
| [`getEngagementByChannel`](#op-getengagementbychannel) | `GET /api/v1/analytics/engagement/by-channel` | read | `analytics:read` | Get Engagement By Channel |
|
|
40
|
+
| [`getEngagementByLandingPage`](#op-getengagementbylandingpage) | `GET /api/v1/analytics/engagement/by-landing-page` | read | `analytics:read` | Get Engagement By Landing Page |
|
|
41
|
+
| [`getEngagementOverview`](#op-getengagementoverview) | `GET /api/v1/analytics/engagement/overview` | read | `analytics:read` | Get Engagement Overview |
|
|
42
|
+
| [`getEngagementTrend`](#op-getengagementtrend) | `GET /api/v1/analytics/engagement/trend` | read | `analytics:read` | Get Engagement Trend |
|
|
43
|
+
| [`getEvents`](#op-getevents) | `GET /api/v1/analytics/behavior/events` | read | `analytics:read` | Get Events |
|
|
44
|
+
| [`getExitPages`](#op-getexitpages) | `GET /api/v1/analytics/behavior/exit-pages` | read | `analytics:read` | Get Exit Pages |
|
|
45
|
+
| [`getFormAnalysis`](#op-getformanalysis) | `GET /api/v1/analytics/conversions/forms/analysis` | read | `analytics:read` | Get Form Analysis |
|
|
46
|
+
| [`getForms`](#op-getforms) | `GET /api/v1/analytics/conversions/forms` | read | `analytics:read` | Get Forms |
|
|
47
|
+
| [`getFormsTrend`](#op-getformstrend) | `GET /api/v1/analytics/conversions/forms/trend` | read | `analytics:read` | Get Forms Trend |
|
|
48
|
+
| [`getFunnel`](#op-getfunnel) | `GET /api/v1/analytics/conversions/funnel` | read | `analytics:read` | Get Funnel |
|
|
49
|
+
| [`getGeoCities`](#op-getgeocities) | `GET /api/v1/analytics/audience/geo/cities` | read | `analytics:read` | Get Geo Cities |
|
|
50
|
+
| [`getGeoCountries`](#op-getgeocountries) | `GET /api/v1/analytics/audience/geo` | read | `analytics:read` | Get Geo Countries |
|
|
51
|
+
| [`getGoals`](#op-getgoals) | `GET /api/v1/analytics/conversions/goals` | read | `analytics:read` | Get Goals |
|
|
52
|
+
| [`getGoalsTrend`](#op-getgoalstrend) | `GET /api/v1/analytics/conversions/goals/trend` | read | `analytics:read` | Get Goals Trend |
|
|
53
|
+
| [`getLandingPages`](#op-getlandingpages) | `GET /api/v1/analytics/behavior/landing-pages` | read | `analytics:read` | Get Landing Pages |
|
|
54
|
+
| [`getPageMetrics`](#op-getpagemetrics) | `GET /api/v1/analytics/behavior/page-metrics` | read | `analytics:read` | Get Page Metrics |
|
|
55
|
+
| [`getRealtime`](#op-getrealtime) | `GET /api/v1/analytics/realtime` | read | `analytics:read` | Get Realtime |
|
|
56
|
+
| [`getRealtimeLocations`](#op-getrealtimelocations) | `GET /api/v1/analytics/realtime/locations` | read | `analytics:read` | Get Realtime Locations |
|
|
57
|
+
| [`getRealtimePages`](#op-getrealtimepages) | `GET /api/v1/analytics/realtime/pages` | read | `analytics:read` | Get Realtime Pages |
|
|
58
|
+
| [`getRealtimeSources`](#op-getrealtimesources) | `GET /api/v1/analytics/realtime/sources` | read | `analytics:read` | Get Realtime Sources |
|
|
59
|
+
| [`getSessionDepthDistribution`](#op-getsessiondepthdistribution) | `GET /api/v1/analytics/engagement/depth-distribution` | read | `analytics:read` | Get Session Depth Distribution |
|
|
60
|
+
| [`getTechnologyOverview`](#op-gettechnologyoverview) | `GET /api/v1/analytics/audience/technology` | read | `analytics:read` | Get Technology Overview |
|
|
61
|
+
| [`getTimeOnSiteDistribution`](#op-gettimeonsitedistribution) | `GET /api/v1/analytics/engagement/time-distribution` | read | `analytics:read` | Get Time On Site Distribution |
|
|
62
|
+
| [`getTopPages`](#op-gettoppages) | `GET /api/v1/analytics/behavior/pages` | read | `analytics:read` | Get Top Pages |
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
<a id="op-getacquisitioncampaigns"></a>
|
|
67
|
+
|
|
68
|
+
### `g8.api.webAnalytics.getAcquisitionCampaigns(input?)`
|
|
69
|
+
|
|
70
|
+
**Get Acquisition Campaigns**
|
|
71
|
+
|
|
72
|
+
- HTTP: `GET /api/v1/analytics/acquisition/campaigns`
|
|
73
|
+
- operationId: `get_acquisition_campaigns_analytics_acquisition_campaigns_get` (also callable as `g8.api.call("get_acquisition_campaigns_analytics_acquisition_campaigns_get", input)`)
|
|
74
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
75
|
+
- API-key scope: `analytics:read`
|
|
76
|
+
|
|
77
|
+
Get UTM campaign performance.
|
|
78
|
+
|
|
79
|
+
**Cache TTL**: 300 seconds (5 min) - campaigns change less frequently.
|
|
80
|
+
|
|
81
|
+
**Input**
|
|
82
|
+
|
|
83
|
+
| Field | Type | Required | Description |
|
|
84
|
+
|---|---|---|---|
|
|
85
|
+
| `query.limit` | `integer` | no | Number of campaigns to return default `50` |
|
|
86
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
87
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
88
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
89
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
90
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
91
|
+
|
|
92
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
93
|
+
|
|
94
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
95
|
+
|
|
96
|
+
**Example**
|
|
97
|
+
|
|
98
|
+
```ts
|
|
99
|
+
const result = await g8.api.webAnalytics.getAcquisitionCampaigns();
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
<a id="op-getacquisitionchannels"></a>
|
|
105
|
+
|
|
106
|
+
### `g8.api.webAnalytics.getAcquisitionChannels(input?)`
|
|
107
|
+
|
|
108
|
+
**Get Acquisition Channels**
|
|
109
|
+
|
|
110
|
+
- HTTP: `GET /api/v1/analytics/acquisition/channels`
|
|
111
|
+
- operationId: `get_acquisition_channels_analytics_acquisition_channels_get` (also callable as `g8.api.call("get_acquisition_channels_analytics_acquisition_channels_get", input)`)
|
|
112
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
113
|
+
- API-key scope: `analytics:read`
|
|
114
|
+
|
|
115
|
+
Get acquisition by channel grouping.
|
|
116
|
+
|
|
117
|
+
Channels: Direct, Organic Search, Paid Search, Organic Social,
|
|
118
|
+
Paid Social, Email, Referral, Display, Affiliates, Other.
|
|
119
|
+
|
|
120
|
+
**Input**
|
|
121
|
+
|
|
122
|
+
| Field | Type | Required | Description |
|
|
123
|
+
|---|---|---|---|
|
|
124
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
125
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
126
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
127
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
128
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
129
|
+
|
|
130
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
131
|
+
|
|
132
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
133
|
+
|
|
134
|
+
**Example**
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
const result = await g8.api.webAnalytics.getAcquisitionChannels();
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
<a id="op-getacquisitionchannelstrend"></a>
|
|
143
|
+
|
|
144
|
+
### `g8.api.webAnalytics.getAcquisitionChannelsTrend(input?)`
|
|
145
|
+
|
|
146
|
+
**Get Acquisition Channels Trend**
|
|
147
|
+
|
|
148
|
+
- HTTP: `GET /api/v1/analytics/acquisition/channels/trend`
|
|
149
|
+
- operationId: `get_acquisition_channels_trend_analytics_acquisition_channels_trend_get` (also callable as `g8.api.call("get_acquisition_channels_trend_analytics_acquisition_channels_trend_get", input)`)
|
|
150
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
151
|
+
- API-key scope: `analytics:read`
|
|
152
|
+
|
|
153
|
+
Get daily channel breakdown for stacked area charts.
|
|
154
|
+
|
|
155
|
+
**Input**
|
|
156
|
+
|
|
157
|
+
| Field | Type | Required | Description |
|
|
158
|
+
|---|---|---|---|
|
|
159
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
160
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
161
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
162
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
163
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
164
|
+
|
|
165
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
166
|
+
|
|
167
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
168
|
+
|
|
169
|
+
**Example**
|
|
170
|
+
|
|
171
|
+
```ts
|
|
172
|
+
const result = await g8.api.webAnalytics.getAcquisitionChannelsTrend();
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
<a id="op-getacquisitionreferrals"></a>
|
|
178
|
+
|
|
179
|
+
### `g8.api.webAnalytics.getAcquisitionReferrals(input?)`
|
|
180
|
+
|
|
181
|
+
**Get Acquisition Referrals**
|
|
182
|
+
|
|
183
|
+
- HTTP: `GET /api/v1/analytics/acquisition/referrals`
|
|
184
|
+
- operationId: `get_acquisition_referrals_analytics_acquisition_referrals_get` (also callable as `g8.api.call("get_acquisition_referrals_analytics_acquisition_referrals_get", input)`)
|
|
185
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
186
|
+
- API-key scope: `analytics:read`
|
|
187
|
+
|
|
188
|
+
Get top referring domains.
|
|
189
|
+
|
|
190
|
+
**Input**
|
|
191
|
+
|
|
192
|
+
| Field | Type | Required | Description |
|
|
193
|
+
|---|---|---|---|
|
|
194
|
+
| `query.limit` | `integer` | no | Number of referrers to return default `50` |
|
|
195
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
196
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
197
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
198
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
199
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
200
|
+
|
|
201
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
202
|
+
|
|
203
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
204
|
+
|
|
205
|
+
**Example**
|
|
206
|
+
|
|
207
|
+
```ts
|
|
208
|
+
const result = await g8.api.webAnalytics.getAcquisitionReferrals();
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
<a id="op-getacquisitionsearch"></a>
|
|
214
|
+
|
|
215
|
+
### `g8.api.webAnalytics.getAcquisitionSearch(input?)`
|
|
216
|
+
|
|
217
|
+
**Get Acquisition Search**
|
|
218
|
+
|
|
219
|
+
- HTTP: `GET /api/v1/analytics/acquisition/search`
|
|
220
|
+
- operationId: `get_acquisition_search_analytics_acquisition_search_get` (also callable as `g8.api.call("get_acquisition_search_analytics_acquisition_search_get", input)`)
|
|
221
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
222
|
+
- API-key scope: `analytics:read`
|
|
223
|
+
|
|
224
|
+
Get acquisition from search engines.
|
|
225
|
+
|
|
226
|
+
**Input**
|
|
227
|
+
|
|
228
|
+
| Field | Type | Required | Description |
|
|
229
|
+
|---|---|---|---|
|
|
230
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
231
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
232
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
233
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
234
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
235
|
+
|
|
236
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
237
|
+
|
|
238
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
239
|
+
|
|
240
|
+
**Example**
|
|
241
|
+
|
|
242
|
+
```ts
|
|
243
|
+
const result = await g8.api.webAnalytics.getAcquisitionSearch();
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
---
|
|
247
|
+
|
|
248
|
+
<a id="op-getacquisitionsocial"></a>
|
|
249
|
+
|
|
250
|
+
### `g8.api.webAnalytics.getAcquisitionSocial(input?)`
|
|
251
|
+
|
|
252
|
+
**Get Acquisition Social**
|
|
253
|
+
|
|
254
|
+
- HTTP: `GET /api/v1/analytics/acquisition/social`
|
|
255
|
+
- operationId: `get_acquisition_social_analytics_acquisition_social_get` (also callable as `g8.api.call("get_acquisition_social_analytics_acquisition_social_get", input)`)
|
|
256
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
257
|
+
- API-key scope: `analytics:read`
|
|
258
|
+
|
|
259
|
+
Get acquisition from social networks.
|
|
260
|
+
|
|
261
|
+
**Input**
|
|
262
|
+
|
|
263
|
+
| Field | Type | Required | Description |
|
|
264
|
+
|---|---|---|---|
|
|
265
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
266
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
267
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
268
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
269
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
270
|
+
|
|
271
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
272
|
+
|
|
273
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
274
|
+
|
|
275
|
+
**Example**
|
|
276
|
+
|
|
277
|
+
```ts
|
|
278
|
+
const result = await g8.api.webAnalytics.getAcquisitionSocial();
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
<a id="op-getacquisitionsources"></a>
|
|
284
|
+
|
|
285
|
+
### `g8.api.webAnalytics.getAcquisitionSources(input?)`
|
|
286
|
+
|
|
287
|
+
**Get Acquisition Sources**
|
|
288
|
+
|
|
289
|
+
- HTTP: `GET /api/v1/analytics/acquisition/sources`
|
|
290
|
+
- operationId: `get_acquisition_sources_analytics_acquisition_sources_get` (also callable as `g8.api.call("get_acquisition_sources_analytics_acquisition_sources_get", input)`)
|
|
291
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
292
|
+
- API-key scope: `analytics:read`
|
|
293
|
+
|
|
294
|
+
Get acquisition by source/medium combination.
|
|
295
|
+
|
|
296
|
+
**Input**
|
|
297
|
+
|
|
298
|
+
| Field | Type | Required | Description |
|
|
299
|
+
|---|---|---|---|
|
|
300
|
+
| `query.limit` | `integer` | no | Number of sources to return default `50` |
|
|
301
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
302
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
303
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
304
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
305
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
306
|
+
|
|
307
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
308
|
+
|
|
309
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
310
|
+
|
|
311
|
+
**Example**
|
|
312
|
+
|
|
313
|
+
```ts
|
|
314
|
+
const result = await g8.api.webAnalytics.getAcquisitionSources();
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
---
|
|
318
|
+
|
|
319
|
+
<a id="op-getaudiencebehavior"></a>
|
|
320
|
+
|
|
321
|
+
### `g8.api.webAnalytics.getAudienceBehavior(input?)`
|
|
322
|
+
|
|
323
|
+
**Get Audience Behavior**
|
|
324
|
+
|
|
325
|
+
- HTTP: `GET /api/v1/analytics/audience/behavior`
|
|
326
|
+
- operationId: `get_audience_behavior_analytics_audience_behavior_get` (also callable as `g8.api.call("get_audience_behavior_analytics_audience_behavior_get", input)`)
|
|
327
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
328
|
+
- API-key scope: `analytics:read`
|
|
329
|
+
|
|
330
|
+
Get new vs returning visitors breakdown.
|
|
331
|
+
|
|
332
|
+
**Input**
|
|
333
|
+
|
|
334
|
+
| Field | Type | Required | Description |
|
|
335
|
+
|---|---|---|---|
|
|
336
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
337
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
338
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
339
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
340
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
341
|
+
|
|
342
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
343
|
+
|
|
344
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
345
|
+
|
|
346
|
+
**Example**
|
|
347
|
+
|
|
348
|
+
```ts
|
|
349
|
+
const result = await g8.api.webAnalytics.getAudienceBehavior();
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
---
|
|
353
|
+
|
|
354
|
+
<a id="op-getaudiencedemographics"></a>
|
|
355
|
+
|
|
356
|
+
### `g8.api.webAnalytics.getAudienceDemographics(input?)`
|
|
357
|
+
|
|
358
|
+
**Get Audience Demographics**
|
|
359
|
+
|
|
360
|
+
- HTTP: `GET /api/v1/analytics/audience/demographics`
|
|
361
|
+
- operationId: `get_audience_demographics_analytics_audience_demographics_get` (also callable as `g8.api.call("get_audience_demographics_analytics_audience_demographics_get", input)`)
|
|
362
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
363
|
+
- API-key scope: `analytics:read`
|
|
364
|
+
|
|
365
|
+
Get combined demographics: countries, cities, languages.
|
|
366
|
+
|
|
367
|
+
Aggregates geographic and language data for the demographics view.
|
|
368
|
+
Returns top 10 entries for each category.
|
|
369
|
+
|
|
370
|
+
**Input**
|
|
371
|
+
|
|
372
|
+
| Field | Type | Required | Description |
|
|
373
|
+
|---|---|---|---|
|
|
374
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
375
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
376
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
377
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
378
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
379
|
+
|
|
380
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
381
|
+
|
|
382
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
383
|
+
|
|
384
|
+
**Example**
|
|
385
|
+
|
|
386
|
+
```ts
|
|
387
|
+
const result = await g8.api.webAnalytics.getAudienceDemographics();
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
---
|
|
391
|
+
|
|
392
|
+
<a id="op-getaudiencelanguages"></a>
|
|
393
|
+
|
|
394
|
+
### `g8.api.webAnalytics.getAudienceLanguages(input?)`
|
|
395
|
+
|
|
396
|
+
**Get Audience Languages**
|
|
397
|
+
|
|
398
|
+
- HTTP: `GET /api/v1/analytics/audience/languages`
|
|
399
|
+
- operationId: `get_audience_languages_analytics_audience_languages_get` (also callable as `g8.api.call("get_audience_languages_analytics_audience_languages_get", input)`)
|
|
400
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
401
|
+
- API-key scope: `analytics:read`
|
|
402
|
+
|
|
403
|
+
Get visitor languages breakdown.
|
|
404
|
+
|
|
405
|
+
**Input**
|
|
406
|
+
|
|
407
|
+
| Field | Type | Required | Description |
|
|
408
|
+
|---|---|---|---|
|
|
409
|
+
| `query.limit` | `integer` | no | Number of languages to return default `20` |
|
|
410
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
411
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
412
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
413
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
414
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
415
|
+
|
|
416
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
417
|
+
|
|
418
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
419
|
+
|
|
420
|
+
**Example**
|
|
421
|
+
|
|
422
|
+
```ts
|
|
423
|
+
const result = await g8.api.webAnalytics.getAudienceLanguages();
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
---
|
|
427
|
+
|
|
428
|
+
<a id="op-getaudienceoverview"></a>
|
|
429
|
+
|
|
430
|
+
### `g8.api.webAnalytics.getAudienceOverview(input?)`
|
|
431
|
+
|
|
432
|
+
**Get Audience Overview**
|
|
433
|
+
|
|
434
|
+
- HTTP: `GET /api/v1/analytics/audience/overview`
|
|
435
|
+
- operationId: `get_audience_overview_analytics_audience_overview_get` (also callable as `g8.api.call("get_audience_overview_analytics_audience_overview_get", input)`)
|
|
436
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
437
|
+
- API-key scope: `analytics:read`
|
|
438
|
+
|
|
439
|
+
Get audience overview: total users, new users, sessions, page views.
|
|
440
|
+
|
|
441
|
+
**Typical use**: Dashboard header metrics.
|
|
442
|
+
|
|
443
|
+
**Input**
|
|
444
|
+
|
|
445
|
+
| Field | Type | Required | Description |
|
|
446
|
+
|---|---|---|---|
|
|
447
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
448
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
449
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
450
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
451
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
452
|
+
|
|
453
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
454
|
+
|
|
455
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
456
|
+
|
|
457
|
+
**Example**
|
|
458
|
+
|
|
459
|
+
```ts
|
|
460
|
+
const result = await g8.api.webAnalytics.getAudienceOverview();
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
---
|
|
464
|
+
|
|
465
|
+
<a id="op-getaudiencetrend"></a>
|
|
466
|
+
|
|
467
|
+
### `g8.api.webAnalytics.getAudienceTrend(input?)`
|
|
468
|
+
|
|
469
|
+
**Get Audience Trend**
|
|
470
|
+
|
|
471
|
+
- HTTP: `GET /api/v1/analytics/audience/trend`
|
|
472
|
+
- operationId: `get_audience_trend_analytics_audience_trend_get` (also callable as `g8.api.call("get_audience_trend_analytics_audience_trend_get", input)`)
|
|
473
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
474
|
+
- API-key scope: `analytics:read`
|
|
475
|
+
|
|
476
|
+
Get daily audience trend for line charts.
|
|
477
|
+
|
|
478
|
+
Returns date, users, new_users, page_views, sessions per day.
|
|
479
|
+
|
|
480
|
+
**Input**
|
|
481
|
+
|
|
482
|
+
| Field | Type | Required | Description |
|
|
483
|
+
|---|---|---|---|
|
|
484
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
485
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
486
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
487
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
488
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
489
|
+
|
|
490
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
491
|
+
|
|
492
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
493
|
+
|
|
494
|
+
**Example**
|
|
495
|
+
|
|
496
|
+
```ts
|
|
497
|
+
const result = await g8.api.webAnalytics.getAudienceTrend();
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
---
|
|
501
|
+
|
|
502
|
+
<a id="op-getconversionrate"></a>
|
|
503
|
+
|
|
504
|
+
### `g8.api.webAnalytics.getConversionRate(input?)`
|
|
505
|
+
|
|
506
|
+
**Get Conversion Rate**
|
|
507
|
+
|
|
508
|
+
- HTTP: `GET /api/v1/analytics/conversions/rate`
|
|
509
|
+
- operationId: `get_conversion_rate_analytics_conversions_rate_get` (also callable as `g8.api.call("get_conversion_rate_analytics_conversions_rate_get", input)`)
|
|
510
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
511
|
+
- API-key scope: `analytics:read`
|
|
512
|
+
|
|
513
|
+
Get overall visitor-to-conversion rate.
|
|
514
|
+
|
|
515
|
+
**Input**
|
|
516
|
+
|
|
517
|
+
| Field | Type | Required | Description |
|
|
518
|
+
|---|---|---|---|
|
|
519
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
520
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
521
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
522
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
523
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
524
|
+
|
|
525
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
526
|
+
|
|
527
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
528
|
+
|
|
529
|
+
**Example**
|
|
530
|
+
|
|
531
|
+
```ts
|
|
532
|
+
const result = await g8.api.webAnalytics.getConversionRate();
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
---
|
|
536
|
+
|
|
537
|
+
<a id="op-getengagementbycampaign"></a>
|
|
538
|
+
|
|
539
|
+
### `g8.api.webAnalytics.getEngagementByCampaign(input?)`
|
|
540
|
+
|
|
541
|
+
**Get Engagement By Campaign**
|
|
542
|
+
|
|
543
|
+
- HTTP: `GET /api/v1/analytics/engagement/by-campaign`
|
|
544
|
+
- operationId: `get_engagement_by_campaign_analytics_engagement_by_campaign_get` (also callable as `g8.api.call("get_engagement_by_campaign_analytics_engagement_by_campaign_get", input)`)
|
|
545
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
546
|
+
- API-key scope: `analytics:read`
|
|
547
|
+
|
|
548
|
+
Get engagement metrics by UTM campaign.
|
|
549
|
+
|
|
550
|
+
Extended campaign metrics including engagement quality.
|
|
551
|
+
**Cache TTL**: 300 seconds (5 min) - campaigns change less frequently.
|
|
552
|
+
|
|
553
|
+
**Input**
|
|
554
|
+
|
|
555
|
+
| Field | Type | Required | Description |
|
|
556
|
+
|---|---|---|---|
|
|
557
|
+
| `query.limit` | `integer` | no | Number of campaigns to return default `50` |
|
|
558
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
559
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
560
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
561
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
562
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
563
|
+
|
|
564
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
565
|
+
|
|
566
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
567
|
+
|
|
568
|
+
**Example**
|
|
569
|
+
|
|
570
|
+
```ts
|
|
571
|
+
const result = await g8.api.webAnalytics.getEngagementByCampaign();
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
---
|
|
575
|
+
|
|
576
|
+
<a id="op-getengagementbychannel"></a>
|
|
577
|
+
|
|
578
|
+
### `g8.api.webAnalytics.getEngagementByChannel(input?)`
|
|
579
|
+
|
|
580
|
+
**Get Engagement By Channel**
|
|
581
|
+
|
|
582
|
+
- HTTP: `GET /api/v1/analytics/engagement/by-channel`
|
|
583
|
+
- operationId: `get_engagement_by_channel_analytics_engagement_by_channel_get` (also callable as `g8.api.call("get_engagement_by_channel_analytics_engagement_by_channel_get", input)`)
|
|
584
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
585
|
+
- API-key scope: `analytics:read`
|
|
586
|
+
|
|
587
|
+
Get engagement metrics by acquisition channel.
|
|
588
|
+
|
|
589
|
+
Shows which channels drive best engagement quality.
|
|
590
|
+
|
|
591
|
+
**Input**
|
|
592
|
+
|
|
593
|
+
| Field | Type | Required | Description |
|
|
594
|
+
|---|---|---|---|
|
|
595
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
596
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
597
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
598
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
599
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
600
|
+
|
|
601
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
602
|
+
|
|
603
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
604
|
+
|
|
605
|
+
**Example**
|
|
606
|
+
|
|
607
|
+
```ts
|
|
608
|
+
const result = await g8.api.webAnalytics.getEngagementByChannel();
|
|
609
|
+
```
|
|
610
|
+
|
|
611
|
+
---
|
|
612
|
+
|
|
613
|
+
<a id="op-getengagementbylandingpage"></a>
|
|
614
|
+
|
|
615
|
+
### `g8.api.webAnalytics.getEngagementByLandingPage(input?)`
|
|
616
|
+
|
|
617
|
+
**Get Engagement By Landing Page**
|
|
618
|
+
|
|
619
|
+
- HTTP: `GET /api/v1/analytics/engagement/by-landing-page`
|
|
620
|
+
- operationId: `get_engagement_by_landing_page_analytics_engagement_by_landing_page_get` (also callable as `g8.api.call("get_engagement_by_landing_page_analytics_engagement_by_landing_page_get", input)`)
|
|
621
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
622
|
+
- API-key scope: `analytics:read`
|
|
623
|
+
|
|
624
|
+
Get engagement metrics by landing page.
|
|
625
|
+
|
|
626
|
+
Shows which landing pages drive best engagement quality.
|
|
627
|
+
Only includes pages with at least 10 sessions.
|
|
628
|
+
|
|
629
|
+
**Input**
|
|
630
|
+
|
|
631
|
+
| Field | Type | Required | Description |
|
|
632
|
+
|---|---|---|---|
|
|
633
|
+
| `query.limit` | `integer` | no | Number of pages to return default `20` |
|
|
634
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
635
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
636
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
637
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
638
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
639
|
+
|
|
640
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
641
|
+
|
|
642
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
643
|
+
|
|
644
|
+
**Example**
|
|
645
|
+
|
|
646
|
+
```ts
|
|
647
|
+
const result = await g8.api.webAnalytics.getEngagementByLandingPage();
|
|
648
|
+
```
|
|
649
|
+
|
|
650
|
+
---
|
|
651
|
+
|
|
652
|
+
<a id="op-getengagementoverview"></a>
|
|
653
|
+
|
|
654
|
+
### `g8.api.webAnalytics.getEngagementOverview(input?)`
|
|
655
|
+
|
|
656
|
+
**Get Engagement Overview**
|
|
657
|
+
|
|
658
|
+
- HTTP: `GET /api/v1/analytics/engagement/overview`
|
|
659
|
+
- operationId: `get_engagement_overview_analytics_engagement_overview_get` (also callable as `g8.api.call("get_engagement_overview_analytics_engagement_overview_get", input)`)
|
|
660
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
661
|
+
- API-key scope: `analytics:read`
|
|
662
|
+
|
|
663
|
+
Get engagement quality overview with trend indicators.
|
|
664
|
+
|
|
665
|
+
Returns:
|
|
666
|
+
- **total_sessions**: Total session count
|
|
667
|
+
- **avg_session_depth**: Average pages per session
|
|
668
|
+
- **avg_time_minutes**: Average session duration in minutes
|
|
669
|
+
- **bounce_rate**: Percentage of single-page sessions
|
|
670
|
+
- **engaged_sessions**: Sessions with >1 page AND >30s duration
|
|
671
|
+
- **engaged_pct**: Percentage of engaged sessions
|
|
672
|
+
- **Trend indicators**: Period-over-period comparison for each metric
|
|
673
|
+
|
|
674
|
+
**Typical use**: Marketing Intelligence dashboard - Engagement Quality card.
|
|
675
|
+
|
|
676
|
+
**Input**
|
|
677
|
+
|
|
678
|
+
| Field | Type | Required | Description |
|
|
679
|
+
|---|---|---|---|
|
|
680
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
681
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
682
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
683
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
684
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
685
|
+
|
|
686
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
687
|
+
|
|
688
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
689
|
+
|
|
690
|
+
**Example**
|
|
691
|
+
|
|
692
|
+
```ts
|
|
693
|
+
const result = await g8.api.webAnalytics.getEngagementOverview();
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
---
|
|
697
|
+
|
|
698
|
+
<a id="op-getengagementtrend"></a>
|
|
699
|
+
|
|
700
|
+
### `g8.api.webAnalytics.getEngagementTrend(input?)`
|
|
701
|
+
|
|
702
|
+
**Get Engagement Trend**
|
|
703
|
+
|
|
704
|
+
- HTTP: `GET /api/v1/analytics/engagement/trend`
|
|
705
|
+
- operationId: `get_engagement_trend_analytics_engagement_trend_get` (also callable as `g8.api.call("get_engagement_trend_analytics_engagement_trend_get", input)`)
|
|
706
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
707
|
+
- API-key scope: `analytics:read`
|
|
708
|
+
|
|
709
|
+
Get daily engagement trend for line charts.
|
|
710
|
+
|
|
711
|
+
Returns daily breakdown of:
|
|
712
|
+
- sessions
|
|
713
|
+
- avg_session_depth
|
|
714
|
+
- avg_time_minutes
|
|
715
|
+
- bounce_rate
|
|
716
|
+
- engaged_sessions
|
|
717
|
+
|
|
718
|
+
**Input**
|
|
719
|
+
|
|
720
|
+
| Field | Type | Required | Description |
|
|
721
|
+
|---|---|---|---|
|
|
722
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
723
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
724
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
725
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
726
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
727
|
+
|
|
728
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
729
|
+
|
|
730
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
731
|
+
|
|
732
|
+
**Example**
|
|
733
|
+
|
|
734
|
+
```ts
|
|
735
|
+
const result = await g8.api.webAnalytics.getEngagementTrend();
|
|
736
|
+
```
|
|
737
|
+
|
|
738
|
+
---
|
|
739
|
+
|
|
740
|
+
<a id="op-getevents"></a>
|
|
741
|
+
|
|
742
|
+
### `g8.api.webAnalytics.getEvents(input?)`
|
|
743
|
+
|
|
744
|
+
**Get Events**
|
|
745
|
+
|
|
746
|
+
- HTTP: `GET /api/v1/analytics/behavior/events`
|
|
747
|
+
- operationId: `get_events_analytics_behavior_events_get` (also callable as `g8.api.call("get_events_analytics_behavior_events_get", input)`)
|
|
748
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
749
|
+
- API-key scope: `analytics:read`
|
|
750
|
+
|
|
751
|
+
Get custom events summary (track events).
|
|
752
|
+
|
|
753
|
+
**Input**
|
|
754
|
+
|
|
755
|
+
| Field | Type | Required | Description |
|
|
756
|
+
|---|---|---|---|
|
|
757
|
+
| `query.limit` | `integer` | no | Number of events to return default `50` |
|
|
758
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
759
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
760
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
761
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
762
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
763
|
+
|
|
764
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
765
|
+
|
|
766
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
767
|
+
|
|
768
|
+
**Example**
|
|
769
|
+
|
|
770
|
+
```ts
|
|
771
|
+
const result = await g8.api.webAnalytics.getEvents();
|
|
772
|
+
```
|
|
773
|
+
|
|
774
|
+
---
|
|
775
|
+
|
|
776
|
+
<a id="op-getexitpages"></a>
|
|
777
|
+
|
|
778
|
+
### `g8.api.webAnalytics.getExitPages(input?)`
|
|
779
|
+
|
|
780
|
+
**Get Exit Pages**
|
|
781
|
+
|
|
782
|
+
- HTTP: `GET /api/v1/analytics/behavior/exit-pages`
|
|
783
|
+
- operationId: `get_exit_pages_analytics_behavior_exit_pages_get` (also callable as `g8.api.call("get_exit_pages_analytics_behavior_exit_pages_get", input)`)
|
|
784
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
785
|
+
- API-key scope: `analytics:read`
|
|
786
|
+
|
|
787
|
+
Get top exit pages (last pages in sessions).
|
|
788
|
+
|
|
789
|
+
**Input**
|
|
790
|
+
|
|
791
|
+
| Field | Type | Required | Description |
|
|
792
|
+
|---|---|---|---|
|
|
793
|
+
| `query.limit` | `integer` | no | Number of pages to return default `50` |
|
|
794
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
795
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
796
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
797
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
798
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
799
|
+
|
|
800
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
801
|
+
|
|
802
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
803
|
+
|
|
804
|
+
**Example**
|
|
805
|
+
|
|
806
|
+
```ts
|
|
807
|
+
const result = await g8.api.webAnalytics.getExitPages();
|
|
808
|
+
```
|
|
809
|
+
|
|
810
|
+
---
|
|
811
|
+
|
|
812
|
+
<a id="op-getformanalysis"></a>
|
|
813
|
+
|
|
814
|
+
### `g8.api.webAnalytics.getFormAnalysis(input?)`
|
|
815
|
+
|
|
816
|
+
**Get Form Analysis**
|
|
817
|
+
|
|
818
|
+
- HTTP: `GET /api/v1/analytics/conversions/forms/analysis`
|
|
819
|
+
- operationId: `get_form_analysis_analytics_conversions_forms_analysis_get` (also callable as `g8.api.call("get_form_analysis_analytics_conversions_forms_analysis_get", input)`)
|
|
820
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
821
|
+
- API-key scope: `analytics:read`
|
|
822
|
+
|
|
823
|
+
Get detailed form analysis with conversion rates.
|
|
824
|
+
|
|
825
|
+
**Input**
|
|
826
|
+
|
|
827
|
+
| Field | Type | Required | Description |
|
|
828
|
+
|---|---|---|---|
|
|
829
|
+
| `query.limit` | `integer` | no | Number of forms to return default `20` |
|
|
830
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
831
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
832
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
833
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
834
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
835
|
+
|
|
836
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
837
|
+
|
|
838
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
839
|
+
|
|
840
|
+
**Example**
|
|
841
|
+
|
|
842
|
+
```ts
|
|
843
|
+
const result = await g8.api.webAnalytics.getFormAnalysis();
|
|
844
|
+
```
|
|
845
|
+
|
|
846
|
+
---
|
|
847
|
+
|
|
848
|
+
<a id="op-getforms"></a>
|
|
849
|
+
|
|
850
|
+
### `g8.api.webAnalytics.getForms(input?)`
|
|
851
|
+
|
|
852
|
+
**Get Forms**
|
|
853
|
+
|
|
854
|
+
- HTTP: `GET /api/v1/analytics/conversions/forms`
|
|
855
|
+
- operationId: `get_forms_analytics_conversions_forms_get` (also callable as `g8.api.call("get_forms_analytics_conversions_forms_get", input)`)
|
|
856
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
857
|
+
- API-key scope: `analytics:read`
|
|
858
|
+
|
|
859
|
+
Get form submission analytics.
|
|
860
|
+
|
|
861
|
+
**Input**
|
|
862
|
+
|
|
863
|
+
| Field | Type | Required | Description |
|
|
864
|
+
|---|---|---|---|
|
|
865
|
+
| `query.limit` | `integer` | no | Number of forms to return default `50` |
|
|
866
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
867
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
868
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
869
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
870
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
871
|
+
|
|
872
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
873
|
+
|
|
874
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
875
|
+
|
|
876
|
+
**Example**
|
|
877
|
+
|
|
878
|
+
```ts
|
|
879
|
+
const result = await g8.api.webAnalytics.getForms();
|
|
880
|
+
```
|
|
881
|
+
|
|
882
|
+
---
|
|
883
|
+
|
|
884
|
+
<a id="op-getformstrend"></a>
|
|
885
|
+
|
|
886
|
+
### `g8.api.webAnalytics.getFormsTrend(input?)`
|
|
887
|
+
|
|
888
|
+
**Get Forms Trend**
|
|
889
|
+
|
|
890
|
+
- HTTP: `GET /api/v1/analytics/conversions/forms/trend`
|
|
891
|
+
- operationId: `get_forms_trend_analytics_conversions_forms_trend_get` (also callable as `g8.api.call("get_forms_trend_analytics_conversions_forms_trend_get", input)`)
|
|
892
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
893
|
+
- API-key scope: `analytics:read`
|
|
894
|
+
|
|
895
|
+
Get daily form submissions trend.
|
|
896
|
+
|
|
897
|
+
**Input**
|
|
898
|
+
|
|
899
|
+
| Field | Type | Required | Description |
|
|
900
|
+
|---|---|---|---|
|
|
901
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
902
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
903
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
904
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
905
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
906
|
+
|
|
907
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
908
|
+
|
|
909
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
910
|
+
|
|
911
|
+
**Example**
|
|
912
|
+
|
|
913
|
+
```ts
|
|
914
|
+
const result = await g8.api.webAnalytics.getFormsTrend();
|
|
915
|
+
```
|
|
916
|
+
|
|
917
|
+
---
|
|
918
|
+
|
|
919
|
+
<a id="op-getfunnel"></a>
|
|
920
|
+
|
|
921
|
+
### `g8.api.webAnalytics.getFunnel(input?)`
|
|
922
|
+
|
|
923
|
+
**Get Funnel**
|
|
924
|
+
|
|
925
|
+
- HTTP: `GET /api/v1/analytics/conversions/funnel`
|
|
926
|
+
- operationId: `get_funnel_analytics_conversions_funnel_get` (also callable as `g8.api.call("get_funnel_analytics_conversions_funnel_get", input)`)
|
|
927
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
928
|
+
- API-key scope: `analytics:read`
|
|
929
|
+
|
|
930
|
+
Get funnel analysis.
|
|
931
|
+
|
|
932
|
+
Default funnel: Site Visitors → Viewed Form → Submitted Form → Booked Meeting
|
|
933
|
+
|
|
934
|
+
**Input**
|
|
935
|
+
|
|
936
|
+
| Field | Type | Required | Description |
|
|
937
|
+
|---|---|---|---|
|
|
938
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
939
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
940
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
941
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
942
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
943
|
+
|
|
944
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
945
|
+
|
|
946
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
947
|
+
|
|
948
|
+
**Example**
|
|
949
|
+
|
|
950
|
+
```ts
|
|
951
|
+
const result = await g8.api.webAnalytics.getFunnel();
|
|
952
|
+
```
|
|
953
|
+
|
|
954
|
+
---
|
|
955
|
+
|
|
956
|
+
<a id="op-getgeocities"></a>
|
|
957
|
+
|
|
958
|
+
### `g8.api.webAnalytics.getGeoCities(input?)`
|
|
959
|
+
|
|
960
|
+
**Get Geo Cities**
|
|
961
|
+
|
|
962
|
+
- HTTP: `GET /api/v1/analytics/audience/geo/cities`
|
|
963
|
+
- operationId: `get_geo_cities_analytics_audience_geo_cities_get` (also callable as `g8.api.call("get_geo_cities_analytics_audience_geo_cities_get", input)`)
|
|
964
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
965
|
+
- API-key scope: `analytics:read`
|
|
966
|
+
|
|
967
|
+
Get geographic distribution by city.
|
|
968
|
+
|
|
969
|
+
**Input**
|
|
970
|
+
|
|
971
|
+
| Field | Type | Required | Description |
|
|
972
|
+
|---|---|---|---|
|
|
973
|
+
| `query.limit` | `integer` | no | Number of cities to return default `50` |
|
|
974
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
975
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
976
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
977
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
978
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
979
|
+
|
|
980
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
981
|
+
|
|
982
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
983
|
+
|
|
984
|
+
**Example**
|
|
985
|
+
|
|
986
|
+
```ts
|
|
987
|
+
const result = await g8.api.webAnalytics.getGeoCities();
|
|
988
|
+
```
|
|
989
|
+
|
|
990
|
+
---
|
|
991
|
+
|
|
992
|
+
<a id="op-getgeocountries"></a>
|
|
993
|
+
|
|
994
|
+
### `g8.api.webAnalytics.getGeoCountries(input?)`
|
|
995
|
+
|
|
996
|
+
**Get Geo Countries**
|
|
997
|
+
|
|
998
|
+
- HTTP: `GET /api/v1/analytics/audience/geo`
|
|
999
|
+
- operationId: `get_geo_countries_analytics_audience_geo_get` (also callable as `g8.api.call("get_geo_countries_analytics_audience_geo_get", input)`)
|
|
1000
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1001
|
+
- API-key scope: `analytics:read`
|
|
1002
|
+
|
|
1003
|
+
Get geographic distribution by country.
|
|
1004
|
+
|
|
1005
|
+
**Input**
|
|
1006
|
+
|
|
1007
|
+
| Field | Type | Required | Description |
|
|
1008
|
+
|---|---|---|---|
|
|
1009
|
+
| `query.limit` | `integer` | no | Number of countries to return default `50` |
|
|
1010
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1011
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
1012
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
1013
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
1014
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1015
|
+
|
|
1016
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1017
|
+
|
|
1018
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1019
|
+
|
|
1020
|
+
**Example**
|
|
1021
|
+
|
|
1022
|
+
```ts
|
|
1023
|
+
const result = await g8.api.webAnalytics.getGeoCountries();
|
|
1024
|
+
```
|
|
1025
|
+
|
|
1026
|
+
---
|
|
1027
|
+
|
|
1028
|
+
<a id="op-getgoals"></a>
|
|
1029
|
+
|
|
1030
|
+
### `g8.api.webAnalytics.getGoals(input?)`
|
|
1031
|
+
|
|
1032
|
+
**Get Goals**
|
|
1033
|
+
|
|
1034
|
+
- HTTP: `GET /api/v1/analytics/conversions/goals`
|
|
1035
|
+
- operationId: `get_goals_analytics_conversions_goals_get` (also callable as `g8.api.call("get_goals_analytics_conversions_goals_get", input)`)
|
|
1036
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1037
|
+
- API-key scope: `analytics:read`
|
|
1038
|
+
|
|
1039
|
+
Get goal completions overview.
|
|
1040
|
+
|
|
1041
|
+
Goals: Form Submissions, Meeting Booked, Signup, Purchase.
|
|
1042
|
+
**Cache TTL**: 300 seconds (5 min)
|
|
1043
|
+
|
|
1044
|
+
**Input**
|
|
1045
|
+
|
|
1046
|
+
| Field | Type | Required | Description |
|
|
1047
|
+
|---|---|---|---|
|
|
1048
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1049
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
1050
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
1051
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
1052
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1053
|
+
|
|
1054
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1055
|
+
|
|
1056
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1057
|
+
|
|
1058
|
+
**Example**
|
|
1059
|
+
|
|
1060
|
+
```ts
|
|
1061
|
+
const result = await g8.api.webAnalytics.getGoals();
|
|
1062
|
+
```
|
|
1063
|
+
|
|
1064
|
+
---
|
|
1065
|
+
|
|
1066
|
+
<a id="op-getgoalstrend"></a>
|
|
1067
|
+
|
|
1068
|
+
### `g8.api.webAnalytics.getGoalsTrend(input?)`
|
|
1069
|
+
|
|
1070
|
+
**Get Goals Trend**
|
|
1071
|
+
|
|
1072
|
+
- HTTP: `GET /api/v1/analytics/conversions/goals/trend`
|
|
1073
|
+
- operationId: `get_goals_trend_analytics_conversions_goals_trend_get` (also callable as `g8.api.call("get_goals_trend_analytics_conversions_goals_trend_get", input)`)
|
|
1074
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1075
|
+
- API-key scope: `analytics:read`
|
|
1076
|
+
|
|
1077
|
+
Get daily trend for goal completions.
|
|
1078
|
+
|
|
1079
|
+
**Input**
|
|
1080
|
+
|
|
1081
|
+
| Field | Type | Required | Description |
|
|
1082
|
+
|---|---|---|---|
|
|
1083
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1084
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
1085
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
1086
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
1087
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1088
|
+
|
|
1089
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1090
|
+
|
|
1091
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1092
|
+
|
|
1093
|
+
**Example**
|
|
1094
|
+
|
|
1095
|
+
```ts
|
|
1096
|
+
const result = await g8.api.webAnalytics.getGoalsTrend();
|
|
1097
|
+
```
|
|
1098
|
+
|
|
1099
|
+
---
|
|
1100
|
+
|
|
1101
|
+
<a id="op-getlandingpages"></a>
|
|
1102
|
+
|
|
1103
|
+
### `g8.api.webAnalytics.getLandingPages(input?)`
|
|
1104
|
+
|
|
1105
|
+
**Get Landing Pages**
|
|
1106
|
+
|
|
1107
|
+
- HTTP: `GET /api/v1/analytics/behavior/landing-pages`
|
|
1108
|
+
- operationId: `get_landing_pages_analytics_behavior_landing_pages_get` (also callable as `g8.api.call("get_landing_pages_analytics_behavior_landing_pages_get", input)`)
|
|
1109
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1110
|
+
- API-key scope: `analytics:read`
|
|
1111
|
+
|
|
1112
|
+
Get top landing pages (entry pages).
|
|
1113
|
+
|
|
1114
|
+
**Input**
|
|
1115
|
+
|
|
1116
|
+
| Field | Type | Required | Description |
|
|
1117
|
+
|---|---|---|---|
|
|
1118
|
+
| `query.limit` | `integer` | no | Number of pages to return default `50` |
|
|
1119
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1120
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
1121
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
1122
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
1123
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1124
|
+
|
|
1125
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1126
|
+
|
|
1127
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1128
|
+
|
|
1129
|
+
**Example**
|
|
1130
|
+
|
|
1131
|
+
```ts
|
|
1132
|
+
const result = await g8.api.webAnalytics.getLandingPages();
|
|
1133
|
+
```
|
|
1134
|
+
|
|
1135
|
+
---
|
|
1136
|
+
|
|
1137
|
+
<a id="op-getpagemetrics"></a>
|
|
1138
|
+
|
|
1139
|
+
### `g8.api.webAnalytics.getPageMetrics(input)`
|
|
1140
|
+
|
|
1141
|
+
**Get Page Metrics**
|
|
1142
|
+
|
|
1143
|
+
- HTTP: `GET /api/v1/analytics/behavior/page-metrics`
|
|
1144
|
+
- operationId: `get_page_metrics_analytics_behavior_page_metrics_get` (also callable as `g8.api.call("get_page_metrics_analytics_behavior_page_metrics_get", input)`)
|
|
1145
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1146
|
+
- API-key scope: `analytics:read`
|
|
1147
|
+
|
|
1148
|
+
Single-page rollup (views/visitors/forms/bookings) — Studio Content Calendar overlay.
|
|
1149
|
+
|
|
1150
|
+
The path goes into a ClickHouse SQL literal (escaped in the query builder);
|
|
1151
|
+
the strict charset check here is the boundary defense, mirroring
|
|
1152
|
+
``_parse_write_keys``.
|
|
1153
|
+
|
|
1154
|
+
**Input**
|
|
1155
|
+
|
|
1156
|
+
| Field | Type | Required | Description |
|
|
1157
|
+
|---|---|---|---|
|
|
1158
|
+
| `query.path` | `string` | yes | Exact context_page_path to roll up |
|
|
1159
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1160
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
1161
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
1162
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
1163
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1164
|
+
|
|
1165
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1166
|
+
|
|
1167
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1168
|
+
|
|
1169
|
+
**Example**
|
|
1170
|
+
|
|
1171
|
+
```ts
|
|
1172
|
+
const result = await g8.api.webAnalytics.getPageMetrics({ query: { path: "example" } });
|
|
1173
|
+
```
|
|
1174
|
+
|
|
1175
|
+
---
|
|
1176
|
+
|
|
1177
|
+
<a id="op-getrealtime"></a>
|
|
1178
|
+
|
|
1179
|
+
### `g8.api.webAnalytics.getRealtime(input?)`
|
|
1180
|
+
|
|
1181
|
+
**Get Realtime**
|
|
1182
|
+
|
|
1183
|
+
- HTTP: `GET /api/v1/analytics/realtime`
|
|
1184
|
+
- operationId: `get_realtime_analytics_realtime_get` (also callable as `g8.api.call("get_realtime_analytics_realtime_get", input)`)
|
|
1185
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1186
|
+
- API-key scope: `analytics:read`
|
|
1187
|
+
|
|
1188
|
+
Get real-time analytics: active users in last 5 and 30 minutes.
|
|
1189
|
+
|
|
1190
|
+
**Refresh rate**: Poll every 10 seconds for real-time updates.
|
|
1191
|
+
**Cache TTL**: 10 seconds
|
|
1192
|
+
|
|
1193
|
+
**Input**
|
|
1194
|
+
|
|
1195
|
+
| Field | Type | Required | Description |
|
|
1196
|
+
|---|---|---|---|
|
|
1197
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1198
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1199
|
+
|
|
1200
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1201
|
+
|
|
1202
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1203
|
+
|
|
1204
|
+
**Example**
|
|
1205
|
+
|
|
1206
|
+
```ts
|
|
1207
|
+
const result = await g8.api.webAnalytics.getRealtime();
|
|
1208
|
+
```
|
|
1209
|
+
|
|
1210
|
+
---
|
|
1211
|
+
|
|
1212
|
+
<a id="op-getrealtimelocations"></a>
|
|
1213
|
+
|
|
1214
|
+
### `g8.api.webAnalytics.getRealtimeLocations(input?)`
|
|
1215
|
+
|
|
1216
|
+
**Get Realtime Locations**
|
|
1217
|
+
|
|
1218
|
+
- HTTP: `GET /api/v1/analytics/realtime/locations`
|
|
1219
|
+
- operationId: `get_realtime_locations_analytics_realtime_locations_get` (also callable as `g8.api.call("get_realtime_locations_analytics_realtime_locations_get", input)`)
|
|
1220
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1221
|
+
- API-key scope: `analytics:read`
|
|
1222
|
+
|
|
1223
|
+
Get active locations in real-time (last 5 minutes).
|
|
1224
|
+
|
|
1225
|
+
**Input**
|
|
1226
|
+
|
|
1227
|
+
| Field | Type | Required | Description |
|
|
1228
|
+
|---|---|---|---|
|
|
1229
|
+
| `query.limit` | `integer \| null` | no | Number of locations to return |
|
|
1230
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1231
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1232
|
+
|
|
1233
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1234
|
+
|
|
1235
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1236
|
+
|
|
1237
|
+
**Example**
|
|
1238
|
+
|
|
1239
|
+
```ts
|
|
1240
|
+
const result = await g8.api.webAnalytics.getRealtimeLocations();
|
|
1241
|
+
```
|
|
1242
|
+
|
|
1243
|
+
---
|
|
1244
|
+
|
|
1245
|
+
<a id="op-getrealtimepages"></a>
|
|
1246
|
+
|
|
1247
|
+
### `g8.api.webAnalytics.getRealtimePages(input?)`
|
|
1248
|
+
|
|
1249
|
+
**Get Realtime Pages**
|
|
1250
|
+
|
|
1251
|
+
- HTTP: `GET /api/v1/analytics/realtime/pages`
|
|
1252
|
+
- operationId: `get_realtime_pages_analytics_realtime_pages_get` (also callable as `g8.api.call("get_realtime_pages_analytics_realtime_pages_get", input)`)
|
|
1253
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1254
|
+
- API-key scope: `analytics:read`
|
|
1255
|
+
|
|
1256
|
+
Get active pages in real-time (last 5 minutes).
|
|
1257
|
+
|
|
1258
|
+
**Input**
|
|
1259
|
+
|
|
1260
|
+
| Field | Type | Required | Description |
|
|
1261
|
+
|---|---|---|---|
|
|
1262
|
+
| `query.limit` | `integer` | no | Number of pages to return default `10` |
|
|
1263
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1264
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1265
|
+
|
|
1266
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1267
|
+
|
|
1268
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1269
|
+
|
|
1270
|
+
**Example**
|
|
1271
|
+
|
|
1272
|
+
```ts
|
|
1273
|
+
const result = await g8.api.webAnalytics.getRealtimePages();
|
|
1274
|
+
```
|
|
1275
|
+
|
|
1276
|
+
---
|
|
1277
|
+
|
|
1278
|
+
<a id="op-getrealtimesources"></a>
|
|
1279
|
+
|
|
1280
|
+
### `g8.api.webAnalytics.getRealtimeSources(input?)`
|
|
1281
|
+
|
|
1282
|
+
**Get Realtime Sources**
|
|
1283
|
+
|
|
1284
|
+
- HTTP: `GET /api/v1/analytics/realtime/sources`
|
|
1285
|
+
- operationId: `get_realtime_sources_analytics_realtime_sources_get` (also callable as `g8.api.call("get_realtime_sources_analytics_realtime_sources_get", input)`)
|
|
1286
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1287
|
+
- API-key scope: `analytics:read`
|
|
1288
|
+
|
|
1289
|
+
Get traffic sources in real-time (last 5 minutes).
|
|
1290
|
+
|
|
1291
|
+
**Input**
|
|
1292
|
+
|
|
1293
|
+
| Field | Type | Required | Description |
|
|
1294
|
+
|---|---|---|---|
|
|
1295
|
+
| `query.limit` | `integer` | no | Number of sources to return default `10` |
|
|
1296
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1297
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1298
|
+
|
|
1299
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1300
|
+
|
|
1301
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1302
|
+
|
|
1303
|
+
**Example**
|
|
1304
|
+
|
|
1305
|
+
```ts
|
|
1306
|
+
const result = await g8.api.webAnalytics.getRealtimeSources();
|
|
1307
|
+
```
|
|
1308
|
+
|
|
1309
|
+
---
|
|
1310
|
+
|
|
1311
|
+
<a id="op-getsessiondepthdistribution"></a>
|
|
1312
|
+
|
|
1313
|
+
### `g8.api.webAnalytics.getSessionDepthDistribution(input?)`
|
|
1314
|
+
|
|
1315
|
+
**Get Session Depth Distribution**
|
|
1316
|
+
|
|
1317
|
+
- HTTP: `GET /api/v1/analytics/engagement/depth-distribution`
|
|
1318
|
+
- operationId: `get_session_depth_distribution_analytics_engagement_depth_distribution_get` (also callable as `g8.api.call("get_session_depth_distribution_analytics_engagement_depth_distribution_get", input)`)
|
|
1319
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1320
|
+
- API-key scope: `analytics:read`
|
|
1321
|
+
|
|
1322
|
+
Get session depth distribution for histogram visualization.
|
|
1323
|
+
|
|
1324
|
+
Returns buckets: 1 page, 2 pages, 3 pages, 4-5 pages, 6-10 pages, 10+ pages.
|
|
1325
|
+
|
|
1326
|
+
**Input**
|
|
1327
|
+
|
|
1328
|
+
| Field | Type | Required | Description |
|
|
1329
|
+
|---|---|---|---|
|
|
1330
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1331
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
1332
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
1333
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
1334
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1335
|
+
|
|
1336
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1337
|
+
|
|
1338
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1339
|
+
|
|
1340
|
+
**Example**
|
|
1341
|
+
|
|
1342
|
+
```ts
|
|
1343
|
+
const result = await g8.api.webAnalytics.getSessionDepthDistribution();
|
|
1344
|
+
```
|
|
1345
|
+
|
|
1346
|
+
---
|
|
1347
|
+
|
|
1348
|
+
<a id="op-gettechnologyoverview"></a>
|
|
1349
|
+
|
|
1350
|
+
### `g8.api.webAnalytics.getTechnologyOverview(input?)`
|
|
1351
|
+
|
|
1352
|
+
**Get Technology Overview**
|
|
1353
|
+
|
|
1354
|
+
- HTTP: `GET /api/v1/analytics/audience/technology`
|
|
1355
|
+
- operationId: `get_technology_overview_analytics_audience_technology_get` (also callable as `g8.api.call("get_technology_overview_analytics_audience_technology_get", input)`)
|
|
1356
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1357
|
+
- API-key scope: `analytics:read`
|
|
1358
|
+
|
|
1359
|
+
Get technology overview: browsers, OS, and devices combined.
|
|
1360
|
+
|
|
1361
|
+
**Input**
|
|
1362
|
+
|
|
1363
|
+
| Field | Type | Required | Description |
|
|
1364
|
+
|---|---|---|---|
|
|
1365
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1366
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
1367
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
1368
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
1369
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1370
|
+
|
|
1371
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1372
|
+
|
|
1373
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1374
|
+
|
|
1375
|
+
**Example**
|
|
1376
|
+
|
|
1377
|
+
```ts
|
|
1378
|
+
const result = await g8.api.webAnalytics.getTechnologyOverview();
|
|
1379
|
+
```
|
|
1380
|
+
|
|
1381
|
+
---
|
|
1382
|
+
|
|
1383
|
+
<a id="op-gettimeonsitedistribution"></a>
|
|
1384
|
+
|
|
1385
|
+
### `g8.api.webAnalytics.getTimeOnSiteDistribution(input?)`
|
|
1386
|
+
|
|
1387
|
+
**Get Time On Site Distribution**
|
|
1388
|
+
|
|
1389
|
+
- HTTP: `GET /api/v1/analytics/engagement/time-distribution`
|
|
1390
|
+
- operationId: `get_time_on_site_distribution_analytics_engagement_time_distribution_get` (also callable as `g8.api.call("get_time_on_site_distribution_analytics_engagement_time_distribution_get", input)`)
|
|
1391
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1392
|
+
- API-key scope: `analytics:read`
|
|
1393
|
+
|
|
1394
|
+
Get time on site distribution for histogram visualization.
|
|
1395
|
+
|
|
1396
|
+
Returns buckets: 0s (bounce), 1-30s, 30s-1m, 1-3m, 3-10m, 10m+.
|
|
1397
|
+
|
|
1398
|
+
**Input**
|
|
1399
|
+
|
|
1400
|
+
| Field | Type | Required | Description |
|
|
1401
|
+
|---|---|---|---|
|
|
1402
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1403
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
1404
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
1405
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
1406
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1407
|
+
|
|
1408
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1409
|
+
|
|
1410
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1411
|
+
|
|
1412
|
+
**Example**
|
|
1413
|
+
|
|
1414
|
+
```ts
|
|
1415
|
+
const result = await g8.api.webAnalytics.getTimeOnSiteDistribution();
|
|
1416
|
+
```
|
|
1417
|
+
|
|
1418
|
+
---
|
|
1419
|
+
|
|
1420
|
+
<a id="op-gettoppages"></a>
|
|
1421
|
+
|
|
1422
|
+
### `g8.api.webAnalytics.getTopPages(input?)`
|
|
1423
|
+
|
|
1424
|
+
**Get Top Pages**
|
|
1425
|
+
|
|
1426
|
+
- HTTP: `GET /api/v1/analytics/behavior/pages`
|
|
1427
|
+
- operationId: `get_top_pages_analytics_behavior_pages_get` (also callable as `g8.api.call("get_top_pages_analytics_behavior_pages_get", input)`)
|
|
1428
|
+
- Tier: `read`: reads data; safe to call and to retry
|
|
1429
|
+
- API-key scope: `analytics:read`
|
|
1430
|
+
|
|
1431
|
+
Get top pages by views and unique visitors.
|
|
1432
|
+
|
|
1433
|
+
**Input**
|
|
1434
|
+
|
|
1435
|
+
| Field | Type | Required | Description |
|
|
1436
|
+
|---|---|---|---|
|
|
1437
|
+
| `query.limit` | `integer` | no | Number of pages to return default `50` |
|
|
1438
|
+
| `query.write_key` | `string \| null` | no | Comma-separated public keys to filter by |
|
|
1439
|
+
| `query.days` | `integer` | no | Number of days to analyze default `30` |
|
|
1440
|
+
| `query.date_from` | `string \| null` | no | Anchored window start (YYYY-MM-DD). Must be sent with date_to. |
|
|
1441
|
+
| `query.date_to` | `string \| null` | no | Anchored window end (YYYY-MM-DD). Must be sent with date_from. |
|
|
1442
|
+
| `headers.X-Org-Id` | `string \| null` | no | |
|
|
1443
|
+
|
|
1444
|
+
**Returns** `AnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
|
|
1445
|
+
|
|
1446
|
+
Other envelope fields: `meta` (AnalyticsMeta), `success` (boolean).
|
|
1447
|
+
|
|
1448
|
+
**Example**
|
|
1449
|
+
|
|
1450
|
+
```ts
|
|
1451
|
+
const result = await g8.api.webAnalytics.getTopPages();
|
|
1452
|
+
```
|