@graph8/sdk 0.245.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 +19 -5
- package/dist/cli.js +216 -0
- package/dist/index.d.mts +283 -12
- package/dist/index.d.ts +283 -12
- package/dist/index.js +88 -2
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +88 -2
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +274 -12
- package/dist/react.d.ts +274 -12
- package/dist/react.js +106 -10
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +97 -11
- 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,964 @@
|
|
|
1
|
+
/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Types for `g8.api.webAnalytics` (Web Analytics): 38 operations.
|
|
5
|
+
*
|
|
6
|
+
* For reading. In code, import from the package instead:
|
|
7
|
+
* import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
|
|
8
|
+
* type In = ApiInput<"get_acquisition_campaigns_analytics_acquisition_campaigns_get">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: webAnalytics.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.webAnalytics.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface WebAnalyticsMembers {
|
|
16
|
+
getAcquisitionCampaigns: "get_acquisition_campaigns_analytics_acquisition_campaigns_get";
|
|
17
|
+
getAcquisitionChannels: "get_acquisition_channels_analytics_acquisition_channels_get";
|
|
18
|
+
getAcquisitionChannelsTrend: "get_acquisition_channels_trend_analytics_acquisition_channels_trend_get";
|
|
19
|
+
getAcquisitionReferrals: "get_acquisition_referrals_analytics_acquisition_referrals_get";
|
|
20
|
+
getAcquisitionSearch: "get_acquisition_search_analytics_acquisition_search_get";
|
|
21
|
+
getAcquisitionSocial: "get_acquisition_social_analytics_acquisition_social_get";
|
|
22
|
+
getAcquisitionSources: "get_acquisition_sources_analytics_acquisition_sources_get";
|
|
23
|
+
getAudienceBehavior: "get_audience_behavior_analytics_audience_behavior_get";
|
|
24
|
+
getAudienceDemographics: "get_audience_demographics_analytics_audience_demographics_get";
|
|
25
|
+
getAudienceLanguages: "get_audience_languages_analytics_audience_languages_get";
|
|
26
|
+
getAudienceOverview: "get_audience_overview_analytics_audience_overview_get";
|
|
27
|
+
getAudienceTrend: "get_audience_trend_analytics_audience_trend_get";
|
|
28
|
+
getConversionRate: "get_conversion_rate_analytics_conversions_rate_get";
|
|
29
|
+
getEngagementByCampaign: "get_engagement_by_campaign_analytics_engagement_by_campaign_get";
|
|
30
|
+
getEngagementByChannel: "get_engagement_by_channel_analytics_engagement_by_channel_get";
|
|
31
|
+
getEngagementByLandingPage: "get_engagement_by_landing_page_analytics_engagement_by_landing_page_get";
|
|
32
|
+
getEngagementOverview: "get_engagement_overview_analytics_engagement_overview_get";
|
|
33
|
+
getEngagementTrend: "get_engagement_trend_analytics_engagement_trend_get";
|
|
34
|
+
getEvents: "get_events_analytics_behavior_events_get";
|
|
35
|
+
getExitPages: "get_exit_pages_analytics_behavior_exit_pages_get";
|
|
36
|
+
getFormAnalysis: "get_form_analysis_analytics_conversions_forms_analysis_get";
|
|
37
|
+
getForms: "get_forms_analytics_conversions_forms_get";
|
|
38
|
+
getFormsTrend: "get_forms_trend_analytics_conversions_forms_trend_get";
|
|
39
|
+
getFunnel: "get_funnel_analytics_conversions_funnel_get";
|
|
40
|
+
getGeoCities: "get_geo_cities_analytics_audience_geo_cities_get";
|
|
41
|
+
getGeoCountries: "get_geo_countries_analytics_audience_geo_get";
|
|
42
|
+
getGoals: "get_goals_analytics_conversions_goals_get";
|
|
43
|
+
getGoalsTrend: "get_goals_trend_analytics_conversions_goals_trend_get";
|
|
44
|
+
getLandingPages: "get_landing_pages_analytics_behavior_landing_pages_get";
|
|
45
|
+
getPageMetrics: "get_page_metrics_analytics_behavior_page_metrics_get";
|
|
46
|
+
getRealtime: "get_realtime_analytics_realtime_get";
|
|
47
|
+
getRealtimeLocations: "get_realtime_locations_analytics_realtime_locations_get";
|
|
48
|
+
getRealtimePages: "get_realtime_pages_analytics_realtime_pages_get";
|
|
49
|
+
getRealtimeSources: "get_realtime_sources_analytics_realtime_sources_get";
|
|
50
|
+
getSessionDepthDistribution: "get_session_depth_distribution_analytics_engagement_depth_distribution_get";
|
|
51
|
+
getTechnologyOverview: "get_technology_overview_analytics_audience_technology_get";
|
|
52
|
+
getTimeOnSiteDistribution: "get_time_on_site_distribution_analytics_engagement_time_distribution_get";
|
|
53
|
+
getTopPages: "get_top_pages_analytics_behavior_pages_get";
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/** Input and output of every `g8.api.webAnalytics` operation, keyed by operationId. */
|
|
57
|
+
export interface WebAnalyticsOperations {
|
|
58
|
+
/**
|
|
59
|
+
* GET /analytics/acquisition/campaigns
|
|
60
|
+
* Get Acquisition Campaigns
|
|
61
|
+
* tier: read · scope: analytics:read
|
|
62
|
+
*/
|
|
63
|
+
get_acquisition_campaigns_analytics_acquisition_campaigns_get: {
|
|
64
|
+
input: {
|
|
65
|
+
query?: {
|
|
66
|
+
/** Number of campaigns to return */
|
|
67
|
+
limit?: number;
|
|
68
|
+
/** Comma-separated public keys to filter by */
|
|
69
|
+
write_key?: string | null;
|
|
70
|
+
/** Number of days to analyze */
|
|
71
|
+
days?: number;
|
|
72
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
73
|
+
date_from?: string | null;
|
|
74
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
75
|
+
date_to?: string | null;
|
|
76
|
+
};
|
|
77
|
+
headers?: {
|
|
78
|
+
"X-Org-Id"?: string | null;
|
|
79
|
+
};
|
|
80
|
+
};
|
|
81
|
+
output: AnalyticsResponse;
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* GET /analytics/acquisition/channels
|
|
85
|
+
* Get Acquisition Channels
|
|
86
|
+
* tier: read · scope: analytics:read
|
|
87
|
+
*/
|
|
88
|
+
get_acquisition_channels_analytics_acquisition_channels_get: {
|
|
89
|
+
input: {
|
|
90
|
+
query?: {
|
|
91
|
+
/** Comma-separated public keys to filter by */
|
|
92
|
+
write_key?: string | null;
|
|
93
|
+
/** Number of days to analyze */
|
|
94
|
+
days?: number;
|
|
95
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
96
|
+
date_from?: string | null;
|
|
97
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
98
|
+
date_to?: string | null;
|
|
99
|
+
};
|
|
100
|
+
headers?: {
|
|
101
|
+
"X-Org-Id"?: string | null;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
output: AnalyticsResponse;
|
|
105
|
+
};
|
|
106
|
+
/**
|
|
107
|
+
* GET /analytics/acquisition/channels/trend
|
|
108
|
+
* Get Acquisition Channels Trend
|
|
109
|
+
* tier: read · scope: analytics:read
|
|
110
|
+
*/
|
|
111
|
+
get_acquisition_channels_trend_analytics_acquisition_channels_trend_get: {
|
|
112
|
+
input: {
|
|
113
|
+
query?: {
|
|
114
|
+
/** Comma-separated public keys to filter by */
|
|
115
|
+
write_key?: string | null;
|
|
116
|
+
/** Number of days to analyze */
|
|
117
|
+
days?: number;
|
|
118
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
119
|
+
date_from?: string | null;
|
|
120
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
121
|
+
date_to?: string | null;
|
|
122
|
+
};
|
|
123
|
+
headers?: {
|
|
124
|
+
"X-Org-Id"?: string | null;
|
|
125
|
+
};
|
|
126
|
+
};
|
|
127
|
+
output: AnalyticsResponse;
|
|
128
|
+
};
|
|
129
|
+
/**
|
|
130
|
+
* GET /analytics/acquisition/referrals
|
|
131
|
+
* Get Acquisition Referrals
|
|
132
|
+
* tier: read · scope: analytics:read
|
|
133
|
+
*/
|
|
134
|
+
get_acquisition_referrals_analytics_acquisition_referrals_get: {
|
|
135
|
+
input: {
|
|
136
|
+
query?: {
|
|
137
|
+
/** Number of referrers to return */
|
|
138
|
+
limit?: number;
|
|
139
|
+
/** Comma-separated public keys to filter by */
|
|
140
|
+
write_key?: string | null;
|
|
141
|
+
/** Number of days to analyze */
|
|
142
|
+
days?: number;
|
|
143
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
144
|
+
date_from?: string | null;
|
|
145
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
146
|
+
date_to?: string | null;
|
|
147
|
+
};
|
|
148
|
+
headers?: {
|
|
149
|
+
"X-Org-Id"?: string | null;
|
|
150
|
+
};
|
|
151
|
+
};
|
|
152
|
+
output: AnalyticsResponse;
|
|
153
|
+
};
|
|
154
|
+
/**
|
|
155
|
+
* GET /analytics/acquisition/search
|
|
156
|
+
* Get Acquisition Search
|
|
157
|
+
* tier: read · scope: analytics:read
|
|
158
|
+
*/
|
|
159
|
+
get_acquisition_search_analytics_acquisition_search_get: {
|
|
160
|
+
input: {
|
|
161
|
+
query?: {
|
|
162
|
+
/** Comma-separated public keys to filter by */
|
|
163
|
+
write_key?: string | null;
|
|
164
|
+
/** Number of days to analyze */
|
|
165
|
+
days?: number;
|
|
166
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
167
|
+
date_from?: string | null;
|
|
168
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
169
|
+
date_to?: string | null;
|
|
170
|
+
};
|
|
171
|
+
headers?: {
|
|
172
|
+
"X-Org-Id"?: string | null;
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
output: AnalyticsResponse;
|
|
176
|
+
};
|
|
177
|
+
/**
|
|
178
|
+
* GET /analytics/acquisition/social
|
|
179
|
+
* Get Acquisition Social
|
|
180
|
+
* tier: read · scope: analytics:read
|
|
181
|
+
*/
|
|
182
|
+
get_acquisition_social_analytics_acquisition_social_get: {
|
|
183
|
+
input: {
|
|
184
|
+
query?: {
|
|
185
|
+
/** Comma-separated public keys to filter by */
|
|
186
|
+
write_key?: string | null;
|
|
187
|
+
/** Number of days to analyze */
|
|
188
|
+
days?: number;
|
|
189
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
190
|
+
date_from?: string | null;
|
|
191
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
192
|
+
date_to?: string | null;
|
|
193
|
+
};
|
|
194
|
+
headers?: {
|
|
195
|
+
"X-Org-Id"?: string | null;
|
|
196
|
+
};
|
|
197
|
+
};
|
|
198
|
+
output: AnalyticsResponse;
|
|
199
|
+
};
|
|
200
|
+
/**
|
|
201
|
+
* GET /analytics/acquisition/sources
|
|
202
|
+
* Get Acquisition Sources
|
|
203
|
+
* tier: read · scope: analytics:read
|
|
204
|
+
*/
|
|
205
|
+
get_acquisition_sources_analytics_acquisition_sources_get: {
|
|
206
|
+
input: {
|
|
207
|
+
query?: {
|
|
208
|
+
/** Number of sources to return */
|
|
209
|
+
limit?: number;
|
|
210
|
+
/** Comma-separated public keys to filter by */
|
|
211
|
+
write_key?: string | null;
|
|
212
|
+
/** Number of days to analyze */
|
|
213
|
+
days?: number;
|
|
214
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
215
|
+
date_from?: string | null;
|
|
216
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
217
|
+
date_to?: string | null;
|
|
218
|
+
};
|
|
219
|
+
headers?: {
|
|
220
|
+
"X-Org-Id"?: string | null;
|
|
221
|
+
};
|
|
222
|
+
};
|
|
223
|
+
output: AnalyticsResponse;
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* GET /analytics/audience/behavior
|
|
227
|
+
* Get Audience Behavior
|
|
228
|
+
* tier: read · scope: analytics:read
|
|
229
|
+
*/
|
|
230
|
+
get_audience_behavior_analytics_audience_behavior_get: {
|
|
231
|
+
input: {
|
|
232
|
+
query?: {
|
|
233
|
+
/** Comma-separated public keys to filter by */
|
|
234
|
+
write_key?: string | null;
|
|
235
|
+
/** Number of days to analyze */
|
|
236
|
+
days?: number;
|
|
237
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
238
|
+
date_from?: string | null;
|
|
239
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
240
|
+
date_to?: string | null;
|
|
241
|
+
};
|
|
242
|
+
headers?: {
|
|
243
|
+
"X-Org-Id"?: string | null;
|
|
244
|
+
};
|
|
245
|
+
};
|
|
246
|
+
output: AnalyticsResponse;
|
|
247
|
+
};
|
|
248
|
+
/**
|
|
249
|
+
* GET /analytics/audience/demographics
|
|
250
|
+
* Get Audience Demographics
|
|
251
|
+
* tier: read · scope: analytics:read
|
|
252
|
+
*/
|
|
253
|
+
get_audience_demographics_analytics_audience_demographics_get: {
|
|
254
|
+
input: {
|
|
255
|
+
query?: {
|
|
256
|
+
/** Comma-separated public keys to filter by */
|
|
257
|
+
write_key?: string | null;
|
|
258
|
+
/** Number of days to analyze */
|
|
259
|
+
days?: number;
|
|
260
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
261
|
+
date_from?: string | null;
|
|
262
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
263
|
+
date_to?: string | null;
|
|
264
|
+
};
|
|
265
|
+
headers?: {
|
|
266
|
+
"X-Org-Id"?: string | null;
|
|
267
|
+
};
|
|
268
|
+
};
|
|
269
|
+
output: AnalyticsResponse;
|
|
270
|
+
};
|
|
271
|
+
/**
|
|
272
|
+
* GET /analytics/audience/languages
|
|
273
|
+
* Get Audience Languages
|
|
274
|
+
* tier: read · scope: analytics:read
|
|
275
|
+
*/
|
|
276
|
+
get_audience_languages_analytics_audience_languages_get: {
|
|
277
|
+
input: {
|
|
278
|
+
query?: {
|
|
279
|
+
/** Number of languages to return */
|
|
280
|
+
limit?: number;
|
|
281
|
+
/** Comma-separated public keys to filter by */
|
|
282
|
+
write_key?: string | null;
|
|
283
|
+
/** Number of days to analyze */
|
|
284
|
+
days?: number;
|
|
285
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
286
|
+
date_from?: string | null;
|
|
287
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
288
|
+
date_to?: string | null;
|
|
289
|
+
};
|
|
290
|
+
headers?: {
|
|
291
|
+
"X-Org-Id"?: string | null;
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
output: AnalyticsResponse;
|
|
295
|
+
};
|
|
296
|
+
/**
|
|
297
|
+
* GET /analytics/audience/overview
|
|
298
|
+
* Get Audience Overview
|
|
299
|
+
* tier: read · scope: analytics:read
|
|
300
|
+
*/
|
|
301
|
+
get_audience_overview_analytics_audience_overview_get: {
|
|
302
|
+
input: {
|
|
303
|
+
query?: {
|
|
304
|
+
/** Comma-separated public keys to filter by */
|
|
305
|
+
write_key?: string | null;
|
|
306
|
+
/** Number of days to analyze */
|
|
307
|
+
days?: number;
|
|
308
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
309
|
+
date_from?: string | null;
|
|
310
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
311
|
+
date_to?: string | null;
|
|
312
|
+
};
|
|
313
|
+
headers?: {
|
|
314
|
+
"X-Org-Id"?: string | null;
|
|
315
|
+
};
|
|
316
|
+
};
|
|
317
|
+
output: AnalyticsResponse;
|
|
318
|
+
};
|
|
319
|
+
/**
|
|
320
|
+
* GET /analytics/audience/trend
|
|
321
|
+
* Get Audience Trend
|
|
322
|
+
* tier: read · scope: analytics:read
|
|
323
|
+
*/
|
|
324
|
+
get_audience_trend_analytics_audience_trend_get: {
|
|
325
|
+
input: {
|
|
326
|
+
query?: {
|
|
327
|
+
/** Comma-separated public keys to filter by */
|
|
328
|
+
write_key?: string | null;
|
|
329
|
+
/** Number of days to analyze */
|
|
330
|
+
days?: number;
|
|
331
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
332
|
+
date_from?: string | null;
|
|
333
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
334
|
+
date_to?: string | null;
|
|
335
|
+
};
|
|
336
|
+
headers?: {
|
|
337
|
+
"X-Org-Id"?: string | null;
|
|
338
|
+
};
|
|
339
|
+
};
|
|
340
|
+
output: AnalyticsResponse;
|
|
341
|
+
};
|
|
342
|
+
/**
|
|
343
|
+
* GET /analytics/conversions/rate
|
|
344
|
+
* Get Conversion Rate
|
|
345
|
+
* tier: read · scope: analytics:read
|
|
346
|
+
*/
|
|
347
|
+
get_conversion_rate_analytics_conversions_rate_get: {
|
|
348
|
+
input: {
|
|
349
|
+
query?: {
|
|
350
|
+
/** Comma-separated public keys to filter by */
|
|
351
|
+
write_key?: string | null;
|
|
352
|
+
/** Number of days to analyze */
|
|
353
|
+
days?: number;
|
|
354
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
355
|
+
date_from?: string | null;
|
|
356
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
357
|
+
date_to?: string | null;
|
|
358
|
+
};
|
|
359
|
+
headers?: {
|
|
360
|
+
"X-Org-Id"?: string | null;
|
|
361
|
+
};
|
|
362
|
+
};
|
|
363
|
+
output: AnalyticsResponse;
|
|
364
|
+
};
|
|
365
|
+
/**
|
|
366
|
+
* GET /analytics/engagement/by-campaign
|
|
367
|
+
* Get Engagement By Campaign
|
|
368
|
+
* tier: read · scope: analytics:read
|
|
369
|
+
*/
|
|
370
|
+
get_engagement_by_campaign_analytics_engagement_by_campaign_get: {
|
|
371
|
+
input: {
|
|
372
|
+
query?: {
|
|
373
|
+
/** Number of campaigns to return */
|
|
374
|
+
limit?: number;
|
|
375
|
+
/** Comma-separated public keys to filter by */
|
|
376
|
+
write_key?: string | null;
|
|
377
|
+
/** Number of days to analyze */
|
|
378
|
+
days?: number;
|
|
379
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
380
|
+
date_from?: string | null;
|
|
381
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
382
|
+
date_to?: string | null;
|
|
383
|
+
};
|
|
384
|
+
headers?: {
|
|
385
|
+
"X-Org-Id"?: string | null;
|
|
386
|
+
};
|
|
387
|
+
};
|
|
388
|
+
output: AnalyticsResponse;
|
|
389
|
+
};
|
|
390
|
+
/**
|
|
391
|
+
* GET /analytics/engagement/by-channel
|
|
392
|
+
* Get Engagement By Channel
|
|
393
|
+
* tier: read · scope: analytics:read
|
|
394
|
+
*/
|
|
395
|
+
get_engagement_by_channel_analytics_engagement_by_channel_get: {
|
|
396
|
+
input: {
|
|
397
|
+
query?: {
|
|
398
|
+
/** Comma-separated public keys to filter by */
|
|
399
|
+
write_key?: string | null;
|
|
400
|
+
/** Number of days to analyze */
|
|
401
|
+
days?: number;
|
|
402
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
403
|
+
date_from?: string | null;
|
|
404
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
405
|
+
date_to?: string | null;
|
|
406
|
+
};
|
|
407
|
+
headers?: {
|
|
408
|
+
"X-Org-Id"?: string | null;
|
|
409
|
+
};
|
|
410
|
+
};
|
|
411
|
+
output: AnalyticsResponse;
|
|
412
|
+
};
|
|
413
|
+
/**
|
|
414
|
+
* GET /analytics/engagement/by-landing-page
|
|
415
|
+
* Get Engagement By Landing Page
|
|
416
|
+
* tier: read · scope: analytics:read
|
|
417
|
+
*/
|
|
418
|
+
get_engagement_by_landing_page_analytics_engagement_by_landing_page_get: {
|
|
419
|
+
input: {
|
|
420
|
+
query?: {
|
|
421
|
+
/** Number of pages to return */
|
|
422
|
+
limit?: number;
|
|
423
|
+
/** Comma-separated public keys to filter by */
|
|
424
|
+
write_key?: string | null;
|
|
425
|
+
/** Number of days to analyze */
|
|
426
|
+
days?: number;
|
|
427
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
428
|
+
date_from?: string | null;
|
|
429
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
430
|
+
date_to?: string | null;
|
|
431
|
+
};
|
|
432
|
+
headers?: {
|
|
433
|
+
"X-Org-Id"?: string | null;
|
|
434
|
+
};
|
|
435
|
+
};
|
|
436
|
+
output: AnalyticsResponse;
|
|
437
|
+
};
|
|
438
|
+
/**
|
|
439
|
+
* GET /analytics/engagement/overview
|
|
440
|
+
* Get Engagement Overview
|
|
441
|
+
* tier: read · scope: analytics:read
|
|
442
|
+
*/
|
|
443
|
+
get_engagement_overview_analytics_engagement_overview_get: {
|
|
444
|
+
input: {
|
|
445
|
+
query?: {
|
|
446
|
+
/** Comma-separated public keys to filter by */
|
|
447
|
+
write_key?: string | null;
|
|
448
|
+
/** Number of days to analyze */
|
|
449
|
+
days?: number;
|
|
450
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
451
|
+
date_from?: string | null;
|
|
452
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
453
|
+
date_to?: string | null;
|
|
454
|
+
};
|
|
455
|
+
headers?: {
|
|
456
|
+
"X-Org-Id"?: string | null;
|
|
457
|
+
};
|
|
458
|
+
};
|
|
459
|
+
output: AnalyticsResponse;
|
|
460
|
+
};
|
|
461
|
+
/**
|
|
462
|
+
* GET /analytics/engagement/trend
|
|
463
|
+
* Get Engagement Trend
|
|
464
|
+
* tier: read · scope: analytics:read
|
|
465
|
+
*/
|
|
466
|
+
get_engagement_trend_analytics_engagement_trend_get: {
|
|
467
|
+
input: {
|
|
468
|
+
query?: {
|
|
469
|
+
/** Comma-separated public keys to filter by */
|
|
470
|
+
write_key?: string | null;
|
|
471
|
+
/** Number of days to analyze */
|
|
472
|
+
days?: number;
|
|
473
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
474
|
+
date_from?: string | null;
|
|
475
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
476
|
+
date_to?: string | null;
|
|
477
|
+
};
|
|
478
|
+
headers?: {
|
|
479
|
+
"X-Org-Id"?: string | null;
|
|
480
|
+
};
|
|
481
|
+
};
|
|
482
|
+
output: AnalyticsResponse;
|
|
483
|
+
};
|
|
484
|
+
/**
|
|
485
|
+
* GET /analytics/behavior/events
|
|
486
|
+
* Get Events
|
|
487
|
+
* tier: read · scope: analytics:read
|
|
488
|
+
*/
|
|
489
|
+
get_events_analytics_behavior_events_get: {
|
|
490
|
+
input: {
|
|
491
|
+
query?: {
|
|
492
|
+
/** Number of events to return */
|
|
493
|
+
limit?: number;
|
|
494
|
+
/** Comma-separated public keys to filter by */
|
|
495
|
+
write_key?: string | null;
|
|
496
|
+
/** Number of days to analyze */
|
|
497
|
+
days?: number;
|
|
498
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
499
|
+
date_from?: string | null;
|
|
500
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
501
|
+
date_to?: string | null;
|
|
502
|
+
};
|
|
503
|
+
headers?: {
|
|
504
|
+
"X-Org-Id"?: string | null;
|
|
505
|
+
};
|
|
506
|
+
};
|
|
507
|
+
output: AnalyticsResponse;
|
|
508
|
+
};
|
|
509
|
+
/**
|
|
510
|
+
* GET /analytics/behavior/exit-pages
|
|
511
|
+
* Get Exit Pages
|
|
512
|
+
* tier: read · scope: analytics:read
|
|
513
|
+
*/
|
|
514
|
+
get_exit_pages_analytics_behavior_exit_pages_get: {
|
|
515
|
+
input: {
|
|
516
|
+
query?: {
|
|
517
|
+
/** Number of pages to return */
|
|
518
|
+
limit?: number;
|
|
519
|
+
/** Comma-separated public keys to filter by */
|
|
520
|
+
write_key?: string | null;
|
|
521
|
+
/** Number of days to analyze */
|
|
522
|
+
days?: number;
|
|
523
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
524
|
+
date_from?: string | null;
|
|
525
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
526
|
+
date_to?: string | null;
|
|
527
|
+
};
|
|
528
|
+
headers?: {
|
|
529
|
+
"X-Org-Id"?: string | null;
|
|
530
|
+
};
|
|
531
|
+
};
|
|
532
|
+
output: AnalyticsResponse;
|
|
533
|
+
};
|
|
534
|
+
/**
|
|
535
|
+
* GET /analytics/conversions/forms/analysis
|
|
536
|
+
* Get Form Analysis
|
|
537
|
+
* tier: read · scope: analytics:read
|
|
538
|
+
*/
|
|
539
|
+
get_form_analysis_analytics_conversions_forms_analysis_get: {
|
|
540
|
+
input: {
|
|
541
|
+
query?: {
|
|
542
|
+
/** Number of forms to return */
|
|
543
|
+
limit?: number;
|
|
544
|
+
/** Comma-separated public keys to filter by */
|
|
545
|
+
write_key?: string | null;
|
|
546
|
+
/** Number of days to analyze */
|
|
547
|
+
days?: number;
|
|
548
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
549
|
+
date_from?: string | null;
|
|
550
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
551
|
+
date_to?: string | null;
|
|
552
|
+
};
|
|
553
|
+
headers?: {
|
|
554
|
+
"X-Org-Id"?: string | null;
|
|
555
|
+
};
|
|
556
|
+
};
|
|
557
|
+
output: AnalyticsResponse;
|
|
558
|
+
};
|
|
559
|
+
/**
|
|
560
|
+
* GET /analytics/conversions/forms
|
|
561
|
+
* Get Forms
|
|
562
|
+
* tier: read · scope: analytics:read
|
|
563
|
+
*/
|
|
564
|
+
get_forms_analytics_conversions_forms_get: {
|
|
565
|
+
input: {
|
|
566
|
+
query?: {
|
|
567
|
+
/** Number of forms to return */
|
|
568
|
+
limit?: number;
|
|
569
|
+
/** Comma-separated public keys to filter by */
|
|
570
|
+
write_key?: string | null;
|
|
571
|
+
/** Number of days to analyze */
|
|
572
|
+
days?: number;
|
|
573
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
574
|
+
date_from?: string | null;
|
|
575
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
576
|
+
date_to?: string | null;
|
|
577
|
+
};
|
|
578
|
+
headers?: {
|
|
579
|
+
"X-Org-Id"?: string | null;
|
|
580
|
+
};
|
|
581
|
+
};
|
|
582
|
+
output: AnalyticsResponse;
|
|
583
|
+
};
|
|
584
|
+
/**
|
|
585
|
+
* GET /analytics/conversions/forms/trend
|
|
586
|
+
* Get Forms Trend
|
|
587
|
+
* tier: read · scope: analytics:read
|
|
588
|
+
*/
|
|
589
|
+
get_forms_trend_analytics_conversions_forms_trend_get: {
|
|
590
|
+
input: {
|
|
591
|
+
query?: {
|
|
592
|
+
/** Comma-separated public keys to filter by */
|
|
593
|
+
write_key?: string | null;
|
|
594
|
+
/** Number of days to analyze */
|
|
595
|
+
days?: number;
|
|
596
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
597
|
+
date_from?: string | null;
|
|
598
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
599
|
+
date_to?: string | null;
|
|
600
|
+
};
|
|
601
|
+
headers?: {
|
|
602
|
+
"X-Org-Id"?: string | null;
|
|
603
|
+
};
|
|
604
|
+
};
|
|
605
|
+
output: AnalyticsResponse;
|
|
606
|
+
};
|
|
607
|
+
/**
|
|
608
|
+
* GET /analytics/conversions/funnel
|
|
609
|
+
* Get Funnel
|
|
610
|
+
* tier: read · scope: analytics:read
|
|
611
|
+
*/
|
|
612
|
+
get_funnel_analytics_conversions_funnel_get: {
|
|
613
|
+
input: {
|
|
614
|
+
query?: {
|
|
615
|
+
/** Comma-separated public keys to filter by */
|
|
616
|
+
write_key?: string | null;
|
|
617
|
+
/** Number of days to analyze */
|
|
618
|
+
days?: number;
|
|
619
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
620
|
+
date_from?: string | null;
|
|
621
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
622
|
+
date_to?: string | null;
|
|
623
|
+
};
|
|
624
|
+
headers?: {
|
|
625
|
+
"X-Org-Id"?: string | null;
|
|
626
|
+
};
|
|
627
|
+
};
|
|
628
|
+
output: AnalyticsResponse;
|
|
629
|
+
};
|
|
630
|
+
/**
|
|
631
|
+
* GET /analytics/audience/geo/cities
|
|
632
|
+
* Get Geo Cities
|
|
633
|
+
* tier: read · scope: analytics:read
|
|
634
|
+
*/
|
|
635
|
+
get_geo_cities_analytics_audience_geo_cities_get: {
|
|
636
|
+
input: {
|
|
637
|
+
query?: {
|
|
638
|
+
/** Number of cities to return */
|
|
639
|
+
limit?: number;
|
|
640
|
+
/** Comma-separated public keys to filter by */
|
|
641
|
+
write_key?: string | null;
|
|
642
|
+
/** Number of days to analyze */
|
|
643
|
+
days?: number;
|
|
644
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
645
|
+
date_from?: string | null;
|
|
646
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
647
|
+
date_to?: string | null;
|
|
648
|
+
};
|
|
649
|
+
headers?: {
|
|
650
|
+
"X-Org-Id"?: string | null;
|
|
651
|
+
};
|
|
652
|
+
};
|
|
653
|
+
output: AnalyticsResponse;
|
|
654
|
+
};
|
|
655
|
+
/**
|
|
656
|
+
* GET /analytics/audience/geo
|
|
657
|
+
* Get Geo Countries
|
|
658
|
+
* tier: read · scope: analytics:read
|
|
659
|
+
*/
|
|
660
|
+
get_geo_countries_analytics_audience_geo_get: {
|
|
661
|
+
input: {
|
|
662
|
+
query?: {
|
|
663
|
+
/** Number of countries to return */
|
|
664
|
+
limit?: number;
|
|
665
|
+
/** Comma-separated public keys to filter by */
|
|
666
|
+
write_key?: string | null;
|
|
667
|
+
/** Number of days to analyze */
|
|
668
|
+
days?: number;
|
|
669
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
670
|
+
date_from?: string | null;
|
|
671
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
672
|
+
date_to?: string | null;
|
|
673
|
+
};
|
|
674
|
+
headers?: {
|
|
675
|
+
"X-Org-Id"?: string | null;
|
|
676
|
+
};
|
|
677
|
+
};
|
|
678
|
+
output: AnalyticsResponse;
|
|
679
|
+
};
|
|
680
|
+
/**
|
|
681
|
+
* GET /analytics/conversions/goals
|
|
682
|
+
* Get Goals
|
|
683
|
+
* tier: read · scope: analytics:read
|
|
684
|
+
*/
|
|
685
|
+
get_goals_analytics_conversions_goals_get: {
|
|
686
|
+
input: {
|
|
687
|
+
query?: {
|
|
688
|
+
/** Comma-separated public keys to filter by */
|
|
689
|
+
write_key?: string | null;
|
|
690
|
+
/** Number of days to analyze */
|
|
691
|
+
days?: number;
|
|
692
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
693
|
+
date_from?: string | null;
|
|
694
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
695
|
+
date_to?: string | null;
|
|
696
|
+
};
|
|
697
|
+
headers?: {
|
|
698
|
+
"X-Org-Id"?: string | null;
|
|
699
|
+
};
|
|
700
|
+
};
|
|
701
|
+
output: AnalyticsResponse;
|
|
702
|
+
};
|
|
703
|
+
/**
|
|
704
|
+
* GET /analytics/conversions/goals/trend
|
|
705
|
+
* Get Goals Trend
|
|
706
|
+
* tier: read · scope: analytics:read
|
|
707
|
+
*/
|
|
708
|
+
get_goals_trend_analytics_conversions_goals_trend_get: {
|
|
709
|
+
input: {
|
|
710
|
+
query?: {
|
|
711
|
+
/** Comma-separated public keys to filter by */
|
|
712
|
+
write_key?: string | null;
|
|
713
|
+
/** Number of days to analyze */
|
|
714
|
+
days?: number;
|
|
715
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
716
|
+
date_from?: string | null;
|
|
717
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
718
|
+
date_to?: string | null;
|
|
719
|
+
};
|
|
720
|
+
headers?: {
|
|
721
|
+
"X-Org-Id"?: string | null;
|
|
722
|
+
};
|
|
723
|
+
};
|
|
724
|
+
output: AnalyticsResponse;
|
|
725
|
+
};
|
|
726
|
+
/**
|
|
727
|
+
* GET /analytics/behavior/landing-pages
|
|
728
|
+
* Get Landing Pages
|
|
729
|
+
* tier: read · scope: analytics:read
|
|
730
|
+
*/
|
|
731
|
+
get_landing_pages_analytics_behavior_landing_pages_get: {
|
|
732
|
+
input: {
|
|
733
|
+
query?: {
|
|
734
|
+
/** Number of pages to return */
|
|
735
|
+
limit?: number;
|
|
736
|
+
/** Comma-separated public keys to filter by */
|
|
737
|
+
write_key?: string | null;
|
|
738
|
+
/** Number of days to analyze */
|
|
739
|
+
days?: number;
|
|
740
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
741
|
+
date_from?: string | null;
|
|
742
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
743
|
+
date_to?: string | null;
|
|
744
|
+
};
|
|
745
|
+
headers?: {
|
|
746
|
+
"X-Org-Id"?: string | null;
|
|
747
|
+
};
|
|
748
|
+
};
|
|
749
|
+
output: AnalyticsResponse;
|
|
750
|
+
};
|
|
751
|
+
/**
|
|
752
|
+
* GET /analytics/behavior/page-metrics
|
|
753
|
+
* Get Page Metrics
|
|
754
|
+
* tier: read · scope: analytics:read
|
|
755
|
+
*/
|
|
756
|
+
get_page_metrics_analytics_behavior_page_metrics_get: {
|
|
757
|
+
input: {
|
|
758
|
+
query: {
|
|
759
|
+
/** Exact context_page_path to roll up */
|
|
760
|
+
path: string;
|
|
761
|
+
/** Comma-separated public keys to filter by */
|
|
762
|
+
write_key?: string | null;
|
|
763
|
+
/** Number of days to analyze */
|
|
764
|
+
days?: number;
|
|
765
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
766
|
+
date_from?: string | null;
|
|
767
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
768
|
+
date_to?: string | null;
|
|
769
|
+
};
|
|
770
|
+
headers?: {
|
|
771
|
+
"X-Org-Id"?: string | null;
|
|
772
|
+
};
|
|
773
|
+
};
|
|
774
|
+
output: AnalyticsResponse;
|
|
775
|
+
};
|
|
776
|
+
/**
|
|
777
|
+
* GET /analytics/realtime
|
|
778
|
+
* Get Realtime
|
|
779
|
+
* tier: read · scope: analytics:read
|
|
780
|
+
*/
|
|
781
|
+
get_realtime_analytics_realtime_get: {
|
|
782
|
+
input: {
|
|
783
|
+
query?: {
|
|
784
|
+
/** Comma-separated public keys to filter by */
|
|
785
|
+
write_key?: string | null;
|
|
786
|
+
};
|
|
787
|
+
headers?: {
|
|
788
|
+
"X-Org-Id"?: string | null;
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
output: AnalyticsResponse;
|
|
792
|
+
};
|
|
793
|
+
/**
|
|
794
|
+
* GET /analytics/realtime/locations
|
|
795
|
+
* Get Realtime Locations
|
|
796
|
+
* tier: read · scope: analytics:read
|
|
797
|
+
*/
|
|
798
|
+
get_realtime_locations_analytics_realtime_locations_get: {
|
|
799
|
+
input: {
|
|
800
|
+
query?: {
|
|
801
|
+
/** Number of locations to return */
|
|
802
|
+
limit?: number | null;
|
|
803
|
+
/** Comma-separated public keys to filter by */
|
|
804
|
+
write_key?: string | null;
|
|
805
|
+
};
|
|
806
|
+
headers?: {
|
|
807
|
+
"X-Org-Id"?: string | null;
|
|
808
|
+
};
|
|
809
|
+
};
|
|
810
|
+
output: AnalyticsResponse;
|
|
811
|
+
};
|
|
812
|
+
/**
|
|
813
|
+
* GET /analytics/realtime/pages
|
|
814
|
+
* Get Realtime Pages
|
|
815
|
+
* tier: read · scope: analytics:read
|
|
816
|
+
*/
|
|
817
|
+
get_realtime_pages_analytics_realtime_pages_get: {
|
|
818
|
+
input: {
|
|
819
|
+
query?: {
|
|
820
|
+
/** Number of pages to return */
|
|
821
|
+
limit?: number;
|
|
822
|
+
/** Comma-separated public keys to filter by */
|
|
823
|
+
write_key?: string | null;
|
|
824
|
+
};
|
|
825
|
+
headers?: {
|
|
826
|
+
"X-Org-Id"?: string | null;
|
|
827
|
+
};
|
|
828
|
+
};
|
|
829
|
+
output: AnalyticsResponse;
|
|
830
|
+
};
|
|
831
|
+
/**
|
|
832
|
+
* GET /analytics/realtime/sources
|
|
833
|
+
* Get Realtime Sources
|
|
834
|
+
* tier: read · scope: analytics:read
|
|
835
|
+
*/
|
|
836
|
+
get_realtime_sources_analytics_realtime_sources_get: {
|
|
837
|
+
input: {
|
|
838
|
+
query?: {
|
|
839
|
+
/** Number of sources to return */
|
|
840
|
+
limit?: number;
|
|
841
|
+
/** Comma-separated public keys to filter by */
|
|
842
|
+
write_key?: string | null;
|
|
843
|
+
};
|
|
844
|
+
headers?: {
|
|
845
|
+
"X-Org-Id"?: string | null;
|
|
846
|
+
};
|
|
847
|
+
};
|
|
848
|
+
output: AnalyticsResponse;
|
|
849
|
+
};
|
|
850
|
+
/**
|
|
851
|
+
* GET /analytics/engagement/depth-distribution
|
|
852
|
+
* Get Session Depth Distribution
|
|
853
|
+
* tier: read · scope: analytics:read
|
|
854
|
+
*/
|
|
855
|
+
get_session_depth_distribution_analytics_engagement_depth_distribution_get: {
|
|
856
|
+
input: {
|
|
857
|
+
query?: {
|
|
858
|
+
/** Comma-separated public keys to filter by */
|
|
859
|
+
write_key?: string | null;
|
|
860
|
+
/** Number of days to analyze */
|
|
861
|
+
days?: number;
|
|
862
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
863
|
+
date_from?: string | null;
|
|
864
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
865
|
+
date_to?: string | null;
|
|
866
|
+
};
|
|
867
|
+
headers?: {
|
|
868
|
+
"X-Org-Id"?: string | null;
|
|
869
|
+
};
|
|
870
|
+
};
|
|
871
|
+
output: AnalyticsResponse;
|
|
872
|
+
};
|
|
873
|
+
/**
|
|
874
|
+
* GET /analytics/audience/technology
|
|
875
|
+
* Get Technology Overview
|
|
876
|
+
* tier: read · scope: analytics:read
|
|
877
|
+
*/
|
|
878
|
+
get_technology_overview_analytics_audience_technology_get: {
|
|
879
|
+
input: {
|
|
880
|
+
query?: {
|
|
881
|
+
/** Comma-separated public keys to filter by */
|
|
882
|
+
write_key?: string | null;
|
|
883
|
+
/** Number of days to analyze */
|
|
884
|
+
days?: number;
|
|
885
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
886
|
+
date_from?: string | null;
|
|
887
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
888
|
+
date_to?: string | null;
|
|
889
|
+
};
|
|
890
|
+
headers?: {
|
|
891
|
+
"X-Org-Id"?: string | null;
|
|
892
|
+
};
|
|
893
|
+
};
|
|
894
|
+
output: AnalyticsResponse;
|
|
895
|
+
};
|
|
896
|
+
/**
|
|
897
|
+
* GET /analytics/engagement/time-distribution
|
|
898
|
+
* Get Time On Site Distribution
|
|
899
|
+
* tier: read · scope: analytics:read
|
|
900
|
+
*/
|
|
901
|
+
get_time_on_site_distribution_analytics_engagement_time_distribution_get: {
|
|
902
|
+
input: {
|
|
903
|
+
query?: {
|
|
904
|
+
/** Comma-separated public keys to filter by */
|
|
905
|
+
write_key?: string | null;
|
|
906
|
+
/** Number of days to analyze */
|
|
907
|
+
days?: number;
|
|
908
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
909
|
+
date_from?: string | null;
|
|
910
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
911
|
+
date_to?: string | null;
|
|
912
|
+
};
|
|
913
|
+
headers?: {
|
|
914
|
+
"X-Org-Id"?: string | null;
|
|
915
|
+
};
|
|
916
|
+
};
|
|
917
|
+
output: AnalyticsResponse;
|
|
918
|
+
};
|
|
919
|
+
/**
|
|
920
|
+
* GET /analytics/behavior/pages
|
|
921
|
+
* Get Top Pages
|
|
922
|
+
* tier: read · scope: analytics:read
|
|
923
|
+
*/
|
|
924
|
+
get_top_pages_analytics_behavior_pages_get: {
|
|
925
|
+
input: {
|
|
926
|
+
query?: {
|
|
927
|
+
/** Number of pages to return */
|
|
928
|
+
limit?: number;
|
|
929
|
+
/** Comma-separated public keys to filter by */
|
|
930
|
+
write_key?: string | null;
|
|
931
|
+
/** Number of days to analyze */
|
|
932
|
+
days?: number;
|
|
933
|
+
/** Anchored window start (YYYY-MM-DD). Must be sent with date_to. */
|
|
934
|
+
date_from?: string | null;
|
|
935
|
+
/** Anchored window end (YYYY-MM-DD). Must be sent with date_from. */
|
|
936
|
+
date_to?: string | null;
|
|
937
|
+
};
|
|
938
|
+
headers?: {
|
|
939
|
+
"X-Org-Id"?: string | null;
|
|
940
|
+
};
|
|
941
|
+
};
|
|
942
|
+
output: AnalyticsResponse;
|
|
943
|
+
};
|
|
944
|
+
}
|
|
945
|
+
|
|
946
|
+
// 2 schemas referenced above (the same as G8Contract.<Name>).
|
|
947
|
+
|
|
948
|
+
/** Metadata for analytics responses. */
|
|
949
|
+
export interface AnalyticsMeta {
|
|
950
|
+
cache_ttl?: number;
|
|
951
|
+
cached: boolean;
|
|
952
|
+
days: number;
|
|
953
|
+
org_id: string;
|
|
954
|
+
query_time_ms?: number | null;
|
|
955
|
+
stale?: boolean;
|
|
956
|
+
timestamp: string;
|
|
957
|
+
}
|
|
958
|
+
|
|
959
|
+
/** Standard analytics response wrapper. */
|
|
960
|
+
export interface AnalyticsResponse {
|
|
961
|
+
data: Record<string, unknown> | Array<unknown>;
|
|
962
|
+
meta: AnalyticsMeta;
|
|
963
|
+
success?: boolean;
|
|
964
|
+
}
|