@llmpulse/sdk 0.0.0-stage → 1.60.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/.github/workflows/ci.yml +17 -0
- package/.github/workflows/publish.yml +37 -0
- package/.openapi-generator/FILES +447 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/LICENSE +21 -0
- package/README.md +444 -2
- package/dist/apis/AIAgentTrafficApi.d.ts +293 -0
- package/dist/apis/AIAgentTrafficApi.js +354 -0
- package/dist/apis/AIModelInsightsApi.d.ts +305 -0
- package/dist/apis/AIModelInsightsApi.js +340 -0
- package/dist/apis/AccountApi.d.ts +59 -0
- package/dist/apis/AccountApi.js +77 -0
- package/dist/apis/AnnotationsApi.d.ts +201 -0
- package/dist/apis/AnnotationsApi.js +253 -0
- package/dist/apis/AnswersApi.d.ts +197 -0
- package/dist/apis/AnswersApi.js +225 -0
- package/dist/apis/CollectionsTagsApi.d.ts +281 -0
- package/dist/apis/CollectionsTagsApi.js +357 -0
- package/dist/apis/CompetitorsApi.d.ts +237 -0
- package/dist/apis/CompetitorsApi.js +304 -0
- package/dist/apis/GEOAuditsApi.d.ts +666 -0
- package/dist/apis/GEOAuditsApi.js +840 -0
- package/dist/apis/GEOWriterApi.d.ts +247 -0
- package/dist/apis/GEOWriterApi.js +316 -0
- package/dist/apis/HealthApi.d.ts +64 -0
- package/dist/apis/HealthApi.js +80 -0
- package/dist/apis/MentionsCitationsApi.d.ts +580 -0
- package/dist/apis/MentionsCitationsApi.js +646 -0
- package/dist/apis/MetricsApi.d.ts +684 -0
- package/dist/apis/MetricsApi.js +728 -0
- package/dist/apis/OwnedMediaCommunitiesApi.d.ts +348 -0
- package/dist/apis/OwnedMediaCommunitiesApi.js +367 -0
- package/dist/apis/ProjectsApi.d.ts +427 -0
- package/dist/apis/ProjectsApi.js +540 -0
- package/dist/apis/PromptsApi.d.ts +497 -0
- package/dist/apis/PromptsApi.js +551 -0
- package/dist/apis/RecommendationsApi.d.ts +185 -0
- package/dist/apis/RecommendationsApi.js +225 -0
- package/dist/apis/ReputationStudiesApi.d.ts +342 -0
- package/dist/apis/ReputationStudiesApi.js +392 -0
- package/dist/apis/SearchConsoleApi.d.ts +611 -0
- package/dist/apis/SearchConsoleApi.js +657 -0
- package/dist/apis/SentimentsApi.d.ts +165 -0
- package/dist/apis/SentimentsApi.js +193 -0
- package/dist/apis/ShoppingAdsApi.d.ts +486 -0
- package/dist/apis/ShoppingAdsApi.js +510 -0
- package/dist/apis/SourcesCitationIntelligenceApi.d.ts +531 -0
- package/dist/apis/SourcesCitationIntelligenceApi.js +599 -0
- package/dist/apis/StoreIntegrationsApi.d.ts +348 -0
- package/dist/apis/StoreIntegrationsApi.js +435 -0
- package/dist/apis/TeamApi.d.ts +227 -0
- package/dist/apis/TeamApi.js +283 -0
- package/dist/apis/TechnicalGEOReportsApi.d.ts +277 -0
- package/dist/apis/TechnicalGEOReportsApi.js +345 -0
- package/dist/apis/WebhooksApi.d.ts +207 -0
- package/dist/apis/WebhooksApi.js +256 -0
- package/dist/apis/index.d.ts +25 -0
- package/dist/apis/index.js +43 -0
- package/dist/esm/apis/AIAgentTrafficApi.d.ts +293 -0
- package/dist/esm/apis/AIAgentTrafficApi.js +350 -0
- package/dist/esm/apis/AIModelInsightsApi.d.ts +305 -0
- package/dist/esm/apis/AIModelInsightsApi.js +336 -0
- package/dist/esm/apis/AccountApi.d.ts +59 -0
- package/dist/esm/apis/AccountApi.js +73 -0
- package/dist/esm/apis/AnnotationsApi.d.ts +201 -0
- package/dist/esm/apis/AnnotationsApi.js +249 -0
- package/dist/esm/apis/AnswersApi.d.ts +197 -0
- package/dist/esm/apis/AnswersApi.js +221 -0
- package/dist/esm/apis/CollectionsTagsApi.d.ts +281 -0
- package/dist/esm/apis/CollectionsTagsApi.js +353 -0
- package/dist/esm/apis/CompetitorsApi.d.ts +237 -0
- package/dist/esm/apis/CompetitorsApi.js +300 -0
- package/dist/esm/apis/GEOAuditsApi.d.ts +666 -0
- package/dist/esm/apis/GEOAuditsApi.js +836 -0
- package/dist/esm/apis/GEOWriterApi.d.ts +247 -0
- package/dist/esm/apis/GEOWriterApi.js +312 -0
- package/dist/esm/apis/HealthApi.d.ts +64 -0
- package/dist/esm/apis/HealthApi.js +76 -0
- package/dist/esm/apis/MentionsCitationsApi.d.ts +580 -0
- package/dist/esm/apis/MentionsCitationsApi.js +642 -0
- package/dist/esm/apis/MetricsApi.d.ts +684 -0
- package/dist/esm/apis/MetricsApi.js +724 -0
- package/dist/esm/apis/OwnedMediaCommunitiesApi.d.ts +348 -0
- package/dist/esm/apis/OwnedMediaCommunitiesApi.js +363 -0
- package/dist/esm/apis/ProjectsApi.d.ts +427 -0
- package/dist/esm/apis/ProjectsApi.js +536 -0
- package/dist/esm/apis/PromptsApi.d.ts +497 -0
- package/dist/esm/apis/PromptsApi.js +547 -0
- package/dist/esm/apis/RecommendationsApi.d.ts +185 -0
- package/dist/esm/apis/RecommendationsApi.js +221 -0
- package/dist/esm/apis/ReputationStudiesApi.d.ts +342 -0
- package/dist/esm/apis/ReputationStudiesApi.js +388 -0
- package/dist/esm/apis/SearchConsoleApi.d.ts +611 -0
- package/dist/esm/apis/SearchConsoleApi.js +653 -0
- package/dist/esm/apis/SentimentsApi.d.ts +165 -0
- package/dist/esm/apis/SentimentsApi.js +189 -0
- package/dist/esm/apis/ShoppingAdsApi.d.ts +486 -0
- package/dist/esm/apis/ShoppingAdsApi.js +506 -0
- package/dist/esm/apis/SourcesCitationIntelligenceApi.d.ts +531 -0
- package/dist/esm/apis/SourcesCitationIntelligenceApi.js +595 -0
- package/dist/esm/apis/StoreIntegrationsApi.d.ts +348 -0
- package/dist/esm/apis/StoreIntegrationsApi.js +431 -0
- package/dist/esm/apis/TeamApi.d.ts +227 -0
- package/dist/esm/apis/TeamApi.js +279 -0
- package/dist/esm/apis/TechnicalGEOReportsApi.d.ts +277 -0
- package/dist/esm/apis/TechnicalGEOReportsApi.js +341 -0
- package/dist/esm/apis/WebhooksApi.d.ts +207 -0
- package/dist/esm/apis/WebhooksApi.js +252 -0
- package/dist/esm/apis/index.d.ts +25 -0
- package/dist/esm/apis/index.js +27 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/AccountCapacity.d.ts +38 -0
- package/dist/esm/models/AccountCapacity.js +43 -0
- package/dist/esm/models/AccountQuota.d.ts +56 -0
- package/dist/esm/models/AccountQuota.js +49 -0
- package/dist/esm/models/Actor.d.ts +64 -0
- package/dist/esm/models/Actor.js +56 -0
- package/dist/esm/models/AgentBot.d.ts +62 -0
- package/dist/esm/models/AgentBot.js +51 -0
- package/dist/esm/models/AgentBotsResponse.d.ts +45 -0
- package/dist/esm/models/AgentBotsResponse.js +46 -0
- package/dist/esm/models/AgentTrafficResponse.d.ts +97 -0
- package/dist/esm/models/AgentTrafficResponse.js +70 -0
- package/dist/esm/models/AiOrdersResponse.d.ts +83 -0
- package/dist/esm/models/AiOrdersResponse.js +78 -0
- package/dist/esm/models/AiOrdersResponseBySourceInner.d.ts +50 -0
- package/dist/esm/models/AiOrdersResponseBySourceInner.js +55 -0
- package/dist/esm/models/AiOrdersResponseSeriesInner.d.ts +44 -0
- package/dist/esm/models/AiOrdersResponseSeriesInner.js +51 -0
- package/dist/esm/models/AiOrdersResponseTotals.d.ts +38 -0
- package/dist/esm/models/AiOrdersResponseTotals.js +47 -0
- package/dist/esm/models/AiOrdersUpdateRequest.d.ts +70 -0
- package/dist/esm/models/AiOrdersUpdateRequest.js +72 -0
- package/dist/esm/models/AiOrdersUpdateRequestDaysInner.d.ts +50 -0
- package/dist/esm/models/AiOrdersUpdateRequestDaysInner.js +55 -0
- package/dist/esm/models/AiOrdersUpdateResponse.d.ts +56 -0
- package/dist/esm/models/AiOrdersUpdateResponse.js +59 -0
- package/dist/esm/models/AnnotationCreateResponse.d.ts +45 -0
- package/dist/esm/models/AnnotationCreateResponse.js +52 -0
- package/dist/esm/models/AnnotationCreateResponseAnnotation.d.ts +62 -0
- package/dist/esm/models/AnnotationCreateResponseAnnotation.js +63 -0
- package/dist/esm/models/AnswerDetails.d.ts +165 -0
- package/dist/esm/models/AnswerDetails.js +86 -0
- package/dist/esm/models/AnswerDetailsLocale.d.ts +38 -0
- package/dist/esm/models/AnswerDetailsLocale.js +43 -0
- package/dist/esm/models/ApiError.d.ts +39 -0
- package/dist/esm/models/ApiError.js +44 -0
- package/dist/esm/models/ApiErrorError.d.ts +79 -0
- package/dist/esm/models/ApiErrorError.js +79 -0
- package/dist/esm/models/AssignPromptTagsRequest.d.ts +56 -0
- package/dist/esm/models/AssignPromptTagsRequest.js +53 -0
- package/dist/esm/models/CatalogProduct.d.ts +74 -0
- package/dist/esm/models/CatalogProduct.js +59 -0
- package/dist/esm/models/CatalogPromptSuggestion.d.ts +87 -0
- package/dist/esm/models/CatalogPromptSuggestion.js +80 -0
- package/dist/esm/models/CatalogPromptSuggestionIdsRequest.d.ts +38 -0
- package/dist/esm/models/CatalogPromptSuggestionIdsRequest.js +47 -0
- package/dist/esm/models/CatalogPromptSuggestionProduct.d.ts +44 -0
- package/dist/esm/models/CatalogPromptSuggestionProduct.js +45 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponse.d.ts +58 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponse.js +61 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.d.ts +44 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.js +51 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.d.ts +38 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.js +47 -0
- package/dist/esm/models/CatalogPromptSuggestionsCreateRequest.d.ts +64 -0
- package/dist/esm/models/CatalogPromptSuggestionsCreateRequest.js +64 -0
- package/dist/esm/models/CatalogPromptSuggestionsCreateResponse.d.ts +57 -0
- package/dist/esm/models/CatalogPromptSuggestionsCreateResponse.js +60 -0
- package/dist/esm/models/CatalogPromptSuggestionsRejectResponse.d.ts +44 -0
- package/dist/esm/models/CatalogPromptSuggestionsRejectResponse.js +51 -0
- package/dist/esm/models/CatalogPromptSuggestionsResponse.d.ts +63 -0
- package/dist/esm/models/CatalogPromptSuggestionsResponse.js +64 -0
- package/dist/esm/models/CitationMatchMode.d.ts +26 -0
- package/dist/esm/models/CitationMatchMode.js +44 -0
- package/dist/esm/models/CitationRecord.d.ts +74 -0
- package/dist/esm/models/CitationRecord.js +71 -0
- package/dist/esm/models/CitationsResponse.d.ts +63 -0
- package/dist/esm/models/CitationsResponse.js +64 -0
- package/dist/esm/models/CollectionCreateResponse.d.ts +57 -0
- package/dist/esm/models/CollectionCreateResponse.js +60 -0
- package/dist/esm/models/CollectionCreateResponseCollection.d.ts +44 -0
- package/dist/esm/models/CollectionCreateResponseCollection.js +51 -0
- package/dist/esm/models/CollectionsResponse.d.ts +45 -0
- package/dist/esm/models/CollectionsResponse.js +52 -0
- package/dist/esm/models/Competitor.d.ts +83 -0
- package/dist/esm/models/Competitor.js +63 -0
- package/dist/esm/models/CompetitorCreateResponse.d.ts +57 -0
- package/dist/esm/models/CompetitorCreateResponse.js +60 -0
- package/dist/esm/models/CompetitorCreateResponseCompetitor.d.ts +69 -0
- package/dist/esm/models/CompetitorCreateResponseCompetitor.js +68 -0
- package/dist/esm/models/CompetitorDetails.d.ts +129 -0
- package/dist/esm/models/CompetitorDetails.js +74 -0
- package/dist/esm/models/CompetitorMentionRecord.d.ts +62 -0
- package/dist/esm/models/CompetitorMentionRecord.js +63 -0
- package/dist/esm/models/CompetitorMentionsResponse.d.ts +63 -0
- package/dist/esm/models/CompetitorMentionsResponse.js +64 -0
- package/dist/esm/models/CreateAnnotationRequest.d.ts +62 -0
- package/dist/esm/models/CreateAnnotationRequest.js +55 -0
- package/dist/esm/models/CreateCollectionRequest.d.ts +50 -0
- package/dist/esm/models/CreateCollectionRequest.js +51 -0
- package/dist/esm/models/CreateCompetitorRequest.d.ts +71 -0
- package/dist/esm/models/CreateCompetitorRequest.js +65 -0
- package/dist/esm/models/CreateProjectDraftRequest.d.ts +62 -0
- package/dist/esm/models/CreateProjectDraftRequest.js +57 -0
- package/dist/esm/models/CreateTeamInvitation201Response.d.ts +123 -0
- package/dist/esm/models/CreateTeamInvitation201Response.js +97 -0
- package/dist/esm/models/CreateTeamInvitationRequest.d.ts +86 -0
- package/dist/esm/models/CreateTeamInvitationRequest.js +66 -0
- package/dist/esm/models/CreateTechnicalGeoReportsRequest.d.ts +50 -0
- package/dist/esm/models/CreateTechnicalGeoReportsRequest.js +51 -0
- package/dist/esm/models/CreateWebhook201Response.d.ts +102 -0
- package/dist/esm/models/CreateWebhook201Response.js +74 -0
- package/dist/esm/models/CreateWebhookRequest.d.ts +60 -0
- package/dist/esm/models/CreateWebhookRequest.js +66 -0
- package/dist/esm/models/DeleteWebhook200Response.d.ts +44 -0
- package/dist/esm/models/DeleteWebhook200Response.js +45 -0
- package/dist/esm/models/FinalizeProjectDraftRequest.d.ts +38 -0
- package/dist/esm/models/FinalizeProjectDraftRequest.js +43 -0
- package/dist/esm/models/GeoAlert.d.ts +81 -0
- package/dist/esm/models/GeoAlert.js +58 -0
- package/dist/esm/models/GeoAlertEventsInner.d.ts +68 -0
- package/dist/esm/models/GeoAlertEventsInner.js +60 -0
- package/dist/esm/models/GeoAlertList.d.ts +63 -0
- package/dist/esm/models/GeoAlertList.js +52 -0
- package/dist/esm/models/GeoAudit.d.ts +161 -0
- package/dist/esm/models/GeoAudit.js +103 -0
- package/dist/esm/models/GeoAuditArchived.d.ts +50 -0
- package/dist/esm/models/GeoAuditArchived.js +47 -0
- package/dist/esm/models/GeoAuditComparison.d.ts +86 -0
- package/dist/esm/models/GeoAuditComparison.js +59 -0
- package/dist/esm/models/GeoAuditComparisonChangesInner.d.ts +86 -0
- package/dist/esm/models/GeoAuditComparisonChangesInner.js +66 -0
- package/dist/esm/models/GeoAuditCreateRequest.d.ts +72 -0
- package/dist/esm/models/GeoAuditCreateRequest.js +73 -0
- package/dist/esm/models/GeoAuditCreateResponse.d.ts +45 -0
- package/dist/esm/models/GeoAuditCreateResponse.js +46 -0
- package/dist/esm/models/GeoAuditFinding.d.ts +91 -0
- package/dist/esm/models/GeoAuditFinding.js +74 -0
- package/dist/esm/models/GeoAuditFindingList.d.ts +63 -0
- package/dist/esm/models/GeoAuditFindingList.js +52 -0
- package/dist/esm/models/GeoAuditIssue.d.ts +124 -0
- package/dist/esm/models/GeoAuditIssue.js +83 -0
- package/dist/esm/models/GeoAuditIssueList.d.ts +63 -0
- package/dist/esm/models/GeoAuditIssueList.js +52 -0
- package/dist/esm/models/GeoAuditIssueResponse.d.ts +136 -0
- package/dist/esm/models/GeoAuditIssueResponse.js +87 -0
- package/dist/esm/models/GeoAuditIssueUpdateRequest.d.ts +38 -0
- package/dist/esm/models/GeoAuditIssueUpdateRequest.js +45 -0
- package/dist/esm/models/GeoAuditList.d.ts +63 -0
- package/dist/esm/models/GeoAuditList.js +52 -0
- package/dist/esm/models/GeoAuditResponse.d.ts +173 -0
- package/dist/esm/models/GeoAuditResponse.js +107 -0
- package/dist/esm/models/GeoAuditRun.d.ts +138 -0
- package/dist/esm/models/GeoAuditRun.js +89 -0
- package/dist/esm/models/GeoAuditRunDetail.d.ts +164 -0
- package/dist/esm/models/GeoAuditRunDetail.js +97 -0
- package/dist/esm/models/GeoAuditRunList.d.ts +63 -0
- package/dist/esm/models/GeoAuditRunList.js +52 -0
- package/dist/esm/models/GeoAuditRunResponse.d.ts +150 -0
- package/dist/esm/models/GeoAuditRunResponse.js +93 -0
- package/dist/esm/models/GeoAuditSchedule.d.ts +44 -0
- package/dist/esm/models/GeoAuditSchedule.js +45 -0
- package/dist/esm/models/GeoAuditUpdateRequest.d.ts +80 -0
- package/dist/esm/models/GeoAuditUpdateRequest.js +67 -0
- package/dist/esm/models/GetAccount200Response.d.ts +91 -0
- package/dist/esm/models/GetAccount200Response.js +67 -0
- package/dist/esm/models/GetAccount200ResponseLimits.d.ts +70 -0
- package/dist/esm/models/GetAccount200ResponseLimits.js +55 -0
- package/dist/esm/models/GetAccount200ResponseRateLimits.d.ts +38 -0
- package/dist/esm/models/GetAccount200ResponseRateLimits.js +43 -0
- package/dist/esm/models/GetAccount200ResponseSubscription.d.ts +44 -0
- package/dist/esm/models/GetAccount200ResponseSubscription.js +45 -0
- package/dist/esm/models/IntelligenceTask.d.ts +158 -0
- package/dist/esm/models/IntelligenceTask.js +83 -0
- package/dist/esm/models/IntelligenceTaskCreateRequest.d.ts +99 -0
- package/dist/esm/models/IntelligenceTaskCreateRequest.js +75 -0
- package/dist/esm/models/IntelligenceTaskProduct.d.ts +75 -0
- package/dist/esm/models/IntelligenceTaskProduct.js +58 -0
- package/dist/esm/models/IntelligenceTaskProductImagesInner.d.ts +38 -0
- package/dist/esm/models/IntelligenceTaskProductImagesInner.js +45 -0
- package/dist/esm/models/IntelligenceTaskSummary.d.ts +98 -0
- package/dist/esm/models/IntelligenceTaskSummary.js +87 -0
- package/dist/esm/models/IntelligenceTaskUpdateRequest.d.ts +46 -0
- package/dist/esm/models/IntelligenceTaskUpdateRequest.js +49 -0
- package/dist/esm/models/IntelligenceTaskUpdateResponse.d.ts +164 -0
- package/dist/esm/models/IntelligenceTaskUpdateResponse.js +85 -0
- package/dist/esm/models/IntelligenceTasksResponse.d.ts +63 -0
- package/dist/esm/models/IntelligenceTasksResponse.js +64 -0
- package/dist/esm/models/LaunchRecommendationsRequest.d.ts +48 -0
- package/dist/esm/models/LaunchRecommendationsRequest.js +54 -0
- package/dist/esm/models/ListCompetitors200Response.d.ts +45 -0
- package/dist/esm/models/ListCompetitors200Response.js +46 -0
- package/dist/esm/models/ListProjects200Response.d.ts +39 -0
- package/dist/esm/models/ListProjects200Response.js +44 -0
- package/dist/esm/models/ListTeamInvitations200Response.d.ts +57 -0
- package/dist/esm/models/ListTeamInvitations200Response.js +50 -0
- package/dist/esm/models/ListTeamMembers200Response.d.ts +57 -0
- package/dist/esm/models/ListTeamMembers200Response.js +50 -0
- package/dist/esm/models/ListWebhooks200Response.d.ts +57 -0
- package/dist/esm/models/ListWebhooks200Response.js +50 -0
- package/dist/esm/models/ListWebhooks200ResponseDataInner.d.ts +90 -0
- package/dist/esm/models/ListWebhooks200ResponseDataInner.js +70 -0
- package/dist/esm/models/LlmsTxtTechnicalGeoReport.d.ts +135 -0
- package/dist/esm/models/LlmsTxtTechnicalGeoReport.js +76 -0
- package/dist/esm/models/LlmsTxtTechnicalGeoReportResultData.d.ts +92 -0
- package/dist/esm/models/LlmsTxtTechnicalGeoReportResultData.js +61 -0
- package/dist/esm/models/LocalBusiness.d.ts +110 -0
- package/dist/esm/models/LocalBusiness.js +67 -0
- package/dist/esm/models/LocalBusinessesResponse.d.ts +70 -0
- package/dist/esm/models/LocalBusinessesResponse.js +55 -0
- package/dist/esm/models/LocalBusinessesTotals.d.ts +56 -0
- package/dist/esm/models/LocalBusinessesTotals.js +49 -0
- package/dist/esm/models/LocalesResponse.d.ts +50 -0
- package/dist/esm/models/LocalesResponse.js +55 -0
- package/dist/esm/models/MentionRecord.d.ts +56 -0
- package/dist/esm/models/MentionRecord.js +59 -0
- package/dist/esm/models/MentionsResponse.d.ts +63 -0
- package/dist/esm/models/MentionsResponse.js +64 -0
- package/dist/esm/models/MetricsFiltersEcho.d.ts +110 -0
- package/dist/esm/models/MetricsFiltersEcho.js +67 -0
- package/dist/esm/models/ModelsResponse.d.ts +63 -0
- package/dist/esm/models/ModelsResponse.js +69 -0
- package/dist/esm/models/PaginatedEnvelope.d.ts +56 -0
- package/dist/esm/models/PaginatedEnvelope.js +59 -0
- package/dist/esm/models/Ping200Response.d.ts +51 -0
- package/dist/esm/models/Ping200Response.js +48 -0
- package/dist/esm/models/Project.d.ts +44 -0
- package/dist/esm/models/Project.js +45 -0
- package/dist/esm/models/ProjectCreateRequest.d.ts +161 -0
- package/dist/esm/models/ProjectCreateRequest.js +94 -0
- package/dist/esm/models/ProjectCreateRequestCollectionsInner.d.ts +38 -0
- package/dist/esm/models/ProjectCreateRequestCollectionsInner.js +45 -0
- package/dist/esm/models/ProjectCreateRequestCompetitorsInner.d.ts +44 -0
- package/dist/esm/models/ProjectCreateRequestCompetitorsInner.js +47 -0
- package/dist/esm/models/ProjectCreateRequestOwnedMedia.d.ts +62 -0
- package/dist/esm/models/ProjectCreateRequestOwnedMedia.js +51 -0
- package/dist/esm/models/ProjectCreateResponse.d.ts +92 -0
- package/dist/esm/models/ProjectCreateResponse.js +65 -0
- package/dist/esm/models/ProjectCreateResponseCollectionsInner.d.ts +44 -0
- package/dist/esm/models/ProjectCreateResponseCollectionsInner.js +45 -0
- package/dist/esm/models/ProjectCreateResponseCompetitors.d.ts +38 -0
- package/dist/esm/models/ProjectCreateResponseCompetitors.js +43 -0
- package/dist/esm/models/ProjectCreateResponseEmailSubscription.d.ts +32 -0
- package/dist/esm/models/ProjectCreateResponseEmailSubscription.js +41 -0
- package/dist/esm/models/ProjectCreateResponseLimits.d.ts +44 -0
- package/dist/esm/models/ProjectCreateResponseLimits.js +45 -0
- package/dist/esm/models/ProjectCreateResponsePrompts.d.ts +52 -0
- package/dist/esm/models/ProjectCreateResponsePrompts.js +52 -0
- package/dist/esm/models/ProjectCreateResponseSameDomainProjectsInner.d.ts +50 -0
- package/dist/esm/models/ProjectCreateResponseSameDomainProjectsInner.js +47 -0
- package/dist/esm/models/ProjectDetails.d.ts +173 -0
- package/dist/esm/models/ProjectDetails.js +90 -0
- package/dist/esm/models/ProjectDetailsAllOfDataCoverage.d.ts +63 -0
- package/dist/esm/models/ProjectDetailsAllOfDataCoverage.js +63 -0
- package/dist/esm/models/ProjectDetailsAllOfSearchConsole.d.ts +47 -0
- package/dist/esm/models/ProjectDetailsAllOfSearchConsole.js +51 -0
- package/dist/esm/models/ProjectDetailsAllOfStats.d.ts +51 -0
- package/dist/esm/models/ProjectDetailsAllOfStats.js +48 -0
- package/dist/esm/models/ProjectDetailsAllOfStatsPromptsByBrandKind.d.ts +44 -0
- package/dist/esm/models/ProjectDetailsAllOfStatsPromptsByBrandKind.js +45 -0
- package/dist/esm/models/ProjectProfile.d.ts +104 -0
- package/dist/esm/models/ProjectProfile.js +73 -0
- package/dist/esm/models/ProjectUpdateResponse.d.ts +57 -0
- package/dist/esm/models/ProjectUpdateResponse.js +60 -0
- package/dist/esm/models/PromptExecutionRecord.d.ts +117 -0
- package/dist/esm/models/PromptExecutionRecord.js +105 -0
- package/dist/esm/models/PromptExecutionsResponse.d.ts +63 -0
- package/dist/esm/models/PromptExecutionsResponse.js +64 -0
- package/dist/esm/models/PromptRecord.d.ts +93 -0
- package/dist/esm/models/PromptRecord.js +84 -0
- package/dist/esm/models/PromptSummaryResponse.d.ts +100 -0
- package/dist/esm/models/PromptSummaryResponse.js +65 -0
- package/dist/esm/models/PromptSummaryRow.d.ts +171 -0
- package/dist/esm/models/PromptSummaryRow.js +88 -0
- package/dist/esm/models/PromptTagsAssignResponse.d.ts +75 -0
- package/dist/esm/models/PromptTagsAssignResponse.js +72 -0
- package/dist/esm/models/PromptsCreateRequest.d.ts +50 -0
- package/dist/esm/models/PromptsCreateRequest.js +55 -0
- package/dist/esm/models/PromptsCreateResponse.d.ts +69 -0
- package/dist/esm/models/PromptsCreateResponse.js +54 -0
- package/dist/esm/models/PromptsCreateResponseDataInner.d.ts +52 -0
- package/dist/esm/models/PromptsCreateResponseDataInner.js +52 -0
- package/dist/esm/models/PromptsResponse.d.ts +63 -0
- package/dist/esm/models/PromptsResponse.js +64 -0
- package/dist/esm/models/QueryWebAnalyticsRequest.d.ts +38 -0
- package/dist/esm/models/QueryWebAnalyticsRequest.js +47 -0
- package/dist/esm/models/RecommendationSummary.d.ts +119 -0
- package/dist/esm/models/RecommendationSummary.js +106 -0
- package/dist/esm/models/RecommendationSummarySummary.d.ts +44 -0
- package/dist/esm/models/RecommendationSummarySummary.js +45 -0
- package/dist/esm/models/RecommendationsResponse.d.ts +63 -0
- package/dist/esm/models/RecommendationsResponse.js +64 -0
- package/dist/esm/models/RemoveTeamMember200Response.d.ts +44 -0
- package/dist/esm/models/RemoveTeamMember200Response.js +45 -0
- package/dist/esm/models/RevokeTeamInvitation200Response.d.ts +44 -0
- package/dist/esm/models/RevokeTeamInvitation200Response.js +45 -0
- package/dist/esm/models/SampleWebhookPayloads200Response.d.ts +45 -0
- package/dist/esm/models/SampleWebhookPayloads200Response.js +46 -0
- package/dist/esm/models/SampleWebhookPayloads200ResponseDataInner.d.ts +56 -0
- package/dist/esm/models/SampleWebhookPayloads200ResponseDataInner.js +49 -0
- package/dist/esm/models/SearchConsoleFiltersInner.d.ts +67 -0
- package/dist/esm/models/SearchConsoleFiltersInner.js +70 -0
- package/dist/esm/models/SearchConsoleListResponse.d.ts +106 -0
- package/dist/esm/models/SearchConsoleListResponse.js +67 -0
- package/dist/esm/models/SearchConsoleListResponseDataInner.d.ts +56 -0
- package/dist/esm/models/SearchConsoleListResponseDataInner.js +49 -0
- package/dist/esm/models/SearchConsoleMetrics.d.ts +50 -0
- package/dist/esm/models/SearchConsoleMetrics.js +47 -0
- package/dist/esm/models/SearchConsoleProperty.d.ts +38 -0
- package/dist/esm/models/SearchConsoleProperty.js +43 -0
- package/dist/esm/models/SearchConsoleRowsResponse.d.ts +112 -0
- package/dist/esm/models/SearchConsoleRowsResponse.js +69 -0
- package/dist/esm/models/SearchConsoleRowsResponseDataInner.d.ts +86 -0
- package/dist/esm/models/SearchConsoleRowsResponseDataInner.js +59 -0
- package/dist/esm/models/SearchConsoleSummaryResponse.d.ts +89 -0
- package/dist/esm/models/SearchConsoleSummaryResponse.js +62 -0
- package/dist/esm/models/SearchConsoleSummaryResponseBreakdownInner.d.ts +56 -0
- package/dist/esm/models/SearchConsoleSummaryResponseBreakdownInner.js +49 -0
- package/dist/esm/models/SearchConsoleTimeseriesResponse.d.ts +76 -0
- package/dist/esm/models/SearchConsoleTimeseriesResponse.js +57 -0
- package/dist/esm/models/SearchConsoleTimeseriesResponseDataInner.d.ts +56 -0
- package/dist/esm/models/SearchConsoleTimeseriesResponseDataInner.js +49 -0
- package/dist/esm/models/SentimentRecord.d.ts +134 -0
- package/dist/esm/models/SentimentRecord.js +119 -0
- package/dist/esm/models/SentimentsResponse.d.ts +63 -0
- package/dist/esm/models/SentimentsResponse.js +64 -0
- package/dist/esm/models/SovResponse.d.ts +105 -0
- package/dist/esm/models/SovResponse.js +70 -0
- package/dist/esm/models/SovResponseBreakdownInner.d.ts +51 -0
- package/dist/esm/models/SovResponseBreakdownInner.js +48 -0
- package/dist/esm/models/SovResponseCurrentInner.d.ts +51 -0
- package/dist/esm/models/SovResponseCurrentInner.js +48 -0
- package/dist/esm/models/SovResponseOthersInner.d.ts +45 -0
- package/dist/esm/models/SovResponseOthersInner.js +46 -0
- package/dist/esm/models/SovResponseOverTimeInner.d.ts +40 -0
- package/dist/esm/models/SovResponseOverTimeInner.js +45 -0
- package/dist/esm/models/SovResponsePeriodsInner.d.ts +56 -0
- package/dist/esm/models/SovResponsePeriodsInner.js +49 -0
- package/dist/esm/models/SovResponseSample.d.ts +56 -0
- package/dist/esm/models/SovResponseSample.js +49 -0
- package/dist/esm/models/StoreConnectionResponse.d.ts +71 -0
- package/dist/esm/models/StoreConnectionResponse.js +70 -0
- package/dist/esm/models/StoreConnectionResponseAccount.d.ts +32 -0
- package/dist/esm/models/StoreConnectionResponseAccount.js +41 -0
- package/dist/esm/models/StoreConnectionResponseCandidatesInner.d.ts +44 -0
- package/dist/esm/models/StoreConnectionResponseCandidatesInner.js +51 -0
- package/dist/esm/models/StoreConnectionResponseProject.d.ts +56 -0
- package/dist/esm/models/StoreConnectionResponseProject.js +55 -0
- package/dist/esm/models/SummaryResponse.d.ts +88 -0
- package/dist/esm/models/SummaryResponse.js +59 -0
- package/dist/esm/models/SummaryResponseAllOfPositionDistribution.d.ts +56 -0
- package/dist/esm/models/SummaryResponseAllOfPositionDistribution.js +49 -0
- package/dist/esm/models/SummaryResponseAllOfSummaryValueInner.d.ts +77 -0
- package/dist/esm/models/SummaryResponseAllOfSummaryValueInner.js +61 -0
- package/dist/esm/models/TagRef.d.ts +38 -0
- package/dist/esm/models/TagRef.js +47 -0
- package/dist/esm/models/TeamAccountRole.d.ts +38 -0
- package/dist/esm/models/TeamAccountRole.js +47 -0
- package/dist/esm/models/TeamInvitation.d.ts +111 -0
- package/dist/esm/models/TeamInvitation.js +91 -0
- package/dist/esm/models/TeamMember.d.ts +135 -0
- package/dist/esm/models/TeamMember.js +106 -0
- package/dist/esm/models/TechnicalGeoReportContentRevertRequest.d.ts +45 -0
- package/dist/esm/models/TechnicalGeoReportContentRevertRequest.js +55 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateRequest.d.ts +58 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateRequest.js +64 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateRequestEdits.d.ts +38 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateRequestEdits.js +43 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateResponse.d.ts +149 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateResponse.js +85 -0
- package/dist/esm/models/TimeseriesPoint.d.ts +38 -0
- package/dist/esm/models/TimeseriesPoint.js +43 -0
- package/dist/esm/models/TimeseriesResponse.d.ts +72 -0
- package/dist/esm/models/TimeseriesResponse.js +54 -0
- package/dist/esm/models/TimeseriesSeries.d.ts +46 -0
- package/dist/esm/models/TimeseriesSeries.js +47 -0
- package/dist/esm/models/TopSourcesResponse.d.ts +88 -0
- package/dist/esm/models/TopSourcesResponse.js +61 -0
- package/dist/esm/models/TopSourcesResponseDataInner.d.ts +50 -0
- package/dist/esm/models/TopSourcesResponseDataInner.js +47 -0
- package/dist/esm/models/UpdateAnnotationRequest.d.ts +62 -0
- package/dist/esm/models/UpdateAnnotationRequest.js +53 -0
- package/dist/esm/models/UpdateCollectionRequest.d.ts +44 -0
- package/dist/esm/models/UpdateCollectionRequest.js +47 -0
- package/dist/esm/models/UpdateCompetitorRequest.d.ts +77 -0
- package/dist/esm/models/UpdateCompetitorRequest.js +63 -0
- package/dist/esm/models/UpdateProjectDraftRequest.d.ts +132 -0
- package/dist/esm/models/UpdateProjectDraftRequest.js +82 -0
- package/dist/esm/models/UpdateProjectRequest.d.ts +98 -0
- package/dist/esm/models/UpdateProjectRequest.js +63 -0
- package/dist/esm/models/WebAnalyticsQueryResponse.d.ts +135 -0
- package/dist/esm/models/WebAnalyticsQueryResponse.js +81 -0
- package/dist/esm/models/WebAnalyticsQueryResponseColumnsInner.d.ts +50 -0
- package/dist/esm/models/WebAnalyticsQueryResponseColumnsInner.js +47 -0
- package/dist/esm/models/WebAnalyticsSchemaResponse.d.ts +108 -0
- package/dist/esm/models/WebAnalyticsSchemaResponse.js +72 -0
- package/dist/esm/models/index.d.ts +193 -0
- package/dist/esm/models/index.js +195 -0
- package/dist/esm/runtime.d.ts +185 -0
- package/dist/esm/runtime.js +354 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/AccountCapacity.d.ts +38 -0
- package/dist/models/AccountCapacity.js +50 -0
- package/dist/models/AccountQuota.d.ts +56 -0
- package/dist/models/AccountQuota.js +56 -0
- package/dist/models/Actor.d.ts +64 -0
- package/dist/models/Actor.js +64 -0
- package/dist/models/AgentBot.d.ts +62 -0
- package/dist/models/AgentBot.js +58 -0
- package/dist/models/AgentBotsResponse.d.ts +45 -0
- package/dist/models/AgentBotsResponse.js +53 -0
- package/dist/models/AgentTrafficResponse.d.ts +97 -0
- package/dist/models/AgentTrafficResponse.js +78 -0
- package/dist/models/AiOrdersResponse.d.ts +83 -0
- package/dist/models/AiOrdersResponse.js +85 -0
- package/dist/models/AiOrdersResponseBySourceInner.d.ts +50 -0
- package/dist/models/AiOrdersResponseBySourceInner.js +62 -0
- package/dist/models/AiOrdersResponseSeriesInner.d.ts +44 -0
- package/dist/models/AiOrdersResponseSeriesInner.js +58 -0
- package/dist/models/AiOrdersResponseTotals.d.ts +38 -0
- package/dist/models/AiOrdersResponseTotals.js +54 -0
- package/dist/models/AiOrdersUpdateRequest.d.ts +70 -0
- package/dist/models/AiOrdersUpdateRequest.js +80 -0
- package/dist/models/AiOrdersUpdateRequestDaysInner.d.ts +50 -0
- package/dist/models/AiOrdersUpdateRequestDaysInner.js +62 -0
- package/dist/models/AiOrdersUpdateResponse.d.ts +56 -0
- package/dist/models/AiOrdersUpdateResponse.js +66 -0
- package/dist/models/AnnotationCreateResponse.d.ts +45 -0
- package/dist/models/AnnotationCreateResponse.js +59 -0
- package/dist/models/AnnotationCreateResponseAnnotation.d.ts +62 -0
- package/dist/models/AnnotationCreateResponseAnnotation.js +70 -0
- package/dist/models/AnswerDetails.d.ts +165 -0
- package/dist/models/AnswerDetails.js +93 -0
- package/dist/models/AnswerDetailsLocale.d.ts +38 -0
- package/dist/models/AnswerDetailsLocale.js +50 -0
- package/dist/models/ApiError.d.ts +39 -0
- package/dist/models/ApiError.js +51 -0
- package/dist/models/ApiErrorError.d.ts +79 -0
- package/dist/models/ApiErrorError.js +87 -0
- package/dist/models/AssignPromptTagsRequest.d.ts +56 -0
- package/dist/models/AssignPromptTagsRequest.js +60 -0
- package/dist/models/CatalogProduct.d.ts +74 -0
- package/dist/models/CatalogProduct.js +66 -0
- package/dist/models/CatalogPromptSuggestion.d.ts +87 -0
- package/dist/models/CatalogPromptSuggestion.js +87 -0
- package/dist/models/CatalogPromptSuggestionIdsRequest.d.ts +38 -0
- package/dist/models/CatalogPromptSuggestionIdsRequest.js +54 -0
- package/dist/models/CatalogPromptSuggestionProduct.d.ts +44 -0
- package/dist/models/CatalogPromptSuggestionProduct.js +52 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponse.d.ts +58 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponse.js +68 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.d.ts +44 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.js +58 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.d.ts +38 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.js +54 -0
- package/dist/models/CatalogPromptSuggestionsCreateRequest.d.ts +64 -0
- package/dist/models/CatalogPromptSuggestionsCreateRequest.js +72 -0
- package/dist/models/CatalogPromptSuggestionsCreateResponse.d.ts +57 -0
- package/dist/models/CatalogPromptSuggestionsCreateResponse.js +67 -0
- package/dist/models/CatalogPromptSuggestionsRejectResponse.d.ts +44 -0
- package/dist/models/CatalogPromptSuggestionsRejectResponse.js +58 -0
- package/dist/models/CatalogPromptSuggestionsResponse.d.ts +63 -0
- package/dist/models/CatalogPromptSuggestionsResponse.js +71 -0
- package/dist/models/CitationMatchMode.d.ts +26 -0
- package/dist/models/CitationMatchMode.js +52 -0
- package/dist/models/CitationRecord.d.ts +74 -0
- package/dist/models/CitationRecord.js +78 -0
- package/dist/models/CitationsResponse.d.ts +63 -0
- package/dist/models/CitationsResponse.js +71 -0
- package/dist/models/CollectionCreateResponse.d.ts +57 -0
- package/dist/models/CollectionCreateResponse.js +67 -0
- package/dist/models/CollectionCreateResponseCollection.d.ts +44 -0
- package/dist/models/CollectionCreateResponseCollection.js +58 -0
- package/dist/models/CollectionsResponse.d.ts +45 -0
- package/dist/models/CollectionsResponse.js +59 -0
- package/dist/models/Competitor.d.ts +83 -0
- package/dist/models/Competitor.js +71 -0
- package/dist/models/CompetitorCreateResponse.d.ts +57 -0
- package/dist/models/CompetitorCreateResponse.js +67 -0
- package/dist/models/CompetitorCreateResponseCompetitor.d.ts +69 -0
- package/dist/models/CompetitorCreateResponseCompetitor.js +75 -0
- package/dist/models/CompetitorDetails.d.ts +129 -0
- package/dist/models/CompetitorDetails.js +81 -0
- package/dist/models/CompetitorMentionRecord.d.ts +62 -0
- package/dist/models/CompetitorMentionRecord.js +70 -0
- package/dist/models/CompetitorMentionsResponse.d.ts +63 -0
- package/dist/models/CompetitorMentionsResponse.js +71 -0
- package/dist/models/CreateAnnotationRequest.d.ts +62 -0
- package/dist/models/CreateAnnotationRequest.js +62 -0
- package/dist/models/CreateCollectionRequest.d.ts +50 -0
- package/dist/models/CreateCollectionRequest.js +58 -0
- package/dist/models/CreateCompetitorRequest.d.ts +71 -0
- package/dist/models/CreateCompetitorRequest.js +73 -0
- package/dist/models/CreateProjectDraftRequest.d.ts +62 -0
- package/dist/models/CreateProjectDraftRequest.js +64 -0
- package/dist/models/CreateTeamInvitation201Response.d.ts +123 -0
- package/dist/models/CreateTeamInvitation201Response.js +105 -0
- package/dist/models/CreateTeamInvitationRequest.d.ts +86 -0
- package/dist/models/CreateTeamInvitationRequest.js +74 -0
- package/dist/models/CreateTechnicalGeoReportsRequest.d.ts +50 -0
- package/dist/models/CreateTechnicalGeoReportsRequest.js +58 -0
- package/dist/models/CreateWebhook201Response.d.ts +102 -0
- package/dist/models/CreateWebhook201Response.js +82 -0
- package/dist/models/CreateWebhookRequest.d.ts +60 -0
- package/dist/models/CreateWebhookRequest.js +74 -0
- package/dist/models/DeleteWebhook200Response.d.ts +44 -0
- package/dist/models/DeleteWebhook200Response.js +52 -0
- package/dist/models/FinalizeProjectDraftRequest.d.ts +38 -0
- package/dist/models/FinalizeProjectDraftRequest.js +50 -0
- package/dist/models/GeoAlert.d.ts +81 -0
- package/dist/models/GeoAlert.js +65 -0
- package/dist/models/GeoAlertEventsInner.d.ts +68 -0
- package/dist/models/GeoAlertEventsInner.js +68 -0
- package/dist/models/GeoAlertList.d.ts +63 -0
- package/dist/models/GeoAlertList.js +59 -0
- package/dist/models/GeoAudit.d.ts +161 -0
- package/dist/models/GeoAudit.js +111 -0
- package/dist/models/GeoAuditArchived.d.ts +50 -0
- package/dist/models/GeoAuditArchived.js +54 -0
- package/dist/models/GeoAuditComparison.d.ts +86 -0
- package/dist/models/GeoAuditComparison.js +66 -0
- package/dist/models/GeoAuditComparisonChangesInner.d.ts +86 -0
- package/dist/models/GeoAuditComparisonChangesInner.js +74 -0
- package/dist/models/GeoAuditCreateRequest.d.ts +72 -0
- package/dist/models/GeoAuditCreateRequest.js +81 -0
- package/dist/models/GeoAuditCreateResponse.d.ts +45 -0
- package/dist/models/GeoAuditCreateResponse.js +53 -0
- package/dist/models/GeoAuditFinding.d.ts +91 -0
- package/dist/models/GeoAuditFinding.js +82 -0
- package/dist/models/GeoAuditFindingList.d.ts +63 -0
- package/dist/models/GeoAuditFindingList.js +59 -0
- package/dist/models/GeoAuditIssue.d.ts +124 -0
- package/dist/models/GeoAuditIssue.js +91 -0
- package/dist/models/GeoAuditIssueList.d.ts +63 -0
- package/dist/models/GeoAuditIssueList.js +59 -0
- package/dist/models/GeoAuditIssueResponse.d.ts +136 -0
- package/dist/models/GeoAuditIssueResponse.js +95 -0
- package/dist/models/GeoAuditIssueUpdateRequest.d.ts +38 -0
- package/dist/models/GeoAuditIssueUpdateRequest.js +52 -0
- package/dist/models/GeoAuditList.d.ts +63 -0
- package/dist/models/GeoAuditList.js +59 -0
- package/dist/models/GeoAuditResponse.d.ts +173 -0
- package/dist/models/GeoAuditResponse.js +115 -0
- package/dist/models/GeoAuditRun.d.ts +138 -0
- package/dist/models/GeoAuditRun.js +97 -0
- package/dist/models/GeoAuditRunDetail.d.ts +164 -0
- package/dist/models/GeoAuditRunDetail.js +105 -0
- package/dist/models/GeoAuditRunList.d.ts +63 -0
- package/dist/models/GeoAuditRunList.js +59 -0
- package/dist/models/GeoAuditRunResponse.d.ts +150 -0
- package/dist/models/GeoAuditRunResponse.js +101 -0
- package/dist/models/GeoAuditSchedule.d.ts +44 -0
- package/dist/models/GeoAuditSchedule.js +52 -0
- package/dist/models/GeoAuditUpdateRequest.d.ts +80 -0
- package/dist/models/GeoAuditUpdateRequest.js +75 -0
- package/dist/models/GetAccount200Response.d.ts +91 -0
- package/dist/models/GetAccount200Response.js +75 -0
- package/dist/models/GetAccount200ResponseLimits.d.ts +70 -0
- package/dist/models/GetAccount200ResponseLimits.js +62 -0
- package/dist/models/GetAccount200ResponseRateLimits.d.ts +38 -0
- package/dist/models/GetAccount200ResponseRateLimits.js +50 -0
- package/dist/models/GetAccount200ResponseSubscription.d.ts +44 -0
- package/dist/models/GetAccount200ResponseSubscription.js +52 -0
- package/dist/models/IntelligenceTask.d.ts +158 -0
- package/dist/models/IntelligenceTask.js +90 -0
- package/dist/models/IntelligenceTaskCreateRequest.d.ts +99 -0
- package/dist/models/IntelligenceTaskCreateRequest.js +83 -0
- package/dist/models/IntelligenceTaskProduct.d.ts +75 -0
- package/dist/models/IntelligenceTaskProduct.js +65 -0
- package/dist/models/IntelligenceTaskProductImagesInner.d.ts +38 -0
- package/dist/models/IntelligenceTaskProductImagesInner.js +52 -0
- package/dist/models/IntelligenceTaskSummary.d.ts +98 -0
- package/dist/models/IntelligenceTaskSummary.js +94 -0
- package/dist/models/IntelligenceTaskUpdateRequest.d.ts +46 -0
- package/dist/models/IntelligenceTaskUpdateRequest.js +56 -0
- package/dist/models/IntelligenceTaskUpdateResponse.d.ts +164 -0
- package/dist/models/IntelligenceTaskUpdateResponse.js +92 -0
- package/dist/models/IntelligenceTasksResponse.d.ts +63 -0
- package/dist/models/IntelligenceTasksResponse.js +71 -0
- package/dist/models/LaunchRecommendationsRequest.d.ts +48 -0
- package/dist/models/LaunchRecommendationsRequest.js +62 -0
- package/dist/models/ListCompetitors200Response.d.ts +45 -0
- package/dist/models/ListCompetitors200Response.js +53 -0
- package/dist/models/ListProjects200Response.d.ts +39 -0
- package/dist/models/ListProjects200Response.js +51 -0
- package/dist/models/ListTeamInvitations200Response.d.ts +57 -0
- package/dist/models/ListTeamInvitations200Response.js +57 -0
- package/dist/models/ListTeamMembers200Response.d.ts +57 -0
- package/dist/models/ListTeamMembers200Response.js +57 -0
- package/dist/models/ListWebhooks200Response.d.ts +57 -0
- package/dist/models/ListWebhooks200Response.js +57 -0
- package/dist/models/ListWebhooks200ResponseDataInner.d.ts +90 -0
- package/dist/models/ListWebhooks200ResponseDataInner.js +78 -0
- package/dist/models/LlmsTxtTechnicalGeoReport.d.ts +135 -0
- package/dist/models/LlmsTxtTechnicalGeoReport.js +83 -0
- package/dist/models/LlmsTxtTechnicalGeoReportResultData.d.ts +92 -0
- package/dist/models/LlmsTxtTechnicalGeoReportResultData.js +68 -0
- package/dist/models/LocalBusiness.d.ts +110 -0
- package/dist/models/LocalBusiness.js +74 -0
- package/dist/models/LocalBusinessesResponse.d.ts +70 -0
- package/dist/models/LocalBusinessesResponse.js +62 -0
- package/dist/models/LocalBusinessesTotals.d.ts +56 -0
- package/dist/models/LocalBusinessesTotals.js +56 -0
- package/dist/models/LocalesResponse.d.ts +50 -0
- package/dist/models/LocalesResponse.js +62 -0
- package/dist/models/MentionRecord.d.ts +56 -0
- package/dist/models/MentionRecord.js +66 -0
- package/dist/models/MentionsResponse.d.ts +63 -0
- package/dist/models/MentionsResponse.js +71 -0
- package/dist/models/MetricsFiltersEcho.d.ts +110 -0
- package/dist/models/MetricsFiltersEcho.js +74 -0
- package/dist/models/ModelsResponse.d.ts +63 -0
- package/dist/models/ModelsResponse.js +77 -0
- package/dist/models/PaginatedEnvelope.d.ts +56 -0
- package/dist/models/PaginatedEnvelope.js +66 -0
- package/dist/models/Ping200Response.d.ts +51 -0
- package/dist/models/Ping200Response.js +55 -0
- package/dist/models/Project.d.ts +44 -0
- package/dist/models/Project.js +52 -0
- package/dist/models/ProjectCreateRequest.d.ts +161 -0
- package/dist/models/ProjectCreateRequest.js +101 -0
- package/dist/models/ProjectCreateRequestCollectionsInner.d.ts +38 -0
- package/dist/models/ProjectCreateRequestCollectionsInner.js +52 -0
- package/dist/models/ProjectCreateRequestCompetitorsInner.d.ts +44 -0
- package/dist/models/ProjectCreateRequestCompetitorsInner.js +54 -0
- package/dist/models/ProjectCreateRequestOwnedMedia.d.ts +62 -0
- package/dist/models/ProjectCreateRequestOwnedMedia.js +58 -0
- package/dist/models/ProjectCreateResponse.d.ts +92 -0
- package/dist/models/ProjectCreateResponse.js +72 -0
- package/dist/models/ProjectCreateResponseCollectionsInner.d.ts +44 -0
- package/dist/models/ProjectCreateResponseCollectionsInner.js +52 -0
- package/dist/models/ProjectCreateResponseCompetitors.d.ts +38 -0
- package/dist/models/ProjectCreateResponseCompetitors.js +50 -0
- package/dist/models/ProjectCreateResponseEmailSubscription.d.ts +32 -0
- package/dist/models/ProjectCreateResponseEmailSubscription.js +48 -0
- package/dist/models/ProjectCreateResponseLimits.d.ts +44 -0
- package/dist/models/ProjectCreateResponseLimits.js +52 -0
- package/dist/models/ProjectCreateResponsePrompts.d.ts +52 -0
- package/dist/models/ProjectCreateResponsePrompts.js +60 -0
- package/dist/models/ProjectCreateResponseSameDomainProjectsInner.d.ts +50 -0
- package/dist/models/ProjectCreateResponseSameDomainProjectsInner.js +54 -0
- package/dist/models/ProjectDetails.d.ts +173 -0
- package/dist/models/ProjectDetails.js +97 -0
- package/dist/models/ProjectDetailsAllOfDataCoverage.d.ts +63 -0
- package/dist/models/ProjectDetailsAllOfDataCoverage.js +71 -0
- package/dist/models/ProjectDetailsAllOfSearchConsole.d.ts +47 -0
- package/dist/models/ProjectDetailsAllOfSearchConsole.js +59 -0
- package/dist/models/ProjectDetailsAllOfStats.d.ts +51 -0
- package/dist/models/ProjectDetailsAllOfStats.js +55 -0
- package/dist/models/ProjectDetailsAllOfStatsPromptsByBrandKind.d.ts +44 -0
- package/dist/models/ProjectDetailsAllOfStatsPromptsByBrandKind.js +52 -0
- package/dist/models/ProjectProfile.d.ts +104 -0
- package/dist/models/ProjectProfile.js +80 -0
- package/dist/models/ProjectUpdateResponse.d.ts +57 -0
- package/dist/models/ProjectUpdateResponse.js +67 -0
- package/dist/models/PromptExecutionRecord.d.ts +117 -0
- package/dist/models/PromptExecutionRecord.js +113 -0
- package/dist/models/PromptExecutionsResponse.d.ts +63 -0
- package/dist/models/PromptExecutionsResponse.js +71 -0
- package/dist/models/PromptRecord.d.ts +93 -0
- package/dist/models/PromptRecord.js +91 -0
- package/dist/models/PromptSummaryResponse.d.ts +100 -0
- package/dist/models/PromptSummaryResponse.js +72 -0
- package/dist/models/PromptSummaryRow.d.ts +171 -0
- package/dist/models/PromptSummaryRow.js +95 -0
- package/dist/models/PromptTagsAssignResponse.d.ts +75 -0
- package/dist/models/PromptTagsAssignResponse.js +79 -0
- package/dist/models/PromptsCreateRequest.d.ts +50 -0
- package/dist/models/PromptsCreateRequest.js +62 -0
- package/dist/models/PromptsCreateResponse.d.ts +69 -0
- package/dist/models/PromptsCreateResponse.js +61 -0
- package/dist/models/PromptsCreateResponseDataInner.d.ts +52 -0
- package/dist/models/PromptsCreateResponseDataInner.js +60 -0
- package/dist/models/PromptsResponse.d.ts +63 -0
- package/dist/models/PromptsResponse.js +71 -0
- package/dist/models/QueryWebAnalyticsRequest.d.ts +38 -0
- package/dist/models/QueryWebAnalyticsRequest.js +54 -0
- package/dist/models/RecommendationSummary.d.ts +119 -0
- package/dist/models/RecommendationSummary.js +114 -0
- package/dist/models/RecommendationSummarySummary.d.ts +44 -0
- package/dist/models/RecommendationSummarySummary.js +52 -0
- package/dist/models/RecommendationsResponse.d.ts +63 -0
- package/dist/models/RecommendationsResponse.js +71 -0
- package/dist/models/RemoveTeamMember200Response.d.ts +44 -0
- package/dist/models/RemoveTeamMember200Response.js +52 -0
- package/dist/models/RevokeTeamInvitation200Response.d.ts +44 -0
- package/dist/models/RevokeTeamInvitation200Response.js +52 -0
- package/dist/models/SampleWebhookPayloads200Response.d.ts +45 -0
- package/dist/models/SampleWebhookPayloads200Response.js +53 -0
- package/dist/models/SampleWebhookPayloads200ResponseDataInner.d.ts +56 -0
- package/dist/models/SampleWebhookPayloads200ResponseDataInner.js +56 -0
- package/dist/models/SearchConsoleFiltersInner.d.ts +67 -0
- package/dist/models/SearchConsoleFiltersInner.js +78 -0
- package/dist/models/SearchConsoleListResponse.d.ts +106 -0
- package/dist/models/SearchConsoleListResponse.js +74 -0
- package/dist/models/SearchConsoleListResponseDataInner.d.ts +56 -0
- package/dist/models/SearchConsoleListResponseDataInner.js +56 -0
- package/dist/models/SearchConsoleMetrics.d.ts +50 -0
- package/dist/models/SearchConsoleMetrics.js +54 -0
- package/dist/models/SearchConsoleProperty.d.ts +38 -0
- package/dist/models/SearchConsoleProperty.js +50 -0
- package/dist/models/SearchConsoleRowsResponse.d.ts +112 -0
- package/dist/models/SearchConsoleRowsResponse.js +76 -0
- package/dist/models/SearchConsoleRowsResponseDataInner.d.ts +86 -0
- package/dist/models/SearchConsoleRowsResponseDataInner.js +66 -0
- package/dist/models/SearchConsoleSummaryResponse.d.ts +89 -0
- package/dist/models/SearchConsoleSummaryResponse.js +69 -0
- package/dist/models/SearchConsoleSummaryResponseBreakdownInner.d.ts +56 -0
- package/dist/models/SearchConsoleSummaryResponseBreakdownInner.js +56 -0
- package/dist/models/SearchConsoleTimeseriesResponse.d.ts +76 -0
- package/dist/models/SearchConsoleTimeseriesResponse.js +64 -0
- package/dist/models/SearchConsoleTimeseriesResponseDataInner.d.ts +56 -0
- package/dist/models/SearchConsoleTimeseriesResponseDataInner.js +56 -0
- package/dist/models/SentimentRecord.d.ts +134 -0
- package/dist/models/SentimentRecord.js +127 -0
- package/dist/models/SentimentsResponse.d.ts +63 -0
- package/dist/models/SentimentsResponse.js +71 -0
- package/dist/models/SovResponse.d.ts +105 -0
- package/dist/models/SovResponse.js +77 -0
- package/dist/models/SovResponseBreakdownInner.d.ts +51 -0
- package/dist/models/SovResponseBreakdownInner.js +55 -0
- package/dist/models/SovResponseCurrentInner.d.ts +51 -0
- package/dist/models/SovResponseCurrentInner.js +55 -0
- package/dist/models/SovResponseOthersInner.d.ts +45 -0
- package/dist/models/SovResponseOthersInner.js +53 -0
- package/dist/models/SovResponseOverTimeInner.d.ts +40 -0
- package/dist/models/SovResponseOverTimeInner.js +52 -0
- package/dist/models/SovResponsePeriodsInner.d.ts +56 -0
- package/dist/models/SovResponsePeriodsInner.js +56 -0
- package/dist/models/SovResponseSample.d.ts +56 -0
- package/dist/models/SovResponseSample.js +56 -0
- package/dist/models/StoreConnectionResponse.d.ts +71 -0
- package/dist/models/StoreConnectionResponse.js +77 -0
- package/dist/models/StoreConnectionResponseAccount.d.ts +32 -0
- package/dist/models/StoreConnectionResponseAccount.js +48 -0
- package/dist/models/StoreConnectionResponseCandidatesInner.d.ts +44 -0
- package/dist/models/StoreConnectionResponseCandidatesInner.js +58 -0
- package/dist/models/StoreConnectionResponseProject.d.ts +56 -0
- package/dist/models/StoreConnectionResponseProject.js +62 -0
- package/dist/models/SummaryResponse.d.ts +88 -0
- package/dist/models/SummaryResponse.js +66 -0
- package/dist/models/SummaryResponseAllOfPositionDistribution.d.ts +56 -0
- package/dist/models/SummaryResponseAllOfPositionDistribution.js +56 -0
- package/dist/models/SummaryResponseAllOfSummaryValueInner.d.ts +77 -0
- package/dist/models/SummaryResponseAllOfSummaryValueInner.js +69 -0
- package/dist/models/TagRef.d.ts +38 -0
- package/dist/models/TagRef.js +54 -0
- package/dist/models/TeamAccountRole.d.ts +38 -0
- package/dist/models/TeamAccountRole.js +54 -0
- package/dist/models/TeamInvitation.d.ts +111 -0
- package/dist/models/TeamInvitation.js +99 -0
- package/dist/models/TeamMember.d.ts +135 -0
- package/dist/models/TeamMember.js +114 -0
- package/dist/models/TechnicalGeoReportContentRevertRequest.d.ts +45 -0
- package/dist/models/TechnicalGeoReportContentRevertRequest.js +63 -0
- package/dist/models/TechnicalGeoReportContentUpdateRequest.d.ts +58 -0
- package/dist/models/TechnicalGeoReportContentUpdateRequest.js +72 -0
- package/dist/models/TechnicalGeoReportContentUpdateRequestEdits.d.ts +38 -0
- package/dist/models/TechnicalGeoReportContentUpdateRequestEdits.js +50 -0
- package/dist/models/TechnicalGeoReportContentUpdateResponse.d.ts +149 -0
- package/dist/models/TechnicalGeoReportContentUpdateResponse.js +93 -0
- package/dist/models/TimeseriesPoint.d.ts +38 -0
- package/dist/models/TimeseriesPoint.js +50 -0
- package/dist/models/TimeseriesResponse.d.ts +72 -0
- package/dist/models/TimeseriesResponse.js +61 -0
- package/dist/models/TimeseriesSeries.d.ts +46 -0
- package/dist/models/TimeseriesSeries.js +54 -0
- package/dist/models/TopSourcesResponse.d.ts +88 -0
- package/dist/models/TopSourcesResponse.js +68 -0
- package/dist/models/TopSourcesResponseDataInner.d.ts +50 -0
- package/dist/models/TopSourcesResponseDataInner.js +54 -0
- package/dist/models/UpdateAnnotationRequest.d.ts +62 -0
- package/dist/models/UpdateAnnotationRequest.js +60 -0
- package/dist/models/UpdateCollectionRequest.d.ts +44 -0
- package/dist/models/UpdateCollectionRequest.js +54 -0
- package/dist/models/UpdateCompetitorRequest.d.ts +77 -0
- package/dist/models/UpdateCompetitorRequest.js +71 -0
- package/dist/models/UpdateProjectDraftRequest.d.ts +132 -0
- package/dist/models/UpdateProjectDraftRequest.js +90 -0
- package/dist/models/UpdateProjectRequest.d.ts +98 -0
- package/dist/models/UpdateProjectRequest.js +70 -0
- package/dist/models/WebAnalyticsQueryResponse.d.ts +135 -0
- package/dist/models/WebAnalyticsQueryResponse.js +89 -0
- package/dist/models/WebAnalyticsQueryResponseColumnsInner.d.ts +50 -0
- package/dist/models/WebAnalyticsQueryResponseColumnsInner.js +54 -0
- package/dist/models/WebAnalyticsSchemaResponse.d.ts +108 -0
- package/dist/models/WebAnalyticsSchemaResponse.js +80 -0
- package/dist/models/index.d.ts +193 -0
- package/dist/models/index.js +211 -0
- package/dist/runtime.d.ts +185 -0
- package/dist/runtime.js +371 -0
- package/docs/AIAgentTrafficApi.md +420 -0
- package/docs/AIModelInsightsApi.md +319 -0
- package/docs/AccountApi.md +73 -0
- package/docs/AccountCapacity.md +37 -0
- package/docs/AccountQuota.md +43 -0
- package/docs/Actor.md +42 -0
- package/docs/AgentBot.md +44 -0
- package/docs/AgentBotsResponse.md +38 -0
- package/docs/AgentTrafficResponse.md +48 -0
- package/docs/AiOrdersResponse.md +50 -0
- package/docs/AiOrdersResponseBySourceInner.md +40 -0
- package/docs/AiOrdersResponseSeriesInner.md +38 -0
- package/docs/AiOrdersResponseTotals.md +36 -0
- package/docs/AiOrdersUpdateRequest.md +44 -0
- package/docs/AiOrdersUpdateRequestDaysInner.md +40 -0
- package/docs/AiOrdersUpdateResponse.md +42 -0
- package/docs/AnnotationCreateResponse.md +38 -0
- package/docs/AnnotationCreateResponseAnnotation.md +44 -0
- package/docs/AnnotationsApi.md +325 -0
- package/docs/AnswerDetails.md +78 -0
- package/docs/AnswerDetailsLocale.md +36 -0
- package/docs/AnswersApi.md +202 -0
- package/docs/ApiError.md +36 -0
- package/docs/ApiErrorError.md +38 -0
- package/docs/AssignPromptTagsRequest.md +42 -0
- package/docs/CatalogProduct.md +48 -0
- package/docs/CatalogPromptSuggestion.md +52 -0
- package/docs/CatalogPromptSuggestionIdsRequest.md +36 -0
- package/docs/CatalogPromptSuggestionProduct.md +39 -0
- package/docs/CatalogPromptSuggestionsAcceptResponse.md +42 -0
- package/docs/CatalogPromptSuggestionsAcceptResponseAcceptedInner.md +38 -0
- package/docs/CatalogPromptSuggestionsAcceptResponseSkippedInner.md +36 -0
- package/docs/CatalogPromptSuggestionsCreateRequest.md +42 -0
- package/docs/CatalogPromptSuggestionsCreateResponse.md +42 -0
- package/docs/CatalogPromptSuggestionsRejectResponse.md +38 -0
- package/docs/CatalogPromptSuggestionsResponse.md +44 -0
- package/docs/CitationMatchMode.md +33 -0
- package/docs/CitationRecord.md +48 -0
- package/docs/CitationsResponse.md +44 -0
- package/docs/CollectionCreateResponse.md +42 -0
- package/docs/CollectionCreateResponseCollection.md +38 -0
- package/docs/CollectionsResponse.md +38 -0
- package/docs/CollectionsTagsApi.md +457 -0
- package/docs/Competitor.md +48 -0
- package/docs/CompetitorCreateResponse.md +42 -0
- package/docs/CompetitorCreateResponseCompetitor.md +46 -0
- package/docs/CompetitorDetails.md +66 -0
- package/docs/CompetitorMentionRecord.md +44 -0
- package/docs/CompetitorMentionsResponse.md +44 -0
- package/docs/CompetitorsApi.md +386 -0
- package/docs/CreateAnnotationRequest.md +44 -0
- package/docs/CreateCollectionRequest.md +40 -0
- package/docs/CreateCompetitorRequest.md +44 -0
- package/docs/CreateProjectDraftRequest.md +44 -0
- package/docs/CreateTeamInvitation201Response.md +60 -0
- package/docs/CreateTeamInvitationRequest.md +48 -0
- package/docs/CreateTechnicalGeoReportsRequest.md +40 -0
- package/docs/CreateWebhook201Response.md +52 -0
- package/docs/CreateWebhookRequest.md +38 -0
- package/docs/DeleteWebhook200Response.md +38 -0
- package/docs/FinalizeProjectDraftRequest.md +36 -0
- package/docs/GEOAuditsApi.md +1045 -0
- package/docs/GEOWriterApi.md +394 -0
- package/docs/GeoAlert.md +50 -0
- package/docs/GeoAlertEventsInner.md +42 -0
- package/docs/GeoAlertList.md +44 -0
- package/docs/GeoAudit.md +66 -0
- package/docs/GeoAuditArchived.md +40 -0
- package/docs/GeoAuditComparison.md +50 -0
- package/docs/GeoAuditComparisonChangesInner.md +48 -0
- package/docs/GeoAuditCreateRequest.md +40 -0
- package/docs/GeoAuditCreateResponse.md +38 -0
- package/docs/GeoAuditFinding.md +46 -0
- package/docs/GeoAuditFindingList.md +44 -0
- package/docs/GeoAuditIssue.md +58 -0
- package/docs/GeoAuditIssueList.md +44 -0
- package/docs/GeoAuditIssueResponse.md +62 -0
- package/docs/GeoAuditIssueUpdateRequest.md +36 -0
- package/docs/GeoAuditList.md +44 -0
- package/docs/GeoAuditResponse.md +70 -0
- package/docs/GeoAuditRun.md +63 -0
- package/docs/GeoAuditRunDetail.md +70 -0
- package/docs/GeoAuditRunList.md +44 -0
- package/docs/GeoAuditRunResponse.md +66 -0
- package/docs/GeoAuditSchedule.md +39 -0
- package/docs/GeoAuditUpdateRequest.md +44 -0
- package/docs/GetAccount200Response.md +50 -0
- package/docs/GetAccount200ResponseLimits.md +46 -0
- package/docs/GetAccount200ResponseRateLimits.md +36 -0
- package/docs/GetAccount200ResponseSubscription.md +39 -0
- package/docs/HealthApi.md +81 -0
- package/docs/IntelligenceTask.md +76 -0
- package/docs/IntelligenceTaskCreateRequest.md +52 -0
- package/docs/IntelligenceTaskProduct.md +49 -0
- package/docs/IntelligenceTaskProductImagesInner.md +36 -0
- package/docs/IntelligenceTaskSummary.md +56 -0
- package/docs/IntelligenceTaskUpdateRequest.md +38 -0
- package/docs/IntelligenceTaskUpdateResponse.md +78 -0
- package/docs/IntelligenceTasksResponse.md +44 -0
- package/docs/LaunchRecommendationsRequest.md +36 -0
- package/docs/ListCompetitors200Response.md +38 -0
- package/docs/ListProjects200Response.md +36 -0
- package/docs/ListTeamInvitations200Response.md +42 -0
- package/docs/ListTeamMembers200Response.md +42 -0
- package/docs/ListWebhooks200Response.md +42 -0
- package/docs/ListWebhooks200ResponseDataInner.md +48 -0
- package/docs/LlmsTxtTechnicalGeoReport.md +69 -0
- package/docs/LlmsTxtTechnicalGeoReportResultData.md +55 -0
- package/docs/LocalBusiness.md +60 -0
- package/docs/LocalBusinessesResponse.md +46 -0
- package/docs/LocalBusinessesTotals.md +42 -0
- package/docs/LocalesResponse.md +40 -0
- package/docs/MentionRecord.md +42 -0
- package/docs/MentionsCitationsApi.md +604 -0
- package/docs/MentionsResponse.md +44 -0
- package/docs/MetricsApi.md +584 -0
- package/docs/MetricsFiltersEcho.md +61 -0
- package/docs/ModelsResponse.md +38 -0
- package/docs/OwnedMediaCommunitiesApi.md +256 -0
- package/docs/PaginatedEnvelope.md +43 -0
- package/docs/Ping200Response.md +40 -0
- package/docs/Project.md +38 -0
- package/docs/ProjectCreateRequest.md +76 -0
- package/docs/ProjectCreateRequestCollectionsInner.md +36 -0
- package/docs/ProjectCreateRequestCompetitorsInner.md +38 -0
- package/docs/ProjectCreateRequestOwnedMedia.md +45 -0
- package/docs/ProjectCreateResponse.md +52 -0
- package/docs/ProjectCreateResponseCollectionsInner.md +38 -0
- package/docs/ProjectCreateResponseCompetitors.md +36 -0
- package/docs/ProjectCreateResponseEmailSubscription.md +34 -0
- package/docs/ProjectCreateResponseLimits.md +38 -0
- package/docs/ProjectCreateResponsePrompts.md +38 -0
- package/docs/ProjectCreateResponseSameDomainProjectsInner.md +40 -0
- package/docs/ProjectDetails.md +80 -0
- package/docs/ProjectDetailsAllOfDataCoverage.md +39 -0
- package/docs/ProjectDetailsAllOfSearchConsole.md +37 -0
- package/docs/ProjectDetailsAllOfStats.md +40 -0
- package/docs/ProjectDetailsAllOfStatsPromptsByBrandKind.md +39 -0
- package/docs/ProjectProfile.md +59 -0
- package/docs/ProjectUpdateResponse.md +42 -0
- package/docs/ProjectsApi.md +752 -0
- package/docs/PromptExecutionRecord.md +56 -0
- package/docs/PromptExecutionsResponse.md +44 -0
- package/docs/PromptRecord.md +54 -0
- package/docs/PromptSummaryResponse.md +56 -0
- package/docs/PromptSummaryRow.md +80 -0
- package/docs/PromptTagsAssignResponse.md +48 -0
- package/docs/PromptsApi.md +498 -0
- package/docs/PromptsCreateRequest.md +40 -0
- package/docs/PromptsCreateResponse.md +46 -0
- package/docs/PromptsCreateResponseDataInner.md +38 -0
- package/docs/PromptsResponse.md +44 -0
- package/docs/QueryWebAnalyticsRequest.md +36 -0
- package/docs/RecommendationSummary.md +56 -0
- package/docs/RecommendationSummarySummary.md +39 -0
- package/docs/RecommendationsApi.md +244 -0
- package/docs/RecommendationsResponse.md +44 -0
- package/docs/RemoveTeamMember200Response.md +38 -0
- package/docs/ReputationStudiesApi.md +436 -0
- package/docs/RevokeTeamInvitation200Response.md +38 -0
- package/docs/SampleWebhookPayloads200Response.md +38 -0
- package/docs/SampleWebhookPayloads200ResponseDataInner.md +42 -0
- package/docs/SearchConsoleApi.md +558 -0
- package/docs/SearchConsoleFiltersInner.md +38 -0
- package/docs/SearchConsoleListResponse.md +58 -0
- package/docs/SearchConsoleListResponseDataInner.md +42 -0
- package/docs/SearchConsoleMetrics.md +40 -0
- package/docs/SearchConsoleProperty.md +36 -0
- package/docs/SearchConsoleRowsResponse.md +60 -0
- package/docs/SearchConsoleRowsResponseDataInner.md +52 -0
- package/docs/SearchConsoleSummaryResponse.md +52 -0
- package/docs/SearchConsoleSummaryResponseBreakdownInner.md +42 -0
- package/docs/SearchConsoleTimeseriesResponse.md +48 -0
- package/docs/SearchConsoleTimeseriesResponseDataInner.md +42 -0
- package/docs/SentimentRecord.md +58 -0
- package/docs/SentimentsApi.md +191 -0
- package/docs/SentimentsResponse.md +44 -0
- package/docs/ShoppingAdsApi.md +386 -0
- package/docs/SourcesCitationIntelligenceApi.md +571 -0
- package/docs/SovResponse.md +56 -0
- package/docs/SovResponseBreakdownInner.md +40 -0
- package/docs/SovResponseCurrentInner.md +40 -0
- package/docs/SovResponseOthersInner.md +38 -0
- package/docs/SovResponseOverTimeInner.md +36 -0
- package/docs/SovResponsePeriodsInner.md +42 -0
- package/docs/SovResponseSample.md +43 -0
- package/docs/StoreConnectionResponse.md +46 -0
- package/docs/StoreConnectionResponseAccount.md +34 -0
- package/docs/StoreConnectionResponseCandidatesInner.md +38 -0
- package/docs/StoreConnectionResponseProject.md +43 -0
- package/docs/StoreIntegrationsApi.md +556 -0
- package/docs/SummaryResponse.md +50 -0
- package/docs/SummaryResponseAllOfPositionDistribution.md +42 -0
- package/docs/SummaryResponseAllOfSummaryValueInner.md +46 -0
- package/docs/TagRef.md +36 -0
- package/docs/TeamAccountRole.md +37 -0
- package/docs/TeamApi.md +388 -0
- package/docs/TeamInvitation.md +56 -0
- package/docs/TeamMember.md +62 -0
- package/docs/TechnicalGEOReportsApi.md +406 -0
- package/docs/TechnicalGeoReportContentRevertRequest.md +36 -0
- package/docs/TechnicalGeoReportContentUpdateRequest.md +40 -0
- package/docs/TechnicalGeoReportContentUpdateRequestEdits.md +37 -0
- package/docs/TechnicalGeoReportContentUpdateResponse.md +70 -0
- package/docs/TimeseriesPoint.md +36 -0
- package/docs/TimeseriesResponse.md +46 -0
- package/docs/TimeseriesSeries.md +38 -0
- package/docs/TopSourcesResponse.md +52 -0
- package/docs/TopSourcesResponseDataInner.md +40 -0
- package/docs/UpdateAnnotationRequest.md +44 -0
- package/docs/UpdateCollectionRequest.md +38 -0
- package/docs/UpdateCompetitorRequest.md +46 -0
- package/docs/UpdateProjectDraftRequest.md +64 -0
- package/docs/UpdateProjectRequest.md +56 -0
- package/docs/WebAnalyticsQueryResponse.md +62 -0
- package/docs/WebAnalyticsQueryResponseColumnsInner.md +40 -0
- package/docs/WebAnalyticsSchemaResponse.md +54 -0
- package/docs/WebhooksApi.md +318 -0
- package/package.json +20 -4
- package/src/apis/AIAgentTrafficApi.ts +615 -0
- package/src/apis/AIModelInsightsApi.ts +585 -0
- package/src/apis/AccountApi.ts +110 -0
- package/src/apis/AnnotationsApi.ts +447 -0
- package/src/apis/AnswersApi.ts +376 -0
- package/src/apis/CollectionsTagsApi.ts +624 -0
- package/src/apis/CompetitorsApi.ts +537 -0
- package/src/apis/GEOAuditsApi.ts +1539 -0
- package/src/apis/GEOWriterApi.ts +557 -0
- package/src/apis/HealthApi.ts +120 -0
- package/src/apis/MentionsCitationsApi.ts +1108 -0
- package/src/apis/MetricsApi.ts +1236 -0
- package/src/apis/OwnedMediaCommunitiesApi.ts +597 -0
- package/src/apis/ProjectsApi.ts +962 -0
- package/src/apis/PromptsApi.ts +938 -0
- package/src/apis/RecommendationsApi.ts +378 -0
- package/src/apis/ReputationStudiesApi.ts +668 -0
- package/src/apis/SearchConsoleApi.ts +1106 -0
- package/src/apis/SentimentsApi.ts +324 -0
- package/src/apis/ShoppingAdsApi.ts +856 -0
- package/src/apis/SourcesCitationIntelligenceApi.ts +1016 -0
- package/src/apis/StoreIntegrationsApi.ts +771 -0
- package/src/apis/TeamApi.ts +489 -0
- package/src/apis/TechnicalGEOReportsApi.ts +605 -0
- package/src/apis/WebhooksApi.ts +436 -0
- package/src/apis/index.ts +27 -0
- package/src/index.ts +5 -0
- package/src/models/AccountCapacity.ts +73 -0
- package/src/models/AccountQuota.ts +97 -0
- package/src/models/Actor.ts +108 -0
- package/src/models/AgentBot.ts +105 -0
- package/src/models/AgentBotsResponse.ts +89 -0
- package/src/models/AgentTrafficResponse.ts +142 -0
- package/src/models/AiOrdersResponse.ts +160 -0
- package/src/models/AiOrdersResponseBySourceInner.ts +93 -0
- package/src/models/AiOrdersResponseSeriesInner.ts +84 -0
- package/src/models/AiOrdersResponseTotals.ts +75 -0
- package/src/models/AiOrdersUpdateRequest.ts +131 -0
- package/src/models/AiOrdersUpdateRequestDaysInner.ts +93 -0
- package/src/models/AiOrdersUpdateResponse.ts +102 -0
- package/src/models/AnnotationCreateResponse.ts +92 -0
- package/src/models/AnnotationCreateResponseAnnotation.ts +111 -0
- package/src/models/AnswerDetails.ts +249 -0
- package/src/models/AnswerDetailsLocale.ts +73 -0
- package/src/models/ApiError.ts +81 -0
- package/src/models/ApiErrorError.ts +119 -0
- package/src/models/AssignPromptTagsRequest.ts +99 -0
- package/src/models/CatalogProduct.ts +123 -0
- package/src/models/CatalogPromptSuggestion.ts +155 -0
- package/src/models/CatalogPromptSuggestionIdsRequest.ts +75 -0
- package/src/models/CatalogPromptSuggestionProduct.ts +81 -0
- package/src/models/CatalogPromptSuggestionsAcceptResponse.ts +117 -0
- package/src/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.ts +84 -0
- package/src/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.ts +75 -0
- package/src/models/CatalogPromptSuggestionsCreateRequest.ts +120 -0
- package/src/models/CatalogPromptSuggestionsCreateResponse.ts +110 -0
- package/src/models/CatalogPromptSuggestionsRejectResponse.ts +84 -0
- package/src/models/CatalogPromptSuggestionsResponse.ts +119 -0
- package/src/models/CitationMatchMode.ts +54 -0
- package/src/models/CitationRecord.ts +129 -0
- package/src/models/CitationsResponse.ts +119 -0
- package/src/models/CollectionCreateResponse.ts +110 -0
- package/src/models/CollectionCreateResponseCollection.ts +84 -0
- package/src/models/CollectionsResponse.ts +92 -0
- package/src/models/Competitor.ts +140 -0
- package/src/models/CompetitorCreateResponse.ts +110 -0
- package/src/models/CompetitorCreateResponseCompetitor.ts +130 -0
- package/src/models/CompetitorDetails.ts +203 -0
- package/src/models/CompetitorMentionRecord.ts +111 -0
- package/src/models/CompetitorMentionsResponse.ts +119 -0
- package/src/models/CreateAnnotationRequest.ts +107 -0
- package/src/models/CreateCollectionRequest.ts +91 -0
- package/src/models/CreateCompetitorRequest.ts +120 -0
- package/src/models/CreateProjectDraftRequest.ts +108 -0
- package/src/models/CreateTeamInvitation201Response.ts +200 -0
- package/src/models/CreateTeamInvitationRequest.ts +135 -0
- package/src/models/CreateTechnicalGeoReportsRequest.ts +91 -0
- package/src/models/CreateWebhook201Response.ts +156 -0
- package/src/models/CreateWebhookRequest.ts +103 -0
- package/src/models/DeleteWebhook200Response.ts +81 -0
- package/src/models/FinalizeProjectDraftRequest.ts +73 -0
- package/src/models/GeoAlert.ts +137 -0
- package/src/models/GeoAlertEventsInner.ts +112 -0
- package/src/models/GeoAlertList.ts +113 -0
- package/src/models/GeoAudit.ts +244 -0
- package/src/models/GeoAuditArchived.ts +89 -0
- package/src/models/GeoAuditComparison.ts +144 -0
- package/src/models/GeoAuditComparisonChangesInner.ts +136 -0
- package/src/models/GeoAuditCreateRequest.ts +118 -0
- package/src/models/GeoAuditCreateResponse.ts +89 -0
- package/src/models/GeoAuditFinding.ts +140 -0
- package/src/models/GeoAuditFindingList.ts +113 -0
- package/src/models/GeoAuditIssue.ts +185 -0
- package/src/models/GeoAuditIssueList.ts +113 -0
- package/src/models/GeoAuditIssueResponse.ts +201 -0
- package/src/models/GeoAuditIssueUpdateRequest.ts +74 -0
- package/src/models/GeoAuditList.ts +113 -0
- package/src/models/GeoAuditResponse.ts +260 -0
- package/src/models/GeoAuditRun.ts +203 -0
- package/src/models/GeoAuditRunDetail.ts +235 -0
- package/src/models/GeoAuditRunList.ts +113 -0
- package/src/models/GeoAuditRunResponse.ts +219 -0
- package/src/models/GeoAuditSchedule.ts +81 -0
- package/src/models/GeoAuditUpdateRequest.ts +127 -0
- package/src/models/GetAccount200Response.ts +162 -0
- package/src/models/GetAccount200ResponseLimits.ts +128 -0
- package/src/models/GetAccount200ResponseRateLimits.ts +73 -0
- package/src/models/GetAccount200ResponseSubscription.ts +81 -0
- package/src/models/IntelligenceTask.ts +233 -0
- package/src/models/IntelligenceTaskCreateRequest.ts +162 -0
- package/src/models/IntelligenceTaskProduct.ts +130 -0
- package/src/models/IntelligenceTaskProductImagesInner.ts +74 -0
- package/src/models/IntelligenceTaskSummary.ts +165 -0
- package/src/models/IntelligenceTaskUpdateRequest.ts +83 -0
- package/src/models/IntelligenceTaskUpdateResponse.ts +241 -0
- package/src/models/IntelligenceTasksResponse.ts +119 -0
- package/src/models/LaunchRecommendationsRequest.ts +87 -0
- package/src/models/ListCompetitors200Response.ts +89 -0
- package/src/models/ListProjects200Response.ts +81 -0
- package/src/models/ListTeamInvitations200Response.ts +105 -0
- package/src/models/ListTeamMembers200Response.ts +105 -0
- package/src/models/ListWebhooks200Response.ts +105 -0
- package/src/models/ListWebhooks200ResponseDataInner.ts +140 -0
- package/src/models/LlmsTxtTechnicalGeoReport.ts +209 -0
- package/src/models/LlmsTxtTechnicalGeoReportResultData.ts +145 -0
- package/src/models/LocalBusiness.ts +169 -0
- package/src/models/LocalBusinessesResponse.ts +128 -0
- package/src/models/LocalBusinessesTotals.ts +97 -0
- package/src/models/LocalesResponse.ts +93 -0
- package/src/models/MentionRecord.ts +102 -0
- package/src/models/MentionsResponse.ts +119 -0
- package/src/models/MetricsFiltersEcho.ts +169 -0
- package/src/models/ModelsResponse.ts +106 -0
- package/src/models/PaginatedEnvelope.ts +102 -0
- package/src/models/Ping200Response.ts +97 -0
- package/src/models/Project.ts +81 -0
- package/src/models/ProjectCreateRequest.ts +259 -0
- package/src/models/ProjectCreateRequestCollectionsInner.ts +74 -0
- package/src/models/ProjectCreateRequestCompetitorsInner.ts +82 -0
- package/src/models/ProjectCreateRequestOwnedMedia.ts +105 -0
- package/src/models/ProjectCreateResponse.ts +180 -0
- package/src/models/ProjectCreateResponseCollectionsInner.ts +81 -0
- package/src/models/ProjectCreateResponseCompetitors.ts +73 -0
- package/src/models/ProjectCreateResponseEmailSubscription.ts +65 -0
- package/src/models/ProjectCreateResponseLimits.ts +81 -0
- package/src/models/ProjectCreateResponsePrompts.ts +92 -0
- package/src/models/ProjectCreateResponseSameDomainProjectsInner.ts +89 -0
- package/src/models/ProjectDetails.ts +271 -0
- package/src/models/ProjectDetailsAllOfDataCoverage.ts +103 -0
- package/src/models/ProjectDetailsAllOfSearchConsole.ts +85 -0
- package/src/models/ProjectDetailsAllOfStats.ts +97 -0
- package/src/models/ProjectDetailsAllOfStatsPromptsByBrandKind.ts +81 -0
- package/src/models/ProjectProfile.ts +165 -0
- package/src/models/ProjectUpdateResponse.ts +110 -0
- package/src/models/PromptExecutionRecord.ts +187 -0
- package/src/models/PromptExecutionsResponse.ts +119 -0
- package/src/models/PromptRecord.ts +164 -0
- package/src/models/PromptSummaryResponse.ts +168 -0
- package/src/models/PromptSummaryRow.ts +257 -0
- package/src/models/PromptTagsAssignResponse.ts +137 -0
- package/src/models/PromptsCreateRequest.ts +93 -0
- package/src/models/PromptsCreateResponse.ts +121 -0
- package/src/models/PromptsCreateResponseDataInner.ts +92 -0
- package/src/models/PromptsResponse.ts +119 -0
- package/src/models/QueryWebAnalyticsRequest.ts +75 -0
- package/src/models/RecommendationSummary.ts +197 -0
- package/src/models/RecommendationSummarySummary.ts +81 -0
- package/src/models/RecommendationsResponse.ts +119 -0
- package/src/models/RemoveTeamMember200Response.ts +81 -0
- package/src/models/RevokeTeamInvitation200Response.ts +81 -0
- package/src/models/SampleWebhookPayloads200Response.ts +89 -0
- package/src/models/SampleWebhookPayloads200ResponseDataInner.ts +97 -0
- package/src/models/SearchConsoleFiltersInner.ts +110 -0
- package/src/models/SearchConsoleListResponse.ts +176 -0
- package/src/models/SearchConsoleListResponseDataInner.ts +97 -0
- package/src/models/SearchConsoleMetrics.ts +89 -0
- package/src/models/SearchConsoleProperty.ts +73 -0
- package/src/models/SearchConsoleRowsResponse.ts +184 -0
- package/src/models/SearchConsoleRowsResponseDataInner.ts +137 -0
- package/src/models/SearchConsoleSummaryResponse.ts +159 -0
- package/src/models/SearchConsoleSummaryResponseBreakdownInner.ts +97 -0
- package/src/models/SearchConsoleTimeseriesResponse.ts +136 -0
- package/src/models/SearchConsoleTimeseriesResponseDataInner.ts +97 -0
- package/src/models/SentimentRecord.ts +208 -0
- package/src/models/SentimentsResponse.ts +119 -0
- package/src/models/SovResponse.ts +203 -0
- package/src/models/SovResponseBreakdownInner.ts +97 -0
- package/src/models/SovResponseCurrentInner.ts +97 -0
- package/src/models/SovResponseOthersInner.ts +89 -0
- package/src/models/SovResponseOverTimeInner.ts +88 -0
- package/src/models/SovResponsePeriodsInner.ts +97 -0
- package/src/models/SovResponseSample.ts +97 -0
- package/src/models/StoreConnectionResponse.ts +142 -0
- package/src/models/StoreConnectionResponseAccount.ts +65 -0
- package/src/models/StoreConnectionResponseCandidatesInner.ts +84 -0
- package/src/models/StoreConnectionResponseProject.ts +100 -0
- package/src/models/SummaryResponse.ts +158 -0
- package/src/models/SummaryResponseAllOfPositionDistribution.ts +97 -0
- package/src/models/SummaryResponseAllOfSummaryValueInner.ts +132 -0
- package/src/models/TagRef.ts +75 -0
- package/src/models/TeamAccountRole.ts +75 -0
- package/src/models/TeamInvitation.ts +183 -0
- package/src/models/TeamMember.ts +216 -0
- package/src/models/TechnicalGeoReportContentRevertRequest.ts +87 -0
- package/src/models/TechnicalGeoReportContentUpdateRequest.ts +113 -0
- package/src/models/TechnicalGeoReportContentUpdateRequestEdits.ts +73 -0
- package/src/models/TechnicalGeoReportContentUpdateResponse.ts +228 -0
- package/src/models/TimeseriesPoint.ts +73 -0
- package/src/models/TimeseriesResponse.ts +128 -0
- package/src/models/TimeseriesSeries.ts +96 -0
- package/src/models/TopSourcesResponse.ts +152 -0
- package/src/models/TopSourcesResponseDataInner.ts +89 -0
- package/src/models/UpdateAnnotationRequest.ts +106 -0
- package/src/models/UpdateCollectionRequest.ts +82 -0
- package/src/models/UpdateCompetitorRequest.ts +126 -0
- package/src/models/UpdateProjectDraftRequest.ts +199 -0
- package/src/models/UpdateProjectRequest.ts +153 -0
- package/src/models/WebAnalyticsQueryResponse.ts +200 -0
- package/src/models/WebAnalyticsQueryResponseColumnsInner.ts +89 -0
- package/src/models/WebAnalyticsSchemaResponse.ts +160 -0
- package/src/models/index.ts +195 -0
- package/src/runtime.ts +454 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,611 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LLM Pulse API
|
|
3
|
+
* REST API client for LLM Pulse AI visibility analytics.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.60.0
|
|
6
|
+
* Contact: info@llmpulse.ai
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import { type SearchConsoleListResponse } from '../models/SearchConsoleListResponse';
|
|
14
|
+
import { type SearchConsoleRowsResponse } from '../models/SearchConsoleRowsResponse';
|
|
15
|
+
import { type SearchConsoleSummaryResponse } from '../models/SearchConsoleSummaryResponse';
|
|
16
|
+
import { type SearchConsoleTimeseriesResponse } from '../models/SearchConsoleTimeseriesResponse';
|
|
17
|
+
export interface GetSearchConsolePagesRequest {
|
|
18
|
+
projectId: number;
|
|
19
|
+
range?: number;
|
|
20
|
+
from?: Date;
|
|
21
|
+
to?: Date;
|
|
22
|
+
sort?: GetSearchConsolePagesSortEnum;
|
|
23
|
+
page?: number;
|
|
24
|
+
perPage?: number;
|
|
25
|
+
startRow?: number;
|
|
26
|
+
output?: GetSearchConsolePagesOutputEnum;
|
|
27
|
+
searchType?: GetSearchConsolePagesSearchTypeEnum;
|
|
28
|
+
filters?: string;
|
|
29
|
+
dataState?: GetSearchConsolePagesDataStateEnum;
|
|
30
|
+
aggregationType?: GetSearchConsolePagesAggregationTypeEnum;
|
|
31
|
+
}
|
|
32
|
+
export interface GetSearchConsoleQueriesRequest {
|
|
33
|
+
projectId: number;
|
|
34
|
+
range?: number;
|
|
35
|
+
from?: Date;
|
|
36
|
+
to?: Date;
|
|
37
|
+
sort?: GetSearchConsoleQueriesSortEnum;
|
|
38
|
+
page?: number;
|
|
39
|
+
perPage?: number;
|
|
40
|
+
startRow?: number;
|
|
41
|
+
output?: GetSearchConsoleQueriesOutputEnum;
|
|
42
|
+
searchType?: GetSearchConsoleQueriesSearchTypeEnum;
|
|
43
|
+
filters?: string;
|
|
44
|
+
dataState?: GetSearchConsoleQueriesDataStateEnum;
|
|
45
|
+
aggregationType?: GetSearchConsoleQueriesAggregationTypeEnum;
|
|
46
|
+
}
|
|
47
|
+
export interface GetSearchConsoleRowsRequest {
|
|
48
|
+
projectId: number;
|
|
49
|
+
dimensions: string;
|
|
50
|
+
range?: number;
|
|
51
|
+
from?: Date;
|
|
52
|
+
to?: Date;
|
|
53
|
+
sort?: GetSearchConsoleRowsSortEnum;
|
|
54
|
+
page?: number;
|
|
55
|
+
perPage?: number;
|
|
56
|
+
startRow?: number;
|
|
57
|
+
output?: GetSearchConsoleRowsOutputEnum;
|
|
58
|
+
searchType?: GetSearchConsoleRowsSearchTypeEnum;
|
|
59
|
+
filters?: string;
|
|
60
|
+
dataState?: GetSearchConsoleRowsDataStateEnum;
|
|
61
|
+
aggregationType?: GetSearchConsoleRowsAggregationTypeEnum;
|
|
62
|
+
}
|
|
63
|
+
export interface GetSearchConsoleSummaryRequest {
|
|
64
|
+
projectId: number;
|
|
65
|
+
range?: number;
|
|
66
|
+
from?: Date;
|
|
67
|
+
to?: Date;
|
|
68
|
+
dimension?: GetSearchConsoleSummaryDimensionEnum;
|
|
69
|
+
limit?: number;
|
|
70
|
+
searchType?: GetSearchConsoleSummarySearchTypeEnum;
|
|
71
|
+
filters?: string;
|
|
72
|
+
dataState?: GetSearchConsoleSummaryDataStateEnum;
|
|
73
|
+
aggregationType?: GetSearchConsoleSummaryAggregationTypeEnum;
|
|
74
|
+
}
|
|
75
|
+
export interface GetSearchConsoleTimeseriesRequest {
|
|
76
|
+
projectId: number;
|
|
77
|
+
range?: number;
|
|
78
|
+
from?: Date;
|
|
79
|
+
to?: Date;
|
|
80
|
+
granularity?: GetSearchConsoleTimeseriesGranularityEnum;
|
|
81
|
+
output?: GetSearchConsoleTimeseriesOutputEnum;
|
|
82
|
+
searchType?: GetSearchConsoleTimeseriesSearchTypeEnum;
|
|
83
|
+
filters?: string;
|
|
84
|
+
dataState?: GetSearchConsoleTimeseriesDataStateEnum;
|
|
85
|
+
aggregationType?: GetSearchConsoleTimeseriesAggregationTypeEnum;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* SearchConsoleApi - interface
|
|
89
|
+
*
|
|
90
|
+
* @export
|
|
91
|
+
* @interface SearchConsoleApiInterface
|
|
92
|
+
*/
|
|
93
|
+
export interface SearchConsoleApiInterface {
|
|
94
|
+
/**
|
|
95
|
+
* Creates request options for getSearchConsolePages without sending the request
|
|
96
|
+
* @param {number} projectId Project ID
|
|
97
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
98
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
99
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
100
|
+
* @param {'impressions' | 'clicks' | 'ctr' | 'position'} [sort]
|
|
101
|
+
* @param {number} [page]
|
|
102
|
+
* @param {number} [perPage]
|
|
103
|
+
* @param {number} [startRow] Google ranks rows by clicks and returns at most 25,000 per request. start_row moves that window down the ranking (e.g. 25000 for the next block); sort and pagination apply within the window.
|
|
104
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
105
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
106
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
107
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
108
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
109
|
+
* @throws {RequiredError}
|
|
110
|
+
* @memberof SearchConsoleApiInterface
|
|
111
|
+
*/
|
|
112
|
+
getSearchConsolePagesRequestOpts(requestParameters: GetSearchConsolePagesRequest): Promise<runtime.RequestOpts>;
|
|
113
|
+
/**
|
|
114
|
+
* Top Google Search Console landing pages over a date range, ranked by impressions, clicks, ctr or position, paginated. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. total counts the rows returned by one Google request, up to 25,000; truncated: true means that limit was reached, and start_row reads the next block. Page rows are counted per page rather than per property, so they can differ from the totals. Sorting and pagination apply to the available set. Stored reads cannot answer this endpoint and return ERR_INVALID_PARAM.
|
|
115
|
+
* @summary Top Search Console pages (Growth+)
|
|
116
|
+
* @param {number} projectId Project ID
|
|
117
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
118
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
119
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
120
|
+
* @param {'impressions' | 'clicks' | 'ctr' | 'position'} [sort]
|
|
121
|
+
* @param {number} [page]
|
|
122
|
+
* @param {number} [perPage]
|
|
123
|
+
* @param {number} [startRow] Google ranks rows by clicks and returns at most 25,000 per request. start_row moves that window down the ranking (e.g. 25000 for the next block); sort and pagination apply within the window.
|
|
124
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
125
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
126
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
127
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
128
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
* @memberof SearchConsoleApiInterface
|
|
132
|
+
*/
|
|
133
|
+
getSearchConsolePagesRaw(requestParameters: GetSearchConsolePagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleListResponse>>;
|
|
134
|
+
/**
|
|
135
|
+
* Top Google Search Console landing pages over a date range, ranked by impressions, clicks, ctr or position, paginated. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. total counts the rows returned by one Google request, up to 25,000; truncated: true means that limit was reached, and start_row reads the next block. Page rows are counted per page rather than per property, so they can differ from the totals. Sorting and pagination apply to the available set. Stored reads cannot answer this endpoint and return ERR_INVALID_PARAM.
|
|
136
|
+
* Top Search Console pages (Growth+)
|
|
137
|
+
*/
|
|
138
|
+
getSearchConsolePages(requestParameters: GetSearchConsolePagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleListResponse>;
|
|
139
|
+
/**
|
|
140
|
+
* Creates request options for getSearchConsoleQueries without sending the request
|
|
141
|
+
* @param {number} projectId Project ID
|
|
142
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
143
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
144
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
145
|
+
* @param {'impressions' | 'clicks' | 'ctr' | 'position'} [sort]
|
|
146
|
+
* @param {number} [page]
|
|
147
|
+
* @param {number} [perPage]
|
|
148
|
+
* @param {number} [startRow] Google ranks rows by clicks and returns at most 25,000 per request. start_row moves that window down the ranking (e.g. 25000 for the next block); sort and pagination apply within the window.
|
|
149
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
150
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
151
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
152
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
153
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
* @memberof SearchConsoleApiInterface
|
|
156
|
+
*/
|
|
157
|
+
getSearchConsoleQueriesRequestOpts(requestParameters: GetSearchConsoleQueriesRequest): Promise<runtime.RequestOpts>;
|
|
158
|
+
/**
|
|
159
|
+
* Top Google Search Console search queries over a date range, ranked by impressions, clicks, ctr or position, paginated. Excludes anonymized queries; for headline totals use /search_console/summary. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. total counts the rows returned by one Google request, up to 25,000; truncated: true means that limit was reached, so the rows add up to less than the totals, and start_row reads the next block. Sorting and pagination apply to the available set. Stored reads cannot answer this endpoint and return ERR_INVALID_PARAM.
|
|
160
|
+
* @summary Top Search Console queries (Growth+)
|
|
161
|
+
* @param {number} projectId Project ID
|
|
162
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
163
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
164
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
165
|
+
* @param {'impressions' | 'clicks' | 'ctr' | 'position'} [sort]
|
|
166
|
+
* @param {number} [page]
|
|
167
|
+
* @param {number} [perPage]
|
|
168
|
+
* @param {number} [startRow] Google ranks rows by clicks and returns at most 25,000 per request. start_row moves that window down the ranking (e.g. 25000 for the next block); sort and pagination apply within the window.
|
|
169
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
170
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
171
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
172
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
173
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
174
|
+
* @param {*} [options] Override http request option.
|
|
175
|
+
* @throws {RequiredError}
|
|
176
|
+
* @memberof SearchConsoleApiInterface
|
|
177
|
+
*/
|
|
178
|
+
getSearchConsoleQueriesRaw(requestParameters: GetSearchConsoleQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleListResponse>>;
|
|
179
|
+
/**
|
|
180
|
+
* Top Google Search Console search queries over a date range, ranked by impressions, clicks, ctr or position, paginated. Excludes anonymized queries; for headline totals use /search_console/summary. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. total counts the rows returned by one Google request, up to 25,000; truncated: true means that limit was reached, so the rows add up to less than the totals, and start_row reads the next block. Sorting and pagination apply to the available set. Stored reads cannot answer this endpoint and return ERR_INVALID_PARAM.
|
|
181
|
+
* Top Search Console queries (Growth+)
|
|
182
|
+
*/
|
|
183
|
+
getSearchConsoleQueries(requestParameters: GetSearchConsoleQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleListResponse>;
|
|
184
|
+
/**
|
|
185
|
+
* Creates request options for getSearchConsoleRows without sending the request
|
|
186
|
+
* @param {number} projectId Project ID
|
|
187
|
+
* @param {string} dimensions Comma-separated dimensions to group by, 1 to 3 of date, country, device, page, query, searchAppearance. Each becomes a field of every row; country and device values are lowercase.
|
|
188
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
189
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
190
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
191
|
+
* @param {'impressions' | 'clicks' | 'ctr' | 'position'} [sort]
|
|
192
|
+
* @param {number} [page]
|
|
193
|
+
* @param {number} [perPage]
|
|
194
|
+
* @param {number} [startRow] Google ranks rows by clicks and returns at most 25,000 per request. start_row moves that window down the ranking (e.g. 25000 for the next block); sort and pagination apply within the window.
|
|
195
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
196
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
197
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
198
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
199
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
200
|
+
* @throws {RequiredError}
|
|
201
|
+
* @memberof SearchConsoleApiInterface
|
|
202
|
+
*/
|
|
203
|
+
getSearchConsoleRowsRequestOpts(requestParameters: GetSearchConsoleRowsRequest): Promise<runtime.RequestOpts>;
|
|
204
|
+
/**
|
|
205
|
+
* Google Search Console rows grouped by 1 to 3 dimensions (date, country, device, page, query, searchAppearance) over a date range, each row carrying its dimension values as fields plus impressions, clicks, ctr (0..1) and position, ranked by impressions, clicks, ctr or position, paginated. Google ranks rows by clicks and returns at most 25,000 per request (truncated: true when reached); start_row moves that window. Query rows exclude anonymized queries, so rows add up to less than the summary totals. Requires a connected Search Console property (Growth+) and live reads: stored reads return ERR_INVALID_PARAM. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access and ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. A combination Google refuses comes back as ERR_INVALID_PARAM with its reason.
|
|
206
|
+
* @summary Search Console rows by several dimensions (Growth+)
|
|
207
|
+
* @param {number} projectId Project ID
|
|
208
|
+
* @param {string} dimensions Comma-separated dimensions to group by, 1 to 3 of date, country, device, page, query, searchAppearance. Each becomes a field of every row; country and device values are lowercase.
|
|
209
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
210
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
211
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
212
|
+
* @param {'impressions' | 'clicks' | 'ctr' | 'position'} [sort]
|
|
213
|
+
* @param {number} [page]
|
|
214
|
+
* @param {number} [perPage]
|
|
215
|
+
* @param {number} [startRow] Google ranks rows by clicks and returns at most 25,000 per request. start_row moves that window down the ranking (e.g. 25000 for the next block); sort and pagination apply within the window.
|
|
216
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
217
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
218
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
219
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
220
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
221
|
+
* @param {*} [options] Override http request option.
|
|
222
|
+
* @throws {RequiredError}
|
|
223
|
+
* @memberof SearchConsoleApiInterface
|
|
224
|
+
*/
|
|
225
|
+
getSearchConsoleRowsRaw(requestParameters: GetSearchConsoleRowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleRowsResponse>>;
|
|
226
|
+
/**
|
|
227
|
+
* Google Search Console rows grouped by 1 to 3 dimensions (date, country, device, page, query, searchAppearance) over a date range, each row carrying its dimension values as fields plus impressions, clicks, ctr (0..1) and position, ranked by impressions, clicks, ctr or position, paginated. Google ranks rows by clicks and returns at most 25,000 per request (truncated: true when reached); start_row moves that window. Query rows exclude anonymized queries, so rows add up to less than the summary totals. Requires a connected Search Console property (Growth+) and live reads: stored reads return ERR_INVALID_PARAM. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access and ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. A combination Google refuses comes back as ERR_INVALID_PARAM with its reason.
|
|
228
|
+
* Search Console rows by several dimensions (Growth+)
|
|
229
|
+
*/
|
|
230
|
+
getSearchConsoleRows(requestParameters: GetSearchConsoleRowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleRowsResponse>;
|
|
231
|
+
/**
|
|
232
|
+
* Creates request options for getSearchConsoleSummary without sending the request
|
|
233
|
+
* @param {number} projectId Project ID
|
|
234
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
235
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
236
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
237
|
+
* @param {'country' | 'device' | 'page' | 'query' | 'searchAppearance'} [dimension] Optional breakdown aggregated over the range. country and device are lowercased; page and query keep the casing Google returns, because a page URL is case sensitive.
|
|
238
|
+
* @param {number} [limit] Maximum breakdown rows, sorted by impressions descending. Default and maximum 1000. Use /search_console/queries or /search_console/pages to page through up to 25,000 rows.
|
|
239
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
240
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
241
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
242
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
243
|
+
* @throws {RequiredError}
|
|
244
|
+
* @memberof SearchConsoleApiInterface
|
|
245
|
+
*/
|
|
246
|
+
getSearchConsoleSummaryRequestOpts(requestParameters: GetSearchConsoleSummaryRequest): Promise<runtime.RequestOpts>;
|
|
247
|
+
/**
|
|
248
|
+
* Google Search Console headline totals (impressions, clicks, ctr as a 0..1 fraction, average position) for the project over a date range. Pass dimension=country, device, page, query or searchAppearance to also receive the breakdown aggregated over the range, capped by limit. With filters and no dimension, totals are the complete figure Google reports for that filter. Breakdown rows are capped by limit and by Google\'s 25,000-row maximum; breakdown_truncated: true means rows were left out. Query rows exclude anonymized queries, and page and searchAppearance rows are counted per page rather than per property, so breakdown rows can differ from the totals. Requires the project to have a connected Search Console property and the Growth plan or above; otherwise returns ERR_SEARCH_CONSOLE_NOT_CONNECTED or ERR_PLAN_REQUIRED. X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying.
|
|
249
|
+
* @summary Search Console summary (Growth+)
|
|
250
|
+
* @param {number} projectId Project ID
|
|
251
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
252
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
253
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
254
|
+
* @param {'country' | 'device' | 'page' | 'query' | 'searchAppearance'} [dimension] Optional breakdown aggregated over the range. country and device are lowercased; page and query keep the casing Google returns, because a page URL is case sensitive.
|
|
255
|
+
* @param {number} [limit] Maximum breakdown rows, sorted by impressions descending. Default and maximum 1000. Use /search_console/queries or /search_console/pages to page through up to 25,000 rows.
|
|
256
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
257
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
258
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
259
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
260
|
+
* @param {*} [options] Override http request option.
|
|
261
|
+
* @throws {RequiredError}
|
|
262
|
+
* @memberof SearchConsoleApiInterface
|
|
263
|
+
*/
|
|
264
|
+
getSearchConsoleSummaryRaw(requestParameters: GetSearchConsoleSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleSummaryResponse>>;
|
|
265
|
+
/**
|
|
266
|
+
* Google Search Console headline totals (impressions, clicks, ctr as a 0..1 fraction, average position) for the project over a date range. Pass dimension=country, device, page, query or searchAppearance to also receive the breakdown aggregated over the range, capped by limit. With filters and no dimension, totals are the complete figure Google reports for that filter. Breakdown rows are capped by limit and by Google\'s 25,000-row maximum; breakdown_truncated: true means rows were left out. Query rows exclude anonymized queries, and page and searchAppearance rows are counted per page rather than per property, so breakdown rows can differ from the totals. Requires the project to have a connected Search Console property and the Growth plan or above; otherwise returns ERR_SEARCH_CONSOLE_NOT_CONNECTED or ERR_PLAN_REQUIRED. X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying.
|
|
267
|
+
* Search Console summary (Growth+)
|
|
268
|
+
*/
|
|
269
|
+
getSearchConsoleSummary(requestParameters: GetSearchConsoleSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleSummaryResponse>;
|
|
270
|
+
/**
|
|
271
|
+
* Creates request options for getSearchConsoleTimeseries without sending the request
|
|
272
|
+
* @param {number} projectId Project ID
|
|
273
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
274
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
275
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
276
|
+
* @param {'day' | 'week' | 'month'} [granularity]
|
|
277
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
278
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
279
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
280
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
281
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
* @memberof SearchConsoleApiInterface
|
|
284
|
+
*/
|
|
285
|
+
getSearchConsoleTimeseriesRequestOpts(requestParameters: GetSearchConsoleTimeseriesRequest): Promise<runtime.RequestOpts>;
|
|
286
|
+
/**
|
|
287
|
+
* Google Search Console series (impressions, clicks, ctr, position) bucketed by day, week or month, property-wide unless filters narrows it. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying.
|
|
288
|
+
* @summary Search Console time series (Growth+)
|
|
289
|
+
* @param {number} projectId Project ID
|
|
290
|
+
* @param {number} [range] Number of days to look back, today included (alternative to from/to). At most 487, Google\'s retention.
|
|
291
|
+
* @param {Date} [from] Start date (YYYY-MM-DD). Defaults to 30 days ago.
|
|
292
|
+
* @param {Date} [to] End date (YYYY-MM-DD), inclusive. Defaults to today. Google publishes data with a 2-3 day lag, so data_through in the response says how far it reaches.
|
|
293
|
+
* @param {'day' | 'week' | 'month'} [granularity]
|
|
294
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
295
|
+
* @param {'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'} [searchType] Which search surface to measure. Defaults to web. discover and googleNews carry no query dimension, so Google rejects /search_console/queries for them.
|
|
296
|
+
* @param {string} [filters] Narrow the query; every entry must match (AND). Send the whole list as one JSON value: filters=[{\"dimension\":\"page\",\"operator\":\"contains\",\"expression\":\"/blog/\"}] (URL-encoded). An array of objects has no query-parameter form a generated client can produce, so the string is what the official SDKs send; see the SearchConsoleFilters schema for the shape it encodes. includingRegex and excludingRegex take RE2 syntax. At most 10 entries, expression at most 500 characters. The bracket form filters[][dimension]=page&filters[][operator]=contains&filters[][expression]=/blog/ is also accepted.
|
|
297
|
+
* @param {'final' | 'all'} [dataState] final (default) counts only rows Google has finalized. all also counts the most recent days, which are still being filled in and will change.
|
|
298
|
+
* @param {'auto' | 'byPage' | 'byProperty'} [aggregationType] How Google counts impressions. auto (default) is what Search Console shows (by page when page is grouped or filtered, else by property). Google rejects byProperty with a page dimension or filter.
|
|
299
|
+
* @param {*} [options] Override http request option.
|
|
300
|
+
* @throws {RequiredError}
|
|
301
|
+
* @memberof SearchConsoleApiInterface
|
|
302
|
+
*/
|
|
303
|
+
getSearchConsoleTimeseriesRaw(requestParameters: GetSearchConsoleTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleTimeseriesResponse>>;
|
|
304
|
+
/**
|
|
305
|
+
* Google Search Console series (impressions, clicks, ctr, position) bucketed by day, week or month, property-wide unless filters narrows it. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying.
|
|
306
|
+
* Search Console time series (Growth+)
|
|
307
|
+
*/
|
|
308
|
+
getSearchConsoleTimeseries(requestParameters: GetSearchConsoleTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleTimeseriesResponse>;
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
*/
|
|
313
|
+
export declare class SearchConsoleApi extends runtime.BaseAPI implements SearchConsoleApiInterface {
|
|
314
|
+
/**
|
|
315
|
+
* Creates request options for getSearchConsolePages without sending the request
|
|
316
|
+
*/
|
|
317
|
+
getSearchConsolePagesRequestOpts(requestParameters: GetSearchConsolePagesRequest): Promise<runtime.RequestOpts>;
|
|
318
|
+
/**
|
|
319
|
+
* Top Google Search Console landing pages over a date range, ranked by impressions, clicks, ctr or position, paginated. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. total counts the rows returned by one Google request, up to 25,000; truncated: true means that limit was reached, and start_row reads the next block. Page rows are counted per page rather than per property, so they can differ from the totals. Sorting and pagination apply to the available set. Stored reads cannot answer this endpoint and return ERR_INVALID_PARAM.
|
|
320
|
+
* Top Search Console pages (Growth+)
|
|
321
|
+
*/
|
|
322
|
+
getSearchConsolePagesRaw(requestParameters: GetSearchConsolePagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleListResponse>>;
|
|
323
|
+
/**
|
|
324
|
+
* Top Google Search Console landing pages over a date range, ranked by impressions, clicks, ctr or position, paginated. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. total counts the rows returned by one Google request, up to 25,000; truncated: true means that limit was reached, and start_row reads the next block. Page rows are counted per page rather than per property, so they can differ from the totals. Sorting and pagination apply to the available set. Stored reads cannot answer this endpoint and return ERR_INVALID_PARAM.
|
|
325
|
+
* Top Search Console pages (Growth+)
|
|
326
|
+
*/
|
|
327
|
+
getSearchConsolePages(requestParameters: GetSearchConsolePagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleListResponse>;
|
|
328
|
+
/**
|
|
329
|
+
* Creates request options for getSearchConsoleQueries without sending the request
|
|
330
|
+
*/
|
|
331
|
+
getSearchConsoleQueriesRequestOpts(requestParameters: GetSearchConsoleQueriesRequest): Promise<runtime.RequestOpts>;
|
|
332
|
+
/**
|
|
333
|
+
* Top Google Search Console search queries over a date range, ranked by impressions, clicks, ctr or position, paginated. Excludes anonymized queries; for headline totals use /search_console/summary. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. total counts the rows returned by one Google request, up to 25,000; truncated: true means that limit was reached, so the rows add up to less than the totals, and start_row reads the next block. Sorting and pagination apply to the available set. Stored reads cannot answer this endpoint and return ERR_INVALID_PARAM.
|
|
334
|
+
* Top Search Console queries (Growth+)
|
|
335
|
+
*/
|
|
336
|
+
getSearchConsoleQueriesRaw(requestParameters: GetSearchConsoleQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleListResponse>>;
|
|
337
|
+
/**
|
|
338
|
+
* Top Google Search Console search queries over a date range, ranked by impressions, clicks, ctr or position, paginated. Excludes anonymized queries; for headline totals use /search_console/summary. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. total counts the rows returned by one Google request, up to 25,000; truncated: true means that limit was reached, so the rows add up to less than the totals, and start_row reads the next block. Sorting and pagination apply to the available set. Stored reads cannot answer this endpoint and return ERR_INVALID_PARAM.
|
|
339
|
+
* Top Search Console queries (Growth+)
|
|
340
|
+
*/
|
|
341
|
+
getSearchConsoleQueries(requestParameters: GetSearchConsoleQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleListResponse>;
|
|
342
|
+
/**
|
|
343
|
+
* Creates request options for getSearchConsoleRows without sending the request
|
|
344
|
+
*/
|
|
345
|
+
getSearchConsoleRowsRequestOpts(requestParameters: GetSearchConsoleRowsRequest): Promise<runtime.RequestOpts>;
|
|
346
|
+
/**
|
|
347
|
+
* Google Search Console rows grouped by 1 to 3 dimensions (date, country, device, page, query, searchAppearance) over a date range, each row carrying its dimension values as fields plus impressions, clicks, ctr (0..1) and position, ranked by impressions, clicks, ctr or position, paginated. Google ranks rows by clicks and returns at most 25,000 per request (truncated: true when reached); start_row moves that window. Query rows exclude anonymized queries, so rows add up to less than the summary totals. Requires a connected Search Console property (Growth+) and live reads: stored reads return ERR_INVALID_PARAM. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access and ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. A combination Google refuses comes back as ERR_INVALID_PARAM with its reason.
|
|
348
|
+
* Search Console rows by several dimensions (Growth+)
|
|
349
|
+
*/
|
|
350
|
+
getSearchConsoleRowsRaw(requestParameters: GetSearchConsoleRowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleRowsResponse>>;
|
|
351
|
+
/**
|
|
352
|
+
* Google Search Console rows grouped by 1 to 3 dimensions (date, country, device, page, query, searchAppearance) over a date range, each row carrying its dimension values as fields plus impressions, clicks, ctr (0..1) and position, ranked by impressions, clicks, ctr or position, paginated. Google ranks rows by clicks and returns at most 25,000 per request (truncated: true when reached); start_row moves that window. Query rows exclude anonymized queries, so rows add up to less than the summary totals. Requires a connected Search Console property (Growth+) and live reads: stored reads return ERR_INVALID_PARAM. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access and ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying. A combination Google refuses comes back as ERR_INVALID_PARAM with its reason.
|
|
353
|
+
* Search Console rows by several dimensions (Growth+)
|
|
354
|
+
*/
|
|
355
|
+
getSearchConsoleRows(requestParameters: GetSearchConsoleRowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleRowsResponse>;
|
|
356
|
+
/**
|
|
357
|
+
* Creates request options for getSearchConsoleSummary without sending the request
|
|
358
|
+
*/
|
|
359
|
+
getSearchConsoleSummaryRequestOpts(requestParameters: GetSearchConsoleSummaryRequest): Promise<runtime.RequestOpts>;
|
|
360
|
+
/**
|
|
361
|
+
* Google Search Console headline totals (impressions, clicks, ctr as a 0..1 fraction, average position) for the project over a date range. Pass dimension=country, device, page, query or searchAppearance to also receive the breakdown aggregated over the range, capped by limit. With filters and no dimension, totals are the complete figure Google reports for that filter. Breakdown rows are capped by limit and by Google\'s 25,000-row maximum; breakdown_truncated: true means rows were left out. Query rows exclude anonymized queries, and page and searchAppearance rows are counted per page rather than per property, so breakdown rows can differ from the totals. Requires the project to have a connected Search Console property and the Growth plan or above; otherwise returns ERR_SEARCH_CONSOLE_NOT_CONNECTED or ERR_PLAN_REQUIRED. X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying.
|
|
362
|
+
* Search Console summary (Growth+)
|
|
363
|
+
*/
|
|
364
|
+
getSearchConsoleSummaryRaw(requestParameters: GetSearchConsoleSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleSummaryResponse>>;
|
|
365
|
+
/**
|
|
366
|
+
* Google Search Console headline totals (impressions, clicks, ctr as a 0..1 fraction, average position) for the project over a date range. Pass dimension=country, device, page, query or searchAppearance to also receive the breakdown aggregated over the range, capped by limit. With filters and no dimension, totals are the complete figure Google reports for that filter. Breakdown rows are capped by limit and by Google\'s 25,000-row maximum; breakdown_truncated: true means rows were left out. Query rows exclude anonymized queries, and page and searchAppearance rows are counted per page rather than per property, so breakdown rows can differ from the totals. Requires the project to have a connected Search Console property and the Growth plan or above; otherwise returns ERR_SEARCH_CONSOLE_NOT_CONNECTED or ERR_PLAN_REQUIRED. X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying.
|
|
367
|
+
* Search Console summary (Growth+)
|
|
368
|
+
*/
|
|
369
|
+
getSearchConsoleSummary(requestParameters: GetSearchConsoleSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleSummaryResponse>;
|
|
370
|
+
/**
|
|
371
|
+
* Creates request options for getSearchConsoleTimeseries without sending the request
|
|
372
|
+
*/
|
|
373
|
+
getSearchConsoleTimeseriesRequestOpts(requestParameters: GetSearchConsoleTimeseriesRequest): Promise<runtime.RequestOpts>;
|
|
374
|
+
/**
|
|
375
|
+
* Google Search Console series (impressions, clicks, ctr, position) bucketed by day, week or month, property-wide unless filters narrows it. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying.
|
|
376
|
+
* Search Console time series (Growth+)
|
|
377
|
+
*/
|
|
378
|
+
getSearchConsoleTimeseriesRaw(requestParameters: GetSearchConsoleTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchConsoleTimeseriesResponse>>;
|
|
379
|
+
/**
|
|
380
|
+
* Google Search Console series (impressions, clicks, ctr, position) bucketed by day, week or month, property-wide unless filters narrows it. Requires a connected Search Console property (Growth+). X-Search-Console-Backend identifies stored or live reads. Stored reads use synced data without contacting Google. Live reads return ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) for revoked Google access; reconnect the property in Preferences > Project Settings > Data Connections. They return ERR_SEARCH_CONSOLE_UPSTREAM (503) when Google Search Console is unavailable or over quota; wait for the number of seconds in Retry-After before retrying.
|
|
381
|
+
* Search Console time series (Growth+)
|
|
382
|
+
*/
|
|
383
|
+
getSearchConsoleTimeseries(requestParameters: GetSearchConsoleTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchConsoleTimeseriesResponse>;
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
* @export
|
|
387
|
+
*/
|
|
388
|
+
export declare const GetSearchConsolePagesSortEnum: {
|
|
389
|
+
readonly Impressions: "impressions";
|
|
390
|
+
readonly Clicks: "clicks";
|
|
391
|
+
readonly Ctr: "ctr";
|
|
392
|
+
readonly Position: "position";
|
|
393
|
+
};
|
|
394
|
+
export type GetSearchConsolePagesSortEnum = typeof GetSearchConsolePagesSortEnum[keyof typeof GetSearchConsolePagesSortEnum];
|
|
395
|
+
/**
|
|
396
|
+
* @export
|
|
397
|
+
*/
|
|
398
|
+
export declare const GetSearchConsolePagesOutputEnum: {
|
|
399
|
+
readonly Flat: "flat";
|
|
400
|
+
readonly Csv: "csv";
|
|
401
|
+
};
|
|
402
|
+
export type GetSearchConsolePagesOutputEnum = typeof GetSearchConsolePagesOutputEnum[keyof typeof GetSearchConsolePagesOutputEnum];
|
|
403
|
+
/**
|
|
404
|
+
* @export
|
|
405
|
+
*/
|
|
406
|
+
export declare const GetSearchConsolePagesSearchTypeEnum: {
|
|
407
|
+
readonly Web: "web";
|
|
408
|
+
readonly Image: "image";
|
|
409
|
+
readonly Video: "video";
|
|
410
|
+
readonly News: "news";
|
|
411
|
+
readonly Discover: "discover";
|
|
412
|
+
readonly GoogleNews: "googleNews";
|
|
413
|
+
};
|
|
414
|
+
export type GetSearchConsolePagesSearchTypeEnum = typeof GetSearchConsolePagesSearchTypeEnum[keyof typeof GetSearchConsolePagesSearchTypeEnum];
|
|
415
|
+
/**
|
|
416
|
+
* @export
|
|
417
|
+
*/
|
|
418
|
+
export declare const GetSearchConsolePagesDataStateEnum: {
|
|
419
|
+
readonly Final: "final";
|
|
420
|
+
readonly All: "all";
|
|
421
|
+
};
|
|
422
|
+
export type GetSearchConsolePagesDataStateEnum = typeof GetSearchConsolePagesDataStateEnum[keyof typeof GetSearchConsolePagesDataStateEnum];
|
|
423
|
+
/**
|
|
424
|
+
* @export
|
|
425
|
+
*/
|
|
426
|
+
export declare const GetSearchConsolePagesAggregationTypeEnum: {
|
|
427
|
+
readonly Auto: "auto";
|
|
428
|
+
readonly ByPage: "byPage";
|
|
429
|
+
readonly ByProperty: "byProperty";
|
|
430
|
+
};
|
|
431
|
+
export type GetSearchConsolePagesAggregationTypeEnum = typeof GetSearchConsolePagesAggregationTypeEnum[keyof typeof GetSearchConsolePagesAggregationTypeEnum];
|
|
432
|
+
/**
|
|
433
|
+
* @export
|
|
434
|
+
*/
|
|
435
|
+
export declare const GetSearchConsoleQueriesSortEnum: {
|
|
436
|
+
readonly Impressions: "impressions";
|
|
437
|
+
readonly Clicks: "clicks";
|
|
438
|
+
readonly Ctr: "ctr";
|
|
439
|
+
readonly Position: "position";
|
|
440
|
+
};
|
|
441
|
+
export type GetSearchConsoleQueriesSortEnum = typeof GetSearchConsoleQueriesSortEnum[keyof typeof GetSearchConsoleQueriesSortEnum];
|
|
442
|
+
/**
|
|
443
|
+
* @export
|
|
444
|
+
*/
|
|
445
|
+
export declare const GetSearchConsoleQueriesOutputEnum: {
|
|
446
|
+
readonly Flat: "flat";
|
|
447
|
+
readonly Csv: "csv";
|
|
448
|
+
};
|
|
449
|
+
export type GetSearchConsoleQueriesOutputEnum = typeof GetSearchConsoleQueriesOutputEnum[keyof typeof GetSearchConsoleQueriesOutputEnum];
|
|
450
|
+
/**
|
|
451
|
+
* @export
|
|
452
|
+
*/
|
|
453
|
+
export declare const GetSearchConsoleQueriesSearchTypeEnum: {
|
|
454
|
+
readonly Web: "web";
|
|
455
|
+
readonly Image: "image";
|
|
456
|
+
readonly Video: "video";
|
|
457
|
+
readonly News: "news";
|
|
458
|
+
readonly Discover: "discover";
|
|
459
|
+
readonly GoogleNews: "googleNews";
|
|
460
|
+
};
|
|
461
|
+
export type GetSearchConsoleQueriesSearchTypeEnum = typeof GetSearchConsoleQueriesSearchTypeEnum[keyof typeof GetSearchConsoleQueriesSearchTypeEnum];
|
|
462
|
+
/**
|
|
463
|
+
* @export
|
|
464
|
+
*/
|
|
465
|
+
export declare const GetSearchConsoleQueriesDataStateEnum: {
|
|
466
|
+
readonly Final: "final";
|
|
467
|
+
readonly All: "all";
|
|
468
|
+
};
|
|
469
|
+
export type GetSearchConsoleQueriesDataStateEnum = typeof GetSearchConsoleQueriesDataStateEnum[keyof typeof GetSearchConsoleQueriesDataStateEnum];
|
|
470
|
+
/**
|
|
471
|
+
* @export
|
|
472
|
+
*/
|
|
473
|
+
export declare const GetSearchConsoleQueriesAggregationTypeEnum: {
|
|
474
|
+
readonly Auto: "auto";
|
|
475
|
+
readonly ByPage: "byPage";
|
|
476
|
+
readonly ByProperty: "byProperty";
|
|
477
|
+
};
|
|
478
|
+
export type GetSearchConsoleQueriesAggregationTypeEnum = typeof GetSearchConsoleQueriesAggregationTypeEnum[keyof typeof GetSearchConsoleQueriesAggregationTypeEnum];
|
|
479
|
+
/**
|
|
480
|
+
* @export
|
|
481
|
+
*/
|
|
482
|
+
export declare const GetSearchConsoleRowsSortEnum: {
|
|
483
|
+
readonly Impressions: "impressions";
|
|
484
|
+
readonly Clicks: "clicks";
|
|
485
|
+
readonly Ctr: "ctr";
|
|
486
|
+
readonly Position: "position";
|
|
487
|
+
};
|
|
488
|
+
export type GetSearchConsoleRowsSortEnum = typeof GetSearchConsoleRowsSortEnum[keyof typeof GetSearchConsoleRowsSortEnum];
|
|
489
|
+
/**
|
|
490
|
+
* @export
|
|
491
|
+
*/
|
|
492
|
+
export declare const GetSearchConsoleRowsOutputEnum: {
|
|
493
|
+
readonly Flat: "flat";
|
|
494
|
+
readonly Csv: "csv";
|
|
495
|
+
};
|
|
496
|
+
export type GetSearchConsoleRowsOutputEnum = typeof GetSearchConsoleRowsOutputEnum[keyof typeof GetSearchConsoleRowsOutputEnum];
|
|
497
|
+
/**
|
|
498
|
+
* @export
|
|
499
|
+
*/
|
|
500
|
+
export declare const GetSearchConsoleRowsSearchTypeEnum: {
|
|
501
|
+
readonly Web: "web";
|
|
502
|
+
readonly Image: "image";
|
|
503
|
+
readonly Video: "video";
|
|
504
|
+
readonly News: "news";
|
|
505
|
+
readonly Discover: "discover";
|
|
506
|
+
readonly GoogleNews: "googleNews";
|
|
507
|
+
};
|
|
508
|
+
export type GetSearchConsoleRowsSearchTypeEnum = typeof GetSearchConsoleRowsSearchTypeEnum[keyof typeof GetSearchConsoleRowsSearchTypeEnum];
|
|
509
|
+
/**
|
|
510
|
+
* @export
|
|
511
|
+
*/
|
|
512
|
+
export declare const GetSearchConsoleRowsDataStateEnum: {
|
|
513
|
+
readonly Final: "final";
|
|
514
|
+
readonly All: "all";
|
|
515
|
+
};
|
|
516
|
+
export type GetSearchConsoleRowsDataStateEnum = typeof GetSearchConsoleRowsDataStateEnum[keyof typeof GetSearchConsoleRowsDataStateEnum];
|
|
517
|
+
/**
|
|
518
|
+
* @export
|
|
519
|
+
*/
|
|
520
|
+
export declare const GetSearchConsoleRowsAggregationTypeEnum: {
|
|
521
|
+
readonly Auto: "auto";
|
|
522
|
+
readonly ByPage: "byPage";
|
|
523
|
+
readonly ByProperty: "byProperty";
|
|
524
|
+
};
|
|
525
|
+
export type GetSearchConsoleRowsAggregationTypeEnum = typeof GetSearchConsoleRowsAggregationTypeEnum[keyof typeof GetSearchConsoleRowsAggregationTypeEnum];
|
|
526
|
+
/**
|
|
527
|
+
* @export
|
|
528
|
+
*/
|
|
529
|
+
export declare const GetSearchConsoleSummaryDimensionEnum: {
|
|
530
|
+
readonly Country: "country";
|
|
531
|
+
readonly Device: "device";
|
|
532
|
+
readonly Page: "page";
|
|
533
|
+
readonly Query: "query";
|
|
534
|
+
readonly SearchAppearance: "searchAppearance";
|
|
535
|
+
};
|
|
536
|
+
export type GetSearchConsoleSummaryDimensionEnum = typeof GetSearchConsoleSummaryDimensionEnum[keyof typeof GetSearchConsoleSummaryDimensionEnum];
|
|
537
|
+
/**
|
|
538
|
+
* @export
|
|
539
|
+
*/
|
|
540
|
+
export declare const GetSearchConsoleSummarySearchTypeEnum: {
|
|
541
|
+
readonly Web: "web";
|
|
542
|
+
readonly Image: "image";
|
|
543
|
+
readonly Video: "video";
|
|
544
|
+
readonly News: "news";
|
|
545
|
+
readonly Discover: "discover";
|
|
546
|
+
readonly GoogleNews: "googleNews";
|
|
547
|
+
};
|
|
548
|
+
export type GetSearchConsoleSummarySearchTypeEnum = typeof GetSearchConsoleSummarySearchTypeEnum[keyof typeof GetSearchConsoleSummarySearchTypeEnum];
|
|
549
|
+
/**
|
|
550
|
+
* @export
|
|
551
|
+
*/
|
|
552
|
+
export declare const GetSearchConsoleSummaryDataStateEnum: {
|
|
553
|
+
readonly Final: "final";
|
|
554
|
+
readonly All: "all";
|
|
555
|
+
};
|
|
556
|
+
export type GetSearchConsoleSummaryDataStateEnum = typeof GetSearchConsoleSummaryDataStateEnum[keyof typeof GetSearchConsoleSummaryDataStateEnum];
|
|
557
|
+
/**
|
|
558
|
+
* @export
|
|
559
|
+
*/
|
|
560
|
+
export declare const GetSearchConsoleSummaryAggregationTypeEnum: {
|
|
561
|
+
readonly Auto: "auto";
|
|
562
|
+
readonly ByPage: "byPage";
|
|
563
|
+
readonly ByProperty: "byProperty";
|
|
564
|
+
};
|
|
565
|
+
export type GetSearchConsoleSummaryAggregationTypeEnum = typeof GetSearchConsoleSummaryAggregationTypeEnum[keyof typeof GetSearchConsoleSummaryAggregationTypeEnum];
|
|
566
|
+
/**
|
|
567
|
+
* @export
|
|
568
|
+
*/
|
|
569
|
+
export declare const GetSearchConsoleTimeseriesGranularityEnum: {
|
|
570
|
+
readonly Day: "day";
|
|
571
|
+
readonly Week: "week";
|
|
572
|
+
readonly Month: "month";
|
|
573
|
+
};
|
|
574
|
+
export type GetSearchConsoleTimeseriesGranularityEnum = typeof GetSearchConsoleTimeseriesGranularityEnum[keyof typeof GetSearchConsoleTimeseriesGranularityEnum];
|
|
575
|
+
/**
|
|
576
|
+
* @export
|
|
577
|
+
*/
|
|
578
|
+
export declare const GetSearchConsoleTimeseriesOutputEnum: {
|
|
579
|
+
readonly Flat: "flat";
|
|
580
|
+
readonly Csv: "csv";
|
|
581
|
+
};
|
|
582
|
+
export type GetSearchConsoleTimeseriesOutputEnum = typeof GetSearchConsoleTimeseriesOutputEnum[keyof typeof GetSearchConsoleTimeseriesOutputEnum];
|
|
583
|
+
/**
|
|
584
|
+
* @export
|
|
585
|
+
*/
|
|
586
|
+
export declare const GetSearchConsoleTimeseriesSearchTypeEnum: {
|
|
587
|
+
readonly Web: "web";
|
|
588
|
+
readonly Image: "image";
|
|
589
|
+
readonly Video: "video";
|
|
590
|
+
readonly News: "news";
|
|
591
|
+
readonly Discover: "discover";
|
|
592
|
+
readonly GoogleNews: "googleNews";
|
|
593
|
+
};
|
|
594
|
+
export type GetSearchConsoleTimeseriesSearchTypeEnum = typeof GetSearchConsoleTimeseriesSearchTypeEnum[keyof typeof GetSearchConsoleTimeseriesSearchTypeEnum];
|
|
595
|
+
/**
|
|
596
|
+
* @export
|
|
597
|
+
*/
|
|
598
|
+
export declare const GetSearchConsoleTimeseriesDataStateEnum: {
|
|
599
|
+
readonly Final: "final";
|
|
600
|
+
readonly All: "all";
|
|
601
|
+
};
|
|
602
|
+
export type GetSearchConsoleTimeseriesDataStateEnum = typeof GetSearchConsoleTimeseriesDataStateEnum[keyof typeof GetSearchConsoleTimeseriesDataStateEnum];
|
|
603
|
+
/**
|
|
604
|
+
* @export
|
|
605
|
+
*/
|
|
606
|
+
export declare const GetSearchConsoleTimeseriesAggregationTypeEnum: {
|
|
607
|
+
readonly Auto: "auto";
|
|
608
|
+
readonly ByPage: "byPage";
|
|
609
|
+
readonly ByProperty: "byProperty";
|
|
610
|
+
};
|
|
611
|
+
export type GetSearchConsoleTimeseriesAggregationTypeEnum = typeof GetSearchConsoleTimeseriesAggregationTypeEnum[keyof typeof GetSearchConsoleTimeseriesAggregationTypeEnum];
|