bisibility

package module

Go to main page

Versions in this module

v0

v0.9.0

Aug 14, 2026

Changes in this version

type Keyword

+ LanguageCode string

+ LanguageLabel string

+ LocationKey string

type KeywordMatchMarket

+ LanguageCode string

+ LanguageLabel string

type LocationSuggestion

+ LanguageCode string

v0.8.0

Aug 13, 2026

Changes in this version

+ type AnalyzeDomainOverviewOptions struct

+ EstimateOnly *bool

+ Fresh *bool

+ KeywordLimit *int

+ LanguageCode string

+ LocationCode int

+ MaxCostCents *int

+ PageLimit *int

+ ScopeOverride *DomainOverviewScope

+ Target string

type Client

+ func (c *Client) AnalyzeDomainOverview(ctx context.Context, projectID string, input AnalyzeDomainOverviewOptions, ...) (*DomainOverviewAnalyzeResponse, error)

+ func (c *Client) LoadDomainOverviewHistory(ctx context.Context, projectID string, input LoadDomainOverviewHistoryOptions, ...) (*DomainOverviewHistoryResponse, error)

+ func (c *Client) LoadDomainOverviewKeywords(ctx context.Context, projectID string, input LoadDomainOverviewKeywordsOptions, ...) (*DomainOverviewKeywordsResponse, error)

+ func (c *Client) LoadDomainOverviewPages(ctx context.Context, projectID string, input LoadDomainOverviewPagesOptions, ...) (*DomainOverviewPagesResponse, error)

+ type DomainOverviewAnalyzeResponse = DataResponse[DomainOverviewAnalyzeResult]

+ type DomainOverviewAnalyzeResult struct

+ Estimate *DomainOverviewEstimate

+ Report *DomainOverviewReport

+ func (result *DomainOverviewAnalyzeResult) UnmarshalJSON(data []byte) error

+ type DomainOverviewEstimate struct

+ Cached bool

+ Estimate bool

+ EstimatedCostCents float64

+ FreshEstimatedCostCents float64

+ HistoryEstimatedCostCents float64

+ HistoryMode DomainOverviewHistoryMode

+ KeywordPageEstimatedCostCents float64

+ LanguageCode string

+ LocationCode int

+ PagePageEstimatedCostCents float64

+ Provider string

+ Scope DomainOverviewScope

+ Target string

+ type DomainOverviewFailureReason string

+ const DomainOverviewFailureBudgetExhausted

+ const DomainOverviewFailureCostLimitExceeded

+ const DomainOverviewFailureInProgress

+ const DomainOverviewFailureLookupFailed

+ const DomainOverviewFailureNeedsReauth

+ const DomainOverviewFailureNoSource

+ const DomainOverviewFailureRateLimited

+ const DomainOverviewFailureSnapshotExpired

+ const DomainOverviewFailureUnsupportedLocation

+ type DomainOverviewHistoryMode string

+ const DomainOverviewHistoryModeLazy

+ type DomainOverviewHistoryResponse = DataResponse[DomainOverviewModuleSuccess[[]HistoricalOverviewRow]]

+ type DomainOverviewKeywordIntent string

+ const DomainOverviewIntentCommercial

+ const DomainOverviewIntentInformational

+ const DomainOverviewIntentNavigational

+ const DomainOverviewIntentTransactional

+ type DomainOverviewKeywordsResponse = DataResponse[DomainOverviewModuleSuccess[DomainOverviewRankedKeywordsPage]]

+ type DomainOverviewModuleOutcome struct

+ Cached *bool

+ CostCents float64

+ Data *T

+ FetchedAt *time.Time

+ OK bool

+ Reason *DomainOverviewFailureReason

+ ResetAt *float64

+ type DomainOverviewModuleSuccess struct

+ Cached bool

+ CostCents float64

+ Data T

+ FetchedAt time.Time

+ type DomainOverviewPagesResponse = DataResponse[DomainOverviewModuleSuccess[DomainOverviewRelevantPagesPage]]

+ type DomainOverviewProblemErrors struct

+ CostCents float64

+ Reason DomainOverviewFailureReason

+ ResetAt *float64

+ type DomainOverviewRankedKeyword struct

+ CPCCents *float64

+ Difficulty *float64

+ EstimatedTraffic *float64

+ Intent *DomainOverviewKeywordIntent

+ Keyword string

+ Position *float64

+ RankAbsolute *float64

+ RankAbsoluteDelta *float64

+ RankingURL *string

+ SERPFeatures []string

+ SearchVolume *float64

+ type DomainOverviewRankedKeywordsPage struct

+ CostCents float64

+ Rows []DomainOverviewRankedKeyword

+ TotalCount *int

+ type DomainOverviewRelevantPage struct

+ ETV *float64

+ ETVDeltaPct *float64

+ KeywordCount *int

+ Path string

+ TopKeyword *string

+ TopKeywordPosition *float64

+ type DomainOverviewRelevantPagesPage struct

+ CostCents float64

+ Rows []DomainOverviewRelevantPage

+ TotalCount int

+ type DomainOverviewReport struct

+ Cached bool

+ CachedUntil time.Time

+ CostCents float64

+ FetchedAt time.Time

+ HistoryMode DomainOverviewHistoryMode

+ Keywords DomainOverviewModuleOutcome[DomainOverviewRankedKeywordsPage]

+ LanguageCode string

+ LocationCode int

+ Overview *DomainRankMetrics

+ Pages DomainOverviewModuleOutcome[DomainOverviewRelevantPagesPage]

+ PreviousFetchedAt *time.Time

+ PreviousOverview *DomainRankMetrics

+ PreviousSourceSnapshotAt *time.Time

+ Provider string

+ Scope DomainOverviewScope

+ SourceSnapshotAt *time.Time

+ State DomainOverviewState

+ Target string

+ type DomainOverviewScope string

+ const DomainOverviewScopeRoot

+ const DomainOverviewScopeSubdomain

+ type DomainOverviewState string

+ const DomainOverviewStateNoData

+ const DomainOverviewStateOK

+ const DomainOverviewStatePartial

+ type DomainRankMetrics struct

+ Count *int

+ ETV *float64

+ EstimatedTrafficCostCents *float64

+ IsDown int

+ IsLost int

+ IsNew int

+ IsUp int

+ Pos1 int

+ Pos11To20 int

+ Pos21To30 int

+ Pos2To3 int

+ Pos31To40 int

+ Pos41To50 int

+ Pos4To10 int

+ Pos51To60 int

+ Pos61To70 int

+ Pos71To80 int

+ Pos81To90 int

+ Pos91To100 int

+ type HistoricalOverviewRow struct

+ Metrics DomainRankMetrics

+ Month int

+ Year int

+ type LoadDomainOverviewHistoryOptions struct

+ Fresh *bool

+ LanguageCode string

+ LocationCode int

+ MaxCostCents int

+ ScopeOverride *DomainOverviewScope

+ Target string

+ type LoadDomainOverviewKeywordsOptions struct

+ Fresh *bool

+ LanguageCode string

+ Limit int

+ LocationCode int

+ MaxCostCents int

+ Offset int

+ ScopeOverride *DomainOverviewScope

+ Target string

+ type LoadDomainOverviewPagesOptions = LoadDomainOverviewKeywordsOptions

v0.7.0

Aug 10, 2026

Changes in this version

+ type ProviderPrioritySyncError struct

+ Cause error

+ func (e *ProviderPrioritySyncError) Error() string

+ func (e *ProviderPrioritySyncError) Unwrap() error

v0.6.1

Aug 4, 2026

v0.6.0

Aug 2, 2026

Changes in this version

type Client

+ func (c *Client) CreateSavedKeywords(ctx context.Context, projectID string, input CreateSavedKeywordsInput, ...) (*CreateSavedKeywordsResult, error)

+ func (c *Client) DeleteProjectSavedKeyword(ctx context.Context, projectID, savedKeywordID string, ...) (*SavedKeywordDeleteResult, error)

+ func (c *Client) GetLiveness(ctx context.Context, options ...RequestOption) (*LivenessResponse, error)

+ func (c *Client) GetReadiness(ctx context.Context, options ...RequestOption) (*ReadinessResponse, error)

+ func (c *Client) IterateSavedKeywords(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[SavedKeyword]

+ func (c *Client) ListSavedKeywords(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListResponse[SavedKeyword], error)

+ type CreateSavedKeywordsInput struct

+ Keywords []SavedKeywordItem

+ type CreateSavedKeywordsResult struct

+ DuplicateCount int

+ Results []SavedKeywordResult

+ SavedCount int

+ type LivenessResponse struct

+ Status string

+ type ReadinessResponse struct

+ Status string

+ type SavedKeyword struct

+ CPC *float64

+ Difficulty *int

+ ID string

+ Intent *string

+ Location string

+ SavedAt time.Time

+ SourceSeed *string

+ Text string

+ Trend []SavedKeywordTrendPoint

+ VariantCount int

+ Volume *int

+ type SavedKeywordDeleteResult struct

+ RemovedCount int

+ type SavedKeywordInput struct

+ CPCCents *int

+ Difficulty *int

+ Intent string

+ Keyword string

+ Location string

+ SearchVolume *int

+ SourceSeed string

+ VariantCount *int

+ type SavedKeywordItem interface

+ type SavedKeywordResult struct

+ Keyword string

+ Status SavedKeywordStatus

+ type SavedKeywordStatus string

+ const SavedKeywordStatusCreated

+ const SavedKeywordStatusSkipped

+ type SavedKeywordText string

+ type SavedKeywordTrendPoint struct

+ Month int

+ SearchVolume *int

+ Year int

v0.5.1

Jul 30, 2026

v0.5.0

Jul 29, 2026

Changes in this version

+ const CloudImportProtocolVersion

+ func IsPublicID(value string) bool

+ func ValidatePublicID(value string) error

+ func ValidatePublicIDPrefix(value string, prefix PublicIDPrefix) error

type AlertRule

+ RecipientIDs []string

+ type CloudImportAlertCondition string

+ const CloudImportAlertConditionCTRDrop

+ const CloudImportAlertConditionChangePct

+ const CloudImportAlertConditionCompetitorOvertake

+ const CloudImportAlertConditionDowntrend

+ const CloudImportAlertConditionEntersTopN

+ const CloudImportAlertConditionExitsTopN

+ const CloudImportAlertConditionPositionDrop

+ const CloudImportAlertConditionSERPFeature

+ const CloudImportAlertConditionThreshold

+ const CloudImportAlertConditionURLMismatch

type CloudImportAlertRule

+ DropPositions *int

+ ID string

+ func (input *CloudImportAlertRule) UnmarshalJSON(data []byte) error

+ func (input CloudImportAlertRule) MarshalJSON() ([]byte, error)

type CloudImportChunkLimits

+ func (input *CloudImportChunkLimits) UnmarshalJSON(data []byte) error

+ func (input CloudImportChunkLimits) MarshalJSON() ([]byte, error)

type CloudImportChunkResponse

+ func (input *CloudImportChunkResponse) UnmarshalJSON(data []byte) error

+ func (input CloudImportChunkResponse) MarshalJSON() ([]byte, error)

type CloudImportCompatibility

+ func (input *CloudImportCompatibility) UnmarshalJSON(data []byte) error

+ func (input CloudImportCompatibility) MarshalJSON() ([]byte, error)

type CloudImportCompetitor

+ ID string

+ func (input *CloudImportCompetitor) UnmarshalJSON(data []byte) error

+ func (input CloudImportCompetitor) MarshalJSON() ([]byte, error)

type CloudImportFinalizeResponse

+ func (input *CloudImportFinalizeResponse) UnmarshalJSON(data []byte) error

+ func (input CloudImportFinalizeResponse) MarshalJSON() ([]byte, error)

type CloudImportKeyword

+ func (input *CloudImportKeyword) UnmarshalJSON(data []byte) error

+ func (input CloudImportKeyword) MarshalJSON() ([]byte, error)

+ type CloudImportKeywordAlertTarget struct

+ Device Device

+ Keyword string

+ KeywordID string

+ Location string

+ func (input *CloudImportKeywordAlertTarget) UnmarshalJSON(data []byte) error

+ func (input CloudImportKeywordAlertTarget) MarshalJSON() ([]byte, error)

+ type CloudImportKeywordsChunk struct

+ Checksum string

+ Keywords []CloudImportKeyword

+ func (input *CloudImportKeywordsChunk) UnmarshalJSON(data []byte) error

+ func (input CloudImportKeywordsChunk) MarshalJSON() ([]byte, error)

type CloudImportNotificationPreference

+ ReportEmail *bool

+ func (input *CloudImportNotificationPreference) UnmarshalJSON(data []byte) error

+ func (input CloudImportNotificationPreference) MarshalJSON() ([]byte, error)

type CloudImportPackage

+ func (input *CloudImportPackage) UnmarshalJSON(data []byte) error

+ func (input CloudImportPackage) MarshalJSON() ([]byte, error)

type CloudImportRankingHistory

+ func (input *CloudImportRankingHistory) UnmarshalJSON(data []byte) error

+ func (input CloudImportRankingHistory) MarshalJSON() ([]byte, error)

type CloudImportSavedView

+ ID string

+ func (input *CloudImportSavedView) UnmarshalJSON(data []byte) error

+ func (input CloudImportSavedView) MarshalJSON() ([]byte, error)

+ type CloudImportSavedViewSurface string

+ const CloudImportSavedViewSurfaceCompetitors

+ const CloudImportSavedViewSurfaceKeywords

+ type CloudImportScope string

+ const CloudImportScopeCurrent

+ const CloudImportScopeHistory

+ type CloudImportSectionsChunk struct

+ Checksum string

+ Sections CloudImportSessionSections

+ func (input *CloudImportSectionsChunk) UnmarshalJSON(data []byte) error

+ func (input CloudImportSectionsChunk) MarshalJSON() ([]byte, error)

type CloudImportSessionCreate

+ SourceProjectID string

+ func (input *CloudImportSessionCreate) UnmarshalJSON(data []byte) error

+ func (input CloudImportSessionCreate) MarshalJSON() ([]byte, error)

type CloudImportSessionCreateResponse

+ func (input *CloudImportSessionCreateResponse) UnmarshalJSON(data []byte) error

+ func (input CloudImportSessionCreateResponse) MarshalJSON() ([]byte, error)

type CloudImportSessionSections

+ func (input *CloudImportSessionSections) UnmarshalJSON(data []byte) error

+ func (input CloudImportSessionSections) MarshalJSON() ([]byte, error)

type CloudImportSessionTotals

+ func (input *CloudImportSessionTotals) UnmarshalJSON(data []byte) error

+ func (input CloudImportSessionTotals) MarshalJSON() ([]byte, error)

type CloudImportSourceKeyword

+ func (input *CloudImportSourceKeyword) UnmarshalJSON(data []byte) error

+ func (input CloudImportSourceKeyword) MarshalJSON() ([]byte, error)

+ type CloudImportTagAlertTarget struct

+ Tag string

+ func (input *CloudImportTagAlertTarget) UnmarshalJSON(data []byte) error

+ func (input CloudImportTagAlertTarget) MarshalJSON() ([]byte, error)

type CreateAlertRuleInput

+ RecipientIDs []string

+ type PublicIDPrefix string

+ const PublicIDPrefixAlert

+ const PublicIDPrefixAudit

+ const PublicIDPrefixCheck

+ const PublicIDPrefixComp

+ const PublicIDPrefixConn

+ const PublicIDPrefixHook

+ const PublicIDPrefixInvite

+ const PublicIDPrefixJob

+ const PublicIDPrefixKey

+ const PublicIDPrefixKeyword

+ const PublicIDPrefixMToken

+ const PublicIDPrefixMember

+ const PublicIDPrefixNotif

+ const PublicIDPrefixPAT

+ const PublicIDPrefixProject

+ const PublicIDPrefixRule

+ const PublicIDPrefixSKW

+ const PublicIDPrefixSession

+ const PublicIDPrefixSignal

+ const PublicIDPrefixTag

+ const PublicIDPrefixUser

+ const PublicIDPrefixView

+ const PublicIDPrefixWebhook

v0.4.1

Jul 27, 2026

Changes in this version

type KeywordMatch

+ RankingURL *string

v0.4.0

Jul 27, 2026

Changes in this version

+ type AnalyzeBacklinksOptions struct

+ EstimateOnly bool

+ Fresh bool

+ IncludeSubdomains bool

+ MaxCostCents int

+ Mode BacklinkMode

+ ResultLimit int

+ Target string

+ TargetScope BacklinkTargetScope

+ type BacklinkMode string

+ const BacklinkModeAsIs

+ const BacklinkModeOnePerDomain

+ type BacklinkRow struct

+ Anchor string

+ DomainAuthority int

+ FirstSeen string

+ Flags []string

+ LinksCount int

+ LostAt *string

+ SourceDomain string

+ SourceURL string

+ SpamScore float64

+ Status BacklinkStatus

+ TargetURL string

+ type BacklinkStatus string

+ const BacklinkStatusActive

+ const BacklinkStatusLost

+ const BacklinkStatusNew

+ type BacklinkTargetScope string

+ const BacklinkTargetScopePage

+ const BacklinkTargetScopeSite

+ type BacklinksHistoryMonth struct

+ LostLinks int

+ Month string

+ NewLinks int

+ type BacklinksSnapshot struct

+ Cached bool

+ CachedUntil time.Time

+ CostCents float64

+ Estimate *bool

+ EstimatedCostCents *float64

+ FetchedAt time.Time

+ FetchedRowCount int

+ History []BacklinksHistoryMonth

+ IncludeSubdomains bool

+ Provider string

+ Rows []BacklinkRow

+ Summary BacklinksSummary

+ Target string

+ TargetScope BacklinkTargetScope

+ TotalRowsAvailable int

+ type BacklinksSnapshotResponse = DataResponse[BacklinksSnapshot]

+ type BacklinksSummary struct

+ BacklinksTotal int

+ BrokenBacklinks int

+ BrokenPages int

+ DofollowPct float64

+ DomainRank int

+ LostBacklinks int

+ LostReferringDomains int

+ NewBacklinks int

+ NewReferringDomains int

+ ReferringDomainsTotal int

+ ReferringPages int

+ SpamScore float64

type Client

+ func (c *Client) AnalyzeBacklinks(ctx context.Context, projectID string, input AnalyzeBacklinksOptions, ...) (*BacklinksSnapshotResponse, error)

+ func (c *Client) GetProjectOverview(ctx context.Context, projectID string, input *ProjectOverviewOptions, ...) (*ProjectOverview, error)

+ func (c *Client) LoadMoreBacklinkRows(ctx context.Context, projectID string, input LoadMoreBacklinkRowsOptions, ...) (*BacklinksSnapshotResponse, error)

+ func (c *Client) MatchProjectKeywords(ctx context.Context, projectID string, input KeywordMatchRequest, ...) (*KeywordMatchResponse, error)

+ type KeywordMatch struct

+ KeywordID string

+ LatestPosition *int

+ Market KeywordMatchMarket

+ MatchedText string

+ PreviousPosition *int

+ Text string

+ type KeywordMatchMarket struct

+ CountryCode string

+ Device Device

+ Location string

+ LocationKey string

+ type KeywordMatchMeta struct

+ TruncatedTexts []string

+ type KeywordMatchRequest struct

+ Texts []string

+ type KeywordMatchResponse struct

+ Data []KeywordMatch

+ Meta KeywordMatchMeta

+ type LoadMoreBacklinkRowsOptions struct

+ IncludeSubdomains bool

+ Limit int

+ Target string

+ TargetScope BacklinkTargetScope

+ type ProjectOverview struct

+ AveragePosition *float64

+ AveragePositionDelta *float64

+ KeywordsAddedThisMonth int

+ LastCheckAt *time.Time

+ NextCheckAt *time.Time

+ PositionDistribution []ProjectOverviewPositionBucket

+ ProjectID string

+ Top100Count *int

+ Top10Count *int

+ Top10Delta *int

+ Top3Count *int

+ TrackedKeywordCount int

+ Visibility *float64

+ VisibilityDelta *float64

+ type ProjectOverviewDevice string

+ const ProjectOverviewDeviceAll

+ const ProjectOverviewDeviceDesktop

+ const ProjectOverviewDeviceMobile

+ type ProjectOverviewOptions struct

+ Device ProjectOverviewDevice

+ Range ProjectOverviewRange

+ Tag string

+ type ProjectOverviewPositionBucket struct

+ Count *int

+ Max int

+ Min int

+ type ProjectOverviewRange string

+ const ProjectOverviewRange28Days

+ const ProjectOverviewRange7Days

+ const ProjectOverviewRange90Days

v0.3.0

Jul 26, 2026

Changes in this version

+ const Version

+ func IsAPIError(err error) bool

+ type APIError struct

+ Body string

+ Header http.Header

+ Method string

+ Problem *ProblemDetails

+ StatusCode int

+ URL string

+ func (e *APIError) Error() string

+ func (e *APIError) IsNotFound() bool

+ func (e *APIError) IsRateLimit() bool

+ func (e *APIError) RetryAfter() (time.Duration, bool)

+ type APIKey struct

+ CreatedAt time.Time

+ ID string

+ LastUsedAt *time.Time

+ Name string

+ Prefix string

+ RevokedAt *time.Time

+ type AddCompetitorInput struct

+ Domain string

+ Label string

+ type AlertChannel string

+ const AlertChannelEmail

+ const AlertChannelSlack

+ const AlertChannelWebhook

+ type AlertConditionType string

+ const AlertConditionTypeChangePct

+ const AlertConditionTypeCompetitorOvertake

+ const AlertConditionTypeEntersTopN

+ const AlertConditionTypeExitsTopN

+ const AlertConditionTypeSERPFeature

+ const AlertConditionTypeThreshold

+ type AlertRule struct

+ ChangePct *FlexibleFloat

+ Channel string

+ Channels []AlertChannel

+ CompetitorDomain *string

+ Condition string

+ ConditionType AlertConditionType

+ CreatedAt *time.Time

+ CreatedByID *string

+ Enabled bool

+ Fires string

+ ID string

+ Name string

+ Period string

+ ProjectID string

+ SERPFeature *string

+ Scope string

+ Severity AlertSeverity

+ Status AlertRuleStatus

+ TargetIDs []string

+ TargetType AlertTargetType

+ Targets []AlertRuleTarget

+ ThresholdPosition *int

+ TopN *int

+ UpdatedAt *time.Time

+ type AlertRuleDeleteResult struct

+ Deleted bool

+ type AlertRuleStatus string

+ const AlertRuleStatusActive

+ const AlertRuleStatusLearning

+ const AlertRuleStatusPaused

+ const AlertRuleStatusSetup

+ type AlertRuleTarget struct

+ ID string

+ KeywordID *string

+ RuleID string

+ TagID *string

+ type AlertSeverity string

+ const AlertSeverityInfo

+ const AlertSeverityUrgent

+ const AlertSeverityWarning

+ type AlertTargetType string

+ const AlertTargetTypeAll

+ const AlertTargetTypeKeyword

+ const AlertTargetTypeTag

+ type AnalyticsConnection struct

+ ID string

+ Label string

+ Provider string

+ type BisibilityError interface

+ type Capability struct

+ Description string

+ InputSchema JSONValue

+ Name string

+ OperationID string

+ type Client struct

+ func NewClient(options ...Option) (*Client, error)

+ func (c *Client) AddCompetitor(ctx context.Context, projectID string, input AddCompetitorInput, ...) (*Competitor, error)

+ func (c *Client) AddKeywords(ctx context.Context, projectID string, keywords []CreateKeywordInput, ...) (*CreateKeywordsResponse, error)

+ func (c *Client) BaseURL() string

+ func (c *Client) BulkUpdateKeywords(ctx context.Context, input KeywordBulkInput, options ...RequestOption) (*KeywordBulkResponse, error)

+ func (c *Client) ConnectProvider(ctx context.Context, projectID string, providerID ProviderID, ...) (*ProviderConnection, error)

+ func (c *Client) CreateAPIKey(ctx context.Context, input CreateAPIKeyInput, options ...RequestOption) (*CreatedAPIKey, error)

+ func (c *Client) CreateAlertRule(ctx context.Context, projectID string, input CreateAlertRuleInput, ...) (*AlertRule, error)

+ func (c *Client) CreateCloudImportSession(ctx context.Context, migrationToken string, input CloudImportSessionCreate, ...) (*CloudImportSessionCreateResponse, error)

+ func (c *Client) CreateKeywords(ctx context.Context, projectID string, input CreateKeywordsInput, ...) (*CreateKeywordsResponse, error)

+ func (c *Client) CreateMyToken(ctx context.Context, input CreateMyTokenInput, options ...RequestOption) (*CreatedPersonalAccessToken, error)

+ func (c *Client) CreateProject(ctx context.Context, input CreateProjectInput, options ...RequestOption) (*Project, error)

+ func (c *Client) CreateProjectAPIKey(ctx context.Context, projectID string, input CreateAPIKeyInput, ...) (*CreatedAPIKey, error)

+ func (c *Client) CreateSavedView(ctx context.Context, projectID string, input CreateSavedViewInput, ...) (*SavedView, error)

+ func (c *Client) CreateSignal(ctx context.Context, input CreateSignalInput, options ...RequestOption) (*Signal, error)

+ func (c *Client) CreateTeamInvite(ctx context.Context, projectID string, input CreateTeamInviteInput, ...) (*CreatedTeamInvite, error)

+ func (c *Client) CreateWebhook(ctx context.Context, projectID string, input CreateWebhookInput, ...) (*Webhook, error)

+ func (c *Client) DeleteAlertRule(ctx context.Context, ruleID string, options ...RequestOption) (*AlertRuleDeleteResult, error)

+ func (c *Client) DeleteKeyword(ctx context.Context, keywordID string, options ...RequestOption) (*Keyword, error)

+ func (c *Client) DeleteProject(ctx context.Context, projectID string, options ...RequestOption) (*Project, error)

+ func (c *Client) DeleteProjectSavedView(ctx context.Context, projectID, viewID string, options ...RequestOption) (*SavedViewDeleteResult, error)

+ func (c *Client) DeleteSavedView(ctx context.Context, viewID string, options ...RequestOption) (*SavedViewDeleteResult, error)

+ func (c *Client) DeleteWebhook(ctx context.Context, projectID, webhookID string, options ...RequestOption) (*Webhook, error)

+ func (c *Client) DisconnectProvider(ctx context.Context, projectID string, providerID ProviderID, ...) (*ProviderDisconnectResult, error)

+ func (c *Client) ExportRankHistory(ctx context.Context, projectID string, input *ExportRankHistoryOptions, ...) (*RankHistoryExportResponse, error)

+ func (c *Client) FinalizeCloudImportSession(ctx context.Context, migrationToken, sessionID string, ...) (*CloudImportFinalizeResponse, error)

+ func (c *Client) GetCapabilities(ctx context.Context, options ...RequestOption) (*DataResponse[[]Capability], error)

+ func (c *Client) GetCloudImportCompatibility(ctx context.Context, options ...RequestOption) (*CloudImportCompatibility, error)

+ func (c *Client) GetCostEstimate(ctx context.Context, input CostEstimateOptions, options ...RequestOption) (*DataResponse[CostEstimate], error)

+ func (c *Client) GetHealth(ctx context.Context, options ...RequestOption) (*HealthResponse, error)

+ func (c *Client) GetKeyword(ctx context.Context, keywordID string, options ...RequestOption) (*Keyword, error)

+ func (c *Client) GetKeywordMetrics(ctx context.Context, projectID string, input GetKeywordMetricsInput, ...) (*KeywordMetricsResponse, error)

+ func (c *Client) GetLLMSText(ctx context.Context, options ...RequestOption) (string, error)

+ func (c *Client) GetMe(ctx context.Context, options ...RequestOption) (*Me, error)

+ func (c *Client) GetNotificationPreferences(ctx context.Context, projectID string, options ...RequestOption) (*NotificationPreferences, error)

+ func (c *Client) GetOpenAPI(ctx context.Context, options ...RequestOption) (*OpenAPIDocument, error)

+ func (c *Client) GetProject(ctx context.Context, projectID string, options ...RequestOption) (*Project, error)

+ func (c *Client) GetProjectDefaults(ctx context.Context, projectID string, options ...RequestOption) (*ProjectDefaults, error)

+ func (c *Client) GetProviderRates(ctx context.Context, options ...RequestOption) (*DataResponse[[]ProviderRate], error)

+ func (c *Client) GetRankCheckResult(ctx context.Context, checkID string, options ...RequestOption) (*RankCheck, error)

+ func (c *Client) ImportCloudExport(ctx context.Context, migrationToken string, pkg CloudImportPackage, ...) (*CloudImportFinalizeResponse, error)

+ func (c *Client) IterateAPIKeys(ctx context.Context, pagination *PaginationOptions, options ...RequestOption) *Pager[APIKey]

+ func (c *Client) IterateAlertRules(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[AlertRule]

+ func (c *Client) IterateCompetitors(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[ManagedCompetitor]

+ func (c *Client) IterateKeywords(ctx context.Context, projectID string, filters *ListKeywordsOptions, ...) *Pager[Keyword]

+ func (c *Client) IterateMigrationTokens(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[MigrationToken]

+ func (c *Client) IterateProjectAPIKeys(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[APIKey]

+ func (c *Client) IterateProviders(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[Provider]

+ func (c *Client) IterateRankChecks(ctx context.Context, keywordID string, filters *ListRankChecksOptions, ...) *Pager[RankCheck]

+ func (c *Client) IterateRankHistory(ctx context.Context, projectID string, filters *ExportRankHistoryOptions, ...) *Pager[RankHistoryExportRow]

+ func (c *Client) IterateSavedViews(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[SavedView]

+ func (c *Client) IterateSignals(ctx context.Context, projectID string, filters *ListSignalsOptions, ...) *Pager[Signal]

+ func (c *Client) IterateTeamInvites(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[TeamInvite]

+ func (c *Client) IterateTeamMembers(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[TeamMember]

+ func (c *Client) IterateTriggeredAlerts(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[TriggeredAlert]

+ func (c *Client) IterateWebhooks(ctx context.Context, projectID string, pagination *PaginationOptions, ...) *Pager[Webhook]

+ func (c *Client) KeywordsCreate(ctx context.Context, projectID string, input CreateKeywordsInput, ...) (*CreateKeywordsResponse, error)

+ func (c *Client) KeywordsList(ctx context.Context, projectID string, filters *ListKeywordsOptions, ...) (*ListResponse[Keyword], error)

+ func (c *Client) ListAPIKeys(ctx context.Context, pagination *PaginationOptions, options ...RequestOption) (*ListResponse[APIKey], error)

+ func (c *Client) ListAlertRules(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListResponse[AlertRule], error)

+ func (c *Client) ListCompetitors(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListCompetitorsResponse, error)

+ func (c *Client) ListKeywords(ctx context.Context, projectID string, filters *ListKeywordsOptions, ...) (*ListResponse[Keyword], error)

+ func (c *Client) ListMigrationTokens(ctx context.Context, projectID string, options ...RequestOption) (*ListMigrationTokensResponse, error)

+ func (c *Client) ListMyTokens(ctx context.Context, options ...RequestOption) (*ListResponse[PersonalAccessToken], error)

+ func (c *Client) ListProjectAPIKeys(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListResponse[APIKey], error)

+ func (c *Client) ListProjects(ctx context.Context, options ...RequestOption) (*ListResponse[Project], error)

+ func (c *Client) ListProviders(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListResponse[Provider], error)

+ func (c *Client) ListRankChecks(ctx context.Context, keywordID string, filters *ListRankChecksOptions, ...) (*ListResponse[RankCheck], error)

+ func (c *Client) ListRankedKeywordSuggestions(ctx context.Context, projectID string, ...) (*RankedKeywordSuggestionsResponse, error)

+ func (c *Client) ListSavedViews(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListResponse[SavedView], error)

+ func (c *Client) ListSearchPerformanceQueryStats(ctx context.Context, projectID string, ...) (*SearchPerformanceQueryStatsResponse, error)

+ func (c *Client) ListSignals(ctx context.Context, projectID string, filters *ListSignalsOptions, ...) (*ListResponse[Signal], error)

+ func (c *Client) ListSitemapMonitors(ctx context.Context, projectID string, options ...RequestOption) (*ListResponse[SitemapMonitor], error)

+ func (c *Client) ListTeamInvites(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListResponse[TeamInvite], error)

+ func (c *Client) ListTeamMembers(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListResponse[TeamMember], error)

+ func (c *Client) ListTrafficSnapshots(ctx context.Context, projectID string, input ListTrafficSnapshotsOptions, ...) (*PageTrafficSnapshotsResponse, error)

+ func (c *Client) ListTriggeredAlerts(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListResponse[TriggeredAlert], error)

+ func (c *Client) ListWebhooks(ctx context.Context, projectID string, pagination *PaginationOptions, ...) (*ListResponse[Webhook], error)

+ func (c *Client) MarkProjectAlertsRead(ctx context.Context, projectID string, options ...RequestOption) (*TriggeredAlertsReadResult, error)

+ func (c *Client) MintMigrationToken(ctx context.Context, projectID string, input MintMigrationTokenInput, ...) (*IssuedMigrationToken, error)

+ func (c *Client) MuteTriggeredAlert(ctx context.Context, projectID, alertID string, options ...RequestOption) (*TriggeredAlertMuteResult, error)

+ func (c *Client) Projects(ctx context.Context, options ...RequestOption) (*ListResponse[Project], error)

+ func (c *Client) RankHistory(ctx context.Context, keywordID string, filters *ListRankChecksOptions, ...) (*ListResponse[RankCheck], error)

+ func (c *Client) RemoveCompetitor(ctx context.Context, competitorID string, options ...RequestOption) (*CompetitorRemoveResult, error)

+ func (c *Client) RemoveProjectCompetitor(ctx context.Context, projectID, competitorID string, options ...RequestOption) (*CompetitorRemoveResult, error)

+ func (c *Client) RemoveTeamMember(ctx context.Context, projectID, memberID string, options ...RequestOption) (*TeamMemberMutationResult, error)

+ func (c *Client) ResearchKeywords(ctx context.Context, projectID string, input ResearchKeywordsOptions, ...) (*KeywordResearchResponse, error)

+ func (c *Client) ResendTeamInvite(ctx context.Context, projectID, inviteID string, options ...RequestOption) (*TeamInviteResendResult, error)

+ func (c *Client) RevokeAPIKey(ctx context.Context, keyID string, options ...RequestOption) (*APIKey, error)

+ func (c *Client) RevokeMigrationToken(ctx context.Context, tokenID string, options ...RequestOption) (*RevokedMigrationToken, error)

+ func (c *Client) RevokeMyToken(ctx context.Context, tokenID string, options ...RequestOption) (*PersonalAccessToken, error)

+ func (c *Client) RevokeProjectMigrationToken(ctx context.Context, projectID, tokenID string, options ...RequestOption) (*RevokedMigrationToken, error)

+ func (c *Client) RevokeProjectTeamInvite(ctx context.Context, projectID, inviteID string, options ...RequestOption) (*RevokeTeamInviteResult, error)

+ func (c *Client) RevokeTeamInvite(ctx context.Context, inviteID string, options ...RequestOption) (*RevokeTeamInviteResult, error)

+ func (c *Client) RunCheck(ctx context.Context, keywordID string, input *RunRankCheckInput, ...) (*RankCheck, error)

+ func (c *Client) RunRankCheck(ctx context.Context, keywordID string, input *RunRankCheckInput, ...) (*RankCheck, error)

+ func (c *Client) SearchLocations(ctx context.Context, input SearchLocationsOptions, options ...RequestOption) (*LocationSuggestionsResponse, error)

+ func (c *Client) SetKeywordTargetURL(ctx context.Context, keywordID string, targetURL *string, ...) (*Keyword, error)

+ func (c *Client) SetPrimaryProvider(ctx context.Context, projectID string, providerID ProviderID, primary bool, ...) (*ProviderConnection, error)

+ func (c *Client) SetProviderEnabled(ctx context.Context, projectID string, providerID ProviderID, enabled bool, ...) (*ProviderConnection, error)

+ func (c *Client) SetProviderPriority(ctx context.Context, projectID string, providerID ProviderID, priority int, ...) (*ProviderConnection, error)

+ func (c *Client) SyncProjectTraffic(ctx context.Context, projectID string, options ...RequestOption) (*TrafficSyncSummary, error)

+ func (c *Client) TestProviderConnection(ctx context.Context, projectID string, providerID ProviderID, ...) (*ProviderTestResult, error)

+ func (c *Client) UpdateAlertRule(ctx context.Context, ruleID string, input UpdateAlertRuleInput, ...) (*AlertRule, error)

+ func (c *Client) UpdateKeyword(ctx context.Context, keywordID string, input UpdateKeywordInput, ...) (*Keyword, error)

+ func (c *Client) UpdateMe(ctx context.Context, input UpdateMeInput, options ...RequestOption) (*Me, error)

+ func (c *Client) UpdateNotificationPreferences(ctx context.Context, projectID string, ...) (*UpdatedNotificationPreferences, error)

+ func (c *Client) UpdateProject(ctx context.Context, projectID string, input UpdateProjectInput, ...) (*Project, error)

+ func (c *Client) UpdateProjectDefaults(ctx context.Context, projectID string, input ProjectDefaultsPatch, ...) (*ProjectDefaults, error)

+ func (c *Client) UpdateProviderSettings(ctx context.Context, projectID string, providerID ProviderID, ...) (*ProviderConnection, error)

+ func (c *Client) UpdateSitemapMonitor(ctx context.Context, projectID, monitorID string, ...) (*SitemapMonitor, error)

+ func (c *Client) UpdateTeamMemberRole(ctx context.Context, projectID, memberID string, ...) (*TeamMemberRoleResult, error)

+ func (c *Client) UpdateWebhook(ctx context.Context, projectID, webhookID string, input UpdateWebhookInput, ...) (*Webhook, error)

+ func (c *Client) UploadCloudImportChunk(ctx context.Context, migrationToken, sessionID string, index int, ...) (*CloudImportChunkResponse, error)

+ func (c *Client) UploadCloudImportChunkRaw(ctx context.Context, migrationToken, sessionID string, index int, ...) (*CloudImportChunkResponse, error)

+ type CloudImportAlertRule struct

+ ChangePct *float64

+ Channels []string

+ CompetitorDomain *string

+ ConditionType string

+ Enabled *bool

+ Name string

+ SerpFeature *string

+ TargetType string

+ Targets []CloudImportAlertRuleTarget

+ ThresholdPosition *int

+ TopN *int

+ type CloudImportAlertRuleTarget struct

+ Device string

+ Keyword string

+ KeywordID string

+ Location string

+ Tag string

+ TagID string

+ Type string

+ type CloudImportChunkLimits struct

+ MaxBodyBytes int

+ MaxHistoryRows int

+ MaxKeywords int

+ type CloudImportChunkResponse struct

+ ChunkCount int

+ ChunksReceived int

+ State string

+ type CloudImportCompatibility struct

+ AppVersion string

+ LatestMigration *string

+ SchemaVersionsSupported []int

+ type CloudImportCompetitor struct

+ Domain string

+ Label *string

+ type CloudImportCounts map[string]int

+ type CloudImportFinalizeResponse struct

+ Counts CloudImportCounts

+ JobID string

+ State string

+ type CloudImportJob struct

+ Counts json.RawMessage

+ CreatedAt *time.Time

+ Error *string

+ FinishedAt *time.Time

+ ID *string

+ Progress int

+ StartedAt *time.Time

+ State CloudImportState

+ type CloudImportKeyword struct

+ Country string

+ Device string

+ ID string

+ Keyword string

+ Location string

+ RankingHistory []CloudImportRankingHistory

+ Tags []string

+ TargetURL *string

+ Text string

+ type CloudImportNotificationPreference struct

+ AlertEmail *bool

+ AlertInApp *bool

+ CheckEmail *bool

+ CheckInApp *bool

+ ImportEmail *bool

+ ImportInApp *bool

+ InviteEmail *bool

+ InviteInApp *bool

+ type CloudImportPackage struct

+ AlertRules []CloudImportAlertRule

+ Competitors []CloudImportCompetitor

+ ExportedAt string

+ Keywords []CloudImportKeyword

+ NotificationPreferences []CloudImportNotificationPreference

+ ProjectID string

+ RankChecks []CloudImportTopLevelRankCheck

+ SavedViews []CloudImportSavedView

+ Scope string

+ Version int

+ type CloudImportRankingHistory struct

+ CheckedAt string

+ Position *int

+ PreviousPosition *int

+ RankingURL *string

+ type CloudImportSavedView struct

+ Config any

+ Name string

+ Surface string

+ type CloudImportSessionCreate struct

+ ChunkCount int

+ Totals *CloudImportSessionTotals

+ Version int

+ type CloudImportSessionCreateResponse struct

+ ChunkLimits CloudImportChunkLimits

+ SessionID string

+ State string

+ type CloudImportSessionSections struct

+ AlertRules []CloudImportAlertRule

+ Competitors []CloudImportCompetitor

+ NotificationPreferences []CloudImportNotificationPreference

+ SavedViews []CloudImportSavedView

+ SourceKeywordIDs map[string]CloudImportSourceKeyword

+ type CloudImportSessionTotals struct

+ Keywords int

+ RankChecks int

+ type CloudImportSourceKeyword struct

+ Device string

+ Location string

+ Text string

+ type CloudImportState string

+ const CloudImportStateDone

+ const CloudImportStateFailed

+ const CloudImportStateIdle

+ const CloudImportStateImporting

+ const CloudImportStateReceiving

+ type CloudImportTopLevelRankCheck struct

+ CheckedAt string

+ Keyword string

+ KeywordID string

+ Position *int

+ PreviousPosition *int

+ RankingURL *string

+ Text string

+ type CloudImportUploadChunk struct

+ Checksum string

+ Keywords []CloudImportKeyword

+ Kind string

+ Sections *CloudImportSessionSections

+ type Competitor struct

+ Domain string

+ ID string

+ Label *string

+ type CompetitorColumn struct

+ Domain string

+ ID string

+ Kind string

+ Label string

+ type CompetitorHeadToHeadRow struct

+ Gap *int

+ Keyword string

+ Ranks map[string]*int

+ type CompetitorMarket struct

+ CheckedKeywordCount int

+ Columns []CompetitorColumn

+ CompetitorCount int

+ Country string

+ Device string

+ Engine string

+ HasRankData bool

+ Key string

+ Rows []CompetitorHeadToHeadRow

+ SharedKeywordCount int

+ Shares []CompetitorShare

+ TrackedKeywordCount int

+ type CompetitorRemoveResult struct

+ Removed bool

+ type CompetitorShare struct

+ Color string

+ Domain string

+ ID string

+ Initials string

+ Kind string

+ Label string

+ ShareOfVoice int

+ SharedKeywords int

+ type CompetitorsMeta struct

+ Markets []CompetitorMarket

+ NextCursor *string

+ Suggestions []SuggestedCompetitor

+ type ConfigurationError struct

+ Message string

+ func (e *ConfigurationError) Error() string

+ type ConnectProviderInput struct

+ CostPerCheck *float64

+ Credentials *ProviderCredentialsInput

+ Enabled *bool

+ Login string

+ Primary *bool

+ Priority *int

+ Secret string

+ type CostEstimate struct

+ ChecksPerRun int

+ EffectiveCostPerCheckCents float64

+ ExceedsLargestPlan bool

+ ExceedsSelectedPlan bool

+ MonthlyChecks int

+ MonthlyCostCents float64

+ MonthlyCostUSD float64

+ PricingModel PricingModel

+ ProviderID ProviderID

+ RateCheckedAt string

+ RateSourceURL string

+ SelectedOption *ProviderRateOption

+ SelectedPlan *ProviderRatePlan

+ type CostEstimateOptions struct

+ Devices int

+ Frequency EstimateFrequency

+ Keywords int

+ Locations int

+ Option string

+ Plan string

+ Provider ProviderID

+ type CreateAPIKeyInput struct

+ Name string

+ type CreateAlertRuleInput struct

+ ChangePct *float64

+ Channels []AlertChannel

+ CompetitorDomain *string

+ ConditionType AlertConditionType

+ Enabled *bool

+ Name string

+ SERPFeature *string

+ TargetIDs []string

+ TargetType AlertTargetType

+ ThresholdPosition *int

+ TopN *int

+ type CreateKeywordInput struct

+ City string

+ Country string

+ Device Device

+ Intent *string

+ Keyword string

+ Location string

+ LocationKey string

+ Schedule *KeywordScheduleInput

+ Tags []string

+ TargetURL *string

+ Topic *string

+ type CreateKeywordResult struct

+ Keyword Keyword

+ Status string

+ Warning string

+ type CreateKeywordsInput struct

+ Keywords []CreateKeywordInput

+ type CreateKeywordsResponse struct

+ Created int

+ Results []CreateKeywordResult

+ Skipped int

+ Warnings []string

+ type CreateMyTokenInput struct

+ ExpiresInDays *int

+ Name string

+ Scope TokenScope

+ type CreateProjectInput struct

+ Defaults *ProjectDefaultsPatch

+ Domain string

+ Name string

+ TrackingScope TrackingScope

+ type CreateSavedViewInput struct

+ Config SavedViewConfig

+ Name string

+ type CreateSignalInput struct

+ HappenedAt *time.Time

+ KeywordID string

+ Payload JSONValue

+ Severity SignalSeverity

+ Source SignalSource

+ Type string

+ URL string

+ type CreateTeamInviteInput struct

+ Email string

+ Role TeamRoleValue

+ type CreateWebhookInput struct

+ Description string

+ Enabled *bool

+ HMACSecret string

+ URL string

+ type CreatedAPIKey struct

+ MaskedValue string

+ Token string

+ type CreatedPersonalAccessToken struct

+ MaskedValue string

+ Token string

+ type CreatedTeamInvite struct

+ ExpiresAt time.Time

+ ID string

+ InviteLink string

+ type DataResponse struct

+ Data T

+ Meta JSONValue

+ type Device string

+ const DeviceDesktop

+ const DeviceMobile

+ type EstimateFrequency string

+ const EstimateFrequencyDaily

+ const EstimateFrequencyMonthly

+ const EstimateFrequencyWeekly

+ type ExportRankHistoryOptions struct

+ Cursor string

+ Format RankHistoryExportFormat

+ Granularity RankHistoryGranularity

+ KeywordIDs []string

+ Limit int

+ Range RankHistoryExportRange

+ type FlexibleFloat float64

+ func (f *FlexibleFloat) UnmarshalJSON(data []byte) error

+ func (f FlexibleFloat) Float64() float64

+ type GetKeywordMetricsInput struct

+ ConnectionID string

+ EstimateOnly bool

+ Fresh bool

+ IncludeClickstream bool

+ Keywords []string

+ MaxCostCents int

+ type HealthResponse struct

+ CheckedAt time.Time

+ Providers struct{ ... }

+ Services struct{ ... }

+ Status string

+ type IssuedMigrationToken struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID string

+ ImportJob CloudImportJob

+ Scope MigrationScope

+ SingleUse bool

+ Token string

+ type JSONValue map[string]any

+ type Keyword struct

+ Country string

+ CreatedAt time.Time

+ Device Device

+ ID string

+ Intent *string

+ LatestPosition *int

+ Location string

+ PreviousPosition *int

+ ProjectID string

+ RankingURL *string

+ Schedule *KeywordSchedule

+ Tags []string

+ TargetURL *string

+ Text string

+ Topic *string

+ UpdatedAt time.Time

+ type KeywordBulkInput struct

+ Frequency *RankCheckFrequency

+ KeywordIDs []string

+ Operation KeywordBulkOperation

+ Schedule *KeywordScheduleInput

+ Tags []string

+ TargetURL NullableString

+ func (in KeywordBulkInput) MarshalJSON() ([]byte, error)

+ type KeywordBulkItemResult struct

+ KeywordID string

+ Status string

+ type KeywordBulkOperation string

+ const KeywordBulkOperationAddTags

+ const KeywordBulkOperationDelete

+ const KeywordBulkOperationRemoveTags

+ const KeywordBulkOperationSetFrequency

+ const KeywordBulkOperationSetTargetURL

+ type KeywordBulkResponse struct

+ Operation KeywordBulkOperation

+ Results []KeywordBulkItemResult

+ type KeywordIntent string

+ const KeywordIntentCommercial

+ const KeywordIntentInformational

+ const KeywordIntentNavigational

+ const KeywordIntentTransactional

+ const KeywordIntentUnknown

+ type KeywordMetrics struct

+ CPCCents *int

+ Competition *float64

+ Difficulty *float64

+ Intent *KeywordIntent

+ MonthlyTrend []KeywordMonthlyTrend

+ SearchVolume *float64

+ type KeywordMetricsResponse struct

+ CachedCount int

+ Connections []KeywordResearchConnection

+ CostCents float64

+ Estimate *bool

+ EstimatedCostCents *float64

+ FetchedAt time.Time

+ FetchedCount int

+ FetchedCountEstimate *int

+ Provider string

+ Rows []KeywordMetricsRow

+ TotalCount int

+ type KeywordMetricsRow struct

+ Keyword string

+ type KeywordMonthlyTrend struct

+ Month int

+ SearchVolume *float64

+ Year int

+ type KeywordResearchConnection = RankedKeywordConnection

+ type KeywordResearchMode string

+ const KeywordResearchModeAuto

+ const KeywordResearchModeIdeas

+ const KeywordResearchModeRelated

+ const KeywordResearchModeSuggestions

+ type KeywordResearchResponse struct

+ Cached bool

+ Connections []KeywordResearchConnection

+ CostCents float64

+ Estimate *bool

+ FetchedAt time.Time

+ Provider string

+ Rows []KeywordResearchRow

+ Sources []KeywordResearchSourceSummary

+ TotalCount int

+ type KeywordResearchRow struct

+ AlreadyTracked bool

+ Keyword string

+ Source KeywordResearchSource

+ type KeywordResearchSource string

+ const KeywordResearchSourceIdea

+ const KeywordResearchSourceRelated

+ const KeywordResearchSourceSuggestion

+ type KeywordResearchSourceReason string

+ const KeywordResearchSourceReasonBudgetExhausted

+ const KeywordResearchSourceReasonCostLimit

+ const KeywordResearchSourceReasonInProgress

+ const KeywordResearchSourceReasonNeedsReauth

+ const KeywordResearchSourceReasonNoSource

+ const KeywordResearchSourceReasonPreviousSourceFailed

+ const KeywordResearchSourceReasonProviderError

+ const KeywordResearchSourceReasonRateLimited

+ const KeywordResearchSourceReasonResultLimit

+ const KeywordResearchSourceReasonUnsupportedLocation

+ type KeywordResearchSourceStatus string

+ const KeywordResearchSourceStatusFailed

+ const KeywordResearchSourceStatusOK

+ const KeywordResearchSourceStatusSkipped

+ type KeywordResearchSourceSummary struct

+ Cached bool

+ CostCents float64

+ Reason *KeywordResearchSourceReason

+ Returned int

+ Source KeywordResearchSource

+ Status KeywordResearchSourceStatus

+ type KeywordSchedule struct

+ CronExpression *string

+ Frequency RankCheckFrequency

+ JitterMinutes int

+ LastCheckedAt *time.Time

+ NextCheckAt *time.Time

+ Timezone string

+ type KeywordScheduleInput struct

+ CronExpression *string

+ Frequency RankCheckFrequency

+ JitterMinutes *int

+ Timezone string

+ type ListCompetitorsResponse struct

+ Data []ManagedCompetitor

+ Meta CompetitorsMeta

+ type ListKeywordsOptions struct

+ Country string

+ Cursor string

+ Device Device

+ Intent string

+ Limit int

+ PositionGT int

+ PositionLT int

+ Search string

+ Sort string

+ Tag string

+ Topic string

+ type ListMeta struct

+ NextCursor *string

+ type ListMigrationTokensResponse struct

+ Data []MigrationToken

+ Meta MigrationTokensMeta

+ type ListRankChecksOptions struct

+ Cursor string

+ Limit int

+ Since time.Time

+ Status RankCheckStatus

+ Until time.Time

+ type ListRankedKeywordSuggestionsOptions struct

+ ConnectionID string

+ Fresh bool

+ Limit int

+ Offset int

+ type ListResponse struct

+ Data []T

+ Meta ListMeta

+ type ListSearchPerformanceQueryStatsOptions struct

+ ConnectionID string

+ EndDate string

+ Limit int

+ Query string

+ StartDate string

+ type ListSignalsOptions struct

+ Cursor string

+ From time.Time

+ Limit int

+ Source SignalSource

+ To time.Time

+ Type string

+ type ListTrafficSnapshotsOptions struct

+ EndDate string

+ Limit int

+ Offset int

+ Paths []string

+ StartDate string

+ type LocationKind string

+ const LocationKindCity

+ const LocationKindCountry

+ const LocationKindRegion

+ type LocationSuggestion struct

+ CityName *string

+ CountryCode string

+ DisplayName string

+ HL string

+ ID string

+ Kind LocationKind

+ LanguageLabel string

+ LocationKey string

+ RegionCode *string

+ RegionName *string

+ type LocationSuggestionsResponse struct

+ Data []LocationSuggestion

+ Meta ListMeta

+ type ManagedCompetitor struct

+ Domain string

+ ID string

+ Initials string

+ Label string

+ type Me struct

+ Email string

+ ID string

+ Name string

+ Projects []MeProject

+ type MeProject struct

+ Domain string

+ ID string

+ Name string

+ Role TeamRoleValue

+ type MigrationScope string

+ const MigrationScopeFull

+ const MigrationScopeKeywords

+ type MigrationToken struct

+ CreatedAt time.Time

+ CreatedBy MigrationTokenCreatedBy

+ ExpiresAt time.Time

+ ID string

+ Scope MigrationScope

+ SingleUse bool

+ type MigrationTokenCreatedBy struct

+ Email string

+ Name string

+ type MigrationTokensMeta struct

+ ImportJob CloudImportJob

+ NextCursor *string

+ type MintMigrationTokenInput struct

+ Scope MigrationScope

+ type NetworkError struct

+ Cause error

+ Method string

+ URL string

+ func (e *NetworkError) Error() string

+ func (e *NetworkError) Unwrap() error

+ type NotificationPreferences struct

+ AlertEmail bool

+ AlertInApp bool

+ AlertSlack bool

+ AlertWebhook bool

+ CheckEmail bool

+ CheckInApp bool

+ Email string

+ EmailVerification string

+ ImportEmail bool

+ ImportInApp bool

+ InviteEmail bool

+ InviteInApp bool

+ ProjectID string

+ SlackAvailable bool

+ WebhookAvailable bool

+ type NullableString struct

+ func NullString() NullableString

+ func StringValue(value string) NullableString

+ func (n NullableString) IsSet() bool

+ func (n NullableString) MarshalJSON() ([]byte, error)

+ func (n NullableString) Value() *string

+ type OpenAPIDocument struct

+ Components JSONValue

+ Extra map[string]any

+ Info JSONValue

+ OpenAPI string

+ Paths JSONValue

+ Servers []JSONValue

+ type Option func(*Client) error

+ func WithAPIKey(apiKey string) Option

+ func WithBaseURL(baseURL string) Option

+ func WithDefaultHeader(key, value string) Option

+ func WithHTTPClient(httpClient *http.Client) Option

+ func WithMaxRetries(maxRetries int) Option

+ func WithProjectID(projectID string) Option

+ type PageTrafficSnapshot struct

+ BounceRate *float64

+ CreatedAt time.Time

+ Date string

+ EngagementRate *float64

+ ID string

+ KeyEvents *float64

+ Path string

+ ProjectID string

+ Provider string

+ ScrollDepth *float64

+ Sessions int

+ UpdatedAt time.Time

+ VisitDurationSeconds *float64

+ Visitors *int

+ WindowDays int

+ type PageTrafficSnapshotsResponse struct

+ Offset int

+ Rows []PageTrafficSnapshot

+ TotalCount int

+ type Pager struct

+ func (p *Pager[T]) Err() error

+ func (p *Pager[T]) Item() T

+ func (p *Pager[T]) Next() bool

+ type PaginationOptions struct

+ Cursor string

+ Limit int

+ type PersonalAccessToken struct

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ ID string

+ LastUsedAt *time.Time

+ Name string

+ Prefix string

+ RevokedAt *time.Time

+ Scope TokenScope

+ type PricingModel string

+ const PricingModelFlat

+ const PricingModelPlan

+ type ProblemDetails struct

+ Detail string

+ DocsURL string

+ Errors json.RawMessage

+ Extensions map[string]json.RawMessage

+ Instance string

+ Status int

+ Title string

+ Type string

+ func (p *ProblemDetails) UnmarshalJSON(data []byte) error

+ type Project struct

+ CreatedAt time.Time

+ Domain string

+ ID string

+ Name string

+ UpdatedAt time.Time

+ WriteMode ProjectWriteMode

+ type ProjectDefaults struct

+ City *string

+ Country string

+ CronExpression *string

+ Device Device

+ Frequency RankCheckFrequency

+ JitterMinutes int

+ LastCheckedAt *time.Time

+ LocationKey string

+ NextCheckAt *time.Time

+ ProjectID string

+ SerpDepth int

+ SerpStopOnMatch bool

+ Source ProjectDefaultsSource

+ Timezone string

+ UpdatedAt *time.Time

+ type ProjectDefaultsPatch struct

+ City *string

+ Country string

+ CronExpression *string

+ Device Device

+ Frequency RankCheckFrequency

+ JitterMinutes *int

+ LocationKey string

+ SerpStopOnMatch *bool

+ Timezone string

+ type ProjectDefaultsSource string

+ const ProjectDefaultsSourceDerived

+ const ProjectDefaultsSourceExplicit

+ const ProjectDefaultsSourceFallback

+ type ProjectWriteMode string

+ const ProjectWriteModeActive

+ const ProjectWriteModeMigrated

+ const ProjectWriteModeMigrationHold

+ type Provider struct

+ CategoryID string

+ CategoryTitle string

+ Description string

+ Drawer ProviderDrawer

+ Enabled *bool

+ ID ProviderID

+ Icon string

+ LogoDomain string

+ Meta []ProviderMetaRow

+ Name string

+ Primary *bool

+ Priority *int

+ SecondaryAction string

+ Status ProviderStatus

+ Tint string

+ type ProviderConnection struct

+ CostPerCheckCents *FlexibleFloat

+ CreatedAt *time.Time

+ CredentialsHash *string

+ Enabled bool

+ ID string

+ IsPrimary bool

+ Kind ProviderKind

+ LastUsedAt *time.Time

+ Priority int

+ ProjectID string

+ Provider ProviderID

+ Status ProviderStatus

+ UpdatedAt *time.Time

+ type ProviderCredentialField struct

+ Label string

+ Name string

+ Placeholder string

+ Type string

+ type ProviderCredentialsInput struct

+ APIKey string

+ Endpoint string

+ Login string

+ Secret string

+ type ProviderDisconnectResult struct

+ OK bool

+ type ProviderDrawer struct

+ Activities []ProviderMetaRow

+ CostHelp string

+ CredentialFields []ProviderCredentialField

+ Defaults ProviderDrawerDefaults

+ EnvHint string

+ PrimaryToggleLabel string

+ type ProviderDrawerDefaults struct

+ CostPerCheck float64

+ Depth string

+ Device string

+ Enabled *bool

+ Language string

+ Location string

+ Login string

+ Primary bool

+ Priority *int

+ Secret string

+ type ProviderID string

+ const ProviderIDAhrefs

+ const ProviderIDDataForSEO

+ const ProviderIDGA4

+ const ProviderIDGSC

+ const ProviderIDPlausible

+ const ProviderIDSemrush

+ const ProviderIDSerpAPI

+ type ProviderKind string

+ const ProviderKindAnalytics

+ const ProviderKindEnrichment

+ const ProviderKindSERP

+ type ProviderMetaRow struct

+ Label string

+ Value string

+ type ProviderRate struct

+ CheckedAt string

+ Label string

+ Notes string

+ Options []ProviderRateOption

+ Plans []ProviderRatePlan

+ PricingModel PricingModel

+ ProviderID ProviderID

+ SourceURL string

+ type ProviderRateOption struct

+ Key string

+ Label string

+ ShortLabel string

+ Turnaround string

+ UnitCostCents float64

+ UnitCostUSD float64

+ type ProviderRatePlan struct

+ IncludedChecks int

+ Label string

+ MonthlyPriceCents float64

+ MonthlyPriceUSD float64

+ PlanKey string

+ type ProviderSettingsInput struct

+ Enabled *bool

+ Primary *bool

+ Priority *int

+ type ProviderStatus string

+ const ProviderStatusConnected

+ const ProviderStatusNeedsReauth

+ const ProviderStatusOptional

+ const ProviderStatusPlanned

+ const ProviderStatusReady

+ type ProviderTestResult struct

+ Balance *float64

+ Message string

+ OK bool

+ type RankCheck struct

+ Attempts []RankCheckAttempt

+ CheckedAt time.Time

+ CostCents *float64

+ Error *string

+ ID string

+ KeywordID string

+ Position *int

+ PreviousPosition *int

+ Provider string

+ RankingURL *string

+ Status string

+ type RankCheckAttempt struct

+ Message string

+ Provider string

+ type RankCheckFrequency string

+ const RankCheckFrequencyCustomCron

+ const RankCheckFrequencyDaily

+ const RankCheckFrequencyManual

+ const RankCheckFrequencyMonthly

+ const RankCheckFrequencyPaused

+ const RankCheckFrequencyWeekly

+ type RankCheckStatus string

+ const RankCheckStatusCompleted

+ const RankCheckStatusFailed

+ const RankCheckStatusRunning

+ type RankHistoryExportFormat string

+ const RankHistoryExportFormatCSV

+ const RankHistoryExportFormatJSON

+ type RankHistoryExportRange string

+ const RankHistoryExportRange30Days

+ const RankHistoryExportRange90Days

+ const RankHistoryExportRangeAll

+ type RankHistoryExportResponse struct

+ CSV string

+ Data []RankHistoryExportRow

+ Format RankHistoryExportFormat

+ Meta ListMeta

+ type RankHistoryExportRow struct

+ CheckedAt time.Time

+ ID string

+ Keyword string

+ KeywordID string

+ Position *int

+ PreviousPosition *int

+ RankingURL *string

+ type RankHistoryGranularity string

+ const RankHistoryGranularityDaily

+ const RankHistoryGranularityWeekly

+ type RankedKeywordConnection struct

+ ID string

+ Label string

+ Provider ProviderID

+ type RankedKeywordSuggestion struct

+ AlreadyTracked bool

+ EstimatedTraffic *float64

+ Keyword string

+ Position *int

+ SearchVolume *float64

+ type RankedKeywordSuggestionsResponse struct

+ Cached bool

+ Connections []RankedKeywordConnection

+ CostCents float64

+ FetchedAt time.Time

+ Offset int

+ Rows []RankedKeywordSuggestion

+ TotalCount *int

+ type RequestOption func(*requestConfig)

+ func WithIdempotencyKey(key string) RequestOption

+ func WithRequestHeader(key, value string) RequestOption

+ type ResearchKeywordsOptions struct

+ ConnectionID string

+ EstimateOnly bool

+ Fresh bool

+ IncludeClickstream bool

+ MaxCostCents int

+ Mode KeywordResearchMode

+ ResultLimit int

+ Seed string

+ type ResponseError struct

+ Body string

+ Cause error

+ Method string

+ StatusCode int

+ URL string

+ func (e *ResponseError) Error() string

+ func (e *ResponseError) Unwrap() error

+ type RevokeTeamInviteResult struct

+ ID string

+ type RevokedMigrationToken struct

+ ID string

+ RevokedAt time.Time

+ type RunRankCheckInput struct

+ Async bool

+ ProviderID string

+ type SavedView struct

+ Config SavedViewConfig

+ CreatedAt time.Time

+ CreatedByID *string

+ ID string

+ Name string

+ type SavedViewConfig struct

+ Filters SavedViewFilters

+ Search string

+ type SavedViewDeleteResult struct

+ Deleted bool

+ type SavedViewFilters struct

+ Change string

+ Contains string

+ Country string

+ Device string

+ Position []SavedViewPositionBucket

+ SERP []string

+ Tags []string

+ VolMax int

+ VolMin int

+ WrongURL bool

+ type SavedViewPositionBucket string

+ const SavedViewPosition11To50

+ const SavedViewPosition51To100

+ const SavedViewPositionTop10

+ const SavedViewPositionTop3

+ type SearchLocationsOptions struct

+ Country string

+ Limit int

+ Query string

+ type SearchPerformanceQueryStat struct

+ CTR float64

+ Clicks int

+ Impressions int

+ Page *string

+ Position float64

+ Query string

+ type SearchPerformanceQueryStatsResponse struct

+ Connection AnalyticsConnection

+ Rows []SearchPerformanceQueryStat

+ type Signal struct

+ CreatedAt time.Time

+ HappenedAt time.Time

+ ID string

+ KeywordID *string

+ Payload JSONValue

+ ProjectID string

+ PublicID string

+ Severity SignalSeverity

+ Source SignalSource

+ Type string

+ URL *string

+ type SignalSeverity string

+ const SignalSeverityCritical

+ const SignalSeverityInfo

+ const SignalSeverityWarning

+ type SignalSource string

+ const SignalSourceAPI

+ const SignalSourceCMS

+ const SignalSourceDeploy

+ const SignalSourceManual

+ const SignalSourceRankTracker

+ const SignalSourceSearchAnalytics

+ const SignalSourceSearchEngineStatus

+ const SignalSourceSitemap

+ const SignalSourceURLInspection

+ type SitemapMonitor struct

+ Enabled bool

+ ID string

+ LatestSnapshot *SitemapMonitorLatestSnapshot

+ ProjectID string

+ SitemapURL *string

+ Status SitemapMonitorStatus

+ type SitemapMonitorLatestSnapshot struct

+ FetchedAt time.Time

+ ID string

+ SitemapURL string

+ URLCount int

+ type SitemapMonitorStatus string

+ const SitemapMonitorStatusActive

+ const SitemapMonitorStatusDisabled

+ const SitemapMonitorStatusPending

+ type SuggestedCompetitor struct

+ Domain string

+ Initials string

+ Overlap int

+ type TeamInvite struct

+ Email string

+ ExpiresLabel string

+ ID string

+ InvitedLabel string

+ Role string

+ RoleValue TeamRoleValue

+ type TeamInviteResendResult struct

+ ExpiresAt time.Time

+ ID string

+ InviteLink string

+ type TeamMember struct

+ Color string

+ Email string

+ ID string

+ Initials string

+ Name string

+ Role string

+ RoleValue TeamRoleValue

+ type TeamMemberMutationResult struct

+ ID string

+ type TeamMemberRoleResult struct

+ ID string

+ Role TeamRoleValue

+ type TeamRoleValue string

+ const TeamRoleAdmin

+ const TeamRoleAuditor

+ const TeamRoleMember

+ const TeamRoleOwner

+ const TeamRoleViewer

+ type TestProviderConnectionInput struct

+ Credentials *ProviderCredentialsInput

+ Login string

+ Secret string

+ type TokenScope string

+ const TokenScopeAdmin

+ const TokenScopeRead

+ const TokenScopeWrite

+ type TrackingScope string

+ const TrackingScopeCity

+ const TrackingScopeCountry

+ type TrafficSyncRun struct

+ ConnectionID string

+ Error *string

+ ErrorClass *string

+ Provider string

+ RowsFetched int

+ RowsMatched int

+ RowsUpserted int

+ Status TrafficSyncRunStatus

+ Truncated bool

+ type TrafficSyncRunStatus string

+ const TrafficSyncRunDeferredRateLimit

+ const TrafficSyncRunFailed

+ const TrafficSyncRunNotApplicable

+ const TrafficSyncRunSucceededEmpty

+ const TrafficSyncRunSucceededWithData

+ type TrafficSyncSkipReason string

+ const TrafficSyncSkipNoCapability

+ const TrafficSyncSkipRateLimited

+ type TrafficSyncSkipped struct

+ Provider string

+ Reason TrafficSyncSkipReason

+ type TrafficSyncSummary struct

+ Connections int

+ KeywordSnapshots int

+ PageSnapshots int

+ ProjectID string

+ Runs []TrafficSyncRun

+ Skipped []TrafficSyncSkipped

+ type TriggeredAlert struct

+ Action string

+ CTAs []string

+ Current string

+ Headline string

+ ID string

+ Keyword string

+ Previous string

+ Rule string

+ Severity AlertSeverity

+ Unread bool

+ When string

+ type TriggeredAlertMuteResult struct

+ Muted bool

+ SnoozedUntil *time.Time

+ type TriggeredAlertsReadResult struct

+ Updated int

+ type UpdateAlertRuleInput = CreateAlertRuleInput

+ type UpdateKeywordInput struct

+ City *string

+ Country *string

+ Device *Device

+ Frequency *RankCheckFrequency

+ Intent NullableString

+ Keyword *string

+ Location *string

+ LocationKey *string

+ Schedule *KeywordScheduleInput

+ Tags []string

+ TargetURL NullableString

+ Topic NullableString

+ func (in UpdateKeywordInput) MarshalJSON() ([]byte, error)

+ type UpdateMeInput struct

+ Name string

+ type UpdateNotificationPreferencesInput struct

+ AlertEmail *bool

+ AlertInApp *bool

+ AlertSlack *bool

+ AlertWebhook *bool

+ CheckEmail *bool

+ CheckInApp *bool

+ ImportEmail *bool

+ ImportInApp *bool

+ InviteEmail *bool

+ InviteInApp *bool

+ type UpdateProjectInput struct

+ Domain *string

+ Name *string

+ type UpdateSitemapMonitorInput struct

+ Enabled bool

+ type UpdateTeamMemberRoleInput struct

+ Role TeamRoleValue

+ type UpdateWebhookInput struct

+ Description *string

+ Enabled *bool

+ HMACSecret string

+ URL string

+ type UpdatedNotificationPreferences struct

+ AlertEmail bool

+ AlertInApp bool

+ AlertSlack bool

+ AlertWebhook bool

+ CheckEmail bool

+ CheckInApp bool

+ ImportEmail bool

+ ImportInApp bool

+ InviteEmail bool

+ InviteInApp bool

+ ProjectID string

+ type Webhook struct

+ CreatedAt time.Time

+ Description *string

+ Enabled bool

+ ID string

+ LastDeliveryAt *time.Time

+ URL string

+ UpdatedAt time.Time

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL