{ "all_actions": [ "AsyncCallLookupAction", "BetaDataSiteMetricsBrandAuthorityFetchAction", "DataGlobalTopDomainListAction", "DataGlobalTopPageListAction", "DataKeywordMetricsDifficultyFetchAction", "DataKeywordMetricsFetchAction", "DataKeywordMetricsOpportunityFetchAction", "DataKeywordMetricsPriorityFetchAction", "DataKeywordMetricsVolumeFetchAction", "DataKeywordSearchIntentFetchAction", "DataKeywordSuggestionsListAction", "DataPingAsyncAction", "DataPingAction", "DataSiteAnchorTextListAction", "DataSiteLinkFilterAnchorTextAction", "DataSiteLinkFilterDomainAction", "DataSiteLinkIntersectFetchAction", "DataSiteLinkListAction", "DataSiteLinkStatusFetchMultipleAction", "DataSiteLinkStatusFetchAction", "DataSiteLinkingDomainFilterRecentlyGainedAction", "DataSiteLinkingDomainFilterRecentlyLostAction", "DataSiteLinkingDomainListAction", "DataSiteMetricsBrandAuthorityFetchAction", "DataSiteMetricsDistributionsFetchAction", "DataSiteMetricsFetchMultipleAction", "DataSiteMetricsFetchAction", "DataSiteMetricsHistoriesFetchAction", "DataSiteRankingKeywordCountAction", "DataSiteRankingKeywordListAction", "DataSiteRedirectFetchAction", "DataSiteTopPageListAction", "DataTestQuotaAsyncAction", "DataTestQuotaAction", "MozbarPageDetailFetchAction", "MozbarPageKeywordReportFetchAction", "MozbarPageOverviewFetchMultipleAction", "MozbarPageRankingKeywordListAction", "QuotaLookupAction", "QuotaUsageReportAction", "QuotaUsageTotalAction", "MetadataIndexFetchAction", "LocalAccountCreateAction", "LocalAccountListAction", "LocalAccountLookupAction", "LocalGroupCreateAction", "LocalGroupFilterAccountAction", "LocalGroupListAction", "LocalGroupLocationAddAction", "LocalGroupLocationListAction", "LocalGroupLocationRemoveAction", "LocalGroupLookupAction", "LocalLocationCancelAction", "LocalLocationCategoryListAction", "LocalLocationCloseAction", "LocalLocationCreateAction", "LocalLocationFilterAccountAction", "LocalLocationFilterStatusAction", "LocalLocationInsightGbpImpressionHistoryFetchAction", "LocalLocationInsightGbpImpressionTotalFetchAction", "LocalLocationInsightGbpLeadHistoryFetchAction", "LocalLocationLevelListAction", "LocalLocationLevelUpdateAction", "LocalLocationListAction", "LocalLocationListingListAction", "LocalLocationLocalGridHistoryFetchAction", "LocalLocationLocalGridKeywordListAction", "LocalLocationLookupAction", "LocalLocationNetworkFieldIssueListAction", "LocalLocationNetworkFieldStatusListAction", "LocalLocationNetworkListAction", "LocalLocationNetworkStatusListAction", "LocalLocationRankingHistoryFetchAction", "LocalLocationUpdateAction" ], "public_actions": [ "DataGlobalTopDomainListAction", "DataGlobalTopPageListAction", "DataKeywordMetricsDifficultyFetchAction", "DataKeywordMetricsFetchAction", "DataKeywordMetricsOpportunityFetchAction", "DataKeywordMetricsPriorityFetchAction", "DataKeywordMetricsVolumeFetchAction", "DataKeywordSearchIntentFetchAction", "DataKeywordSuggestionsListAction", "DataSiteAnchorTextListAction", "DataSiteLinkFilterAnchorTextAction", "DataSiteLinkFilterDomainAction", "DataSiteLinkIntersectFetchAction", "DataSiteLinkListAction", "DataSiteLinkStatusFetchMultipleAction", "DataSiteLinkStatusFetchAction", "DataSiteLinkingDomainFilterRecentlyGainedAction", "DataSiteLinkingDomainFilterRecentlyLostAction", "DataSiteLinkingDomainListAction", "DataSiteMetricsBrandAuthorityFetchAction", "DataSiteMetricsDistributionsFetchAction", "DataSiteMetricsFetchMultipleAction", "DataSiteMetricsFetchAction", "DataSiteMetricsHistoriesFetchAction", "DataSiteRankingKeywordCountAction", "DataSiteRankingKeywordListAction", "DataSiteRedirectFetchAction", "DataSiteTopPageListAction", "QuotaLookupAction", "MetadataIndexFetchAction", "LocalAccountCreateAction", "LocalAccountListAction", "LocalAccountLookupAction", "LocalGroupCreateAction", "LocalGroupFilterAccountAction", "LocalGroupListAction", "LocalGroupLocationAddAction", "LocalGroupLocationListAction", "LocalGroupLocationRemoveAction", "LocalGroupLookupAction", "LocalLocationCancelAction", "LocalLocationCategoryListAction", "LocalLocationCloseAction", "LocalLocationCreateAction", "LocalLocationFilterAccountAction", "LocalLocationFilterStatusAction", "LocalLocationInsightGbpImpressionHistoryFetchAction", "LocalLocationInsightGbpImpressionTotalFetchAction", "LocalLocationInsightGbpLeadHistoryFetchAction", "LocalLocationLevelListAction", "LocalLocationLevelUpdateAction", "LocalLocationListAction", "LocalLocationListingListAction", "LocalLocationLocalGridHistoryFetchAction", "LocalLocationLocalGridKeywordListAction", "LocalLocationLookupAction", "LocalLocationNetworkFieldIssueListAction", "LocalLocationNetworkFieldStatusListAction", "LocalLocationNetworkListAction", "LocalLocationNetworkStatusListAction", "LocalLocationRankingHistoryFetchAction", "LocalLocationUpdateAction" ], "action_namespaces": { "data": { "_title": "Data", "global": "Global", "keyword": { "_title": "Keyword", "metrics": "Metrics" }, "site": { "_title": "Site", "link": "Link", "linking-domain": "Linking Domain", "metrics": "Metrics" } }, "mozbar": { "_title": "Mozbar" }, "quota": "Quota", "metadata": "Metadata", "local": { "_title": "Local", "account": "Account", "group": { "_title": "Group", "location": "Location" }, "location": { "_title": "Location", "filter": "Filter", "insight": "Google Insights", "local": { "_title": "Local Grid" }, "network": { "_title": "Network" }, "ranking": "Ranking" } }, "async": "Async" }, "definitions": { "AsyncCallLookupActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/AsyncCallLookupActionData" } }, "required": [ "auth", "data" ], "additionalProperties": false }, "ValidAuthPayload": { "anyOf": [ { "$ref": "#/definitions/SessionIdAuthPayload" }, { "$ref": "#/definitions/TokenIdAuthPayload" }, { "$ref": "#/definitions/ApiKeyAuthPayload" } ], "description": "ValidAuth is the most basic authenticated request expectation, and allows all levels higher than itself, but can be created from either a session or api key" }, "SessionIdAuthPayload": { "type": "object", "properties": { "session_id": { "type": "string", "description": "A session_id string to authenticate as a logged in user" } }, "required": [ "session_id" ], "additionalProperties": false, "description": "SessionIdAuth is simply a representation of a passed session_id parameter. This is meant to be used to make types (e.g. see other auths below), but can be used to restrict a type of auth for downstream services e.g. Extract to only have session_id based auth accepted in the call" }, "TokenIdAuthPayload": { "type": "object", "properties": { "token_id": { "type": "string", "description": "A token_id string to authenticate as a logged in user" } }, "required": [ "token_id" ], "additionalProperties": false, "description": "TokenIdAuth is simply a representation of a passed token_id parameter. This is meant to be used to make types (e.g. see other auths below), but can be used to restrict a type of auth for downstream services e.g. Extract to only have token_id based auth accepted in the call" }, "ApiKeyAuthPayload": { "type": "object", "properties": { "apikey_id": { "type": "string", "description": "An API key to use for authenticating a request" } }, "required": [ "apikey_id" ], "additionalProperties": false, "description": "ApiKeyAuth is simply a representation of a passed apikey_id parameter. This is meant to be used to make types (e.g. see other auths below), but can be used to restrict a type of auth for downstream services e.g. Extract to only have apikey_id based auth accepted in the call" }, "AsyncCallLookupActionData": { "type": "object", "properties": { "id": { "$ref": "#/definitions/AsyncCallLookupActionDataId" } }, "required": [ "id" ], "additionalProperties": false, "examples": [ { "id": "c3397e5a-ce31-42fb-8607-ed40487aea18" } ] }, "AsyncCallLookupActionDataId": { "type": "string", "description": "The ID of the `async_call` to lookup." }, "AsyncCallLookupActionResult": { "type": "object", "properties": { "async_call": { "$ref": "#/definitions/AsyncCallObject" } }, "required": [ "async_call" ], "additionalProperties": false, "examples": [ { "async_call": { "id": "c3397e5a-ce31-42fb-8607-ed40487aea18", "action": "data.ping.async", "status": "pending", "ttl": 30, "result": null, "error": null } }, { "async_call": { "id": "3d446f53-aaba-4bdb-9d47-b1d0754bfe90", "action": "data.ping.async", "status": "complete", "ttl": 10, "result": { "message": "Hello, world." }, "error": null } }, { "async_call": { "id": "18e5de71-af54-490d-8eb1-0596a4f68121", "action": "data.ping.async", "status": "complete", "ttl": 10, "result": null, "error": { "message": "An unexpected error occurred.", "code": -32602, "status": 500, "data": { "explanation": null, "issue": null, "key": null, "value": null } } } } ] }, "AsyncCallObject": { "type": "object", "properties": { "id": { "$ref": "#/definitions/AsyncCallObjectId" }, "action": { "$ref": "#/definitions/AsyncCallObjectActionName" }, "status": { "$ref": "#/definitions/AsyncCallObjectStatus" }, "ttl": { "$ref": "#/definitions/AsyncCallObjectTtl" }, "result": { "anyOf": [ { "$ref": "#/definitions/JsonrpcResponseResult" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/definitions/JsonrpcResponseError" }, { "type": "null" } ] } }, "required": [ "id", "action", "status", "ttl", "result", "error" ], "additionalProperties": false, "description": "Represents an asynchronous request. The `result` and `error` properties will be null if the call is still in progress. Once the status is `\"complete\"`, only one of `result` or `error` will be non-null depending on whether the request was successful." }, "AsyncCallObjectId": { "type": "string", "description": "The ID of an async call. Use this to retrieve the call with `async.call.lookup`." }, "AsyncCallObjectActionName": { "type": "string", "description": "The action being tracked by an async call." }, "AsyncCallObjectStatus": { "type": "string", "enum": [ "initializing", "pending", "processing", "complete" ], "description": "The status of an async call. Expect either a `result` or `error` to be present once this is `complete`." }, "AsyncCallObjectTtl": { "type": "number", "description": "The time to live for the call (in seconds)." }, "JsonrpcResponseResult": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object" }, { "type": "null" }, { "type": "array", "items": { "type": "object" } } ] }, "description": "The result of a successful JSON-RPC request." }, "JsonrpcResponseError": { "type": "object", "properties": { "message": { "type": "string", "description": "The error message." }, "code": { "type": "number", "description": "Unique code tied to the type of error." }, "status": { "type": "number", "description": "The relevant HTTP status code for the type of error." }, "data": { "$ref": "#/definitions/JsonrpcResponseErrorData" } }, "required": [ "message", "code", "status", "data" ], "additionalProperties": false, "description": "A JSON-RPC error response." }, "JsonrpcResponseErrorData": { "type": "object", "properties": { "explanation": { "type": "string", "description": "A human-readable explanation of the error." }, "issue": { "type": "string", "description": "A machine-readable string to represent why the error is being returned." }, "key": { "type": "string", "description": "The path to the relevant input that caused the error." }, "value": { "description": "The value of the relevant input that triggered the error.", "type": "object" } }, "additionalProperties": false, "description": "Additional data to help describe the error." }, "AsyncCallLookupActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "AsyncCallLookupAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/AsyncCallLookupActionPayload" }, "result": { "$ref": "#/definitions/AsyncCallLookupActionResult" }, "quota": { "$ref": "#/definitions/AsyncCallLookupActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Fetch an `async_call` by ID to retrieve the result or error. If the call has not completed yet, both `result` and `error` will be null. Once the `status` of the call is `complete`, only one of `result` or `error` will be non-null.\n\nUpon retrieving an `async_call` that has been completed, the TTL will be updated to 10 seconds.\n\nWhile every action has a different processing time (and the documentation for each will suggest a polling interval), it is recommended to not poll the status of a call more frequently than once every 5 seconds.", "default": "Fetch Async Call" }, "BetaDataSiteMetricsBrandAuthorityFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/BetaDataSiteMetricsBrandAuthorityFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "BetaDataSiteMetricsBrandAuthorityFetchActionData": { "type": "object", "properties": { "target_query": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataTargetQueryInputQuery" }, "scope": { "$ref": "#/definitions/BrandAuthorityDataTargetQueryInputScope" }, "locale": { "$ref": "#/definitions/BrandAuthorityDataTargetQueryInputLocale" } }, "required": [ "locale", "query", "scope" ], "additionalProperties": false } }, "required": [ "target_query" ], "additionalProperties": false, "examples": [ { "target_query": { "query": "https://moz.com", "scope": "domain", "locale": "en-US" } }, { "target_query": { "query": "https://en.wikipedia.org/wiki/Fundamental_analysis", "scope": "domain", "locale": "en-US" } } ] }, "DataTargetQueryInputQuery": { "type": "string", "description": "A URL to query for." }, "BrandAuthorityDataTargetQueryInputScope": { "type": "string", "const": "domain", "description": "Brand Authority only supports the \"domain\" scope." }, "BrandAuthorityDataTargetQueryInputLocale": { "type": "string", "const": "en-US", "description": "Brand Authority currently only supports the \"en-US\" locale." }, "BetaDataSiteMetricsBrandAuthorityFetchActionResult": { "type": "object", "properties": { "metrics": { "type": "object", "properties": { "brand_authority_score": { "$ref": "#/definitions/BetaDataSiteMetricsBrandAuthorityFetchActionResultBrandAuthorityScore" } }, "required": [ "brand_authority_score" ], "additionalProperties": false }, "target_query": { "$ref": "#/definitions/DataTargetQueryObject" } }, "required": [ "metrics", "target_query" ], "additionalProperties": false, "examples": [ { "metrics": { "brand_authority_score": 57 }, "target_query": { "query": "https://moz.com", "scope": "domain", "locale": "en-US", "original_target_query": { "query": "https://moz.com/blog", "scope": "domain", "locale": "en-US" }, "suggestion": null } } ] }, "BetaDataSiteMetricsBrandAuthorityFetchActionResultBrandAuthorityScore": { "type": "number", "description": "The Brand Authority score - a value ranging from 1 (worst) to 100 (best)." }, "DataTargetQueryObject": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataTargetQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataTargetQueryInputScopes" }, "locale": { "$ref": "#/definitions/DataTargetQueryInputLocales" }, "original_target_query": { "$ref": "#/definitions/DataTargetQueryObjectOriginalTargetQuery" }, "suggestion": { "anyOf": [ { "$ref": "#/definitions/TargetSuggestionObject" }, { "type": "null" } ] } }, "required": [ "locale", "original_target_query", "query", "scope", "suggestion" ], "additionalProperties": false, "description": "Represents a parsed target query." }, "DataTargetQueryInputScopes": { "type": "string", "enum": [ "domain", "subdomain", "subfolder", "url" ], "description": "The scope to parse the query with. Providing a less detailed scope than the provided URL will alter the input. e.g. `moz.com/foo/bar` with a scope of `domain` will ultimately resolve to `moz.com`" }, "DataTargetQueryInputLocales": { "type": "string", "enum": [ "en-US", "en-GB", "en-CA", "en-AU" ], "description": "The locale to search in. Only a limited subset of locales are supported for target queries - see the acceptable values below." }, "DataTargetQueryObjectOriginalTargetQuery": { "type": "object", "additionalProperties": false, "properties": { "query": { "$ref": "#/definitions/DataTargetQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataTargetQueryInputScopes" }, "locale": { "$ref": "#/definitions/DataTargetQueryInputLocales" } }, "required": [ "locale", "query", "scope" ], "description": "A TargetQuery provides a target URL along with several options to specify how the query is run. This is returned in the response in case the user-provided TargetQuery is modified during parsing for the data retrieval process." }, "TargetSuggestionObject": { "type": "object", "properties": { "query": { "$ref": "#/definitions/TargetSuggestionObjectQuery" }, "scope": { "$ref": "#/definitions/TargetSuggestionObjectScopes" }, "locale": { "$ref": "#/definitions/TargetSuggestionObjectLocales" }, "explanation": { "$ref": "#/definitions/TargetSuggestionObjectExplanation" }, "issue": { "$ref": "#/definitions/TargetSuggestionObjectIssue" } }, "required": [ "query", "scope", "locale", "explanation", "issue" ], "additionalProperties": false, "description": "Represents a suggestion to the user for a target input in case it is determined that a better option may exist (e.g. due to redirects)." }, "TargetSuggestionObjectQuery": { "type": "string", "description": "A suggested URL to query for." }, "TargetSuggestionObjectScopes": { "type": "string", "enum": [ "domain", "subdomain", "subfolder", "url" ], "description": "The scope to parse the query with. Providing a less detailed scope than the provided URL will alter the input. e.g. `moz.com/foo/bar` with a scope of `domain` will ultimately resolve to `moz.com`" }, "TargetSuggestionObjectLocales": { "type": "string", "enum": [ "en-US", "en-GB", "en-CA", "en-AU" ], "description": "The locale to search in." }, "TargetSuggestionObjectExplanation": { "type": "string", "description": "A human readable explanation for why the suggestion is being made. e.g. \"The provided URL redirects to another page.\"" }, "TargetSuggestionObjectIssue": { "type": "string", "description": "A machine readable string to represent why the suggestion is being made. e.g. \"redirect\"" }, "BetaDataSiteMetricsBrandAuthorityFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.beta.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per call." }, "BetaDataSiteMetricsBrandAuthorityFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/BetaDataSiteMetricsBrandAuthorityFetchActionPayload" }, "result": { "$ref": "#/definitions/BetaDataSiteMetricsBrandAuthorityFetchActionResult" }, "quota": { "$ref": "#/definitions/BetaDataSiteMetricsBrandAuthorityFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "This endpoint returns a Brand Authority\u2122 score for the provided target. Use this metric to understand the strength of your website\u2019s brand, benchmark against competitors, and more.", "default": "Fetch Brand Authority" }, "DataGlobalTopDomainListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataGlobalTopDomainListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataGlobalTopDomainListActionData": { "type": "object", "properties": { "page": { "$ref": "#/definitions/DataPageInput" } }, "required": [ "page" ], "additionalProperties": false, "examples": [ {}, { "page": { "limit": 50, "n": 1 } } ] }, "DataPageInput": { "type": "object", "properties": { "n": { "$ref": "#/definitions/DataPageInputN" }, "limit": { "$ref": "#/definitions/DataPageInputLimit" } }, "additionalProperties": false, "description": "Control how much data is returned by providing a specific page number (n) and limit to the number of results in a given page." }, "DataPageInputN": { "type": "number", "description": "The page number to load.", "default": 0 }, "DataPageInputLimit": { "type": "number", "description": "The number of results per page.", "default": 50 }, "DataGlobalTopDomainListActionResult": { "type": "object", "properties": { "page": { "$ref": "#/definitions/DataPageObject" }, "top_domains": { "type": "array", "items": { "$ref": "#/definitions/DataSiteMetricsObject" } } }, "required": [ "page", "top_domains" ], "additionalProperties": false, "examples": [ { "page": { "limit": 1, "n": 0 }, "top_domains": [ { "page": "www.blogger.com/", "subdomain": "www.blogger.com", "root_domain": "www.blogger.com", "title": "", "last_crawled": "2025-04-07", "http_code": 302, "pages_to_page": 1565869660, "nofollow_pages_to_page": 143563956, "redirect_pages_to_page": 19919, "external_pages_to_page": 1565869644, "external_nofollow_pages_to_page": 143563956, "external_redirect_pages_to_page": 19919, "deleted_pages_to_page": 59175346, "root_domains_to_page": 23761419, "indirect_root_domains_to_page": 254134, "deleted_root_domains_to_page": 286480, "nofollow_root_domains_to_page": 3532975, "pages_to_subdomain": 27664371074, "nofollow_pages_to_subdomain": 6521309262, "redirect_pages_to_subdomain": 1710576, "external_pages_to_subdomain": 27664071600, "external_nofollow_pages_to_subdomain": 6521309225, "external_redirect_pages_to_subdomain": 1651010, "deleted_pages_to_subdomain": 2948413789, "root_domains_to_subdomain": 31698558, "deleted_root_domains_to_subdomain": 370994, "nofollow_root_domains_to_subdomain": 595361, "pages_to_root_domain": 27664372095, "nofollow_pages_to_root_domain": 6521309275, "redirect_pages_to_root_domain": 1710582, "external_pages_to_root_domain": 27664072621, "external_indirect_pages_to_root_domain": 124960569, "external_nofollow_pages_to_root_domain": 6521309238, "external_redirect_pages_to_root_domain": 1651016, "deleted_pages_to_root_domain": 2948414431, "root_domains_to_root_domain": 31698567, "indirect_root_domains_to_root_domain": 59294, "deleted_root_domains_to_root_domain": 370995, "nofollow_root_domains_to_root_domain": 595361, "page_authority": 100, "domain_authority": 100, "link_propensity": 0.0001562269754, "spam_score": -1, "root_domains_from_page": 0, "nofollow_root_domains_from_page": 0, "pages_from_page": 0, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 7826, "nofollow_root_domains_from_root_domain": 4704, "pages_from_root_domain": 1627126, "nofollow_pages_from_root_domain": 4937, "pages_crawled_from_root_domain": 50093782 } ] } ] }, "DataPageObject": { "type": "object", "properties": { "n": { "$ref": "#/definitions/DataPageObjectN" }, "limit": { "$ref": "#/definitions/DataPageObjectLimit" } }, "additionalProperties": false, "description": "Control how much data is returned by providing a specific page number (n) and limit to the number of results in a given page." }, "DataPageObjectN": { "type": "number", "description": "The page number to load.", "default": 0 }, "DataPageObjectLimit": { "type": "number", "description": "The number of results per page.", "default": 50 }, "DataSiteMetricsObject": { "type": "object", "properties": { "page": { "$ref": "#/definitions/Page" }, "subdomain": { "$ref": "#/definitions/Subdomain" }, "root_domain": { "$ref": "#/definitions/RootDomain" }, "title": { "$ref": "#/definitions/Title" }, "last_crawled": { "$ref": "#/definitions/LastCrawled" }, "http_code": { "$ref": "#/definitions/HttpCode" }, "pages_to_page": { "$ref": "#/definitions/PagesToPage" }, "nofollow_pages_to_page": { "$ref": "#/definitions/NofollowPagesToPage" }, "redirect_pages_to_page": { "$ref": "#/definitions/RedirectPagesToPage" }, "external_pages_to_page": { "$ref": "#/definitions/ExternalPagesToPage" }, "external_nofollow_pages_to_page": { "$ref": "#/definitions/ExternalNofollowPagesToPage" }, "external_redirect_pages_to_page": { "$ref": "#/definitions/ExternalRedirectPagesToPage" }, "deleted_pages_to_page": { "$ref": "#/definitions/DeletedPagesToPage" }, "root_domains_to_page": { "$ref": "#/definitions/RootDomainsToPage" }, "indirect_root_domains_to_page": { "$ref": "#/definitions/IndirectRootDomainsToPage" }, "deleted_root_domains_to_page": { "$ref": "#/definitions/DeletedRootDomainsToPage" }, "nofollow_root_domains_to_page": { "$ref": "#/definitions/NofollowRootDomainsToPage" }, "pages_to_subdomain": { "$ref": "#/definitions/PagesToSubdomain" }, "nofollow_pages_to_subdomain": { "$ref": "#/definitions/NofollowPagesToSubdomain" }, "redirect_pages_to_subdomain": { "$ref": "#/definitions/RedirectPagesToSubdomain" }, "external_pages_to_subdomain": { "$ref": "#/definitions/ExternalPagesToSubdomain" }, "external_nofollow_pages_to_subdomain": { "$ref": "#/definitions/ExternalNofollowPagesToSubdomain" }, "external_redirect_pages_to_subdomain": { "$ref": "#/definitions/ExternalRedirectPagesToSubdomain" }, "deleted_pages_to_subdomain": { "$ref": "#/definitions/DeletedPagesToSubdomain" }, "root_domains_to_subdomain": { "$ref": "#/definitions/RootDomainsToSubdomain" }, "deleted_root_domains_to_subdomain": { "$ref": "#/definitions/DeletedRootDomainsToSubdomain" }, "nofollow_root_domains_to_subdomain": { "$ref": "#/definitions/NofollowRootDomainsToSubdomain" }, "pages_to_root_domain": { "$ref": "#/definitions/PagesToRootDomain" }, "nofollow_pages_to_root_domain": { "$ref": "#/definitions/NofollowPagesToRootDomain" }, "redirect_pages_to_root_domain": { "$ref": "#/definitions/RedirectPagesToRootDomain" }, "external_pages_to_root_domain": { "$ref": "#/definitions/ExternalPagesToRootDomain" }, "external_indirect_pages_to_root_domain": { "$ref": "#/definitions/ExternalIndirectPagesToRootDomain" }, "external_nofollow_pages_to_root_domain": { "$ref": "#/definitions/ExternalNofollowPagesToRootDomain" }, "external_redirect_pages_to_root_domain": { "$ref": "#/definitions/ExternalRedirectPagesToRootDomain" }, "deleted_pages_to_root_domain": { "$ref": "#/definitions/DeletedPagesToRootDomain" }, "root_domains_to_root_domain": { "$ref": "#/definitions/RootDomainsToRootDomain" }, "indirect_root_domains_to_root_domain": { "$ref": "#/definitions/IndirectRootDomainsToRootDomain" }, "deleted_root_domains_to_root_domain": { "$ref": "#/definitions/DeletedRootDomainsToRootDomain" }, "nofollow_root_domains_to_root_domain": { "$ref": "#/definitions/NofollowRootDomainsToRootDomain" }, "page_authority": { "$ref": "#/definitions/PageAuthority" }, "domain_authority": { "$ref": "#/definitions/DomainAuthority" }, "link_propensity": { "$ref": "#/definitions/LinkPropensity" }, "spam_score": { "$ref": "#/definitions/SpamScore" }, "root_domains_from_page": { "$ref": "#/definitions/RootDomainsFromPage" }, "nofollow_root_domains_from_page": { "$ref": "#/definitions/NofollowRootDomainsFromPage" }, "pages_from_page": { "$ref": "#/definitions/PagesFromPage" }, "nofollow_pages_from_page": { "$ref": "#/definitions/NofollowPagesFromPage" }, "root_domains_from_root_domain": { "$ref": "#/definitions/RootDomainsFromRootDomain" }, "nofollow_root_domains_from_root_domain": { "$ref": "#/definitions/NofollowRootDomainsFromRootDomain" }, "pages_from_root_domain": { "$ref": "#/definitions/PagesFromRootDomain" }, "nofollow_pages_from_root_domain": { "$ref": "#/definitions/NofollowPagesFromRootDomain" }, "pages_crawled_from_root_domain": { "$ref": "#/definitions/PagesCrawledFromRootDomain" } }, "required": [ "page", "subdomain", "root_domain", "title", "last_crawled", "http_code", "pages_to_page", "nofollow_pages_to_page", "redirect_pages_to_page", "external_pages_to_page", "external_nofollow_pages_to_page", "external_redirect_pages_to_page", "deleted_pages_to_page", "root_domains_to_page", "indirect_root_domains_to_page", "deleted_root_domains_to_page", "nofollow_root_domains_to_page", "pages_to_subdomain", "nofollow_pages_to_subdomain", "redirect_pages_to_subdomain", "external_pages_to_subdomain", "external_nofollow_pages_to_subdomain", "external_redirect_pages_to_subdomain", "deleted_pages_to_subdomain", "root_domains_to_subdomain", "deleted_root_domains_to_subdomain", "nofollow_root_domains_to_subdomain", "pages_to_root_domain", "nofollow_pages_to_root_domain", "redirect_pages_to_root_domain", "external_pages_to_root_domain", "external_indirect_pages_to_root_domain", "external_nofollow_pages_to_root_domain", "external_redirect_pages_to_root_domain", "deleted_pages_to_root_domain", "root_domains_to_root_domain", "indirect_root_domains_to_root_domain", "deleted_root_domains_to_root_domain", "nofollow_root_domains_to_root_domain", "page_authority", "domain_authority", "link_propensity", "spam_score", "root_domains_from_page", "nofollow_root_domains_from_page", "pages_from_page", "nofollow_pages_from_page", "root_domains_from_root_domain", "nofollow_root_domains_from_root_domain", "pages_from_root_domain", "nofollow_pages_from_root_domain", "pages_crawled_from_root_domain" ], "additionalProperties": false, "description": "Represents a Site Metrics object." }, "Page": { "type": "string", "description": "The page of the target requested, after canonicalization." }, "Subdomain": { "type": "string", "description": "The subdomain of the target requested, after canonicalization." }, "RootDomain": { "type": "string", "description": "The root domain of the target requested, after canonicalization." }, "Title": { "type": "string", "description": "The title of the page seen the most recent time it has been crawled, or an empty string if the page has never been crawled." }, "LastCrawled": { "type": "string", "description": "The date the most recent time the page has been crawled in 'YYYY-MM-DD' format, or an empty string if the page has never been crawled." }, "HttpCode": { "type": "number", "description": "The status code returned by the host the most recent time the page was crawled, or 0 if the page has never been crawled. Values < 100 are reserved for internal use and indicate various types of crawl failure." }, "PagesToPage": { "type": "number", "description": "The number of unique pages currently linking to this page. Pages that link to themselves do not contribute to this count." }, "NofollowPagesToPage": { "type": "number", "description": "The number of unique pages currently linking to this page with only nofollow links. Pages that link to themselves do not contribute to this count." }, "RedirectPagesToPage": { "type": "number", "description": "The number of unique pages currently redirecting to this page. Pages that link to themselves do not contribute to this count." }, "ExternalPagesToPage": { "type": "number", "description": "The number of unique pages from a different root domain currently linking to this page." }, "ExternalNofollowPagesToPage": { "type": "number", "description": "The number of unique pages from a different root domain currently linking to this page with only nofollow links." }, "ExternalRedirectPagesToPage": { "type": "number", "description": "The number of unique pages from a different root domain currently redirecting to this page." }, "DeletedPagesToPage": { "type": "number", "description": "The number of unique pages that used to link to this page, but no longer do." }, "RootDomainsToPage": { "type": "number", "description": "The number of unique root domains currently linking to this page. Links from the same root domain as the target do not contribute to this count." }, "IndirectRootDomainsToPage": { "type": "number", "description": "The number of unique root domains currently linking to this page via a redirecting page or rel-canonical link. Link chains that are entirely within the same root domain as the target do not contribute to this count." }, "DeletedRootDomainsToPage": { "type": "number", "description": "The number of unique root domains that used to link to this page, but no longer do." }, "NofollowRootDomainsToPage": { "type": "number", "description": "The number of unique root domains currently linking to this page with only nofollow links. Links from the same root domain as the target do not contribute to this count." }, "PagesToSubdomain": { "type": "number", "description": "The number of unique pages currently linking to this subdomain. Pages that link to themselves do not contribute to this count." }, "NofollowPagesToSubdomain": { "type": "number", "description": "The number of unique pages currently linking to this subdomain with only nofollow links. Pages that link to themselves do not contribute to this count." }, "RedirectPagesToSubdomain": { "type": "number", "description": "The number of unique pages currently redirecting to this subdomain. Pages that link to themselves do not contribute to this count." }, "ExternalPagesToSubdomain": { "type": "number", "description": "The number of unique pages from a different root domain currently linking to this subdomain." }, "ExternalNofollowPagesToSubdomain": { "type": "number", "description": "The number of unique pages from a different root domain currently linking to this subdomain with only nofollow links." }, "ExternalRedirectPagesToSubdomain": { "type": "number", "description": "The number of unique pages from a different root domain currently redirecting to this subdomain." }, "DeletedPagesToSubdomain": { "type": "number", "description": "The number of unique pages that used to link to this subdomain, but no longer do." }, "RootDomainsToSubdomain": { "type": "number", "description": "The number of unique root domains currently linking to this subdomain. Links from the same root domain as the target do not contribute to this count." }, "DeletedRootDomainsToSubdomain": { "type": "number", "description": "The number of unique root domains that used to link to this subdomain, but no longer do." }, "NofollowRootDomainsToSubdomain": { "type": "number", "description": "The number of unique root domains currently linking to this subdomain with only nofollow links. Links from the same root domain as the target do not contribute to this count." }, "PagesToRootDomain": { "type": "number", "description": "The number of unique pages currently linking to this root domain. Pages that link to themselves do not contribute to this count." }, "NofollowPagesToRootDomain": { "type": "number", "description": "The number of unique pages currently linking to this root domain with only nofollow links. Pages that link to themselves do not contribute to this count." }, "RedirectPagesToRootDomain": { "type": "number", "description": "The number of unique pages currently redirecting to this root domain. Pages that link to themselves do not contribute to this count." }, "ExternalPagesToRootDomain": { "type": "number", "description": "The number of unique pages from a different root domain currently linking to this root domain." }, "ExternalIndirectPagesToRootDomain": { "type": "number", "description": "The number of unique pages from a different root domain currently linking to this page via a redirecting page or rel-canonical link." }, "ExternalNofollowPagesToRootDomain": { "type": "number", "description": "The number of unique pages from a different root domain currently linking to this root domain with only nofollow links." }, "ExternalRedirectPagesToRootDomain": { "type": "number", "description": "The number of unique pages from a different root domain currently redirecting to this root domain." }, "DeletedPagesToRootDomain": { "type": "number", "description": "The number of unique pages that used to link to this root domain, but no longer do." }, "RootDomainsToRootDomain": { "type": "number", "description": "The number of unique root domains currently linking to this root domain. Links from the same root domain as the target do not contribute to this count." }, "IndirectRootDomainsToRootDomain": { "type": "number", "description": "The number of unique root domains currently linking to this root domain via a redirecting page or rel-canonical link. Link chains that are entirely within the same root domain as the target do not contribute to this count." }, "DeletedRootDomainsToRootDomain": { "type": "number", "description": "The number of unique root domains that used to link to this root domain, but no longer do." }, "NofollowRootDomainsToRootDomain": { "type": "number", "description": "The number of unique root domains currently linking to this root domain with only nofollow links. Links from the same root domain as the target do not contribute to this count." }, "PageAuthority": { "type": "number", "description": "A score from 1 to 100 representing the likelihood that this page will rank well in search engine result pages." }, "DomainAuthority": { "type": "number", "description": "A score from 1 to 100 representing the likelihood that this root domain will rank well in search engine result pages." }, "LinkPropensity": { "type": "number", "description": "A score from 0 to 1 indicating the likelihood of the target root domain to link out to other root domains. This is currently calculated as the ratio of 'root_domains_from_root_domain' to 'pages_crawled_from_root_domain'." }, "SpamScore": { "type": "number", "description": "The spam score for the target requested, or -1 if a spam score does not exist for that target." }, "RootDomainsFromPage": { "type": "number", "description": "The unique number of root domains linked to by the target page, or 0 if the page has never been crawled." }, "NofollowRootDomainsFromPage": { "type": "number", "description": "The unique number of root domains linked to by the target page using only nofollow links, or 0 if the page has never been crawled." }, "PagesFromPage": { "type": "number", "description": "The unique number of pages linked to by the target page, or 0 if the page has never been crawled." }, "NofollowPagesFromPage": { "type": "number", "description": "The unique number of pages linked to by the target page using only nofollow links, or 0 if the page has never been crawled." }, "RootDomainsFromRootDomain": { "type": "number", "description": "The unique number of root domains linked to by the target root domain, or 0 if no pages on the root domain have ever been crawled." }, "NofollowRootDomainsFromRootDomain": { "type": "number", "description": "The unique number of root domains linked to by the target root domain using only nofollow links, or 0 if no pages on the root domain have ever been crawled." }, "PagesFromRootDomain": { "type": "number", "description": "The unique number of pages linked to by the target root domain, or 0 if no pages on the root domain have ever been crawled." }, "NofollowPagesFromRootDomain": { "type": "number", "description": "The unique number of pages linked to by the target root domain using only nofollow links, or 0 if the page has never been crawled." }, "PagesCrawledFromRootDomain": { "type": "number", "description": "The number of pages on the target root domain that have been successfully crawled (i.e., a response was received from the host, regardless of the http status code associated with that response)." }, "DataGlobalTopDomainListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "DataGlobalTopDomainListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataGlobalTopDomainListActionPayload" }, "result": { "$ref": "#/definitions/DataGlobalTopDomainListActionResult" }, "quota": { "$ref": "#/definitions/DataGlobalTopDomainListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Get the top ranking domains globally.", "default": "Get Top Ranking Domains", "title": "data.global.top-domain.list" }, "DataGlobalTopPageListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataGlobalTopPageListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataGlobalTopPageListActionData": { "type": "object", "properties": { "page": { "$ref": "#/definitions/DataPageInput" } }, "required": [ "page" ], "additionalProperties": false, "examples": [ {}, { "page": { "limit": 50, "n": 1 } } ] }, "DataGlobalTopPageListActionResult": { "type": "object", "properties": { "page": { "$ref": "#/definitions/DataPageObject" }, "top_pages": { "type": "array", "items": { "$ref": "#/definitions/DataSiteMetricsObject" } } }, "required": [ "page", "top_pages" ], "additionalProperties": false, "examples": [ { "page": { "limit": 1, "n": 0 }, "top_pages": [ { "page": "www.youtube.com/", "subdomain": "www.youtube.com", "root_domain": "youtube.com", "title": "", "last_crawled": "2025-04-06", "http_code": 302, "pages_to_page": 1137036299, "nofollow_pages_to_page": 180014631, "redirect_pages_to_page": 5858192, "external_pages_to_page": 1130643833, "external_nofollow_pages_to_page": 180014631, "external_redirect_pages_to_page": 5853509, "deleted_pages_to_page": 206334924, "root_domains_to_page": 2258502, "indirect_root_domains_to_page": 687320, "deleted_root_domains_to_page": 231531, "nofollow_root_domains_to_page": 580510, "pages_to_subdomain": 41228097268, "nofollow_pages_to_subdomain": 5911633339, "redirect_pages_to_subdomain": 157146924, "external_pages_to_subdomain": 40999301825, "external_nofollow_pages_to_subdomain": 5848909313, "external_redirect_pages_to_subdomain": 154737967, "deleted_pages_to_subdomain": 10168632649, "root_domains_to_subdomain": 26010444, "deleted_root_domains_to_subdomain": 2007963, "nofollow_root_domains_to_subdomain": 2361713, "pages_to_root_domain": 64679396434, "nofollow_pages_to_root_domain": 9635085052, "redirect_pages_to_root_domain": 300087796, "external_pages_to_root_domain": 64435538467, "external_indirect_pages_to_root_domain": 24007214543, "external_nofollow_pages_to_root_domain": 9572360127, "external_redirect_pages_to_root_domain": 283147377, "deleted_pages_to_root_domain": 14972386554, "root_domains_to_root_domain": 26860972, "indirect_root_domains_to_root_domain": 281771, "deleted_root_domains_to_root_domain": 2085989, "nofollow_root_domains_to_root_domain": 2395659, "page_authority": 100, "domain_authority": 100, "link_propensity": 0.008363260888, "spam_score": 4, "root_domains_from_page": 0, "nofollow_root_domains_from_page": 0, "pages_from_page": 0, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 405085, "nofollow_root_domains_from_root_domain": 180598, "pages_from_root_domain": 11246746, "nofollow_pages_from_root_domain": 981907, "pages_crawled_from_root_domain": 48436253 } ] } ] }, "DataGlobalTopPageListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "DataGlobalTopPageListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataGlobalTopPageListActionPayload" }, "result": { "$ref": "#/definitions/DataGlobalTopPageListActionResult" }, "quota": { "$ref": "#/definitions/DataGlobalTopPageListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Get the top ranking pages globally.", "default": "Get Top Ranking Pages", "title": "data.global.top-page.list" }, "DataKeywordMetricsDifficultyFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataKeywordMetricsDifficultyFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataKeywordMetricsDifficultyFetchActionData": { "type": "object", "properties": { "serp_query": { "$ref": "#/definitions/DataSerpQueryInput" } }, "required": [ "serp_query" ], "additionalProperties": false, "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google" } } ] }, "DataSerpQueryInput": { "type": "object", "properties": { "keyword": { "$ref": "#/definitions/DataSerpQueryInputKeyword" }, "locale": { "type": "string", "description": "The locale to search in, provided as an `hl-gl` pair - a valid Google `hl` (host language) value and a valid `gl` (country) value, joined by a hyphen, e.g. `en-US`." }, "device": { "$ref": "#/definitions/DataSerpQueryInputDevice" }, "engine": { "$ref": "#/definitions/DataSerpQueryInputEngine" }, "vicinity": { "$ref": "#/definitions/DataSerpQueryInputVicinity" } }, "required": [ "keyword", "locale", "device", "engine" ], "additionalProperties": false, "description": "The SERP query object describes a keyword or search phrase in combination with several options to specify how the query is run (i.e. how a SERP should be retrieved for this keyword if necessary)." }, "DataSerpQueryInputKeyword": { "type": "string", "description": "The keyword to query. Must be between 1 and 255 characters." }, "DataSerpQueryInputDevice": { "type": "string", "enum": [ "desktop", "mobile_android", "mobile_ios" ], "description": "The device to perform the query for." }, "DataSerpQueryInputEngine": { "type": "string", "enum": [ "google", "bing", "yahoo" ], "description": "The engine for the query." }, "DataSerpQueryInputVicinity": { "type": "string", "description": "The location to perform the search from - e.g. `New York, NY`. This field is optional and defaults to a blank string, which is interpreted as national." }, "DataKeywordMetricsDifficultyFetchActionResult": { "type": "object", "properties": { "keyword_metrics": { "$ref": "#/definitions/DataKeywordMetricsDifficultyObject" }, "serp_query": { "$ref": "#/definitions/DataSerpQueryObject" } }, "required": [ "keyword_metrics", "serp_query" ], "additionalProperties": false, "description": "Results include both the parsed Serp Query along with the keyword metrics. If a value cannot be found, a `NotFoundError` is thrown.", "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" }, "keyword_metrics": { "volume": null, "difficulty": 69, "organic_ctr": null, "priority": null } } ] }, "DataKeywordMetricsDifficultyObject": { "type": "object", "properties": { "volume": { "type": "null", "description": "Monthly search volume is not available in this endpoint. Use the full metrics endpoint to access this value." }, "difficulty": { "$ref": "#/definitions/DataKeywordMetricsObjectDifficulty", "description": "A score from 0-100 indicating how difficult it would be to rank for this keyword, where higher scores indicate greater difficulty." }, "organic_ctr": { "type": "null", "description": "Organic click-through rate is not available in this endpoint. Use the full metrics endpoint to access this value." }, "priority": { "type": "null", "description": "Priority score is not available in this endpoint. Use the full metrics endpoint to access this value." } }, "required": [ "volume", "difficulty", "organic_ctr", "priority" ], "additionalProperties": false, "description": "Available metrics for a given keyword. In this action only `difficulty` will have a value, all other metrics will always be `null`." }, "DataKeywordMetricsObjectDifficulty": { "type": [ "number", "null" ], "description": "How difficult the keyword is to rank for - between 1 and 100 with 100 being the most difficult." }, "DataSerpQueryObject": { "type": "object", "properties": { "keyword": { "$ref": "#/definitions/DataSerpQueryObjectKeyword" }, "locale": { "type": "string", "description": "The locale to search in, provided as an `hl-gl` pair - a valid Google `hl` (host language) value and a valid `gl` (country) value, joined by a hyphen, e.g. `en-US`." }, "device": { "$ref": "#/definitions/DataSerpQueryObjectDevice" }, "engine": { "$ref": "#/definitions/DataSerpQueryObjectEngine" }, "vicinity": { "$ref": "#/definitions/DataSerpQueryObjectVicinity" } }, "required": [ "keyword", "locale", "device", "engine", "vicinity" ], "additionalProperties": false, "description": "Represents a SERP query object." }, "DataSerpQueryObjectKeyword": { "type": "string", "description": "The keyword to query. Must be between 1 and 255 characters." }, "DataSerpQueryObjectDevice": { "type": "string", "enum": [ "desktop", "mobile_android", "mobile_ios" ], "description": "The device to perform the query for." }, "DataSerpQueryObjectEngine": { "type": "string", "enum": [ "google", "bing", "yahoo" ], "description": "The engine for the query." }, "DataSerpQueryObjectVicinity": { "type": "string", "description": "The location to perform the search from - e.g. `New York, NY`. This field is optional and defaults to a blank string, which is interpreted as national." }, "DataKeywordMetricsDifficultyFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per call." }, "DataKeywordMetricsDifficultyFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataKeywordMetricsDifficultyFetchActionPayload" }, "result": { "$ref": "#/definitions/DataKeywordMetricsDifficultyFetchActionResult" }, "quota": { "$ref": "#/definitions/DataKeywordMetricsDifficultyFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve the most recent difficulty metric for any keyword that exists in our database.", "default": "Fetch Difficulty" }, "DataKeywordMetricsFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataKeywordMetricsFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataKeywordMetricsFetchActionData": { "type": "object", "properties": { "serp_query": { "$ref": "#/definitions/DataSerpQueryInput" } }, "required": [ "serp_query" ], "additionalProperties": false, "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google" } }, { "serp_query": { "keyword": "beginner guide to seo", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" } }, { "serp_query": { "keyword": "best hotdog stand", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "New York, NY" } } ] }, "DataKeywordMetricsFetchActionResult": { "type": "object", "properties": { "keyword_metrics": { "$ref": "#/definitions/DataKeywordMetricsObject" }, "serp_query": { "$ref": "#/definitions/DataSerpQueryObject" } }, "required": [ "keyword_metrics", "serp_query" ], "additionalProperties": false, "description": "Results include both the parsed Serp Query along with the keyword metrics. If a value cannot be found, or an error has occurred when generating it, it will be `null`.", "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" }, "keyword_metrics": { "volume": 2200, "difficulty": 69, "organic_ctr": 79, "priority": 57 } }, { "serp_query": { "keyword": "a very obscure sample keyword", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" }, "keyword_metrics": { "volume": 0, "difficulty": 13, "organic_ctr": 27, "priority": 12 } }, { "serp_query": { "keyword": "a keyword missing some data", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" }, "keyword_metrics": { "volume": null, "difficulty": 17, "organic_ctr": 23, "priority": 8 } } ] }, "DataKeywordMetricsObject": { "type": "object", "properties": { "volume": { "$ref": "#/definitions/DataKeywordMetricsObjectVolume" }, "difficulty": { "$ref": "#/definitions/DataKeywordMetricsObjectDifficulty" }, "organic_ctr": { "$ref": "#/definitions/DataKeywordMetricsObjectOrganicCtr" }, "priority": { "$ref": "#/definitions/DataKeywordMetricsObjectPriority" } }, "required": [ "volume", "difficulty", "organic_ctr", "priority" ], "additionalProperties": false, "description": "Available metrics for a given keyword. If a value is null, it could not be calculated when the keyword was last collected." }, "DataKeywordMetricsObjectVolume": { "type": [ "number", "null" ], "description": "The approximate monthly search volume for the given keyword." }, "DataKeywordMetricsObjectOrganicCtr": { "type": [ "number", "null" ], "description": "The organic clickthrough rate for the given keyword." }, "DataKeywordMetricsObjectPriority": { "type": [ "number", "null" ], "description": "A metric on a 1-100 scale that combines volume, difficulty, and organic ctr to create a unified score indicating the overall SEO value of a particular search query." }, "DataKeywordMetricsFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_value" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_value_multiplier": { "type": "number", "const": 1 }, "max_values": { "type": "number", "const": 4 } }, "required": [ "max_values", "path", "per_value_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned value, for a max of 4. Any unavailable (null) values will be discounted from the total row usage." }, "DataKeywordMetricsFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataKeywordMetricsFetchActionPayload" }, "result": { "$ref": "#/definitions/DataKeywordMetricsFetchActionResult" }, "quota": { "$ref": "#/definitions/DataKeywordMetricsFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve the most recent difficulty, volume, organic CTR, and/or priority metrics for any keyword that exists in our database.", "default": "Fetch All" }, "DataKeywordMetricsOpportunityFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataKeywordMetricsOpportunityFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataKeywordMetricsOpportunityFetchActionData": { "type": "object", "properties": { "serp_query": { "$ref": "#/definitions/DataSerpQueryInput" } }, "required": [ "serp_query" ], "additionalProperties": false, "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google" } } ] }, "DataKeywordMetricsOpportunityFetchActionResult": { "type": "object", "properties": { "keyword_metrics": { "$ref": "#/definitions/DataKeywordMetricsOpportunityObject" }, "serp_query": { "$ref": "#/definitions/DataSerpQueryObject" } }, "required": [ "keyword_metrics", "serp_query" ], "additionalProperties": false, "description": "Results include both the parsed Serp Query along with the keyword metrics. If the value cannot be found, a `NotFoundError` is thrown.", "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" }, "keyword_metrics": { "volume": null, "difficulty": null, "organic_ctr": 79, "priority": null } } ] }, "DataKeywordMetricsOpportunityObject": { "type": "object", "properties": { "volume": { "type": "null", "description": "Monthly search volume is not available in this endpoint. Use the full metrics endpoint to access this value." }, "difficulty": { "type": "null", "description": "Difficulty score is not available in this endpoint. Use the full metrics endpoint to access this value." }, "organic_ctr": { "$ref": "#/definitions/DataKeywordMetricsObjectOrganicCtr", "description": "The organic click-through rate (CTR) represents the percentage likelihood that a user will click on an organic search result for this keyword. Ranges from 0 to 100." }, "priority": { "type": "null", "description": "Priority score is not available in this endpoint. Use the full metrics endpoint to access this value." } }, "required": [ "volume", "difficulty", "organic_ctr", "priority" ], "additionalProperties": false, "description": "Available metrics for a given keyword. In this action only `organic_ctr` will have a value, all other metrics will always be `null`." }, "DataKeywordMetricsOpportunityFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per call." }, "DataKeywordMetricsOpportunityFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataKeywordMetricsOpportunityFetchActionPayload" }, "result": { "$ref": "#/definitions/DataKeywordMetricsOpportunityFetchActionResult" }, "quota": { "$ref": "#/definitions/DataKeywordMetricsOpportunityFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve the most recent organic CTR (opportunity) metric for any keyword that exists in our database.", "default": "Fetch Opportunity (CTR)" }, "DataKeywordMetricsPriorityFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataKeywordMetricsPriorityFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataKeywordMetricsPriorityFetchActionData": { "type": "object", "properties": { "serp_query": { "$ref": "#/definitions/DataSerpQueryInput" } }, "required": [ "serp_query" ], "additionalProperties": false, "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google" } } ] }, "DataKeywordMetricsPriorityFetchActionResult": { "type": "object", "properties": { "keyword_metrics": { "$ref": "#/definitions/DataKeywordMetricsPriorityObject" }, "serp_query": { "$ref": "#/definitions/DataSerpQueryObject" } }, "required": [ "keyword_metrics", "serp_query" ], "additionalProperties": false, "description": "Results include both the parsed Serp Query along with the keyword metrics. If the value cannot be found, a `NotFoundError` is thrown.", "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" }, "keyword_metrics": { "volume": null, "difficulty": null, "organic_ctr": null, "priority": 57 } } ] }, "DataKeywordMetricsPriorityObject": { "type": "object", "properties": { "volume": { "type": "null", "description": "Monthly search volume is not available in this endpoint. Use the full metrics endpoint to access this value." }, "difficulty": { "type": "null", "description": "Difficulty score is not available in this endpoint. Use the full metrics endpoint to access this value." }, "organic_ctr": { "type": "null", "description": "Organic click-through rate is not available in this endpoint. Use the full metrics endpoint to access this value." }, "priority": { "$ref": "#/definitions/DataKeywordMetricsObjectPriority", "description": "The priority score for the keyword, ranging from 0 to 100, where higher scores indicate greater opportunity." } }, "required": [ "volume", "difficulty", "organic_ctr", "priority" ], "additionalProperties": false, "description": "Available metrics for a given keyword. In this action only `priority` will have a value, all other metrics will always be `null`." }, "DataKeywordMetricsPriorityFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per call." }, "DataKeywordMetricsPriorityFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataKeywordMetricsPriorityFetchActionPayload" }, "result": { "$ref": "#/definitions/DataKeywordMetricsPriorityFetchActionResult" }, "quota": { "$ref": "#/definitions/DataKeywordMetricsPriorityFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve the most recent priority metric for any keyword that exists in our database.", "default": "Fetch Priority" }, "DataKeywordMetricsVolumeFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataKeywordMetricsVolumeFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataKeywordMetricsVolumeFetchActionData": { "type": "object", "properties": { "serp_query": { "$ref": "#/definitions/DataSerpQueryInput" } }, "required": [ "serp_query" ], "additionalProperties": false, "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google" } } ] }, "DataKeywordMetricsVolumeFetchActionResult": { "type": "object", "properties": { "keyword_metrics": { "$ref": "#/definitions/DataKeywordMetricsVolumeObject" }, "serp_query": { "$ref": "#/definitions/DataSerpQueryObject" } }, "required": [ "keyword_metrics", "serp_query" ], "additionalProperties": false, "description": "Results include both the parsed Serp Query along with the keyword metrics. If a value cannot be found, a `NotFoundError` is thrown.", "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" }, "keyword_metrics": { "volume": 2200, "difficulty": null, "organic_ctr": null, "priority": null } } ] }, "DataKeywordMetricsVolumeObject": { "type": "object", "properties": { "volume": { "$ref": "#/definitions/DataKeywordMetricsObjectVolume", "description": "The average monthly search volume for the keyword." }, "difficulty": { "type": "null", "description": "Difficulty score is not available in this endpoint. Use the full metrics endpoint to access this value." }, "organic_ctr": { "type": "null", "description": "Organic click-through rate is not available in this endpoint. Use the full metrics endpoint to access this value." }, "priority": { "type": "null", "description": "Priority score is not available in this endpoint. Use the full metrics endpoint to access this value." } }, "required": [ "volume", "difficulty", "organic_ctr", "priority" ], "additionalProperties": false, "description": "Available metrics for a given keyword. In this action only `volume` will have a value, all other metrics will always be `null`." }, "DataKeywordMetricsVolumeFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per call." }, "DataKeywordMetricsVolumeFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataKeywordMetricsVolumeFetchActionPayload" }, "result": { "$ref": "#/definitions/DataKeywordMetricsVolumeFetchActionResult" }, "quota": { "$ref": "#/definitions/DataKeywordMetricsVolumeFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve the most recent volume metric for any keyword that exists in our database.", "default": "Fetch Volume" }, "DataKeywordSearchIntentFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataKeywordSearchIntentFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataKeywordSearchIntentFetchActionData": { "type": "object", "properties": { "serp_query": { "type": "object", "properties": { "keyword": { "$ref": "#/definitions/DataSerpQueryInputKeyword" }, "locale": { "type": "string", "enum": [ "en-AU", "en-CA", "en-GB", "en-US" ], "description": "Supports a subset of locales." }, "device": { "type": "string", "const": "desktop", "description": "Currently only supports one device." }, "engine": { "type": "string", "const": "google", "description": "Currently only supports one engine." }, "vicinity": { "$ref": "#/definitions/DataSerpQueryInputVicinity" } }, "required": [ "device", "engine", "keyword", "locale" ], "additionalProperties": false, "description": "The SERP query object describes a keyword or search phrase in combination with several options to specify how the query is run (i.e. how a SERP should be retrieved for this keyword if necessary). Search intent has a smaller set of acceptable input values for certain fields than other methods which accept SERP queries such as `fetch keyword metrics`." } }, "required": [ "serp_query" ], "additionalProperties": false, "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google" } }, { "serp_query": { "keyword": "beginner guide to seo", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" } }, { "serp_query": { "keyword": "best hotdog stand", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "New York, NY" } } ] }, "DataKeywordSearchIntentFetchActionResult": { "type": "object", "properties": { "keyword_intent": { "$ref": "#/definitions/DataKeywordSearchIntentObject" }, "serp_query": { "$ref": "#/definitions/DataSerpQueryObject" } }, "required": [ "keyword_intent", "serp_query" ], "additionalProperties": false, "description": "Results will include both the parsed Serp Query along with the keyword intent information.", "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "" }, "keyword_intent": { "primary_intents": [ "informational" ], "all_intents": [ { "label": "informational", "score": 0.59 }, { "label": "navigational", "score": 0.19 }, { "label": "commercial", "score": 0.12 }, { "label": "transactional", "score": 0.1 } ] } } ] }, "DataKeywordSearchIntentObject": { "type": "object", "properties": { "primary_intents": { "$ref": "#/definitions/KeywordSearchIntentPrimaryIntents" }, "all_intents": { "$ref": "#/definitions/KeywordSearchIntentAllIntents" } }, "required": [ "primary_intents", "all_intents" ], "additionalProperties": false, "description": "Information for the intent of a given keyword." }, "KeywordSearchIntentPrimaryIntents": { "type": "array", "items": { "$ref": "#/definitions/KeywordSearchIntentValue" }, "description": "An array of strings that name the primary (highest match) intent scores for a given keyword. Will return multiple values in the event of a tie." }, "KeywordSearchIntentValue": { "type": "string", "enum": [ "informational", "commercial", "transactional", "navigational" ], "description": "The possible values for Keyword Search Intent." }, "KeywordSearchIntentAllIntents": { "type": "array", "items": { "$ref": "#/definitions/KeywordSearchIntent" }, "description": "All intents with their scores, for reference or comparison." }, "KeywordSearchIntent": { "type": "object", "properties": { "label": { "$ref": "#/definitions/KeywordSearchIntentValue" }, "score": { "$ref": "#/definitions/KeywordSearchIntentScore" } }, "required": [ "label", "score" ], "additionalProperties": false, "description": "A specific intent and calculated score." }, "KeywordSearchIntentScore": { "type": "number", "description": "The value of how strongly the given query matches a specific intent. The value will be between 0 and 1, with higher values indicating a closer match." }, "DataKeywordSearchIntentFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per successful call." }, "DataKeywordSearchIntentFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataKeywordSearchIntentFetchActionPayload" }, "result": { "$ref": "#/definitions/DataKeywordSearchIntentFetchActionResult" }, "quota": { "$ref": "#/definitions/DataKeywordSearchIntentFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve the most recent search intent scores (navigational, informational, commercial, and transactional) for any keyword that exists in our database.", "default": "Fetch Search Intent" }, "DataKeywordSuggestionsListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataKeywordSuggestionsListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataKeywordSuggestionsListActionData": { "type": "object", "properties": { "serp_query": { "$ref": "#/definitions/DataKeywordSuggestionsListActionSerpQueryInput" }, "options": { "$ref": "#/definitions/DataKeywordSuggestionsOptionsInput" }, "page": { "$ref": "#/definitions/DataPageInput" } }, "required": [ "serp_query" ], "additionalProperties": false, "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google" } }, { "serp_query": { "keyword": "best hotdog stand", "locale": "en-US", "device": "desktop", "engine": "google", "vicinity": "New York, NY" }, "options": { "strategy": "moz_api" }, "page": { "n": 1, "limit": 25 } } ] }, "DataKeywordSuggestionsListActionSerpQueryInput": { "type": "object", "properties": { "keyword": { "$ref": "#/definitions/DataSerpQueryInputKeyword" }, "locale": { "type": "string", "description": "The locale to search in, provided as an `hl-gl` pair - a valid Google `hl` (host language) value and a valid `gl` (country) value, joined by a hyphen, e.g. `en-US`." }, "device": { "$ref": "#/definitions/DataKeywordSuggestionsListActionSerpQueryObjectDevice" }, "engine": { "$ref": "#/definitions/DataKeywordSuggestionsListActionSerpQueryObjectEngine" }, "vicinity": { "$ref": "#/definitions/DataSerpQueryInputVicinity" } }, "required": [ "device", "engine", "keyword", "locale" ], "additionalProperties": false, "description": "The SERP query object describes a keyword or search phrase in combination with several options to specify how the query is run (i.e. how a SERP should be retrieved for this keyword if necessary)." }, "DataKeywordSuggestionsListActionSerpQueryObjectDevice": { "type": "string", "const": "desktop", "description": "The device to perform the query for.", "default": "desktop" }, "DataKeywordSuggestionsListActionSerpQueryObjectEngine": { "type": "string", "const": "google", "description": "The engine for the query.", "default": "google" }, "DataKeywordSuggestionsOptionsInput": { "type": "object", "properties": { "strategy": { "$ref": "#/definitions/DataKeywordSuggestionsOptionsInputStrategy" } }, "additionalProperties": false, "description": "Options to further filter or refine which keyword suggestions are returned. Strategy will default to `default` if not provided." }, "DataKeywordSuggestionsOptionsInputStrategy": { "type": "string", "enum": [ "default", "universal" ], "description": "The algorithm to use to generate the keyword suggestions. Currently available strategies are \"default\", which combines proprietary machine learning capabilities with recent search data, and \"universal\", which uses cached data only and is designed to generate semantically-related results for any input keyword. Defaults to \"default\" if not provided.", "default": "default" }, "DataKeywordSuggestionsListActionResult": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "$ref": "#/definitions/DataKeywordSuggestionObject" } }, "serp_query": { "$ref": "#/definitions/DataSerpQueryObject" }, "options": { "$ref": "#/definitions/DataKeywordSuggestionsOptionsObject" }, "page": { "$ref": "#/definitions/DataPageObject" } }, "required": [ "suggestions", "serp_query", "options", "page" ], "additionalProperties": false, "examples": [ { "serp_query": { "keyword": "domain authority", "locale": "en-US", "device": "desktop", "engine": "google" }, "page": { "n": 0, "limit": 50 }, "options": { "strategy": "default" }, "suggestions": [ { "keyword": "domain authority", "relevance": 1 }, { "keyword": "domain authority checker", "relevance": 0.9877959194006802 }, { "keyword": "domain authority checker moz", "relevance": 0.9870885222670346 } ] } ] }, "DataKeywordSuggestionObject": { "type": "object", "properties": { "keyword": { "$ref": "#/definitions/DataKeywordSuggestionObjectKeyword" }, "relevance": { "$ref": "#/definitions/DataKeywordSuggestionObjectRelevance" } }, "required": [ "keyword", "relevance" ], "additionalProperties": false }, "DataKeywordSuggestionObjectKeyword": { "type": "string", "description": "The keyword that is suggested. Assume the same locale, engine, device, and vicinity as the provided SERP query input." }, "DataKeywordSuggestionObjectRelevance": { "type": "number", "description": "A score for how relevant the suggestion is to the provided SERP query." }, "DataKeywordSuggestionsOptionsObject": { "type": "object", "properties": { "strategy": { "$ref": "#/definitions/DataKeywordSuggestionsOptionsObjectStrategy" } }, "required": [ "strategy" ], "additionalProperties": false }, "DataKeywordSuggestionsOptionsObjectStrategy": { "type": "string", "enum": [ "default", "universal" ], "description": "The strategy used when generating suggestions." }, "DataKeywordSuggestionsListActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataKeywordSuggestionsListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataKeywordSuggestionsListActionPayload" }, "result": { "$ref": "#/definitions/DataKeywordSuggestionsListActionResult" }, "quota": { "$ref": "#/definitions/DataKeywordSuggestionsListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve a list of related keyword suggestions for a given input keyword.", "default": "List Related Keywords" }, "DataPingAsyncActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataPingAsyncActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataPingAsyncActionData": { "type": "object", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "A message to return to the caller.", "default": "Hello, world." }, "error": { "type": "boolean", "description": "If true, will throw an error.", "default": false } }, "examples": [ { "message": "Hello, world." }, { "error": true } ] }, "DataPingAsyncActionResult": { "type": "object", "properties": { "async_call": { "$ref": "#/definitions/GenericAsyncCallObject%3CDataPingActionResult%3E" } }, "required": [ "async_call" ], "additionalProperties": false, "examples": [ { "async_call": { "id": "c3397e5a-ce31-42fb-8607-ed40487aea18", "action": "data.ping.async", "status": "pending", "ttl": 30, "result": null, "error": null } }, { "async_call": { "id": "3d446f53-aaba-4bdb-9d47-b1d0754bfe90", "action": "data.ping.async", "status": "complete", "ttl": 10, "result": { "message": "Hello, world." }, "error": null } }, { "async_call": { "id": "18e5de71-af54-490d-8eb1-0596a4f68121", "action": "data.ping.async", "status": "complete", "ttl": 10, "result": null, "error": { "message": "An unexpected error occurred.", "code": -32602, "status": 500, "data": { "explanation": null, "issue": null, "key": null, "value": null } } } } ] }, "GenericAsyncCallObject": { "type": "object", "properties": { "id": { "$ref": "#/definitions/AsyncCallObjectId" }, "action": { "$ref": "#/definitions/AsyncCallObjectActionName" }, "status": { "$ref": "#/definitions/AsyncCallObjectStatus" }, "ttl": { "$ref": "#/definitions/AsyncCallObjectTtl" }, "result": { "anyOf": [ { "$ref": "#/definitions/DataPingActionResult" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/definitions/JsonrpcResponseError" }, { "type": "null" } ] } }, "required": [ "action", "error", "id", "result", "status", "ttl" ], "additionalProperties": false }, "DataPingActionResult": { "type": "object", "properties": { "message": { "type": "string", "description": "The response message." } }, "required": [ "message" ], "additionalProperties": false, "description": "Returns the message that was sent, or a default if none is provided.", "examples": [ { "message": "hello, world." } ] }, "DataPingAsyncActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "DataPingAsyncAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataPingAsyncActionPayload" }, "result": { "$ref": "#/definitions/DataPingAsyncActionResult" }, "quota": { "$ref": "#/definitions/DataPingAsyncActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Basic asynchronous action that responds with a message or an error. Intended for API clients to validate their integration with the API using asynchronous responses.", "default": "Async Ping" }, "DataPingActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataPingActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataPingActionData": { "type": "object", "properties": { "message": { "type": "string", "description": "A message to return to the caller.", "default": "Hello, world." }, "error": { "type": "boolean", "description": "If true, will throw an error.", "default": false } }, "additionalProperties": false, "examples": [ { "message": "Hi!" }, { "error": true } ] }, "DataPingActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "DataPingAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataPingActionPayload" }, "result": { "$ref": "#/definitions/DataPingActionResult" }, "quota": { "$ref": "#/definitions/DataPingActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Basic action that responds with a message or an error. Intended for API clients to validate their integration with the API.", "default": "Ping" }, "DataSiteAnchorTextListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteAnchorTextListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteAnchorTextListActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "offset": { "$ref": "#/definitions/DataSiteAnchorTextListActionDataOffsetInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "moz.com", "scope": "domain" }, "offset": { "limit": 1 } } ] }, "DataSiteQueryInput": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteQueryInputScopes" } }, "required": [ "query", "scope" ], "additionalProperties": false, "description": "A SiteQuery provides a target URL along with a scope to define how the query is parsed." }, "DataSiteQueryInputQuery": { "type": "string", "description": "A URL to query for." }, "DataSiteQueryInputScopes": { "type": "string", "enum": [ "domain", "subdomain", "subfolder", "url" ], "description": "The scope to parse the query with. Providing a less detailed scope than the provided URL will alter the input. e.g. `moz.com/foo/bar` with a scope of `domain` will ultimately resolve to `moz.com`" }, "DataSiteAnchorTextListActionDataOffsetInput": { "type": "object", "properties": { "token": { "$ref": "#/definitions/DataOffsetInputToken" }, "limit": { "$ref": "#/definitions/DataSiteAnchorTextListActionDataOffsetInputLimit" } }, "additionalProperties": false, "description": "Defines the input parameters used to retrieve anchor text data for a given target. It allows controlling the pagination, and number of results returned." }, "DataOffsetInputToken": { "type": [ "string", "null" ], "description": "The provided token for pagination, if accessing a subsequent page of results. Exclude or provide `null` to start at the beginning of a set of results. Must have a value (provided in the previous request) to access the next page of results." }, "DataSiteAnchorTextListActionDataOffsetInputLimit": { "type": "number", "description": "The number of results to return. Must be between 1 and 50.", "default": 25 }, "DataSiteAnchorTextListActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "offset": { "$ref": "#/definitions/DataOffsetObject" }, "anchor_texts": { "type": "array", "items": { "$ref": "#/definitions/DataSiteAnchorTextObject" } } }, "required": [ "site_query", "offset", "anchor_texts" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null }, "offset": { "provided_token": null, "token": "IIkQVg4s9ak8aiQ+800Sb3BlbiBzaXRlIGV4cGxvcmVy9+HnUO36uaM=", "limit": 1 }, "anchor_texts": [ { "text": "moz", "external_root_domains": 31377, "external_pages": 776762 } ] } ] }, "DataSiteQueryObject": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteQueryInputScopes" }, "original_site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "site_query_suggestion": { "anyOf": [ { "$ref": "#/definitions/SiteQuerySuggestionObject" }, { "type": "null" } ] } }, "required": [ "original_site_query", "query", "scope", "site_query_suggestion" ], "additionalProperties": false, "description": "Represents a parsed site query." }, "SiteQuerySuggestionObject": { "type": "object", "properties": { "query": { "$ref": "#/definitions/SiteQuerySuggestionObjectQuery" }, "scope": { "$ref": "#/definitions/SiteQuerySuggestionObjectScopes" }, "explanation": { "$ref": "#/definitions/SiteQuerySuggestionObjectExplanation" }, "issue": { "$ref": "#/definitions/SiteQuerySuggestionObjectIssue" } }, "required": [ "query", "scope", "explanation", "issue" ], "additionalProperties": false, "description": "Represents a suggestion to the user for a site query in case it is determined that a better option may exist (e.g. due to redirects)." }, "SiteQuerySuggestionObjectQuery": { "type": "string", "description": "A suggested URL to query for." }, "SiteQuerySuggestionObjectScopes": { "type": "string", "enum": [ "domain", "subdomain", "subfolder", "url" ], "description": "The scope to parse the query with. Providing a less detailed scope than the provided URL will alter the input. e.g. `moz.com/foo/bar` with a scope of `domain` will ultimately resolve to `moz.com`" }, "SiteQuerySuggestionObjectExplanation": { "type": "string", "description": "A human readable explanation for why the suggestion is being made. e.g. \"The provided URL redirects to another page.\"" }, "SiteQuerySuggestionObjectIssue": { "type": "string", "description": "A machine readable string to represent why the suggestion is being made. e.g. \"redirect\"" }, "DataOffsetObject": { "type": "object", "properties": { "provided_token": { "$ref": "#/definitions/DataOffsetProvidedToken" }, "token": { "$ref": "#/definitions/DataOffsetToken" }, "limit": { "$ref": "#/definitions/DataOffsetLimit" } }, "required": [ "provided_token", "token", "limit" ], "additionalProperties": false, "description": "Represents the token to provide to get the next set of results, in addition to the token that was provided (if applicable)." }, "DataOffsetProvidedToken": { "type": [ "string", "null" ], "description": "The provided offset token for the current request. Will be null if not provided." }, "DataOffsetToken": { "type": [ "string", "null" ], "description": "The next token for more results. Will be null if not available. Provide this value in the `offset > token` field of a subsequent request to access the next page of results." }, "DataOffsetLimit": { "type": "number", "description": "The number of results to return. Will match what was provided, or will be set to the default if not provided." }, "DataSiteAnchorTextObject": { "type": "object", "properties": { "text": { "type": "string", "description": "The anchor text of the link, after normalization. The steps used for normalization are: strip `HTML` tags, remove leading and trailing whitespace, replace whitespace between words with a single space, and drop all letters to lowercase. To request links with no anchor text, set this parameter to a single null character `(\"\\u0000\")`." }, "external_root_domains": { "type": "number", "description": "The number of unique root domains linking to `target` with this anchor text." }, "external_pages": { "type": "number", "description": "The number of unique pages from a different root domain linking to `target` with this anchor text." } }, "required": [ "text", "external_root_domains", "external_pages" ], "additionalProperties": false, "description": "The anchor text object." }, "DataSiteAnchorTextListActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteAnchorTextListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteAnchorTextListActionPayload" }, "result": { "$ref": "#/definitions/DataSiteAnchorTextListActionResult" }, "quota": { "$ref": "#/definitions/DataSiteAnchorTextListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get data about anchor text used to link to a specified site. This can be helpful when trying to understand how people are linking to and talking about your brand. Additionally, this information can be used for topic research to identify clusters or trends in how people are talking about (or linking to) particular sites. The data pulled from this endpoint is similar to the data seen in the [Anchor Text section of Link Explorer](/help/link-explorer/link-building/anchor-text) but does not include the **Top Links** noted in the web app.", "default": "List Anchor Texts", "title": "data.site.anchor-text.list" }, "DataSiteLinkFilterAnchorTextActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteLinkFilterAnchorTextActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteLinkFilterAnchorTextActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "anchor_text": { "$ref": "#/definitions/DataSiteLinkFilterAnchorTextActionDataAnchorTextInput" }, "options": { "type": "object", "properties": { "scope": { "$ref": "#/definitions/DataSiteLinkListOptionsInputScope" }, "subdomains_limited_to_one": { "$ref": "#/definitions/DataSiteLinkListOptionsInputSubdomainsLimitedToOneArray" }, "sort": { "type": "string", "enum": [ "source_page_authority", "source_domain_authority", "source_link_propensity", "source_spam_score" ], "description": "Value by which to sort the list of returned links. (Then keep default value + acceptable values)", "default": "source_page_authority" }, "filters": { "$ref": "#/definitions/DataSiteLinkListOptionsInputFilters" } }, "additionalProperties": false, "description": "Options for filtering links by anchor text." }, "offset": { "$ref": "#/definitions/DataSiteLinkFilterAnchorTextActionDataOffsetInput" } }, "required": [ "site_query", "anchor_text" ], "additionalProperties": false, "examples": [ { "anchor_text": "click here", "site_query": { "query": "moz.com", "scope": "domain" }, "offset": { "limit": 1 } }, { "anchor_text": null, "site_query": { "query": "moz.com", "scope": "domain" } }, { "anchor_text": "click here", "site_query": { "query": "moz.com", "scope": "domain" }, "options": { "sort": "source_spam_score", "filters": [ "external", "nofollow" ] }, "offset": { "limit": 1 } }, { "anchor_text": "click here", "site_query": { "query": "moz.com", "scope": "subdomain" }, "options": { "subdomains_limited_to_one": [ "analytics.moz.com" ], "sort": "source_page_authority", "filters": [ "external", "nofollow" ] }, "offset": { "limit": 1 } } ] }, "DataSiteLinkFilterAnchorTextActionDataAnchorTextInput": { "type": [ "string", "null" ], "description": "The anchor text provided for filtering in the original request. Pass an explicit `null` to request links with no anchor text." }, "DataSiteLinkListOptionsInputScope": { "type": "string", "enum": [ "subdomain", "domain", "page" ], "description": "If set to `subdomain` or `root_domain`, return only the best link from each source at that scope, as ordered by the `sort` parameter. The default value is `page`." }, "DataSiteLinkListOptionsInputSubdomainsLimitedToOneArray": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkListOptionsInputSubdomainsLimitedToOne" }, "description": "If set, return at most one link (the top link as ordered by the `sort` parameter) from each of the specified subdomains. If this field is set, a value must be provided in the `sort` field as well." }, "DataSiteLinkListOptionsInputSubdomainsLimitedToOne": { "type": "string", "description": "If set, return at most one link (the top link as ordered by the `sort` parameter) from each of the specified subdomains. If this field is set, a value must be provided in the `sort` field as well." }, "DataSiteLinkListOptionsInputFilters": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkListOptionsInputFilter" }, "description": "Only return links that match these filters. As many filter values as desired can be supplied, separated by `+` *(with no spaces)*, but if providing multiple filters, `external` must be one of them.\n\n**Acceptable values:** `external`, `follow`, `nofollow`, `deleted`, `not_deleted`, `redirect`, `not_redirect`, `rel_canonical`, `not_rel_canonical`, `via_redirect`, `not_via_redirect`, `via_rel_canonical`, `not_via_rel_canonical`" }, "DataSiteLinkListOptionsInputFilter": { "type": "string", "enum": [ "external", "follow", "nofollow", "deleted", "not_deleted", "redirect", "not_redirect", "rel_canonical", "not_rel_canonical", "via_redirect", "not_via_redirect", "via_rel_canonical", "not_via_rel_canonical", "gained_last_60_days", "lost_last_60_days" ], "description": "Filtering will default to `external` if none is provided. If a request needs multiple filters, `external` must be included as one.\n\n- `external` - Only return linking root domains that are external to the target domain.\n- `follow` - Only return linking root domains that have at least one followed link from the source domain to the target.\n- `nofollow` - Only return linking root domains that have all links from the source domain to the target be nofollow links.\n- `deleted` - Only return linking root domains that used to link to the target but currently do not.\n- `not_deleted` - Only return linking root domains that are currently linking to the target.\n- `redirect` - Only return linking root domains that have at least one redirect link from the source domain to the target.\n- `not_redirect` - Only return linking root domains that have all links from the source domain to the target be not redirect links.\n- `rel_canonical` - Only return linking root domains that have at least one rel-canonical link from the source domain to the target.\n- `not_rel_canonical` - Only return linking root domains that have all links from the source domain to the target be not rel-canonical links.\n- `via_redirect` - Only return linking root domains that have at least one via redirect link from the source domain to the target.\n- `not_via_redirect` - Only return linking root domains that have all links from the source domain to the target be not via redirect links.\n- `via_rel_canonical` - Only return linking root domains that have at least one via rel-canonical link from the source domain to the target.\n- `not_via_rel_canonical` - Only return linking root domains that have all links from the source domain to the target be not via rel-canonical links.\n- `gained_last_60_days` - Only return linking root domains that have gained at least one link from the source domain to the target in the last 60 days.\n- `lost_last_60_days` - Only return linking root domains that have lost at least one link from the source domain to the target in the last 60 days." }, "DataSiteLinkFilterAnchorTextActionDataOffsetInput": { "type": "object", "properties": { "token": { "$ref": "#/definitions/DataOffsetInputToken" }, "limit": { "$ref": "#/definitions/DataSiteLinkFilterAnchorTextActionDataOffsetInputLimit" } }, "additionalProperties": false, "description": "Limit and pagination controls. Optionally specify the total number of desired results and, after the first request has been made, access results on the next page of results." }, "DataSiteLinkFilterAnchorTextActionDataOffsetInputLimit": { "type": "number", "description": "The number of results to return. Must be between 1 and 50.", "default": 25 }, "DataSiteLinkFilterAnchorTextActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "offset": { "$ref": "#/definitions/DataOffsetObject" }, "links": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkObject" } }, "options": { "$ref": "#/definitions/DataSiteLinkListOptionsObject" }, "anchor_text": { "$ref": "#/definitions/DataSiteLinkFilterAnchorTextActionDataAnchorTextInput" } }, "required": [ "site_query", "offset", "links", "options", "anchor_text" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null }, "offset": { "provided_token": null, "token": "AWUcXCoqez9a", "limit": 1 }, "anchor_text": "click here", "options": { "sort": "source_page_authority", "filters": [ "external", "follow" ] }, "links": [ { "source_site_metrics": { "page": "affiliate-program.amazon.com/resource-center/how-to-scale-your-content-and-marketing-for-international-traffic", "subdomain": "affiliate-program.amazon.com", "root_domain": "amazon.com", "title": "", "last_crawled": "2024-08-09", "http_code": 302, "pages_to_page": 2, "nofollow_pages_to_page": 2, "redirect_pages_to_page": 0, "external_pages_to_page": 2, "external_nofollow_pages_to_page": 2, "external_redirect_pages_to_page": 0, "deleted_pages_to_page": 1, "root_domains_to_page": 2, "indirect_root_domains_to_page": 0, "deleted_root_domains_to_page": 1, "nofollow_root_domains_to_page": 2, "pages_to_subdomain": 5082662, "nofollow_pages_to_subdomain": 727324, "redirect_pages_to_subdomain": 16649, "external_pages_to_subdomain": 5032571, "external_nofollow_pages_to_subdomain": 727312, "external_redirect_pages_to_subdomain": 15899, "deleted_pages_to_subdomain": 763894, "root_domains_to_subdomain": 43289, "deleted_root_domains_to_subdomain": 7077, "nofollow_root_domains_to_subdomain": 9518, "pages_to_root_domain": 7001126911, "nofollow_pages_to_root_domain": 2255200385, "redirect_pages_to_root_domain": 130768965, "external_pages_to_root_domain": 6808514438, "external_indirect_pages_to_root_domain": 1032635861, "external_nofollow_pages_to_root_domain": 2251257299, "external_redirect_pages_to_root_domain": 126155120, "deleted_pages_to_root_domain": 1438153986, "root_domains_to_root_domain": 5397867, "indirect_root_domains_to_root_domain": 348824, "deleted_root_domains_to_root_domain": 412625, "nofollow_root_domains_to_root_domain": 565211, "page_authority": 55, "domain_authority": 95, "link_propensity": 0.004186744336, "spam_score": 7, "root_domains_from_page": 0, "nofollow_root_domains_from_page": 0, "pages_from_page": 0, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 43072, "nofollow_root_domains_from_root_domain": 13863, "pages_from_root_domain": 428515, "nofollow_pages_from_root_domain": 30363, "pages_crawled_from_root_domain": 10287707 }, "target_site_metrics": { "page": "moz.com/learn/seo/international-seo", "subdomain": "moz.com", "root_domain": "moz.com", "title": "International SEO Best Practices - Moz", "last_crawled": "2025-05-02", "http_code": 200, "pages_to_page": 1656, "nofollow_pages_to_page": 222, "redirect_pages_to_page": 15, "external_pages_to_page": 1605, "external_nofollow_pages_to_page": 197, "external_redirect_pages_to_page": 7, "deleted_pages_to_page": 661, "root_domains_to_page": 597, "indirect_root_domains_to_page": 47, "deleted_root_domains_to_page": 95, "nofollow_root_domains_to_page": 75, "pages_to_subdomain": 89878939, "nofollow_pages_to_subdomain": 12824122, "redirect_pages_to_subdomain": 48402042, "external_pages_to_subdomain": 68006906, "external_nofollow_pages_to_subdomain": 12818433, "external_redirect_pages_to_subdomain": 41491081, "deleted_pages_to_subdomain": 15122370, "root_domains_to_subdomain": 192914, "deleted_root_domains_to_subdomain": 28853, "nofollow_root_domains_to_subdomain": 42525, "pages_to_root_domain": 91007022, "nofollow_pages_to_root_domain": 12925064, "redirect_pages_to_root_domain": 48407316, "external_pages_to_root_domain": 68842462, "external_indirect_pages_to_root_domain": 43935332, "external_nofollow_pages_to_root_domain": 12919085, "external_redirect_pages_to_root_domain": 41494783, "deleted_pages_to_root_domain": 15732542, "root_domains_to_root_domain": 194979, "indirect_root_domains_to_root_domain": 27097, "deleted_root_domains_to_root_domain": 29667, "nofollow_root_domains_to_root_domain": 42633, "page_authority": 61, "domain_authority": 91, "link_propensity": 0.009299114347, "spam_score": 3, "root_domains_from_page": 9, "nofollow_root_domains_from_page": 0, "pages_from_page": 14, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 77491, "nofollow_root_domains_from_root_domain": 65303, "pages_from_root_domain": 295013, "nofollow_pages_from_root_domain": 235224, "pages_crawled_from_root_domain": 8333159 }, "anchor_text": "click here", "date_first_seen": "2020-01-01", "date_last_seen": "2024-04-18", "date_disappeared": "2024-08-09", "nofollow": false, "redirect": false, "rel_canonical": false, "via_redirect": false, "via_rel_canonical": false } ] } ] }, "DataSiteLinkObject": { "type": "object", "properties": { "source_site_metrics": { "$ref": "#/definitions/DataSiteMetricsObject" }, "target_site_metrics": { "$ref": "#/definitions/DataSiteMetricsObject" }, "anchor_text": { "$ref": "#/definitions/DataSiteLinkObjectAnchorText" }, "date_first_seen": { "$ref": "#/definitions/DataSiteLinkObjectDateFirstSeen" }, "date_last_seen": { "$ref": "#/definitions/DataSiteLinkObjectDateLastSeen" }, "date_disappeared": { "$ref": "#/definitions/DataSiteLinkObjectDateDisappeared" }, "nofollow": { "$ref": "#/definitions/DataSiteLinkObjectNofollow" }, "redirect": { "$ref": "#/definitions/DataSiteLinkObjectRedirect" }, "rel_canonical": { "$ref": "#/definitions/DataSiteLinkObjectRelCanonical" }, "via_redirect": { "$ref": "#/definitions/DataSiteLinkObjectViaRedirect" }, "via_rel_canonical": { "$ref": "#/definitions/DataSiteLinkObjectViaRelCanonical" } }, "required": [ "source_site_metrics", "target_site_metrics", "anchor_text", "date_first_seen", "date_last_seen", "date_disappeared", "nofollow", "redirect", "rel_canonical", "via_redirect", "via_rel_canonical" ], "additionalProperties": false, "description": "A single link to the target." }, "DataSiteLinkObjectAnchorText": { "type": "string", "description": "The anchor text of the link." }, "DataSiteLinkObjectDateFirstSeen": { "type": "string", "description": "The date the link was first seen." }, "DataSiteLinkObjectDateLastSeen": { "type": "string", "description": "The date the link was last seen." }, "DataSiteLinkObjectDateDisappeared": { "type": [ "string", "null" ], "description": "The date the link disappeared." }, "DataSiteLinkObjectNofollow": { "type": "boolean", "description": "Whether the link is a nofollow link." }, "DataSiteLinkObjectRedirect": { "type": "boolean", "description": "Whether the link is a redirect link." }, "DataSiteLinkObjectRelCanonical": { "type": "boolean", "description": "Whether the link is a rel-canonical link." }, "DataSiteLinkObjectViaRedirect": { "type": "boolean", "description": "Whether the link is a via redirect link." }, "DataSiteLinkObjectViaRelCanonical": { "type": "boolean", "description": "Whether the link is a via rel-canonical link." }, "DataSiteLinkListOptionsObject": { "type": "object", "properties": { "scope": { "$ref": "#/definitions/DataSiteLinkListOptionsOutputScope" }, "subdomains_limited_to_one": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkListOptionsOutputSubdomainsLimitedToOne" } }, "sort": { "$ref": "#/definitions/DataSiteLinkListOptionsObjectSort" }, "filters": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkListOptionsObjectFilter" } } }, "required": [ "scope", "subdomains_limited_to_one", "sort", "filters" ], "additionalProperties": false, "description": "Echoes back the parameters provided in the original request." }, "DataSiteLinkListOptionsOutputScope": { "type": "string", "enum": [ "subdomain", "domain", "page" ], "description": "If set to `subdomain` or `root_domain`, return only the best link from each source at that scope, as ordered by the `sort` parameter. The default value is `page`." }, "DataSiteLinkListOptionsOutputSubdomainsLimitedToOne": { "type": "string", "description": "If set, only return the best link from each of the subdomains specified, as ordered by the 'sort' parameter. The default value is an empty array (e.g. do not limit subdomains to one)." }, "DataSiteLinkListOptionsObjectSort": { "type": "string", "enum": [ "root_domains_to_source_root_domain", "root_domains_to_source_page", "source_page_authority", "source_domain_authority", "source_link_propensity", "source_spam_score" ], "description": "The order to return links in. Results are returned in descending order (higher values first)." }, "DataSiteLinkListOptionsObjectFilter": { "type": "string", "enum": [ "external", "follow", "nofollow", "deleted", "not_deleted", "redirect", "not_redirect", "rel_canonical", "not_rel_canonical", "via_redirect", "not_via_redirect", "via_rel_canonical", "not_via_rel_canonical", "gained_last_60_days", "lost_last_60_days" ], "description": "Filtering will default to `external` if none is provided. If a request needs multiple filters, `external` must be included as one.\n\n- `external` - Only return linking root domains that are external to the target domain.\n- `follow` - Only return linking root domains that have at least one followed link from the source domain to the target.\n- `nofollow` - Only return linking root domains that have all links from the source domain to the target be nofollow links.\n- `deleted` - Only return linking root domains that used to link to the target but currently do not.\n- `not_deleted` - Only return linking root domains that are currently linking to the target.\n- `redirect` - Only return linking root domains that have at least one redirect link from the source domain to the target.\n- `not_redirect` - Only return linking root domains that have all links from the source domain to the target be not redirect links.\n- `rel_canonical` - Only return linking root domains that have at least one rel-canonical link from the source domain to the target.\n- `not_rel_canonical` - Only return linking root domains that have all links from the source domain to the target be not rel-canonical links.\n- `via_redirect` - Only return linking root domains that have at least one via redirect link from the source domain to the target.\n- `not_via_redirect` - Only return linking root domains that have all links from the source domain to the target be not via redirect links.\n- `via_rel_canonical` - Only return linking root domains that have at least one via rel-canonical link from the source domain to the target.\n- `not_via_rel_canonical` - Only return linking root domains that have all links from the source domain to the target be not via rel-canonical links.\n- `gained_last_60_days` - Only return linking root domains that have gained at least one link from the source domain to the target in the last 60 days.\n- `lost_last_60_days` - Only return linking root domains that have lost at least one link from the source domain to the target in the last 60 days." }, "DataSiteLinkFilterAnchorTextActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteLinkFilterAnchorTextAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteLinkFilterAnchorTextActionPayload" }, "result": { "$ref": "#/definitions/DataSiteLinkFilterAnchorTextActionResult" }, "quota": { "$ref": "#/definitions/DataSiteLinkFilterAnchorTextActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get a list of links to a target where the anchor text exactly matches a particular string.", "default": "Filter Link by Anchor Text" }, "DataSiteLinkFilterDomainActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteLinkFilterDomainActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteLinkFilterDomainActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "domain_site_query": { "$ref": "#/definitions/DataSiteLinkFilterDomainListDomainDataSiteQueryInput" }, "options": { "$ref": "#/definitions/DataSiteLinkFilterDomainListDataSiteLinkListOptionsInput" }, "offset": { "$ref": "#/definitions/DataSiteLinkFilterDomainActionDataOffsetInput" } }, "required": [ "site_query", "domain_site_query" ], "additionalProperties": false, "examples": [ { "domain_site_query": { "query": "moz.com", "scope": "domain" }, "site_query": { "query": "getstat.com", "scope": "domain" }, "offset": { "limit": 1 } }, { "domain_site_query": { "query": "moz.com", "scope": "domain" }, "site_query": { "query": "getstat.com", "scope": "domain" }, "options": { "filters": [ "external", "follow" ] }, "offset": { "limit": 1 } }, { "anchor_text": "click here", "domain_site_query": { "query": "moz.com", "scope": "domain" }, "site_query": { "query": "getstat.com", "scope": "domain" }, "options": { "subdomains_limited_to_one": [ "analytics.moz.com" ], "sort": "source_page_authority", "filters": [ "external", "nofollow" ] }, "offset": { "limit": 1 } } ] }, "DataSiteLinkFilterDomainListDomainDataSiteQueryInput": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteLinkFilterDomainListDomainDataSiteQueryInputScope" } }, "required": [ "query", "scope" ], "additionalProperties": false, "description": "Specify the source domain to filter by. Must be a fully resolved site_query with a scope of `domain`." }, "DataSiteLinkFilterDomainListDomainDataSiteQueryInputScope": { "type": "string", "const": "domain", "description": "The scope of the domain to filter by.", "default": "domain" }, "DataSiteLinkFilterDomainListDataSiteLinkListOptionsInput": { "type": "object", "properties": { "scope": { "$ref": "#/definitions/DataSiteLinkListOptionsInputScope" }, "subdomains_limited_to_one": { "$ref": "#/definitions/DataSiteLinkListOptionsInputSubdomainsLimitedToOneArray" }, "sort": { "$ref": "#/definitions/DataSiteLinkFilterDomainListDataSiteLinkListOptionsInputSort" }, "filters": { "$ref": "#/definitions/DataSiteLinkFilterDomainListDataSiteLinkListOptionsInputFilters" } }, "additionalProperties": false, "description": "Options for filtering links by domain." }, "DataSiteLinkFilterDomainListDataSiteLinkListOptionsInputSort": { "type": "string", "const": "source_page_authority", "description": "Filtering by domain only allows sorting by `source_page_authority`. This will default to that value if none is provided.", "default": "source_page_authority" }, "DataSiteLinkFilterDomainListDataSiteLinkListOptionsInputFilters": { "type": "array", "items": { "type": "string", "enum": [ "external", "follow", "nofollow", "deleted", "not_deleted", "gained_last_60_days", "lost_last_60_days" ], "description": "Only return links that match these filters. As many filter values as desired can be supplied in the array, but if providing multiple filters, `external` must be one of them.\n\n**Acceptable values:** `external`, `follow`, `nofollow`, `deleted`, `not_deleted`, `gained_last_60_days`, `lost_last_60_days`.", "default": [ "external" ] }, "description": "Only return links that match these filters. As many filter values as desired can be supplied in the array, but if providing multiple filters, `external` must be one of them.\n\n**Acceptable values:** `external`, `follow`, `nofollow`, `deleted`, `not_deleted`, `gained_last_60_days`, `lost_last_60_days`.", "default": [ "external" ] }, "DataSiteLinkFilterDomainActionDataOffsetInput": { "type": "object", "properties": { "token": { "$ref": "#/definitions/DataOffsetInputToken" }, "limit": { "$ref": "#/definitions/DataSiteLinkFilterDomainActionDataOffsetInputLimit" } }, "additionalProperties": false, "description": "Limit and pagination controls. Optionally specify the total number of desired results and, after the first request has been made, access results on the next page of results." }, "DataSiteLinkFilterDomainActionDataOffsetInputLimit": { "type": "number", "description": "The number of results to return. Must be between 1 and 50.", "default": 25 }, "DataSiteLinkFilterDomainActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "domain_site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "offset": { "$ref": "#/definitions/DataOffsetObject" }, "links": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkObject" } }, "options": { "$ref": "#/definitions/DataSiteLinkListOptionsObject" } }, "required": [ "site_query", "domain_site_query", "offset", "links", "options" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://getstat.com", "scope": "domain", "original_site_query": { "query": "getstat.com", "scope": "domain" }, "site_query_suggestion": null }, "domain_site_query": { "original_site_query": { "query": "getstat.com", "scope": "domain" }, "site_query_suggestion": null, "query": "https://getstat.com", "scope": "domain" }, "offset": { "provided_token": null, "token": "AW5SUhawd1xt", "limit": 1 }, "links": [ { "source_site_metrics": { "page": "ahrefs.com/blog/featured-snippets-study/", "subdomain": "ahrefs.com", "root_domain": "ahrefs.com", "title": "Ahrefs' Study Of 2 Million Featured Snippets: 10 Important Takeaways", "last_crawled": "2025-05-02", "http_code": 200, "pages_to_page": 4549, "nofollow_pages_to_page": 684, "redirect_pages_to_page": 30, "external_pages_to_page": 4448, "external_nofollow_pages_to_page": 678, "external_redirect_pages_to_page": 20, "deleted_pages_to_page": 1125, "root_domains_to_page": 2043, "indirect_root_domains_to_page": 69, "deleted_root_domains_to_page": 325, "nofollow_root_domains_to_page": 327, "pages_to_subdomain": 18899682, "nofollow_pages_to_subdomain": 556711, "redirect_pages_to_subdomain": 358104, "external_pages_to_subdomain": 3255512, "external_nofollow_pages_to_subdomain": 553096, "external_redirect_pages_to_subdomain": 125457, "deleted_pages_to_subdomain": 6107340, "root_domains_to_subdomain": 117014, "deleted_root_domains_to_subdomain": 22689, "nofollow_root_domains_to_subdomain": 25198, "pages_to_root_domain": 20148211, "nofollow_pages_to_root_domain": 722423, "redirect_pages_to_root_domain": 362303, "external_pages_to_root_domain": 3584203, "external_indirect_pages_to_root_domain": 244418, "external_nofollow_pages_to_root_domain": 574639, "external_redirect_pages_to_root_domain": 126856, "deleted_pages_to_root_domain": 6718900, "root_domains_to_root_domain": 120595, "indirect_root_domains_to_root_domain": 1387, "deleted_root_domains_to_root_domain": 23821, "nofollow_root_domains_to_root_domain": 25643, "page_authority": 64, "domain_authority": 85, "link_propensity": 0.005104495212, "spam_score": 1, "root_domains_from_page": 13, "nofollow_root_domains_from_page": 2, "pages_from_page": 18, "nofollow_pages_from_page": 3, "root_domains_from_root_domain": 3767, "nofollow_root_domains_from_root_domain": 465, "pages_from_root_domain": 19539, "nofollow_pages_from_root_domain": 7034, "pages_crawled_from_root_domain": 737977 }, "target_site_metrics": { "page": "getstat.com/blog/featured-snippets/", "subdomain": "getstat.com", "root_domain": "getstat.com", "title": "", "last_crawled": "2025-05-05", "http_code": 301, "pages_to_page": 858, "nofollow_pages_to_page": 170, "redirect_pages_to_page": 4, "external_pages_to_page": 856, "external_nofollow_pages_to_page": 170, "external_redirect_pages_to_page": 4, "deleted_pages_to_page": 137, "root_domains_to_page": 454, "indirect_root_domains_to_page": 54, "deleted_root_domains_to_page": 76, "nofollow_root_domains_to_page": 86, "pages_to_subdomain": 49331, "nofollow_pages_to_subdomain": 3438, "redirect_pages_to_subdomain": 4153, "external_pages_to_subdomain": 42457, "external_nofollow_pages_to_subdomain": 3438, "external_redirect_pages_to_subdomain": 213, "deleted_pages_to_subdomain": 8138, "root_domains_to_subdomain": 4222, "deleted_root_domains_to_subdomain": 1448, "nofollow_root_domains_to_subdomain": 730, "pages_to_root_domain": 68901, "nofollow_pages_to_root_domain": 3790, "redirect_pages_to_root_domain": 4248, "external_pages_to_root_domain": 52073, "external_indirect_pages_to_root_domain": 13366, "external_nofollow_pages_to_root_domain": 3788, "external_redirect_pages_to_root_domain": 217, "deleted_pages_to_root_domain": 16138, "root_domains_to_root_domain": 5282, "indirect_root_domains_to_root_domain": 27, "deleted_root_domains_to_root_domain": 984, "nofollow_root_domains_to_root_domain": 765, "page_authority": 49, "domain_authority": 46, "link_propensity": 0.004296754021, "spam_score": 4, "root_domains_from_page": 0, "nofollow_root_domains_from_page": 0, "pages_from_page": 0, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 139, "nofollow_root_domains_from_root_domain": 0, "pages_from_root_domain": 473, "nofollow_pages_from_root_domain": 0, "pages_crawled_from_root_domain": 32350 }, "anchor_text": "a recent study from getstat", "date_first_seen": "2018-07-07", "date_last_seen": "2025-05-02", "date_disappeared": "2023-01-13", "nofollow": false, "redirect": false, "rel_canonical": false, "via_redirect": false, "via_rel_canonical": false } ], "options": { "sort": "source_page_authority", "filters": [ "external", "follow" ] } } ] }, "DataSiteLinkFilterDomainActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteLinkFilterDomainAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteLinkFilterDomainActionPayload" }, "result": { "$ref": "#/definitions/DataSiteLinkFilterDomainActionResult" }, "quota": { "$ref": "#/definitions/DataSiteLinkFilterDomainActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to find links pointing to a target only if they originate from a particular root domain. Results sorted by descending page authority.", "default": "Filter Links by Domain", "title": "data.site.link.filter.domain" }, "DataSiteLinkIntersectFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteLinkIntersectFetchActionData": { "type": "object", "properties": { "is_linking_to": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionDataPositiveSiteQueries" }, "not_linking_to": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionDataNegativeSiteQueries" }, "options": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionDataSiteLinkIntersectOptionsInput" }, "offset": { "$ref": "#/definitions/DataSiteLinkIntersectActionDataOffsetInput" } }, "required": [ "is_linking_to" ], "additionalProperties": false, "examples": [ { "is_linking_to": [ { "query": "latimes.com", "scope": "domain" }, { "query": "http://blog.nytimes.com", "scope": "subdomain" } ], "not_linking_to": [ { "query": "moz.com", "scope": "domain" } ] }, { "options": { "minimum_matching_targets": 1, "scope": "domain", "sort": "source_domain_authority" }, "offset": { "limit": 1 }, "is_linking_to": [ { "query": "latimes.com", "scope": "domain" }, { "query": "http://blog.nytimes.com", "scope": "subdomain" } ], "not_linking_to": [ { "query": "moz.com", "scope": "domain" } ] } ] }, "DataSiteLinkIntersectFetchActionDataPositiveSiteQueries": { "type": "array", "items": { "$ref": "#/definitions/DataSiteQueryInput" }, "description": "Get sources that link to at least one of the provided sites, or more if `minimum_matching_targets` is set (see description of `minimum_matching_targets` below). Up to 6 total targets may be specified in the `is_linking_to` and `not_linking_to` fields combined, and at least one target must be specified in `is_linking_to`." }, "DataSiteLinkIntersectFetchActionDataNegativeSiteQueries": { "type": "array", "items": { "$ref": "#/definitions/DataSiteQueryInput" }, "description": "Optionally, ensure that the returned sources that do not link to any of the provided sites." }, "DataSiteLinkIntersectFetchActionDataSiteLinkIntersectOptionsInput": { "type": "object", "properties": { "minimum_matching_targets": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionDataSiteLinkIntersectOptionsInputMinimumMatchingTargets" }, "scope": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionDataSiteLinkIntersectOptionsInputScope" }, "sort": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionDataSiteLinkIntersectOptionsInputSort" } }, "additionalProperties": false, "examples": [ { "scope": "domain", "sort": "source_domain_authority", "minimum_matching_targets": 1 } ] }, "DataSiteLinkIntersectFetchActionDataSiteLinkIntersectOptionsInputMinimumMatchingTargets": { "type": [ "number", "null" ], "description": "The minimum number of positive targets in `is_linking_to` that a result must match to be returned. Can be between 1 and the length of the `is_linking_to` array, or left blank (which is equivalent to defaulting to 1, i.e. requiring only one positive match from the `is_linking_to` array).", "default": null }, "DataSiteLinkIntersectFetchActionDataSiteLinkIntersectOptionsInputScope": { "type": "string", "enum": [ "page", "domain" ], "description": "The scope of the source to return.", "default": "page" }, "DataSiteLinkIntersectFetchActionDataSiteLinkIntersectOptionsInputSort": { "type": "string", "enum": [ "matching_target_count", "source_spam_score", "source_domain_authority" ], "description": "The order to return results in. Results are returned in descending order (higher values first).", "default": "matching_target_count" }, "DataSiteLinkIntersectActionDataOffsetInput": { "type": "object", "properties": { "token": { "$ref": "#/definitions/DataOffsetInputToken" }, "limit": { "$ref": "#/definitions/DataSiteLinkIntersectActionDataOffsetInputLimit" } }, "additionalProperties": false, "description": "Limit and pagination controls. Optionally specify the total number of desired results and, after the first request has been made, access results on the next page of results.", "default": 25 }, "DataSiteLinkIntersectActionDataOffsetInputLimit": { "type": "number", "description": "The number of results to return. Must be between 1 and 50. Defaults to 25." }, "DataSiteLinkIntersectFetchActionResult": { "type": "object", "properties": { "is_linking_to": { "type": "array", "items": { "$ref": "#/definitions/DataSiteQueryObject" } }, "not_linking_to": { "type": "array", "items": { "$ref": "#/definitions/DataSiteQueryObject" } }, "options": { "$ref": "#/definitions/DataSiteLinkIntersectOptionsObject" }, "offset": { "$ref": "#/definitions/DataOffsetObject" }, "link_intersects": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkIntersectObject" } } }, "required": [ "is_linking_to", "not_linking_to", "options", "offset", "link_intersects" ], "additionalProperties": false, "examples": [ { "is_linking_to": [ { "query": "https://latimes.com", "scope": "domain", "original_site_query": { "query": "latimes.com", "scope": "domain" }, "site_query_suggestion": null }, { "query": "http://blog.nytimes.com", "scope": "subdomain", "original_site_query": { "query": "http://blog.nytimes.com", "scope": "subdomain" }, "site_query_suggestion": null } ], "not_linking_to": [ { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null } ], "offset": { "provided_token": null, "token": "ASP+gHcla1GA", "limit": 1 }, "options": { "minimum_matching_targets": null, "scope": "page", "sort": "matching_target_count" }, "link_intersects": [ { "page": "www.google.com/amp/www.latimes.com/local/lanow/la-me-ln-aliso-viejo-shooting-20171012-story,amp.html", "title": "", "domain_authority": 100, "spam_score": 8, "matching_target_indexes": [ 0 ] } ] } ] }, "DataSiteLinkIntersectOptionsObject": { "type": "object", "properties": { "minimum_matching_targets": { "$ref": "#/definitions/DataSiteLinkIntersectOptionsObjectMinimumMatchingTargets" }, "scope": { "$ref": "#/definitions/DataSiteLinkIntersectOptionsObjectScope" }, "sort": { "$ref": "#/definitions/DataSiteLinkIntersectOptionsObjectSort" } }, "required": [ "minimum_matching_targets", "scope", "sort" ], "additionalProperties": false, "description": "Echoes back the parameters provided in the original request." }, "DataSiteLinkIntersectOptionsObjectMinimumMatchingTargets": { "type": [ "number", "null" ], "description": "If set, only results that match at least this many positive targets will be returned." }, "DataSiteLinkIntersectOptionsObjectScope": { "type": "string", "enum": [ "page", "domain" ], "description": "The scope of the source to return." }, "DataSiteLinkIntersectOptionsObjectSort": { "type": "string", "enum": [ "matching_target_count", "source_spam_score", "source_domain_authority" ], "description": "The order to return results in. Results are returned in descending order (higher values first)." }, "DataSiteLinkIntersectObject": { "type": "object", "properties": { "page": { "$ref": "#/definitions/DataSiteLinkIntersectObjectPage" }, "title": { "$ref": "#/definitions/DataSiteLinkIntersectObjectTitle" }, "domain_authority": { "$ref": "#/definitions/DataSiteLinkIntersectObjectDomainAuthority" }, "spam_score": { "$ref": "#/definitions/DataSiteLinkIntersectObjectSpamScore" }, "matching_target_indexes": { "$ref": "#/definitions/DataSiteLinkIntersectObjectMatchingTargetIndexes" }, "matching_source_pages": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkIntersectObjectMatchingSourcePage" } } }, "required": [ "page", "title", "domain_authority", "spam_score", "matching_target_indexes" ], "additionalProperties": false, "description": "The list of links matching the parameters specified in the original request." }, "DataSiteLinkIntersectObjectPage": { "type": "string", "description": "The url of the source, after canonicalization." }, "DataSiteLinkIntersectObjectTitle": { "type": "string", "description": "If the 'source_scope' request parameter is 'page', the title of the source page seen the most recent time it has been crawled. If the 'source_scope' request parameter is 'root_domain', this element will always be blank." }, "DataSiteLinkIntersectObjectDomainAuthority": { "type": "number", "description": "A score from 1 to 100 representing the likelihood that the source root domain will rank well in search engine result pages." }, "DataSiteLinkIntersectObjectSpamScore": { "type": "number", "description": "The spam score for the source, or -1 if a spam score does not exist for that source" }, "DataSiteLinkIntersectObjectMatchingTargetIndexes": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkIntersectObjectMatchingTargetIndex" }, "description": "An array of indexes into the 'positive_targets' request parameter, with one entry for each positive target this source links to. The values in this array are sorted in ascending order." }, "DataSiteLinkIntersectObjectMatchingTargetIndex": { "type": "number", "description": "The index of the positive target that this source links to." }, "DataSiteLinkIntersectObjectMatchingSourcePage": { "type": "object", "properties": { "page": { "$ref": "#/definitions/DataSiteLinkIntersectObjectPage" }, "page_authority": { "$ref": "#/definitions/DataSiteLinkIntersectObjectPageAuthority" } }, "required": [ "page", "page_authority" ], "additionalProperties": false, "description": "The source page, after canonicalization. Will only be present if the provided `options.scope` is `domain`." }, "DataSiteLinkIntersectObjectPageAuthority": { "type": "number", "description": "A score from 1 to 100 representing the likelihood that this page will rank well in search engine result pages." }, "DataSiteLinkIntersectFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "path": { "type": "string", "const": "api.limits.data.rows" } }, "required": [ "path", "type" ], "additionalProperties": false, "description": "Uses N quota per result, where `N` is the total quantity of items in `is_linking_to` and `not_linking_to`." }, "DataSiteLinkIntersectFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionPayload" }, "result": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionResult" }, "quota": { "$ref": "#/definitions/DataSiteLinkIntersectFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "This endpoint returns information about sites that point to two or more specified domains, or that point at some domains but not others. It can be thought of as a Venn diagram or set construction tool for links.", "default": "Fetch Link Intersects", "title": "data.site.link.intersect.fetch" }, "DataSiteLinkListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteLinkListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteLinkListActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "options": { "$ref": "#/definitions/DataSiteLinkListActionOptionsInput" }, "offset": { "$ref": "#/definitions/DataSiteLinkListActionDataOffsetInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "moz.com/blog", "scope": "url" } }, { "site_query": { "query": "moz.com", "scope": "domain" }, "options": { "sort": "source_link_propensity", "filters": [ "external", "follow" ] }, "offset": { "limit": 50 } } ] }, "DataSiteLinkListActionOptionsInput": { "type": "object", "properties": { "scope": { "$ref": "#/definitions/DataSiteLinkListOptionsInputScope" }, "subdomains_limited_to_one": { "$ref": "#/definitions/DataSiteLinkListOptionsInputSubdomainsLimitedToOneArray" }, "sort": { "$ref": "#/definitions/DataSiteLinkListActionOptionsInputSort" }, "filters": { "$ref": "#/definitions/DataSiteLinkListActionOptionsInputFilters" } }, "additionalProperties": false, "description": "Options for fetching linking domains." }, "DataSiteLinkListActionOptionsInputSort": { "$ref": "#/definitions/DataSiteLinkListOptionsInputSort", "description": "The order to return links in. Results are returned in descending order (higher values first).", "default": "source_page_authority" }, "DataSiteLinkListOptionsInputSort": { "type": "string", "enum": [ "root_domains_to_source_root_domain", "root_domains_to_source_page", "source_page_authority", "source_domain_authority", "source_link_propensity", "source_spam_score" ], "description": "Sorting will default to `source_page_authority` if none is provided.", "default": "source_page_authority" }, "DataSiteLinkListActionOptionsInputFilters": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkListOptionsInputFilter" }, "description": "Only return links that match these filters. As many filter values as desired can be supplied in the array, but if providing multiple filters, `\"external\"` must be one of them.\n\n**Acceptable values:** `external`, `follow`, `nofollow`, `deleted`, `not_deleted`, `redirect`, `not_redirect`, `rel_canonical`, `not_rel_canonical`, `via_redirect`, `not_via_redirect`, `via_rel_canonical`, `not_via_rel_canonical`.", "default": [ "external" ] }, "DataSiteLinkListActionDataOffsetInput": { "type": "object", "properties": { "token": { "$ref": "#/definitions/DataOffsetInputToken" }, "limit": { "$ref": "#/definitions/DataSiteLinkListActionDataOffsetInputLimit" } }, "additionalProperties": false, "description": "Limit and pagination controls. Optionally specify the total number of desired results and, after the first request has been made, access results on the next page of results." }, "DataSiteLinkListActionDataOffsetInputLimit": { "type": "number", "description": "The number of results to return. Must be between 1 and 50.", "default": 25 }, "DataSiteLinkListActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "offset": { "$ref": "#/definitions/DataOffsetObject" }, "links": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkObject" } }, "options": { "$ref": "#/definitions/DataSiteLinkListOptionsObject" } }, "required": [ "site_query", "offset", "links", "options" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com/blog", "scope": "url", "original_site_query": { "query": "moz.com/blog", "scope": "url" }, "site_query_suggestion": null }, "offset": { "provided_token": null, "token": "AWrG9eXz5oaz", "limit": 1 }, "links": [ { "source_site_metrics": { "page": "zhanhao.online/domain.php?part=05/15/2025/219", "subdomain": "zhanhao.online", "root_domain": "zhanhao.online", "title": "High-LevelSEO Practice: A Comprehensive Guide from Technical Optimization", "last_crawled": "2025-06-25", "http_code": 200, "pages_to_page": 1, "nofollow_pages_to_page": 0, "redirect_pages_to_page": 0, "external_pages_to_page": 0, "external_nofollow_pages_to_page": 0, "external_redirect_pages_to_page": 0, "deleted_pages_to_page": 0, "root_domains_to_page": 0, "indirect_root_domains_to_page": 0, "deleted_root_domains_to_page": 0, "nofollow_root_domains_to_page": 0, "pages_to_subdomain": 9136809, "nofollow_pages_to_subdomain": 101137, "redirect_pages_to_subdomain": 240, "external_pages_to_subdomain": 1281, "external_nofollow_pages_to_subdomain": 339, "external_redirect_pages_to_subdomain": 240, "deleted_pages_to_subdomain": 1520701, "root_domains_to_subdomain": 171, "deleted_root_domains_to_subdomain": 15, "nofollow_root_domains_to_subdomain": 86, "pages_to_root_domain": 9136809, "nofollow_pages_to_root_domain": 101137, "redirect_pages_to_root_domain": 240, "external_pages_to_root_domain": 1281, "external_indirect_pages_to_root_domain": 34, "external_nofollow_pages_to_root_domain": 339, "external_redirect_pages_to_root_domain": 240, "deleted_pages_to_root_domain": 1520701, "root_domains_to_root_domain": 171, "indirect_root_domains_to_root_domain": 3, "deleted_root_domains_to_root_domain": 15, "nofollow_root_domains_to_root_domain": 86, "page_authority": 17, "domain_authority": 9, "link_propensity": 730.3268433, "spam_score": 20, "root_domains_from_page": 1037, "nofollow_root_domains_from_page": 1035, "pages_from_page": 1184, "nofollow_pages_from_page": 1182, "root_domains_from_root_domain": 93457738, "nofollow_root_domains_from_root_domain": 93457694, "pages_from_root_domain": 103684200, "nofollow_pages_from_root_domain": 103626243, "pages_crawled_from_root_domain": 127967 }, "target_site_metrics": { "page": "moz.com/blog", "subdomain": "moz.com", "root_domain": "moz.com", "title": "The Moz Blog [SEO] - Moz", "last_crawled": "2025-07-01", "http_code": 200, "pages_to_page": 666783, "nofollow_pages_to_page": 7082, "redirect_pages_to_page": 4225, "external_pages_to_page": 457888, "external_nofollow_pages_to_page": 7082, "external_redirect_pages_to_page": 286, "deleted_pages_to_page": 137630, "root_domains_to_page": 10860, "indirect_root_domains_to_page": 2136, "deleted_root_domains_to_page": 1489, "nofollow_root_domains_to_page": 1917, "pages_to_subdomain": 89854572, "nofollow_pages_to_subdomain": 12826229, "redirect_pages_to_subdomain": 48401563, "external_pages_to_subdomain": 68010457, "external_nofollow_pages_to_subdomain": 12820516, "external_redirect_pages_to_subdomain": 41491423, "deleted_pages_to_subdomain": 15374654, "root_domains_to_subdomain": 192939, "deleted_root_domains_to_subdomain": 29166, "nofollow_root_domains_to_subdomain": 42533, "pages_to_root_domain": 90982253, "nofollow_pages_to_root_domain": 12927065, "redirect_pages_to_root_domain": 48406838, "external_pages_to_root_domain": 68846012, "external_indirect_pages_to_root_domain": 43936712, "external_nofollow_pages_to_root_domain": 12921061, "external_redirect_pages_to_root_domain": 41495125, "deleted_pages_to_root_domain": 15990174, "root_domains_to_root_domain": 195005, "indirect_root_domains_to_root_domain": 27097, "deleted_root_domains_to_root_domain": 29998, "nofollow_root_domains_to_root_domain": 42641, "page_authority": 70, "domain_authority": 91, "link_propensity": 0.009283081628, "spam_score": 3, "root_domains_from_page": 6, "nofollow_root_domains_from_page": 0, "pages_from_page": 8, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 77345, "nofollow_root_domains_from_root_domain": 65131, "pages_from_root_domain": 294579, "nofollow_pages_from_root_domain": 234505, "pages_crawled_from_root_domain": 8331824 }, "anchor_text": "pikpas.com", "date_first_seen": "2025-06-21", "date_last_seen": "2025-06-25", "date_disappeared": "", "nofollow": true, "redirect": false, "rel_canonical": false, "via_redirect": false, "via_rel_canonical": true } ], "options": { "sort": "source_link_propensity", "filters": [ "external", "nofollow" ] } } ] }, "DataSiteLinkListActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteLinkListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteLinkListActionPayload" }, "result": { "$ref": "#/definitions/DataSiteLinkListActionResult" }, "quota": { "$ref": "#/definitions/DataSiteLinkListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get a list of links to a target.", "default": "List Links", "title": "data.site.link.list" }, "DataSiteLinkStatusFetchMultipleActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false, "description": "The payload for the data.site.link.status.fetch.multiple action." }, "DataSiteLinkStatusFetchMultipleActionData": { "type": "object", "properties": { "queries": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionDataQuery" } } }, "required": [ "queries" ], "additionalProperties": false, "description": "The payload for the `data.site.link.status.fetch.multiple` action.", "examples": [ { "queries": [ { "target_site_query": { "query": "moz.com/blog", "scope": "url" }, "source_site_query": { "query": "facebook.com", "scope": "domain" } }, { "target_site_query": { "query": "moz.com", "scope": "domain" }, "source_site_query": { "query": "facebook.com/about", "scope": "url" } } ] } ] }, "DataSiteLinkStatusFetchMultipleActionDataQuery": { "type": "object", "properties": { "target_site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "source_site_query": { "$ref": "#/definitions/DataSiteQueryInput" } }, "required": [ "target_site_query", "source_site_query" ], "additionalProperties": false, "description": "Specifies the target and source site queries for a single link" }, "DataSiteLinkStatusFetchMultipleActionResult": { "type": "object", "properties": { "results_by_query": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionResultByQuery" } }, "errors_by_query": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionErrorByQuery" } } }, "required": [ "results_by_query", "errors_by_query" ], "additionalProperties": false, "examples": [ { "results_by_query": [ { "source_site_query": { "query": "https://facebook.com/about", "scope": "url", "original_site_query": { "query": "facebook.com/about", "scope": "url" }, "site_query_suggestion": null }, "target_site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null }, "exists": false }, { "source_site_query": { "query": "https://facebook.com", "scope": "domain", "original_site_query": { "query": "facebook.com", "scope": "domain" }, "site_query_suggestion": null }, "target_site_query": { "query": "https://moz.com/blog", "scope": "url", "original_site_query": { "query": "moz.com/blog", "scope": "url" }, "site_query_suggestion": null }, "exists": false } ], "errors_by_query": [] }, { "results_by_query": [ { "source_site_query": { "query": "https://facebook.com", "scope": "domain", "original_site_query": { "query": "facebook.com", "scope": "domain" }, "site_query_suggestion": null }, "target_site_query": { "query": "https://moz.com/blog", "scope": "url", "original_site_query": { "query": "moz.com/blog", "scope": "url" }, "site_query_suggestion": null }, "exists": true } ], "errors_by_query": [ { "source_site_query": { "query": "https://facebook.com/about", "scope": "url", "original_site_query": { "query": "facebook.com/about", "scope": "url" }, "site_query_suggestion": null }, "target_site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null }, "error": { "name": "UnhandledError", "data": { "key": "source_site_query.1.query", "value": "facebook.com/about" }, "httpStatus": 500, "jsonrpcCode": -32602 } } ] } ] }, "DataSiteLinkStatusFetchMultipleActionResultByQuery": { "type": "object", "properties": { "target_site_query": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionResultTargetSiteQueryObject" }, "source_site_query": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionResultSourceSiteQueryObject" }, "exists": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionResultExists" } }, "required": [ "target_site_query", "source_site_query", "exists" ], "additionalProperties": false, "description": "Specifies the target and source site queries for a single link" }, "DataSiteLinkStatusFetchMultipleActionResultTargetSiteQueryObject": { "type": "object", "additionalProperties": false, "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteQueryInputScopes" }, "original_site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "site_query_suggestion": { "anyOf": [ { "$ref": "#/definitions/SiteQuerySuggestionObject" }, { "type": "null" } ] } }, "required": [ "original_site_query", "query", "scope", "site_query_suggestion" ], "description": "The provided target site query." }, "DataSiteLinkStatusFetchMultipleActionResultSourceSiteQueryObject": { "type": "object", "additionalProperties": false, "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteQueryInputScopes" }, "original_site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "site_query_suggestion": { "anyOf": [ { "$ref": "#/definitions/SiteQuerySuggestionObject" }, { "type": "null" } ] } }, "required": [ "original_site_query", "query", "scope", "site_query_suggestion" ], "description": "The provided source site query." }, "DataSiteLinkStatusFetchMultipleActionResultExists": { "type": "boolean", "description": "Whether or not a link exists from the source to the target." }, "DataSiteLinkStatusFetchMultipleActionErrorByQuery": { "type": "object", "properties": { "target_site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "source_site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "error": { "$ref": "#/definitions/UnifiedApiPylonError" } }, "required": [ "target_site_query", "source_site_query", "error" ], "additionalProperties": false, "description": "Specifies the target and source site queries for a single link" }, "UnifiedApiPylonError": { "type": "object", "properties": { "message": { "$ref": "#/definitions/UnifiedApiPylonErrorMessage" }, "name": { "$ref": "#/definitions/UnifiedApiPylonErrorName" }, "data": { "type": "object", "properties": { "key": { "$ref": "#/definitions/UnifiedApiPylonErrorDataKey" }, "value": { "$ref": "#/definitions/UnifiedApiPylonErrorDataValue" } }, "additionalProperties": false }, "httpStatus": { "$ref": "#/definitions/UnifiedApiPylonErrorHttpStatus" }, "jsonrpcCode": { "$ref": "#/definitions/UnifiedApiPylonErrorDataJsonrpcCode" } }, "required": [ "message", "name", "data", "httpStatus", "jsonrpcCode" ], "additionalProperties": false, "description": "An error returned from the API." }, "UnifiedApiPylonErrorMessage": { "type": "string", "description": "The error message." }, "UnifiedApiPylonErrorName": { "type": "string", "description": "The name of the error returned." }, "UnifiedApiPylonErrorDataKey": { "type": "string", "description": "If applicable, the path to the relevant input that caused the error." }, "UnifiedApiPylonErrorDataValue": { "type": "string", "description": "If applicable, the value of the relevant input that caused the error." }, "UnifiedApiPylonErrorHttpStatus": { "type": "number", "description": "The relevant HTTP Status code that the error could be interpretted as." }, "UnifiedApiPylonErrorDataJsonrpcCode": { "type": "number", "description": "The relevant JSON-RPC Error code that can be used to uniquely identify this type of error." }, "DataSiteLinkStatusFetchMultipleActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteLinkStatusFetchMultipleAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionPayload" }, "result": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionResult" }, "quota": { "$ref": "#/definitions/DataSiteLinkStatusFetchMultipleActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get the status of multiple links from a source to a target.", "default": "Get Multiple Link Status", "title": "data.site.link.status.fetch.multiple" }, "DataSiteLinkStatusFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteLinkStatusFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false, "description": "The payload for the data.site.link.status.fetch action." }, "DataSiteLinkStatusFetchActionData": { "type": "object", "properties": { "target_site_query": { "$ref": "#/definitions/DataSiteLinkStatusFetchActionDataTargetSiteQueryInput" }, "source_site_query": { "$ref": "#/definitions/DataSiteLinkStatusFetchActionDataSourceSiteQueryInput" } }, "required": [ "target_site_query", "source_site_query" ], "additionalProperties": false, "description": "The data for the data.site.link.status.fetch action.", "examples": [ { "target_site_query": { "query": "latimes.com", "scope": "domain" }, "source_site_query": { "query": "moz.com", "scope": "domain" } }, { "target_site_query": { "query": "moz.com/blog", "scope": "url" }, "source_site_query": { "query": "facebook.com", "scope": "domain" } } ] }, "DataSiteLinkStatusFetchActionDataTargetSiteQueryInput": { "type": "object", "additionalProperties": false, "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteQueryInputScopes" } }, "required": [ "query", "scope" ], "description": "Specify the target to check for an existing link." }, "DataSiteLinkStatusFetchActionDataSourceSiteQueryInput": { "type": "object", "additionalProperties": false, "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteQueryInputScopes" } }, "required": [ "query", "scope" ], "description": "Specify the source to check for an existing link." }, "DataSiteLinkStatusFetchActionResult": { "type": "object", "properties": { "target_site_query": { "$ref": "#/definitions/DataSiteLinkStatusFetchActionResultTargetSiteQueryObject" }, "source_site_query": { "$ref": "#/definitions/DataSiteLinkStatusFetchActionResultSourceSiteQueryObject" }, "exists": { "$ref": "#/definitions/DataSiteLinkStatusFetchActionResultExists" } }, "required": [ "target_site_query", "source_site_query", "exists" ], "additionalProperties": false, "examples": [ { "target_site_query": { "original_site_query": { "query": "latimes.com", "scope": "domain" }, "site_query_suggestion": null, "query": "https://latimes.com", "scope": "domain" }, "source_site_query": { "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null, "query": "https://moz.com", "scope": "domain" }, "exists": true } ] }, "DataSiteLinkStatusFetchActionResultTargetSiteQueryObject": { "type": "object", "additionalProperties": false, "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteQueryInputScopes" }, "original_site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "site_query_suggestion": { "anyOf": [ { "$ref": "#/definitions/SiteQuerySuggestionObject" }, { "type": "null" } ] } }, "required": [ "original_site_query", "query", "scope", "site_query_suggestion" ], "description": "The provided target site query." }, "DataSiteLinkStatusFetchActionResultSourceSiteQueryObject": { "type": "object", "additionalProperties": false, "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteQueryInputScopes" }, "original_site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "site_query_suggestion": { "anyOf": [ { "$ref": "#/definitions/SiteQuerySuggestionObject" }, { "type": "null" } ] } }, "required": [ "original_site_query", "query", "scope", "site_query_suggestion" ], "description": "The provided source site query." }, "DataSiteLinkStatusFetchActionResultExists": { "type": "boolean", "description": "Whether or not a link exists from the source to the target." }, "DataSiteLinkStatusFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per call." }, "DataSiteLinkStatusFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteLinkStatusFetchActionPayload" }, "result": { "$ref": "#/definitions/DataSiteLinkStatusFetchActionResult" }, "quota": { "$ref": "#/definitions/DataSiteLinkStatusFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get the status of a link from a source to a target.", "default": "Get Link Status", "title": "data.site.link.status.fetch" }, "DataSiteLinkingDomainFilterRecentlyGainedActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyGainedActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteLinkingDomainFilterRecentlyGainedActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "options": { "$ref": "#/definitions/DataSiteLinkingDomainFilterOptionsInput" }, "offset": { "$ref": "#/definitions/PostValidateDataSiteLinkingDomainFilterRecentlyGainedActionDataOffsetInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "moz.com", "scope": "domain" } }, { "site_query": { "query": "moz.com", "scope": "domain" }, "options": { "begin_date": "2025-06-20", "end_date": "2025-06-26" }, "offset": { "limit": 10 } } ] }, "DataSiteLinkingDomainFilterOptionsInput": { "type": "object", "properties": { "begin_date": { "$ref": "#/definitions/DataSiteLinkingDomainFilterBeginDate", "description": "The beginning of the date range" }, "end_date": { "$ref": "#/definitions/DataSiteLinkingDomainFilterEndDate", "description": "The end of the date range" } }, "additionalProperties": false, "description": "Optional date ranges to filter by." }, "DataSiteLinkingDomainFilterBeginDate": { "type": [ "string", "null" ], "description": "Restrict results to only those gained or lost on or after this date. Values must be in `YYYY-MM-DD` form." }, "DataSiteLinkingDomainFilterEndDate": { "type": [ "string", "null" ], "description": "Restrict results to only those gained or lost on or before this date. Values must be in `YYYY-MM-DD` form." }, "PostValidateDataSiteLinkingDomainFilterRecentlyGainedActionDataOffsetInput": { "type": "object", "properties": { "token": { "$ref": "#/definitions/DataOffsetInputToken" }, "limit": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyGainedActionDataOffsetInputLimit" } }, "required": [ "limit", "token" ], "additionalProperties": false, "description": "Limit and pagination controls. Optionally specify the total number of desired results and, after the first request has been made, access results on the next page of results." }, "DataSiteLinkingDomainFilterRecentlyGainedActionDataOffsetInputLimit": { "type": "number", "description": "The number of results to return. Must be between 1 and 50.", "default": 25 }, "DataSiteLinkingDomainFilterRecentlyGainedActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "offset": { "$ref": "#/definitions/DataOffsetObject" }, "gained_linking_domains": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkingDomainGainedObject" } }, "options": { "$ref": "#/definitions/DataSiteLinkingDomainFilterOptionsObject" } }, "required": [ "site_query", "offset", "gained_linking_domains", "options" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null }, "offset": { "provided_token": null, "token": "EokQVg4s9ak8sNgEfHoa+dKFvJaYHXNvtIKv", "limit": 1 }, "gained_linking_domains": [ { "site_metrics": { "page": "at-ill.com/", "subdomain": "at-ill.com", "root_domain": "at-ill.com", "title": "Bot Verification", "last_crawled": "2025-05-21", "http_code": 200, "pages_to_page": 69479, "nofollow_pages_to_page": 7, "redirect_pages_to_page": 0, "external_pages_to_page": 12, "external_nofollow_pages_to_page": 7, "external_redirect_pages_to_page": 0, "deleted_pages_to_page": 4, "root_domains_to_page": 12, "indirect_root_domains_to_page": 0, "deleted_root_domains_to_page": 1, "nofollow_root_domains_to_page": 7, "pages_to_subdomain": 30979379, "nofollow_pages_to_subdomain": 69456, "redirect_pages_to_subdomain": 0, "external_pages_to_subdomain": 18, "external_nofollow_pages_to_subdomain": 7, "external_redirect_pages_to_subdomain": 0, "deleted_pages_to_subdomain": 753689, "root_domains_to_subdomain": 18, "deleted_root_domains_to_subdomain": 3, "nofollow_root_domains_to_subdomain": 7, "pages_to_root_domain": 30979379, "nofollow_pages_to_root_domain": 69456, "redirect_pages_to_root_domain": 0, "external_pages_to_root_domain": 18, "external_indirect_pages_to_root_domain": 0, "external_nofollow_pages_to_root_domain": 7, "external_redirect_pages_to_root_domain": 0, "deleted_pages_to_root_domain": 753689, "root_domains_to_root_domain": 18, "indirect_root_domains_to_root_domain": 0, "deleted_root_domains_to_root_domain": 3, "nofollow_root_domains_to_root_domain": 7, "page_authority": 19, "domain_authority": 6, "link_propensity": 0.6309486032, "spam_score": 76, "root_domains_from_page": 0, "nofollow_root_domains_from_page": 0, "pages_from_page": 0, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 43885, "nofollow_root_domains_from_root_domain": 0, "pages_from_root_domain": 375276, "nofollow_pages_from_root_domain": 0, "pages_crawled_from_root_domain": 69554 }, "link_propensity": 0.6309486032, "targeted_pages": 1, "targeted_nofollow_pages": 0, "targeted_redirect_pages": 0, "targeted_deleted_pages": 0, "date_gained": "2025-06-24" } ], "options": { "begin_date": "2025-06-20", "end_date": "2025-06-26" } } ] }, "DataSiteLinkingDomainGainedObject": { "type": "object", "properties": { "site_metrics": { "$ref": "#/definitions/DataSiteMetricsObject" }, "link_propensity": { "$ref": "#/definitions/DataSiteLinkingDomainObjectLinkPropensity" }, "targeted_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedPages" }, "targeted_nofollow_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedNofollowPages" }, "targeted_redirect_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedRedirectPages" }, "targeted_deleted_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedDeletedPages" }, "date_gained": { "$ref": "#/definitions/DataSiteLinkingDomainGainedObjectDateGained" } }, "required": [ "date_gained", "link_propensity", "site_metrics", "targeted_deleted_pages", "targeted_nofollow_pages", "targeted_pages", "targeted_redirect_pages" ], "additionalProperties": false, "description": "The list of domains which added links to the target in the requested timeframe." }, "DataSiteLinkingDomainObjectLinkPropensity": { "type": "number", "description": "A score from 0 to 1 indicating the likelihood of the source root domain to link out to other root domains. This is currently calculated as the ratio of 'root_domains_from_root_domain' to 'pages_crawled_from_root_domain'." }, "DataSiteLinkingDomainObjectTargetedPages": { "type": "number", "description": "The number of pages on the source root domain currently linking to the target." }, "DataSiteLinkingDomainObjectTargetedNofollowPages": { "type": "number", "description": "The number of pages on the source root domain currently linking to the target with only nofollow links." }, "DataSiteLinkingDomainObjectTargetedRedirectPages": { "type": "number", "description": "The number of pages on the source root domain currently redirecting to the target." }, "DataSiteLinkingDomainObjectTargetedDeletedPages": { "type": "number", "description": "The number of pages on the source root domain that used to link to the target, but no longer do." }, "DataSiteLinkingDomainGainedObjectDateGained": { "type": "string", "description": "The date the linking root domain was gained" }, "DataSiteLinkingDomainFilterOptionsObject": { "type": "object", "properties": { "begin_date": { "$ref": "#/definitions/DataSiteLinkingDomainFilterOptionsObjectBeginDate" }, "end_date": { "$ref": "#/definitions/DataSiteLinkingDomainFilterOptionsObjectEndDate" } }, "required": [ "begin_date", "end_date" ], "additionalProperties": false, "description": "Optional date ranges that were used to filter results." }, "DataSiteLinkingDomainFilterOptionsObjectBeginDate": { "type": [ "string", "null" ], "description": "Restrict results to only those gained or lost on or after this date. Values are in `YYYY-MM-DD` form." }, "DataSiteLinkingDomainFilterOptionsObjectEndDate": { "type": [ "string", "null" ], "description": "Restrict results to only those gained or lost on or before this date. Values are in `YYYY-MM-DD` form." }, "DataSiteLinkingDomainFilterRecentlyGainedActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteLinkingDomainFilterRecentlyGainedAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyGainedActionPayload" }, "result": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyGainedActionResult" }, "quota": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyGainedActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "This endpoint will return information about external root domains that added new links to a target during the past 60 days.", "default": "List Recently Gained Linking Domains", "title": "data.site.linking-domain.filter.recently-gained" }, "DataSiteLinkingDomainFilterRecentlyLostActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyLostActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteLinkingDomainFilterRecentlyLostActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "options": { "$ref": "#/definitions/DataSiteLinkingDomainFilterOptionsInput" }, "offset": { "$ref": "#/definitions/PostValidateDataSiteLinkingDomainFilterRecentlyLostActionDataOffsetInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "moz.com", "scope": "domain" } }, { "site_query": { "query": "moz.com", "scope": "domain" }, "options": { "begin_date": "2025-06-20", "end_date": "2025-06-26" }, "offset": { "limit": 10 } } ] }, "PostValidateDataSiteLinkingDomainFilterRecentlyLostActionDataOffsetInput": { "type": "object", "properties": { "token": { "$ref": "#/definitions/DataOffsetInputToken" }, "limit": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyLostActionDataOffsetInputLimit" } }, "required": [ "limit", "token" ], "additionalProperties": false, "description": "Limit and pagination controls. Optionally specify the total number of desired results and, after the first request has been made, access results on the next page of results." }, "DataSiteLinkingDomainFilterRecentlyLostActionDataOffsetInputLimit": { "type": "number", "description": "The number of results to return. Must be between 1 and 50.", "default": 25 }, "DataSiteLinkingDomainFilterRecentlyLostActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "offset": { "$ref": "#/definitions/DataOffsetObject" }, "lost_linking_domains": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkingDomainLostObject" } }, "options": { "$ref": "#/definitions/DataSiteLinkingDomainFilterOptionsObject" } }, "required": [ "site_query", "offset", "lost_linking_domains", "options" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null }, "offset": { "provided_token": null, "token": "EokQVg4s9ak8sNwE+eTfSkltYDg4W2Xlv/3s", "limit": 1 }, "lost_linking_domains": [ { "site_metrics": { "page": "ledendebate24.com/", "subdomain": "ledendebate24.com", "root_domain": "ledendebate24.com", "title": "Leden Debate 24", "last_crawled": "2025-03-24", "http_code": 200, "pages_to_page": 464, "nofollow_pages_to_page": 7, "redirect_pages_to_page": 0, "external_pages_to_page": 12, "external_nofollow_pages_to_page": 7, "external_redirect_pages_to_page": 0, "deleted_pages_to_page": 1144, "root_domains_to_page": 12, "indirect_root_domains_to_page": 0, "deleted_root_domains_to_page": 1, "nofollow_root_domains_to_page": 7, "pages_to_subdomain": 21515, "nofollow_pages_to_subdomain": 460, "redirect_pages_to_subdomain": 1444, "external_pages_to_subdomain": 13, "external_nofollow_pages_to_subdomain": 8, "external_redirect_pages_to_subdomain": 0, "deleted_pages_to_subdomain": 65758, "root_domains_to_subdomain": 13, "deleted_root_domains_to_subdomain": 1, "nofollow_root_domains_to_subdomain": 8, "pages_to_root_domain": 21515, "nofollow_pages_to_root_domain": 460, "redirect_pages_to_root_domain": 1444, "external_pages_to_root_domain": 13, "external_indirect_pages_to_root_domain": 0, "external_nofollow_pages_to_root_domain": 8, "external_redirect_pages_to_root_domain": 0, "deleted_pages_to_root_domain": 65758, "root_domains_to_root_domain": 13, "indirect_root_domains_to_root_domain": 0, "deleted_root_domains_to_root_domain": 1, "nofollow_root_domains_to_root_domain": 8, "page_authority": 18, "domain_authority": 6, "link_propensity": 0.06489994377, "spam_score": 2, "root_domains_from_page": 0, "nofollow_root_domains_from_page": 0, "pages_from_page": 0, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 240, "nofollow_root_domains_from_root_domain": 19, "pages_from_root_domain": 892, "nofollow_pages_from_root_domain": 75, "pages_crawled_from_root_domain": 3698 }, "link_propensity": 0.06489994377, "targeted_pages": 0, "targeted_nofollow_pages": 0, "targeted_redirect_pages": 0, "targeted_deleted_pages": 2, "date_lost": "2025-06-20" } ], "options": { "begin_date": "2025-01-20", "end_date": "2025-06-20" } } ] }, "DataSiteLinkingDomainLostObject": { "type": "object", "properties": { "site_metrics": { "$ref": "#/definitions/DataSiteMetricsObject" }, "link_propensity": { "$ref": "#/definitions/DataSiteLinkingDomainObjectLinkPropensity" }, "targeted_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedPages" }, "targeted_nofollow_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedNofollowPages" }, "targeted_redirect_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedRedirectPages" }, "targeted_deleted_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedDeletedPages" }, "date_lost": { "$ref": "#/definitions/DataSiteLinkingDomainLostObjectDateLost" } }, "required": [ "date_lost", "link_propensity", "site_metrics", "targeted_deleted_pages", "targeted_nofollow_pages", "targeted_pages", "targeted_redirect_pages" ], "additionalProperties": false, "description": "The list of domains which removed links to the target in the requested timeframe." }, "DataSiteLinkingDomainLostObjectDateLost": { "type": "string", "description": "The date the linking root domain was lost" }, "DataSiteLinkingDomainFilterRecentlyLostActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteLinkingDomainFilterRecentlyLostAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyLostActionPayload" }, "result": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyLostActionResult" }, "quota": { "$ref": "#/definitions/DataSiteLinkingDomainFilterRecentlyLostActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "This endpoint will return information about root domains that removed links to a target during the past 60 days.", "default": "List Recently Lost Linking Domains", "title": "data.site.linking-domain.filter.recently-lost" }, "DataSiteLinkingDomainListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteLinkingDomainListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteLinkingDomainListActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "options": { "$ref": "#/definitions/DataSiteLinkingDomainListActionOptionsInput" }, "offset": { "$ref": "#/definitions/DataSiteLinkingDomainListActionDataOffsetInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "moz.com/blog", "scope": "url" } }, { "site_query": { "query": "moz.com", "scope": "domain" }, "options": { "sort": "source_link_propensity", "filters": [ "external", "follow" ] }, "offset": { "limit": 50 } } ] }, "DataSiteLinkingDomainListActionOptionsInput": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/DataSiteLinkingDomainListActionOptionsInputSort" }, "filters": { "$ref": "#/definitions/DataSiteLinkingDomainListActionOptionsInputFilters" } }, "additionalProperties": false, "description": "Options for fetching linking domains." }, "DataSiteLinkingDomainListActionOptionsInputSort": { "$ref": "#/definitions/DataSiteLinkingDomainListOptionsInputSort", "description": "The order to return linking root domains in. The default value is `source_domain_authority`. Results are returned in descending order (higher values first). If using `date_gained`, the filters must be set to `external+gained_last_60_days`. If using `date_lost`, the filters must be set to `external+lost_last_60_days`.\n\n**Acceptable Values:** `source_domain_authority`, `source_link_propensity`, `source_spam_score`, `date_gained`, and `date_lost`", "default": "`source_domain_authority`" }, "DataSiteLinkingDomainListOptionsInputSort": { "type": "string", "enum": [ "source_domain_authority", "source_link_propensity", "source_spam_score" ], "description": "The order to return linking root domains in. The default value is `\"source_domain_authority\"`. Results are returned in descending order (higher values first).", "default": "`source_domain_authority`" }, "DataSiteLinkingDomainListActionOptionsInputFilters": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkingDomainListOptionsInputFilter" }, "description": "Optional. Only return linking root domains that match these filters. As many filter values as desired can be supplied in the array, but if providing multiple filters, `external` must be one of them.\n\n**Acceptable Values:** `external`, `follow`, `nofollow`, `deleted`, `not_deleted`.", "default": [ "external" ] }, "DataSiteLinkingDomainListOptionsInputFilter": { "type": "string", "enum": [ "external", "follow", "nofollow", "deleted", "not_deleted" ], "description": "Filters to apply to the linking root domains. Possible values are:\n\n- `external` - Only return linking root domains that are external to the target domain.\n- `follow` - Only return linking root domains that have at least one followed link from the source domain to the target.\n- `nofollow` - Only return linking root domains that have all links from the source domain to the target be nofollow links.\n- `deleted` - Only return linking root domains that used to link to the target but currently do not.\n- `not_deleted` - Only return linking root domains that are currently linking to the target." }, "DataSiteLinkingDomainListActionDataOffsetInput": { "type": "object", "properties": { "token": { "$ref": "#/definitions/DataOffsetInputToken" }, "limit": { "$ref": "#/definitions/DataSiteLinkingDomainListActionDataOffsetInputLimit" } }, "additionalProperties": false, "description": "Limit and pagination controls. Optionally specify the total number of desired results and, after the first request has been made, access results on the next page of results." }, "DataSiteLinkingDomainListActionDataOffsetInputLimit": { "type": "number", "description": "The number of results to return. Must be between 1 and 50.", "default": 25 }, "DataSiteLinkingDomainListActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "offset": { "$ref": "#/definitions/DataOffsetObject" }, "linking_domains": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkingDomainObject" } }, "options": { "$ref": "#/definitions/DataSiteLinkingDomainListOptionsObject" } }, "required": [ "site_query", "offset", "linking_domains", "options" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null }, "offset": { "provided_token": null, "token": "cHnchjo94iRQu9/kNL5bX5Lgpkjblw", "limit": 25 }, "options": { "sort": "source_domain_authority", "filters": [ "external" ] }, "linking_domains": [ { "site_metrics": { "page": "www.google.com/", "subdomain": "www.google.com", "root_domain": "www.google.com", "title": "Google", "last_crawled": "2025-06-20", "http_code": 200, "pages_to_page": 1898138433, "nofollow_pages_to_page": 178380729, "redirect_pages_to_page": 438049399, "external_pages_to_page": 1892590980, "external_nofollow_pages_to_page": 178380729, "external_redirect_pages_to_page": 438047715, "deleted_pages_to_page": 374128171, "root_domains_to_page": 2533807, "indirect_root_domains_to_page": 1169603, "deleted_root_domains_to_page": 408110, "nofollow_root_domains_to_page": 363627, "pages_to_subdomain": 18753876101, "nofollow_pages_to_subdomain": 2989983530, "redirect_pages_to_subdomain": 645502864, "external_pages_to_subdomain": 18533987097, "external_nofollow_pages_to_subdomain": 2989983524, "external_redirect_pages_to_subdomain": 644888134, "deleted_pages_to_subdomain": 3047198326, "root_domains_to_subdomain": 14626209, "deleted_root_domains_to_subdomain": 1668330, "nofollow_root_domains_to_subdomain": 1104389, "pages_to_root_domain": 18753895498, "nofollow_pages_to_root_domain": 2989984418, "redirect_pages_to_root_domain": 645502871, "external_pages_to_root_domain": 18534006494, "external_indirect_pages_to_root_domain": 3985620070, "external_nofollow_pages_to_root_domain": 2989984412, "external_redirect_pages_to_root_domain": 644888141, "deleted_pages_to_root_domain": 3047204216, "root_domains_to_root_domain": 14626290, "indirect_root_domains_to_root_domain": 1675268, "deleted_root_domains_to_root_domain": 1668333, "nofollow_root_domains_to_root_domain": 1104397, "page_authority": 100, "domain_authority": 100, "link_propensity": 0.01273761503, "spam_score": 9, "root_domains_from_page": 12, "nofollow_root_domains_from_page": 0, "pages_from_page": 15, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 166846, "nofollow_root_domains_from_root_domain": 34, "pages_from_root_domain": 20973873, "nofollow_pages_from_root_domain": 33528, "pages_crawled_from_root_domain": 13098684 }, "link_propensity": 0.01273761503, "targeted_pages": 3, "targeted_nofollow_pages": 0, "targeted_redirect_pages": 2, "targeted_deleted_pages": 0 } ] } ] }, "DataSiteLinkingDomainObject": { "type": "object", "properties": { "site_metrics": { "$ref": "#/definitions/DataSiteMetricsObject" }, "link_propensity": { "$ref": "#/definitions/DataSiteLinkingDomainObjectLinkPropensity" }, "targeted_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedPages" }, "targeted_nofollow_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedNofollowPages" }, "targeted_redirect_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedRedirectPages" }, "targeted_deleted_pages": { "$ref": "#/definitions/DataSiteLinkingDomainObjectTargetedDeletedPages" } }, "required": [ "site_metrics", "link_propensity", "targeted_pages", "targeted_nofollow_pages", "targeted_redirect_pages", "targeted_deleted_pages" ], "additionalProperties": false, "description": "A single linking root domain to the target." }, "DataSiteLinkingDomainListOptionsObject": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/DataSiteLinkingDomainListOptionsObjectSort" }, "filters": { "$ref": "#/definitions/DataSiteLinkingDomainListOptionsObjectFilters" } }, "required": [ "sort", "filters" ], "additionalProperties": false, "description": "Echoes back the parameters provided in the original request" }, "DataSiteLinkingDomainListOptionsObjectSort": { "type": "string", "enum": [ "source_domain_authority", "source_link_propensity", "source_spam_score" ], "description": "The sort order that was applied to the results." }, "DataSiteLinkingDomainListOptionsObjectFilters": { "type": "array", "items": { "$ref": "#/definitions/DataSiteLinkingDomainListOptionsObjectFilter" }, "description": "The filters that were applied to the results." }, "DataSiteLinkingDomainListOptionsObjectFilter": { "type": "string", "enum": [ "external", "follow", "nofollow", "deleted", "not_deleted" ], "description": "Filters to apply to the linking root domains. Possible values are:\n\n- `external` - Only return linking root domains that are external to the target domain.\n- `follow` - Only return linking root domains that have at least one followed link from the source domain to the target.\n- `nofollow` - Only return linking root domains that have all links from the source domain to the target be nofollow links.\n- `deleted` - Only return linking root domains that used to link to the target but currently do not.\n- `not_deleted` - Only return linking root domains that are currently linking to the target." }, "DataSiteLinkingDomainListActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteLinkingDomainListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteLinkingDomainListActionPayload" }, "result": { "$ref": "#/definitions/DataSiteLinkingDomainListActionResult" }, "quota": { "$ref": "#/definitions/DataSiteLinkingDomainListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get a list of linking root domains to a target, with information about each root domain and the aggregate number of links to the target.", "default": "List Linking Domains", "title": "data.site.linking-domain.list" }, "DataSiteMetricsBrandAuthorityFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteMetricsBrandAuthorityFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteMetricsBrandAuthorityFetchActionData": { "type": "object", "properties": { "site_query": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/BrandAuthorityDataSiteQueryInputScope" } }, "required": [ "query", "scope" ], "additionalProperties": false } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain" } }, { "site_query": { "query": "https://en.wikipedia.org/wiki/Fundamental_analysis", "scope": "domain" } } ] }, "BrandAuthorityDataSiteQueryInputScope": { "type": "string", "const": "domain", "description": "Brand Authority only supports the \"domain\" scope." }, "DataSiteMetricsBrandAuthorityFetchActionResult": { "type": "object", "properties": { "site_metrics": { "type": "object", "properties": { "brand_authority_score": { "$ref": "#/definitions/DataSiteMetricsBrandAuthorityFetchActionResultBrandAuthorityScore" } }, "required": [ "brand_authority_score" ], "additionalProperties": false }, "site_query": { "$ref": "#/definitions/DataSiteQueryObject" } }, "required": [ "site_metrics", "site_query" ], "additionalProperties": false, "examples": [ { "site_metrics": { "brand_authority_score": 57 }, "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "https://moz.com/blog", "scope": "domain" }, "site_query_suggestion": null } } ] }, "DataSiteMetricsBrandAuthorityFetchActionResultBrandAuthorityScore": { "type": "number", "description": "The Brand Authority score - a value ranging from 1 (worst) to 100 (best)." }, "DataSiteMetricsBrandAuthorityFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per call." }, "DataSiteMetricsBrandAuthorityFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteMetricsBrandAuthorityFetchActionPayload" }, "result": { "$ref": "#/definitions/DataSiteMetricsBrandAuthorityFetchActionResult" }, "quota": { "$ref": "#/definitions/DataSiteMetricsBrandAuthorityFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "This endpoint returns a Brand Authority\u2122 score for the provided site. Use this metric to understand the strength of your website\u2019s brand, benchmark against competitors, and more.", "default": "Fetch Brand Authority" }, "DataSiteMetricsDistributionsFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteMetricsDistributionsFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteMetricsDistributionsFetchActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com/blog", "scope": "url" } }, { "site_query": { "query": "https://moz.com", "scope": "domain" } } ] }, "DataSiteMetricsDistributionsFetchActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "site_metrics_distributions": { "$ref": "#/definitions/DataSiteMetricsDistributionObject" } }, "required": [ "site_query", "site_metrics_distributions" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain" }, "site_metrics_distributions": { "root_domains_to_page_by_root_domains": [ 20993, 53357, 39763, 35898, 21599, 5898, 864, 61, 11, 0 ], "root_domains_to_root_domain_by_root_domains": [ 34239, 105888, 86245, 78604, 45604, 9317, 1128, 71, 14, 0 ], "nofollow_root_domains_to_root_domain_by_root_domains": [ 4575, 21287, 20473, 20430, 13822, 2329, 188, 12, 3, 0 ], "root_domains_to_page_by_domain_authority": [ 112607, 25379, 15208, 9859, 5712, 4467, 2192, 1512, 1010, 498 ], "root_domains_to_subdomain_by_domain_authority": [ 133631, 31621, 18842, 12238, 6981, 5305, 2525, 1699, 1125, 526 ], "root_domains_to_root_domain_by_domain_authority": [ 221189, 57409, 33171, 21346, 11227, 8792, 3770, 2216, 1382, 608 ], "nofollow_root_domains_to_root_domain_by_domain_authority": [ 45841, 15383, 8666, 5973, 3230, 2226, 951, 468, 274, 107 ], "pages_to_root_domain_by_spam_score": [ 71801563, 11137580, 6004361, 6916159, 4496245, 2694223, 1621052, 4531426, 576916, 245654 ], "nofollow_pages_to_root_domain_by_spam_score": [ 4555388, 762635, 556323, 238022, 98816, 76580, 50641, 798280, 327778, 13755 ], "root_domains_to_page_by_spam_score": [ 74166, 25512, 12151, 8552, 6511, 5329, 3520, 2758, 2175, 1350 ], "root_domains_to_subdomain_by_spam_score": [ 89553, 30189, 14725, 10320, 8075, 6851, 4596, 3519, 2655, 1471 ], "root_domains_to_root_domain_by_spam_score": [ 156089, 48474, 24953, 17385, 13206, 11197, 7846, 6160, 4473, 2248 ], "nofollow_root_domains_to_root_domain_by_spam_score": [ 37714, 10480, 5463, 3435, 2355, 2119, 1462, 1034, 589, 142 ] } } ] }, "DataSiteMetricsDistributionObject": { "type": "object", "additionalProperties": false, "properties": { "root_domains_to_page_by_root_domains": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsByRootDomain" } }, "root_domains_to_root_domain_by_root_domains": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsByRootDomain" } }, "nofollow_root_domains_to_root_domain_by_root_domains": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsByRootDomain" } }, "root_domains_to_page_by_domain_authority": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsByDomainAuthority" } }, "root_domains_to_subdomain_by_domain_authority": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsByDomainAuthority" } }, "root_domains_to_root_domain_by_domain_authority": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsByDomainAuthority" } }, "nofollow_root_domains_to_root_domain_by_domain_authority": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsByDomainAuthority" } }, "pages_to_root_domain_by_spam_score": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsBySpamScore" } }, "nofollow_pages_to_root_domain_by_spam_score": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsBySpamScore" } }, "root_domains_to_page_by_spam_score": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsBySpamScore" } }, "root_domains_to_subdomain_by_spam_score": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsBySpamScore" } }, "root_domains_to_root_domain_by_spam_score": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsBySpamScore" } }, "nofollow_root_domains_to_root_domain_by_spam_score": { "type": "array", "items": { "$ref": "#/definitions/BetaDataSiteMetricsDistributionMetricsBySpamScore" } } }, "required": [ "nofollow_pages_to_root_domain_by_spam_score", "nofollow_root_domains_to_root_domain_by_domain_authority", "nofollow_root_domains_to_root_domain_by_root_domains", "nofollow_root_domains_to_root_domain_by_spam_score", "pages_to_root_domain_by_spam_score", "root_domains_to_page_by_domain_authority", "root_domains_to_page_by_root_domains", "root_domains_to_page_by_spam_score", "root_domains_to_root_domain_by_domain_authority", "root_domains_to_root_domain_by_root_domains", "root_domains_to_root_domain_by_spam_score", "root_domains_to_subdomain_by_domain_authority", "root_domains_to_subdomain_by_spam_score" ], "description": "Represents a Site Metrics Distribution object." }, "BetaDataSiteMetricsDistributionMetricsByRootDomain": { "type": "number", "description": "Metric is bucketed by the number of root domains linking to the source of each link." }, "BetaDataSiteMetricsDistributionMetricsByDomainAuthority": { "type": "number", "description": "Metric is bucketed by the domain authority of the source root domain of each link." }, "BetaDataSiteMetricsDistributionMetricsBySpamScore": { "type": "number", "description": "Metric is bucketed by the spam score of the source root domain of each link." }, "DataSiteMetricsDistributionsFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per successful call." }, "DataSiteMetricsDistributionsFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteMetricsDistributionsFetchActionPayload" }, "result": { "$ref": "#/definitions/DataSiteMetricsDistributionsFetchActionResult" }, "quota": { "$ref": "#/definitions/DataSiteMetricsDistributionsFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get information about how links to one or more target sites are distributed based on the source site's metrics, such as Domain Authority.\n\nEach distribution is named with the pattern `METRIC_BY_MEASURE`, where `METRIC` has the same meaning as the stand-alone metric with the same name, and `MEASURE` determines how that metric is split into buckets. `MEASURE` can have the following values:\n\n- **root_domains** metric is bucketed by the number of root domains linking to the source of each link. The ranges represented in each bucket are: - `[0, 1-9, 10-99, 100-999, 1000-9999, 10000-99999, 100000-999999, 1000000-9999999, 10000000-99999999, 100000000+]`\n- **domain_authority** metric is bucketed by the domain authority of the source root domain of each link. The ranges represented in each bucket are: - `[1-10, 11-20, 21-30, 31-40, 41-50, 51-60, 61-70, 71-80, 81-90, 91-100]`\n- **spam_score** metric is bucketed by the spam score of the source root domain of each link. The ranges represented in each bucket are: - `[1-10, 11-20, 21-30, 31-40, 41-50, 51-60, 61-70, 71-80, 81-90, 91-100]`\n\nFor some source root domains, a spam score is not available. Links from these domains are not counted in the response distribution.", "default": "Fetch Site Metrics Distributions" }, "DataSiteMetricsFetchMultipleActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteMetricsFetchMultipleActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteMetricsFetchMultipleActionData": { "type": "object", "properties": { "site_queries": { "type": "array", "items": { "$ref": "#/definitions/DataSiteQueryInput" } } }, "required": [ "site_queries" ], "additionalProperties": false, "examples": [ { "site_queries": [ { "query": "https://moz.com/", "scope": "domain" }, { "query": "https://moz.com/blog", "scope": "url" } ] } ] }, "DataSiteMetricsFetchMultipleActionResult": { "type": "object", "properties": { "results_by_site": { "type": "array", "items": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "site_metrics": { "$ref": "#/definitions/DataSiteMetricsObject" } }, "required": [ "site_query", "site_metrics" ], "additionalProperties": false } }, "errors_by_site": { "type": "array", "items": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "error": { "$ref": "#/definitions/UnifiedApiPylonError" } }, "required": [ "site_query", "error" ], "additionalProperties": false } } }, "required": [ "results_by_site", "errors_by_site" ], "additionalProperties": false, "examples": [ { "results_by_site": [ { "site_query": { "query": "https://moz.com/blog", "scope": "url", "original_site_query": { "query": "moz.com/blog", "scope": "url" }, "site_query_suggestion": null }, "site_metrics": { "page": "moz.com/blog", "subdomain": "moz.com", "root_domain": "moz.com", "title": "The Moz Blog [SEO] - Moz", "last_crawled": "2024-11-02", "http_code": 200, "pages_to_page": 710698, "nofollow_pages_to_page": 7073, "redirect_pages_to_page": 812, "external_pages_to_page": 461992, "external_nofollow_pages_to_page": 7073, "external_redirect_pages_to_page": 273, "deleted_pages_to_page": 198443, "root_domains_to_page": 10409, "indirect_root_domains_to_page": 2107, "deleted_root_domains_to_page": 1564, "nofollow_root_domains_to_page": 1903, "pages_to_subdomain": 91619477, "nofollow_pages_to_subdomain": 13403603, "redirect_pages_to_subdomain": 47747395, "external_pages_to_subdomain": 67812167, "external_nofollow_pages_to_subdomain": 13383578, "external_redirect_pages_to_subdomain": 41154251, "deleted_pages_to_subdomain": 19706071, "root_domains_to_subdomain": 186553, "deleted_root_domains_to_subdomain": 29562, "nofollow_root_domains_to_subdomain": 38718, "pages_to_root_domain": 93088010, "nofollow_pages_to_root_domain": 13513706, "redirect_pages_to_root_domain": 47753026, "external_pages_to_root_domain": 68942297, "external_indirect_pages_to_root_domain": 44373352, "external_nofollow_pages_to_root_domain": 13492593, "external_redirect_pages_to_root_domain": 41157669, "deleted_pages_to_root_domain": 20137876, "root_domains_to_root_domain": 188816, "indirect_root_domains_to_root_domain": 27597, "deleted_root_domains_to_root_domain": 30393, "nofollow_root_domains_to_root_domain": 38829, "page_authority": 70, "domain_authority": 90, "link_propensity": 0.01030706428, "spam_score": 3, "root_domains_from_page": 6, "nofollow_root_domains_from_page": 0, "pages_from_page": 8, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 83316, "nofollow_root_domains_from_root_domain": 69184, "pages_from_root_domain": 398300, "nofollow_pages_from_root_domain": 261292, "pages_crawled_from_root_domain": 8083388 } }, { "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null }, "site_metrics": { "page": "moz.com/", "subdomain": "moz.com", "root_domain": "moz.com", "title": "Moz - SEO Software for Smarter Marketing", "last_crawled": "2024-11-04", "http_code": 200, "pages_to_page": 14888332, "nofollow_pages_to_page": 7348137, "redirect_pages_to_page": 3685769, "external_pages_to_page": 14630805, "external_nofollow_pages_to_page": 7348137, "external_redirect_pages_to_page": 3685309, "deleted_pages_to_page": 2785246, "root_domains_to_page": 45303, "indirect_root_domains_to_page": 10655, "deleted_root_domains_to_page": 7248, "nofollow_root_domains_to_page": 9374, "pages_to_subdomain": 91619477, "nofollow_pages_to_subdomain": 13403603, "redirect_pages_to_subdomain": 47747395, "external_pages_to_subdomain": 67812167, "external_nofollow_pages_to_subdomain": 13383578, "external_redirect_pages_to_subdomain": 41154251, "deleted_pages_to_subdomain": 19706071, "root_domains_to_subdomain": 186553, "deleted_root_domains_to_subdomain": 29562, "nofollow_root_domains_to_subdomain": 38718, "pages_to_root_domain": 93088010, "nofollow_pages_to_root_domain": 13513706, "redirect_pages_to_root_domain": 47753026, "external_pages_to_root_domain": 68942297, "external_indirect_pages_to_root_domain": 44373352, "external_nofollow_pages_to_root_domain": 13492593, "external_redirect_pages_to_root_domain": 41157669, "deleted_pages_to_root_domain": 20137876, "root_domains_to_root_domain": 188816, "indirect_root_domains_to_root_domain": 27597, "deleted_root_domains_to_root_domain": 30393, "nofollow_root_domains_to_root_domain": 38829, "page_authority": 75, "domain_authority": 90, "link_propensity": 0.01030706428, "spam_score": 3, "root_domains_from_page": 10, "nofollow_root_domains_from_page": 0, "pages_from_page": 13, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 83316, "nofollow_root_domains_from_root_domain": 69184, "pages_from_root_domain": 398300, "nofollow_pages_from_root_domain": 261292, "pages_crawled_from_root_domain": 8083388 } } ], "errors_by_site": [] } ] }, "DataSiteMetricsFetchMultipleActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteMetricsFetchMultipleAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteMetricsFetchMultipleActionPayload" }, "result": { "$ref": "#/definitions/DataSiteMetricsFetchMultipleActionResult" }, "quota": { "$ref": "#/definitions/DataSiteMetricsFetchMultipleActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get metrics such as Domain Authority, Page Authority, Spam Score, link counts and more about one or more URLs", "default": "Fetch Multiple Site Metrics" }, "DataSiteMetricsFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteMetricsFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteMetricsFetchActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com/blog", "scope": "domain" } }, { "site_query": { "query": "https://store.google.com", "scope": "subdomain" } } ] }, "DataSiteMetricsFetchActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "site_metrics": { "$ref": "#/definitions/DataSiteMetricsObject" } }, "required": [ "site_query", "site_metrics" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "moz.com", "scope": "domain" }, "site_query_suggestion": null }, "site_metrics": { "page": "moz.com", "subdomain": "moz.com", "root_domain": "moz.com", "title": "The Moz Blog", "last_crawled": "2023-06-01", "http_code": 200, "pages_to_page": 123, "nofollow_pages_to_page": 5, "redirect_pages_to_page": 10, "external_pages_to_page": 100, "external_nofollow_pages_to_page": 3, "external_redirect_pages_to_page": 8, "deleted_pages_to_page": 2, "root_domains_to_page": 50, "indirect_root_domains_to_page": 15, "deleted_root_domains_to_page": 1, "nofollow_root_domains_to_page": 2, "pages_to_subdomain": 500, "nofollow_pages_to_subdomain": 20, "redirect_pages_to_subdomain": 40, "external_pages_to_subdomain": 400, "external_nofollow_pages_to_subdomain": 15, "external_redirect_pages_to_subdomain": 30, "deleted_pages_to_subdomain": 10, "root_domains_to_subdomain": 100, "deleted_root_domains_to_subdomain": 5, "nofollow_root_domains_to_subdomain": 10, "pages_to_root_domain": 5000, "nofollow_pages_to_root_domain": 200, "redirect_pages_to_root_domain": 400, "external_pages_to_root_domain": 4000, "external_indirect_pages_to_root_domain": 1000, "external_nofollow_pages_to_root_domain": 150, "external_redirect_pages_to_root_domain": 300, "deleted_pages_to_root_domain": 100, "root_domains_to_root_domain": 500, "indirect_root_domains_to_root_domain": 200, "deleted_root_domains_to_root_domain": 50, "nofollow_root_domains_to_root_domain": 100, "page_authority": 45, "domain_authority": 55, "link_propensity": 0.8, "spam_score": 2, "root_domains_from_page": 10, "nofollow_root_domains_from_page": 1, "pages_from_page": 50, "nofollow_pages_from_page": 5, "root_domains_from_root_domain": 1000, "nofollow_root_domains_from_root_domain": 100, "pages_from_root_domain": 5000, "nofollow_pages_from_root_domain": 500, "pages_crawled_from_root_domain": 10000 } } ] }, "DataSiteMetricsFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per call." }, "DataSiteMetricsFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteMetricsFetchActionPayload" }, "result": { "$ref": "#/definitions/DataSiteMetricsFetchActionResult" }, "quota": { "$ref": "#/definitions/DataSiteMetricsFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get metrics such as Domain Authority, Page Authority, Spam Score, link counts and more for one URL", "default": "Fetch Site Metrics" }, "DataSiteMetricsHistoriesFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteMetricsHistoriesFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteMetricsHistoriesFetchActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" }, "get_daily_history_deltas_for": { "$ref": "#/definitions/DataDailyHistoryDeltasForInput" }, "get_daily_history_values_for": { "$ref": "#/definitions/DataDailyHistoryValuesForInput" }, "get_monthly_history_deltas_for": { "$ref": "#/definitions/DataMonthlyHistoryDeltasForInput" }, "get_monthly_history_values_for": { "$ref": "#/definitions/DataMonthlyHistoryValuesForInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain" }, "get_monthly_history_deltas_for": [ "page_authority", "domain_authority" ] } ] }, "DataDailyHistoryDeltasForInput": { "type": "array", "items": { "$ref": "#/definitions/HistoryDeltasKeys" }, "description": "Optional array of values for which to get daily history deltas. Valid values are all non-deleted link count metrics from the site_metrics object in [Fetch Site Metrics](/api/docs/methods/DataSiteMetricsFetchAction) (`pages_to_page`, etc), `page_authority`, and `domain_authority`. At least one value must be provided between `get_daily_history_deltas_for`, `get_daily_history_values_for`, `get_monthly_history_deltas_for`, and `get_monthly_history_values_for`." }, "HistoryDeltasKeys": { "type": "string", "enum": [ "pages_to_page", "nofollow_pages_to_page", "redirect_pages_to_page", "external_pages_to_page", "external_nofollow_pages_to_page", "external_redirect_pages_to_page", "root_domains_to_page", "indirect_root_domains_to_page", "nofollow_root_domains_to_page", "pages_to_subdomain", "nofollow_pages_to_subdomain", "redirect_pages_to_subdomain", "external_pages_to_subdomain", "external_nofollow_pages_to_subdomain", "external_redirect_pages_to_subdomain", "root_domains_to_subdomain", "nofollow_root_domains_to_subdomain", "pages_to_root_domain", "nofollow_pages_to_root_domain", "redirect_pages_to_root_domain", "external_pages_to_root_domain", "external_indirect_pages_to_root_domain", "external_nofollow_pages_to_root_domain", "external_redirect_pages_to_root_domain", "root_domains_to_root_domain", "indirect_root_domains_to_root_domain", "nofollow_root_domains_to_root_domain", "page_authority", "domain_authority" ], "description": "Optional array of values for which to get daily history deltas. Valid values are all non-deleted link count metrics from the site_metrics object in [Fetch Site Metrics](https://moz.com/api/docs/methods/DataSiteMetricsFetchAction) (`pages_to_page`, etc), `page_authority`, and `domain_authority`. At least one value must be provided between `get_daily_history_deltas_for`, `get_daily_history_values_for`, `get_monthly_history_deltas_for`, and `get_monthly_history_values_for`." }, "DataDailyHistoryValuesForInput": { "type": "array", "items": { "$ref": "#/definitions/HistoryValuesKeys" }, "description": "Optional array of values for which to get daily history values. Valid values are all non-deleted link count metrics from the site_metrics object in [Fetch Site Metrics](/api/docs/methods/DataSiteMetricsFetchAction) (`pages_to_page`, etc), `page_authority`, `domain_authority`, `nofollow_pages_to_root_domain_by_spam_score`, `nofollow_root_domains_to_root_domain_by_root_domains`, `nofollow_root_domains_to_root_domain_by_spam_score`, `pages_to_root_domain_by_spam_score`, `root_domains_to_root_domain_by_root_domains`, `root_domains_to_root_domain_by_spam_score`. At least one value must be provided between `get_daily_history_deltas_for`, `get_daily_history_values_for`, `get_monthly_history_deltas_for`, and `get_monthly_history_values_for`." }, "HistoryValuesKeys": { "type": "string", "enum": [ "pages_to_page", "nofollow_pages_to_page", "redirect_pages_to_page", "external_pages_to_page", "external_nofollow_pages_to_page", "external_redirect_pages_to_page", "root_domains_to_page", "indirect_root_domains_to_page", "nofollow_root_domains_to_page", "pages_to_subdomain", "nofollow_pages_to_subdomain", "redirect_pages_to_subdomain", "external_pages_to_subdomain", "external_nofollow_pages_to_subdomain", "external_redirect_pages_to_subdomain", "root_domains_to_subdomain", "nofollow_root_domains_to_subdomain", "pages_to_root_domain", "nofollow_pages_to_root_domain", "redirect_pages_to_root_domain", "external_pages_to_root_domain", "external_indirect_pages_to_root_domain", "external_nofollow_pages_to_root_domain", "external_redirect_pages_to_root_domain", "root_domains_to_root_domain", "indirect_root_domains_to_root_domain", "nofollow_root_domains_to_root_domain", "page_authority", "domain_authority", "root_domains_to_root_domain_by_root_domains", "nofollow_root_domains_to_root_domain_by_root_domains", "pages_to_root_domain_by_spam_score", "nofollow_pages_to_root_domain_by_spam_score", "root_domains_to_root_domain_by_spam_score", "nofollow_root_domains_to_root_domain_by_spam_score" ], "description": "Optional array of values for which to get daily history values. Valid values are all non-deleted link count metrics from the site_metrics object in [Fetch Site Metrics](https://moz.com/api/docs/methods/DataSiteMetricsFetchAction) (`pages_to_page`, etc), `page_authority`, `domain_authority`, `nofollow_pages_to_root_domain_by_spam_score`, `nofollow_root_domains_to_root_domain_by_root_domains`, `nofollow_root_domains_to_root_domain_by_spam_score`, `pages_to_root_domain_by_spam_score`, `root_domains_to_root_domain_by_root_domains`, `root_domains_to_root_domain_by_spam_score`. At least one value must be provided between `get_daily_history_deltas_for`, `get_daily_history_values_for`, `get_monthly_history_deltas_for`, and `get_monthly_history_values_for`." }, "DataMonthlyHistoryDeltasForInput": { "type": "array", "items": { "$ref": "#/definitions/HistoryDeltasMonthlyKeys" }, "description": "Optional array of values for which to get monthly history deltas. Valid values are all non-deleted link count metrics from the site_metrics object in [Fetch Site Metrics](/api/docs/methods/DataSiteMetricsFetchAction) (`pages_to_page`, etc), `page_authority`, and `domain_authority`. At least one value must be provided between `get_daily_history_deltas_for`, `get_daily_history_values_for`, `get_monthly_history_deltas_for`, and `get_monthly_history_values_for`." }, "HistoryDeltasMonthlyKeys": { "type": "string", "enum": [ "pages_to_page", "nofollow_pages_to_page", "redirect_pages_to_page", "external_pages_to_page", "external_nofollow_pages_to_page", "external_redirect_pages_to_page", "root_domains_to_page", "indirect_root_domains_to_page", "nofollow_root_domains_to_page", "pages_to_subdomain", "nofollow_pages_to_subdomain", "redirect_pages_to_subdomain", "external_pages_to_subdomain", "external_nofollow_pages_to_subdomain", "external_redirect_pages_to_subdomain", "root_domains_to_subdomain", "nofollow_root_domains_to_subdomain", "pages_to_root_domain", "nofollow_pages_to_root_domain", "redirect_pages_to_root_domain", "external_pages_to_root_domain", "external_indirect_pages_to_root_domain", "external_nofollow_pages_to_root_domain", "external_redirect_pages_to_root_domain", "root_domains_to_root_domain", "indirect_root_domains_to_root_domain", "nofollow_root_domains_to_root_domain", "page_authority", "domain_authority" ], "description": "Optional array of values for which to get monthly history deltas. Valid values are all non-deleted link count metrics from the site_metrics object in [Fetch Site Metrics](https://moz.com/api/docs/methods/DataSiteMetricsFetchAction) (`pages_to_page`, etc), `page_authority`, and `domain_authority`. At least one value must be provided between `get_daily_history_deltas_for`, `get_daily_history_values_for`, `get_monthly_history_deltas_for`, and `get_monthly_history_values_for`." }, "DataMonthlyHistoryValuesForInput": { "type": "array", "items": { "$ref": "#/definitions/HistoryValuesMonthlyKeys" }, "description": "Optional array of values for which to get monthly history values. Valid values are all non-deleted link count metrics from the site_metrics object in [Fetch Site Metrics](/api/docs/methods/DataSiteMetricsFetchAction) (`pages_to_page`, etc), `page_authority`, `domain_authority`, `nofollow_pages_to_root_domain_by_spam_score`, `nofollow_root_domains_to_root_domain_by_root_domains`, `nofollow_root_domains_to_root_domain_by_spam_score`, `pages_to_root_domain_by_spam_score`, `root_domains_to_root_domain_by_root_domains`, `root_domains_to_root_domain_by_spam_score`. At least one value must be provided between `get_daily_history_deltas_for`, `get_daily_history_values_for`, `get_monthly_history_deltas_for`, and `get_monthly_history_values_for`." }, "HistoryValuesMonthlyKeys": { "type": "string", "enum": [ "pages_to_page", "nofollow_pages_to_page", "redirect_pages_to_page", "external_pages_to_page", "external_nofollow_pages_to_page", "external_redirect_pages_to_page", "root_domains_to_page", "indirect_root_domains_to_page", "nofollow_root_domains_to_page", "pages_to_subdomain", "nofollow_pages_to_subdomain", "redirect_pages_to_subdomain", "external_pages_to_subdomain", "external_nofollow_pages_to_subdomain", "external_redirect_pages_to_subdomain", "root_domains_to_subdomain", "nofollow_root_domains_to_subdomain", "pages_to_root_domain", "nofollow_pages_to_root_domain", "redirect_pages_to_root_domain", "external_pages_to_root_domain", "external_indirect_pages_to_root_domain", "external_nofollow_pages_to_root_domain", "external_redirect_pages_to_root_domain", "root_domains_to_root_domain", "indirect_root_domains_to_root_domain", "nofollow_root_domains_to_root_domain", "page_authority", "domain_authority", "root_domains_to_root_domain_by_root_domains", "nofollow_root_domains_to_root_domain_by_root_domains", "pages_to_root_domain_by_spam_score", "nofollow_pages_to_root_domain_by_spam_score", "root_domains_to_root_domain_by_spam_score", "nofollow_root_domains_to_root_domain_by_spam_score" ], "description": "Optional array of values for which to get monthly history values. Valid values are all non-deleted link count metrics from the site_metrics object in [Fetch Site Metrics](https://moz.com/api/docs/methods/DataSiteMetricsFetchAction) (`pages_to_page`, etc), `page_authority`, `domain_authority`, `nofollow_pages_to_root_domain_by_spam_score`, `nofollow_root_domains_to_root_domain_by_root_domains`, `nofollow_root_domains_to_root_domain_by_spam_score`, `pages_to_root_domain_by_spam_score`, `root_domains_to_root_domain_by_root_domains`, `root_domains_to_root_domain_by_spam_score`. At least one value must be provided between `get_daily_history_deltas_for`, `get_daily_history_values_for`, `get_monthly_history_deltas_for`, and `get_monthly_history_values_for`." }, "DataSiteMetricsHistoriesFetchActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "site_metrics_histories": { "$ref": "#/definitions/DataSiteMetricsHistoriesObject" } }, "required": [ "site_query", "site_metrics_histories" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "https://www.moz.com", "scope": "domain" }, "suggestion": null }, "site_metrics_histories": { "monthly_history_values": [ { "metric_name": "external_pages_to_subdomain", "metric_values": [ { "date": "2024-04", "value": 68470586 }, { "date": "2024-05", "value": 68157308 }, { "date": "2024-06", "value": 68017964 } ] }, { "metric_name": "nofollow_pages_to_subdomain", "metric_values": [ { "date": "2024-04", "value": 14002752 }, { "date": "2024-05", "value": 13648645 }, { "date": "2024-06", "value": 13511416 } ] } ] } }, { "site_query": { "query": "https://moz.com", "scope": "domain", "original_site_query": { "query": "https://www.moz.com", "scope": "domain" }, "suggestion": null }, "site_metrics_histories": { "monthly_history_deltas": [ { "metric_name": "external_pages_to_subdomain", "metric_deltas": { "gained": [ { "date": "2024-06", "count": 164072 }, { "date": "2024-05", "count": 555174 }, { "date": "2024-04", "count": 2164846 } ], "lost": [ { "date": "2024-06", "count": 303416 }, { "date": "2024-05", "count": 868452 }, { "date": "2024-04", "count": 1050554 } ] } }, { "metric_name": "nofollow_pages_to_subdomain", "metric_deltas": { "gained": [ { "date": "2024-06", "count": 31105 }, { "date": "2024-05", "count": 93768 }, { "date": "2024-04", "count": 80665 } ], "lost": [ { "date": "2024-06", "count": 168334 }, { "date": "2024-05", "count": 447875 }, { "date": "2024-04", "count": 789012 } ] } } ] } } ] }, "DataSiteMetricsHistoriesObject": { "type": "object", "properties": { "daily_history_deltas": { "type": "array", "items": { "$ref": "#/definitions/DataSiteMetricsHistoriesDelta" } }, "daily_history_values": { "type": "array", "items": { "$ref": "#/definitions/DataSiteMetricsHistoriesValue" } }, "monthly_history_deltas": { "type": "array", "items": { "$ref": "#/definitions/DataSiteMetricsHistoriesDelta" } }, "monthly_history_values": { "type": "array", "items": { "$ref": "#/definitions/DataSiteMetricsHistoriesValue" } } }, "additionalProperties": false, "description": "Represents a Site Metrics Histories object." }, "DataSiteMetricsHistoriesDelta": { "type": "object", "properties": { "metric_name": { "$ref": "#/definitions/HistoryDeltasKeys" }, "metric_deltas": { "$ref": "#/definitions/GainedAndLost" } }, "required": [ "metric_name", "metric_deltas" ], "additionalProperties": false, "description": "A list of metrics to return daily history for as a sequence of dated gains and losses. Results for each metric will appear under a key matching its name in the '{daily/monthly}_history_deltas' response. Delta values for count metrics (pages_to_page, etc) will begin with the most recent gain or loss for that metric, and end no earlier than 60 days prior for daily, and 32 months for monthly. Delta values for authority metrics (page_authority, domain_authority) will begin on the day the index was last updated and end no earlier than 60 days prior (for daily), and 32 months (for monthly)." }, "GainedAndLost": { "type": "object", "properties": { "gained": { "type": "array", "items": { "$ref": "#/definitions/DateAndCount" } }, "lost": { "type": "array", "items": { "$ref": "#/definitions/DateAndCount" } } }, "required": [ "gained", "lost" ], "additionalProperties": false }, "DateAndCount": { "type": "object", "properties": { "date": { "$ref": "#/definitions/DateAndCountDate" }, "count": { "$ref": "#/definitions/DateAndCountCount" } }, "required": [ "date", "count" ], "additionalProperties": false }, "DateAndCountDate": { "type": "string", "description": "The date of the loss in 'YYYY-MM-DD' or 'YYYY-MM'for GainedAndLost format." }, "DateAndCountCount": { "type": "number", "description": "The value of the associated with a count metric on 'date'." }, "DataSiteMetricsHistoriesValue": { "type": "object", "properties": { "metric_name": { "$ref": "#/definitions/HistoryValuesKeys" }, "metric_values": { "type": "array", "items": { "$ref": "#/definitions/DataSiteMetricsHistoriesValueMetricsValues" } } }, "required": [ "metric_name", "metric_values" ], "additionalProperties": false, "description": "A list of metrics to return daily/monthly history for as a sequence of date + value pairs. Results for each metric will appear under a key matching its name in the '{daily/monthly}_history_values' response. History values will begin on the day the index was last updated and end 60 days prior (for daily), and 32 months (for monthly)." }, "DataSiteMetricsHistoriesValueMetricsValues": { "type": "object", "properties": { "date": { "$ref": "#/definitions/DateAndCountDate" }, "value": { "$ref": "#/definitions/DateAndCountCount" } }, "required": [ "date", "value" ], "additionalProperties": false }, "DataSiteMetricsHistoriesFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_value" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_value_multiplier": { "type": "number", "const": 1 }, "max_values": { "type": "number", "const": 100 } }, "required": [ "max_values", "path", "per_value_multiplier", "type" ], "additionalProperties": false, "description": "Uses 1 row of quota for every root-level item in `result.site_metrics_histories.daily_history_values`, 1 row of quota for every root-level item in `result.site_metrics_histories.daily_history_deltas`, 1 row of quota for every root-level item in `result.site_metrics_histories.monthly_history_values`, and 1 row of quota for every root-level item in `result.site_metrics_histories.monthly_history_deltas` (i.e. total quota used is the sum of the length of each of these 4 arrays in the response)." }, "DataSiteMetricsHistoriesFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteMetricsHistoriesFetchActionPayload" }, "result": { "$ref": "#/definitions/DataSiteMetricsHistoriesFetchActionResult" }, "quota": { "$ref": "#/definitions/DataSiteMetricsHistoriesFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to get daily or monthly metric histories for a single site. Histories can be returned as absolute values, or relative +/- deltas.", "default": "Fetch Site Metric Histories", "title": "data.site.metrics.histories.fetch" }, "DataSiteRankingKeywordCountActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteRankingKeywordCountActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteRankingKeywordCountActionData": { "type": "object", "properties": { "target_query": { "$ref": "#/definitions/DataSiteRankingKeywordCountActionDataTargetQuery" } }, "required": [ "target_query" ], "additionalProperties": false, "examples": [ { "target_query": { "query": "moz.com", "scope": "domain", "locale": "en-US" } }, { "target_query": { "query": "moz.com", "scope": "domain", "locale": "en-GB" } }, { "target_query": { "query": "moz.com/blog", "scope": "url", "locale": "en-US" } }, { "target_query": { "query": "store.google.com", "scope": "subdomain", "locale": "en-US" } } ] }, "DataSiteRankingKeywordCountActionDataTargetQuery": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataTargetQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteRankingKeywordCountActionDataTargetQueryScope" }, "locale": { "$ref": "#/definitions/DataTargetQueryInputLocales" } }, "required": [ "locale", "query", "scope" ], "additionalProperties": false, "description": "The target query to use for the ranking keyword count." }, "DataSiteRankingKeywordCountActionDataTargetQueryScope": { "type": "string", "enum": [ "domain", "subdomain", "url" ], "description": "Ranking keyword count currently supports only the following scopes." }, "DataSiteRankingKeywordCountActionResult": { "type": "object", "properties": { "ranking_keyword_count": { "$ref": "#/definitions/DataSiteRankingKeywordCountObject" }, "target_query": { "$ref": "#/definitions/DataSiteRankingKeywordCountActionResultDataTargetQueryObject" } }, "required": [ "ranking_keyword_count", "target_query" ], "additionalProperties": false, "examples": [ { "target_query": { "query": "moz.com", "scope": "domain", "locale": "en-US", "original_target_query": { "query": "moz.com", "scope": "domain", "locale": "en-US" }, "suggestion": null }, "ranking_keyword_count": { "total": 39817, "position": { "rank_1": 2689, "rank_2": 1062, "rank_3": 1014, "rank_4": 989, "rank_5": 1093, "rank_6": 1145, "rank_7": 1206, "rank_8": 1273, "rank_9": 1112, "rank_10": 1082, "rank_11": 983, "rank_12": 976, "rank_13": 876, "rank_14": 834, "rank_15": 833, "rank_16": 778, "rank_17": 774, "rank_18": 770, "rank_19": 776, "rank_20": 772, "rank_21": 755, "rank_22": 762, "rank_23": 724, "rank_24": 718, "rank_25": 725, "rank_26": 700, "rank_27": 690, "rank_28": 698, "rank_29": 713, "rank_30": 685, "rank_31": 751, "rank_32": 721, "rank_33": 711, "rank_34": 666, "rank_35": 648, "rank_36": 651, "rank_37": 641, "rank_38": 631, "rank_39": 595, "rank_40": 582, "rank_41": 566, "rank_42": 597, "rank_43": 584, "rank_44": 579, "rank_45": 573, "rank_46": 549, "rank_47": 518, "rank_48": 473, "rank_49": 361, "rank_50": 213 } } } ] }, "DataSiteRankingKeywordCountObject": { "type": "object", "properties": { "total": { "$ref": "#/definitions/DataSiteRankingKeywordCountTotal" }, "position": { "$ref": "#/definitions/DataSiteRankingKeywordCountObjectPosition" } }, "required": [ "total", "position" ], "additionalProperties": false, "description": "An object describing the number of keywords for which the given query ranks in the top 50 results." }, "DataSiteRankingKeywordCountTotal": { "type": "number", "description": "The total number of keywords for which the given query ranks in the top 50." }, "DataSiteRankingKeywordCountObjectPosition": { "type": "object", "properties": { "rank_1": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank1Count" }, "rank_2": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank2Count" }, "rank_3": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank3Count" }, "rank_4": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank4Count" }, "rank_5": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank5Count" }, "rank_6": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank6Count" }, "rank_7": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank7Count" }, "rank_8": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank8Count" }, "rank_9": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank9Count" }, "rank_10": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank10Count" }, "rank_11": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank11Count" }, "rank_12": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank12Count" }, "rank_13": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank13Count" }, "rank_14": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank14Count" }, "rank_15": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank15Count" }, "rank_16": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank16Count" }, "rank_17": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank17Count" }, "rank_18": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank18Count" }, "rank_19": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank19Count" }, "rank_20": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank20Count" }, "rank_21": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank21Count" }, "rank_22": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank22Count" }, "rank_23": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank23Count" }, "rank_24": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank24Count" }, "rank_25": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank25Count" }, "rank_26": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank26Count" }, "rank_27": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank27Count" }, "rank_28": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank28Count" }, "rank_29": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank29Count" }, "rank_30": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank30Count" }, "rank_31": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank31Count" }, "rank_32": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank32Count" }, "rank_33": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank33Count" }, "rank_34": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank34Count" }, "rank_35": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank35Count" }, "rank_36": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank36Count" }, "rank_37": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank37Count" }, "rank_38": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank38Count" }, "rank_39": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank39Count" }, "rank_40": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank40Count" }, "rank_41": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank41Count" }, "rank_42": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank42Count" }, "rank_43": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank43Count" }, "rank_44": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank44Count" }, "rank_45": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank45Count" }, "rank_46": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank46Count" }, "rank_47": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank47Count" }, "rank_48": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank48Count" }, "rank_49": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank49Count" }, "rank_50": { "$ref": "#/definitions/DataSiteRankingKeywordCountPositionRank50Count" } }, "required": [ "rank_1", "rank_2", "rank_3", "rank_4", "rank_5", "rank_6", "rank_7", "rank_8", "rank_9", "rank_10", "rank_11", "rank_12", "rank_13", "rank_14", "rank_15", "rank_16", "rank_17", "rank_18", "rank_19", "rank_20", "rank_21", "rank_22", "rank_23", "rank_24", "rank_25", "rank_26", "rank_27", "rank_28", "rank_29", "rank_30", "rank_31", "rank_32", "rank_33", "rank_34", "rank_35", "rank_36", "rank_37", "rank_38", "rank_39", "rank_40", "rank_41", "rank_42", "rank_43", "rank_44", "rank_45", "rank_46", "rank_47", "rank_48", "rank_49", "rank_50" ], "additionalProperties": false, "description": "An object describing the number of keywords for which the given query ranks in the top 50. Each key represents the position ranking, and the value is the number of keywords the target ranks for that position." }, "DataSiteRankingKeywordCountPositionRank1Count": { "type": "number", "description": "Number of keywords where the query ranks at position 1." }, "DataSiteRankingKeywordCountPositionRank2Count": { "type": "number", "description": "Number of keywords where the query ranks at position 2." }, "DataSiteRankingKeywordCountPositionRank3Count": { "type": "number", "description": "Number of keywords where the query ranks at position 3." }, "DataSiteRankingKeywordCountPositionRank4Count": { "type": "number", "description": "Number of keywords where the query ranks at position 4." }, "DataSiteRankingKeywordCountPositionRank5Count": { "type": "number", "description": "Number of keywords where the query ranks at position 5." }, "DataSiteRankingKeywordCountPositionRank6Count": { "type": "number", "description": "Number of keywords where the query ranks at position 6." }, "DataSiteRankingKeywordCountPositionRank7Count": { "type": "number", "description": "Number of keywords where the query ranks at position 7." }, "DataSiteRankingKeywordCountPositionRank8Count": { "type": "number", "description": "Number of keywords where the query ranks at position 8." }, "DataSiteRankingKeywordCountPositionRank9Count": { "type": "number", "description": "Number of keywords where the query ranks at position 9." }, "DataSiteRankingKeywordCountPositionRank10Count": { "type": "number", "description": "Number of keywords where the query ranks at position 10." }, "DataSiteRankingKeywordCountPositionRank11Count": { "type": "number", "description": "Number of keywords where the query ranks at position 11." }, "DataSiteRankingKeywordCountPositionRank12Count": { "type": "number", "description": "Number of keywords where the query ranks at position 12." }, "DataSiteRankingKeywordCountPositionRank13Count": { "type": "number", "description": "Number of keywords where the query ranks at position 13." }, "DataSiteRankingKeywordCountPositionRank14Count": { "type": "number", "description": "Number of keywords where the query ranks at position 14." }, "DataSiteRankingKeywordCountPositionRank15Count": { "type": "number", "description": "Number of keywords where the query ranks at position 15." }, "DataSiteRankingKeywordCountPositionRank16Count": { "type": "number", "description": "Number of keywords where the query ranks at position 16." }, "DataSiteRankingKeywordCountPositionRank17Count": { "type": "number", "description": "Number of keywords where the query ranks at position 17." }, "DataSiteRankingKeywordCountPositionRank18Count": { "type": "number", "description": "Number of keywords where the query ranks at position 18." }, "DataSiteRankingKeywordCountPositionRank19Count": { "type": "number", "description": "Number of keywords where the query ranks at position 19." }, "DataSiteRankingKeywordCountPositionRank20Count": { "type": "number", "description": "Number of keywords where the query ranks at position 20." }, "DataSiteRankingKeywordCountPositionRank21Count": { "type": "number", "description": "Number of keywords where the query ranks at position 21." }, "DataSiteRankingKeywordCountPositionRank22Count": { "type": "number", "description": "Number of keywords where the query ranks at position 22." }, "DataSiteRankingKeywordCountPositionRank23Count": { "type": "number", "description": "Number of keywords where the query ranks at position 23." }, "DataSiteRankingKeywordCountPositionRank24Count": { "type": "number", "description": "Number of keywords where the query ranks at position 24." }, "DataSiteRankingKeywordCountPositionRank25Count": { "type": "number", "description": "Number of keywords where the query ranks at position 25." }, "DataSiteRankingKeywordCountPositionRank26Count": { "type": "number", "description": "Number of keywords where the query ranks at position 26." }, "DataSiteRankingKeywordCountPositionRank27Count": { "type": "number", "description": "Number of keywords where the query ranks at position 27." }, "DataSiteRankingKeywordCountPositionRank28Count": { "type": "number", "description": "Number of keywords where the query ranks at position 28." }, "DataSiteRankingKeywordCountPositionRank29Count": { "type": "number", "description": "Number of keywords where the query ranks at position 29." }, "DataSiteRankingKeywordCountPositionRank30Count": { "type": "number", "description": "Number of keywords where the query ranks at position 30." }, "DataSiteRankingKeywordCountPositionRank31Count": { "type": "number", "description": "Number of keywords where the query ranks at position 31." }, "DataSiteRankingKeywordCountPositionRank32Count": { "type": "number", "description": "Number of keywords where the query ranks at position 32." }, "DataSiteRankingKeywordCountPositionRank33Count": { "type": "number", "description": "Number of keywords where the query ranks at position 33." }, "DataSiteRankingKeywordCountPositionRank34Count": { "type": "number", "description": "Number of keywords where the query ranks at position 34." }, "DataSiteRankingKeywordCountPositionRank35Count": { "type": "number", "description": "Number of keywords where the query ranks at position 35." }, "DataSiteRankingKeywordCountPositionRank36Count": { "type": "number", "description": "Number of keywords where the query ranks at position 36." }, "DataSiteRankingKeywordCountPositionRank37Count": { "type": "number", "description": "Number of keywords where the query ranks at position 37." }, "DataSiteRankingKeywordCountPositionRank38Count": { "type": "number", "description": "Number of keywords where the query ranks at position 38." }, "DataSiteRankingKeywordCountPositionRank39Count": { "type": "number", "description": "Number of keywords where the query ranks at position 39." }, "DataSiteRankingKeywordCountPositionRank40Count": { "type": "number", "description": "Number of keywords where the query ranks at position 40." }, "DataSiteRankingKeywordCountPositionRank41Count": { "type": "number", "description": "Number of keywords where the query ranks at position 41." }, "DataSiteRankingKeywordCountPositionRank42Count": { "type": "number", "description": "Number of keywords where the query ranks at position 42." }, "DataSiteRankingKeywordCountPositionRank43Count": { "type": "number", "description": "Number of keywords where the query ranks at position 43." }, "DataSiteRankingKeywordCountPositionRank44Count": { "type": "number", "description": "Number of keywords where the query ranks at position 44." }, "DataSiteRankingKeywordCountPositionRank45Count": { "type": "number", "description": "Number of keywords where the query ranks at position 45." }, "DataSiteRankingKeywordCountPositionRank46Count": { "type": "number", "description": "Number of keywords where the query ranks at position 46." }, "DataSiteRankingKeywordCountPositionRank47Count": { "type": "number", "description": "Number of keywords where the query ranks at position 47." }, "DataSiteRankingKeywordCountPositionRank48Count": { "type": "number", "description": "Number of keywords where the query ranks at position 48." }, "DataSiteRankingKeywordCountPositionRank49Count": { "type": "number", "description": "Number of keywords where the query ranks at position 49." }, "DataSiteRankingKeywordCountPositionRank50Count": { "type": "number", "description": "Number of keywords where the query ranks at position 50." }, "DataSiteRankingKeywordCountActionResultDataTargetQueryObject": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataTargetQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteRankingKeywordCountActionResultDataTargetQueryObjectScope" }, "locale": { "$ref": "#/definitions/DataTargetQueryInputLocales" }, "original_target_query": { "$ref": "#/definitions/DataTargetQueryObjectOriginalTargetQuery" }, "suggestion": { "anyOf": [ { "$ref": "#/definitions/TargetSuggestionObject" }, { "type": "null" } ] } }, "required": [ "locale", "original_target_query", "query", "scope", "suggestion" ], "additionalProperties": false }, "DataSiteRankingKeywordCountActionResultDataTargetQueryObjectScope": { "type": "string", "enum": [ "domain", "subdomain", "url" ], "description": "The scope used to parse the query." }, "DataSiteRankingKeywordCountActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses 1 row per call." }, "DataSiteRankingKeywordCountAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteRankingKeywordCountActionPayload" }, "result": { "$ref": "#/definitions/DataSiteRankingKeywordCountActionResult" }, "quota": { "$ref": "#/definitions/DataSiteRankingKeywordCountActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve a summary of the number of keywords for which the provided query (domain, subdomain, or page) ranks in the top 50.", "default": "Count Ranking Keywords", "title": "data.site.ranking-keyword.count" }, "DataSiteRankingKeywordListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteRankingKeywordListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteRankingKeywordListActionData": { "type": "object", "properties": { "target_query": { "$ref": "#/definitions/DataTargetQueryInput" }, "options": { "$ref": "#/definitions/DataSiteRankingKeywordListOptionsObject" }, "page": { "$ref": "#/definitions/DataSiteRankingKeywordListTargetQueryInputPage" } }, "required": [ "target_query" ], "additionalProperties": false, "examples": [ { "target_query": { "query": "moz.com", "scope": "domain", "locale": "en-US" } }, { "target_query": { "query": "moz.com", "scope": "domain", "locale": "en-US" }, "options": { "sort": "rank" } }, { "target_query": { "query": "moz.com", "scope": "domain", "locale": "en-US" }, "page": { "n": 1, "limit": 10 } }, { "target_query": { "query": "store.google.com", "scope": "subdomain", "locale": "en-US" } } ] }, "DataTargetQueryInput": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataTargetQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataTargetQueryInputScopes" }, "locale": { "$ref": "#/definitions/DataTargetQueryInputLocales" } }, "required": [ "query", "scope", "locale" ], "additionalProperties": false, "description": "A TargetQuery provides a target URL along with several options to specify how the query is run." }, "DataSiteRankingKeywordListOptionsObject": { "type": "object", "properties": { "sort": { "$ref": "#/definitions/DataSiteRankingKeywordsOptionsSort" } }, "required": [ "sort" ], "additionalProperties": false, "description": "The options used when generating site ranking keywords result." }, "DataSiteRankingKeywordsOptionsSort": { "$ref": "#/definitions/Sort", "description": "Allowed sort options" }, "Sort": { "type": "string", "enum": [ "rank", "alpha", "difficulty", "volume" ], "default": null, "description": "Allowed sort options" }, "DataSiteRankingKeywordListTargetQueryInputPage": { "type": "object", "properties": { "n": { "$ref": "#/definitions/DataPageInputN" }, "limit": { "$ref": "#/definitions/DataSiteRankingKeywordListTargetQueryInputPageInputLimit" } }, "additionalProperties": false, "description": "Control the number of results returned per call in addition to fetching additional results. The default \"limit\" is 25 with an \"n\" value of 0 (indicating the first page of results). Make subsequent calls to the endpoint with incrementing \"n\" values to fetch additional pages of results." }, "DataSiteRankingKeywordListTargetQueryInputPageInputLimit": { "type": "number", "description": "The number of results per page. May be any value from 1 to 500.", "default": 25 }, "DataSiteRankingKeywordListActionResult": { "type": "object", "properties": { "ranking_keywords": { "type": "array", "items": { "$ref": "#/definitions/DataSiteRankingKeywordObject" } }, "target_query": { "$ref": "#/definitions/DataTargetQueryObject" }, "options": { "$ref": "#/definitions/DataSiteRankingKeywordListOptionsObject" }, "page": { "$ref": "#/definitions/DataPageObject" } }, "required": [ "ranking_keywords", "target_query", "options", "page" ], "additionalProperties": false, "examples": [ { "target_query": { "query": "moz.com", "scope": "domain", "locale": "en-US", "original_target_query": { "query": "moz.com", "scope": "domain", "locale": "en-US" }, "suggestion": null }, "options": { "sort": "rank" }, "page": { "n": 0, "limit": 50 }, "ranking_keywords": [ { "keyword": "moz", "ranking_page": "https://moz.com/", "rank_position": 1, "difficulty": 72, "volume": 6133 }, { "keyword": "domain authority checker", "ranking_page": "https://moz.com/domain-analysis", "rank_position": 1, "difficulty": 57, "volume": 3300 }, { "keyword": "check domain authority", "ranking_page": "https://moz.com/domain-analysis", "rank_position": 1, "difficulty": 60, "volume": 3300 } ] } ] }, "DataSiteRankingKeywordObject": { "type": "object", "properties": { "keyword": { "$ref": "#/definitions/DataSiteRankingKeywordObjectKeyword" }, "ranking_page": { "$ref": "#/definitions/DataSiteRankingKeywordObjectRankingPage" }, "rank_position": { "$ref": "#/definitions/DataSiteRankingKeywordObjectRankPosition" }, "difficulty": { "$ref": "#/definitions/DataSiteRankingKeywordObjectDifficulty" }, "volume": { "$ref": "#/definitions/DataSiteRankingKeywordObjectVolume" } }, "required": [ "keyword", "ranking_page", "rank_position", "difficulty", "volume" ], "additionalProperties": false, "description": "The information for the keywords ranked for a given site" }, "DataSiteRankingKeywordObjectKeyword": { "type": "string", "description": "The keyword that is ranked for. Assume the same locale as the provided input." }, "DataSiteRankingKeywordObjectRankingPage": { "type": "string", "description": "The exact URL that ranks for the given keyword." }, "DataSiteRankingKeywordObjectRankPosition": { "type": "number", "description": "The position of the given page for the given keyword on a SERP." }, "DataSiteRankingKeywordObjectDifficulty": { "type": [ "number", "null" ], "description": "How difficult the keyword is to rank for - between 1 and 100 with 100 being the most difficult. If not available, will be null." }, "DataSiteRankingKeywordObjectVolume": { "type": [ "number", "null" ], "description": "The approximate monthly search volume for the given keyword. If not available, will be null." }, "DataSiteRankingKeywordListActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteRankingKeywordListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteRankingKeywordListActionPayload" }, "result": { "$ref": "#/definitions/DataSiteRankingKeywordListActionResult" }, "quota": { "$ref": "#/definitions/DataSiteRankingKeywordListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve a list of keywords for which the provided site (domain, subdomain, subfolder, or page) ranks in the top 50, along with the ranking position and the difficulty and monthly search volume for each keyword.", "default": "List Ranking Keywords", "title": "data.site.ranking-keyword.list" }, "DataSiteRedirectFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteRedirectFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteRedirectFetchActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "seomoz.org/blog", "scope": "url" } } ] }, "DataSiteRedirectFetchActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "destination": { "$ref": "#/definitions/DataSiteRedirectFetchActionResultDestination" } }, "required": [ "site_query", "destination" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://seomoz.org/blog", "scope": "url", "original_site_query": { "query": "seomoz.org/blog", "scope": "url" }, "site_query_suggestion": null }, "destination": "moz.com/blog" } ] }, "DataSiteRedirectFetchActionResultDestination": { "type": [ "string", "null" ], "description": "If the provided site query redirects, this will be the final destination after following it and any subsequent redirects. If it does not redirect, it will be `null`." }, "DataSiteRedirectFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per call." }, "DataSiteRedirectFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteRedirectFetchActionPayload" }, "result": { "$ref": "#/definitions/DataSiteRedirectFetchActionResult" }, "quota": { "$ref": "#/definitions/DataSiteRedirectFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to see the final redirect target of a page after following known redirects in the index. This data can be helpful for tasks like technical audits, checking that redirects were implemented correctly after domain migrations or page moves.", "default": "Get Final Redirect Target" }, "DataSiteTopPageListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataSiteTopPageListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataSiteTopPageListActionData": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteTopPageListActionDataDataSiteQueryInput" }, "options": { "$ref": "#/definitions/DataSiteTopPageListActionDataOptionsInput" }, "offset": { "$ref": "#/definitions/DataSiteTopPageListActionDataOffsetInput" } }, "required": [ "site_query" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com/", "scope": "domain" } }, { "site_query": { "query": "https://store.google.com/", "scope": "subdomain" }, "options": { "sort": "root_domains_to_page", "filter": "status_200" } } ] }, "DataSiteTopPageListActionDataDataSiteQueryInput": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataSiteQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataSiteTopPageListActionDataDataSiteQueryInputScope" } }, "required": [ "query", "scope" ], "additionalProperties": false, "description": "A SiteQuery provides a target URL along with a scope to define how the query is parsed." }, "DataSiteTopPageListActionDataDataSiteQueryInputScope": { "type": "string", "enum": [ "domain", "subdomain" ], "description": "The scope to parse the query with. Providing a less detailed scope than the provided URL will alter the input. e.g. `moz.com/foo/bar` with a scope of `domain` will ultimately resolve to `moz.com`. options are `domain` or `subdomain`" }, "DataSiteTopPageListActionDataOptionsInput": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/DataSiteTopPageListActionDataOptionsInputFilter" }, "sort": { "$ref": "#/definitions/DataSiteTopPageListActionDataOptionsInputSort" } }, "additionalProperties": false, "description": "Options for fetching top pages." }, "DataSiteTopPageListActionDataOptionsInputFilter": { "$ref": "#/definitions/DataSiteTopPageListOptionsInputFilter", "description": "If set, only return results that match this filter. The valid values correspond to the http status code returned the most recent time a page was crawled.", "default": "all" }, "DataSiteTopPageListOptionsInputFilter": { "type": "string", "enum": [ "all", "status_200", "status_301", "status_302", "status_4xx", "status_5xx" ], "description": "Only return results that match this filter. The valid values correspond to the http status code returned the most recent time a page was crawled.", "default": "all" }, "DataSiteTopPageListActionDataOptionsInputSort": { "$ref": "#/definitions/DataSiteTopPageListOptionsInputSort", "description": "The order to return results in. Results are returned in descending order (higher values first).", "default": "page_authority" }, "DataSiteTopPageListOptionsInputSort": { "type": "string", "enum": [ "page_authority", "root_domains_to_page", "external_pages_to_page" ], "description": "The order to return results in. Results are returned in descending order (higher values first).", "default": "page_authority" }, "DataSiteTopPageListActionDataOffsetInput": { "type": "object", "properties": { "token": { "$ref": "#/definitions/DataOffsetInputToken" }, "limit": { "$ref": "#/definitions/DataSiteTopPageListActionDataOffsetInputLimit" } }, "additionalProperties": false, "description": "Limit and pagination controls. Optionally specify the total number of desired results and, after the first request has been made, access results on the next page of results." }, "DataSiteTopPageListActionDataOffsetInputLimit": { "type": "number", "description": "The limit of results to return. Must be between 1 and 50.", "default": 25 }, "DataSiteTopPageListActionResult": { "type": "object", "properties": { "site_query": { "$ref": "#/definitions/DataSiteQueryObject" }, "offset": { "$ref": "#/definitions/DataOffsetObject" }, "options": { "$ref": "#/definitions/DataSiteTopPageListOptionsObject" }, "top_pages": { "type": "array", "items": { "$ref": "#/definitions/DataSiteMetricsObject" } } }, "required": [ "site_query", "offset", "options", "top_pages" ], "additionalProperties": false, "examples": [ { "site_query": { "query": "https://moz.com/", "scope": "domain" }, "top_pages": [ { "page": "www.youtube.com/", "subdomain": "www.youtube.com", "root_domain": "youtube.com", "title": "", "last_crawled": "2025-04-06", "http_code": 302, "pages_to_page": 1137036299, "nofollow_pages_to_page": 180014631, "redirect_pages_to_page": 5858192, "external_pages_to_page": 1130643833, "external_nofollow_pages_to_page": 180014631, "external_redirect_pages_to_page": 5853509, "deleted_pages_to_page": 206334924, "root_domains_to_page": 2258502, "indirect_root_domains_to_page": 687320, "deleted_root_domains_to_page": 231531, "nofollow_root_domains_to_page": 580510, "pages_to_subdomain": 41228097268, "nofollow_pages_to_subdomain": 5911633339, "redirect_pages_to_subdomain": 157146924, "external_pages_to_subdomain": 40999301825, "external_nofollow_pages_to_subdomain": 5848909313, "external_redirect_pages_to_subdomain": 154737967, "deleted_pages_to_subdomain": 10168632649, "root_domains_to_subdomain": 26010444, "deleted_root_domains_to_subdomain": 2007963, "nofollow_root_domains_to_subdomain": 2361713, "pages_to_root_domain": 64679396434, "nofollow_pages_to_root_domain": 9635085052, "redirect_pages_to_root_domain": 300087796, "external_pages_to_root_domain": 64435538467, "external_indirect_pages_to_root_domain": 24007214543, "external_nofollow_pages_to_root_domain": 9572360127, "external_redirect_pages_to_root_domain": 283147377, "deleted_pages_to_root_domain": 14972386554, "root_domains_to_root_domain": 26860972, "indirect_root_domains_to_root_domain": 281771, "deleted_root_domains_to_root_domain": 2085989, "nofollow_root_domains_to_root_domain": 2395659, "page_authority": 100, "domain_authority": 100, "link_propensity": 0.008363260888, "spam_score": 4, "root_domains_from_page": 0, "nofollow_root_domains_from_page": 0, "pages_from_page": 0, "nofollow_pages_from_page": 0, "root_domains_from_root_domain": 405085, "nofollow_root_domains_from_root_domain": 180598, "pages_from_root_domain": 11246746, "nofollow_pages_from_root_domain": 981907, "pages_crawled_from_root_domain": 48436253 } ] } ] }, "DataSiteTopPageListOptionsObject": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/DataSiteTopPageListOptionsObjectFilter" }, "sort": { "$ref": "#/definitions/DataSiteTopPageListOptionsObjectSort" } }, "required": [ "filter", "sort" ], "additionalProperties": false, "description": "Echoes back the parameters provided in the original request." }, "DataSiteTopPageListOptionsObjectFilter": { "type": "string", "enum": [ "all", "status_200", "status_301", "status_302", "status_4xx", "status_5xx" ], "description": "The filter of results returned. The valid values correspond to the http status code returned the most recent time a page was crawled." }, "DataSiteTopPageListOptionsObjectSort": { "type": "string", "enum": [ "page_authority", "root_domains_to_page", "external_pages_to_page" ], "description": "The order of results returned. Results are returned in descending order (higher values first)." }, "DataSiteTopPageListActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "api.limits.data.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one row per returned result." }, "DataSiteTopPageListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataSiteTopPageListActionPayload" }, "result": { "$ref": "#/definitions/DataSiteTopPageListActionResult" }, "quota": { "$ref": "#/definitions/DataSiteTopPageListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to return a list of the top pages on a target domain, sorted by descending page authority, linking root domains, or external linking pages.", "default": "List Top Pages", "title": "data.site.top-page.list" }, "DataTestQuotaAsyncActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataTestQuotaAsyncActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "DataTestQuotaAsyncActionData": { "type": "object", "additionalProperties": false, "properties": { "quota_start": { "type": "number", "description": "Starting quota units to require before running the action (passed to requireMinimumQuota)." }, "quota_total": { "type": "number", "description": "Total quota units to report after the action (returned from getTotalQuota)." }, "error": { "type": "boolean", "description": "If true, will throw an error." } }, "required": [ "error", "quota_start", "quota_total" ], "examples": [ { "quota_start": 5, "quota_total": 10 }, { "quota_start": 1, "quota_total": 0, "error": true } ] }, "DataTestQuotaAsyncActionResult": { "type": "object", "properties": { "async_call": { "$ref": "#/definitions/GenericAsyncCallObject%3CDataTestQuotaActionResult%3E" } }, "required": [ "async_call" ], "additionalProperties": false, "examples": [ { "async_call": { "id": "c3397e5a-ce31-42fb-8607-ed40487aea18", "action": "data.test.quota.async", "status": "pending", "ttl": 30, "result": null, "error": null } }, { "async_call": { "id": "3d446f53-aaba-4bdb-9d47-b1d0754bfe90", "action": "data.test.quota.async", "status": "complete", "ttl": 10, "result": { "quota_start": 5, "quota_total": 10 }, "error": null } }, { "async_call": { "id": "18e5de71-af54-490d-8eb1-0596a4f68121", "action": "data.test.quota.async", "status": "complete", "ttl": 10, "result": null, "error": { "message": "We've thrown an error!", "code": -32602, "status": 400, "data": { "explanation": null, "issue": null, "key": null, "value": null } } } } ] }, "GenericAsyncCallObject": { "type": "object", "properties": { "id": { "$ref": "#/definitions/AsyncCallObjectId" }, "action": { "$ref": "#/definitions/AsyncCallObjectActionName" }, "status": { "$ref": "#/definitions/AsyncCallObjectStatus" }, "ttl": { "$ref": "#/definitions/AsyncCallObjectTtl" }, "result": { "anyOf": [ { "$ref": "#/definitions/DataTestQuotaActionResult" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/definitions/JsonrpcResponseError" }, { "type": "null" } ] } }, "required": [ "action", "error", "id", "result", "status", "ttl" ], "additionalProperties": false }, "DataTestQuotaActionResult": { "type": "object", "properties": { "quota_start": { "type": "number", "description": "Starting quota units to require before running the action (passed to requireMinimumQuota)." }, "quota_total": { "type": "number", "description": "Total quota units to report after the action (returned from getTotalQuota)." } }, "required": [ "quota_start", "quota_total" ], "additionalProperties": false, "examples": [ { "quota_start": 5, "quota_total": 10 } ] }, "DataTestQuotaAsyncActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "path": { "type": "string", "const": "api.limits.mozscape.rows" } }, "required": [ "path", "type" ], "additionalProperties": false, "description": "Variable quota based on payload for testing." }, "DataTestQuotaAsyncAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataTestQuotaAsyncActionPayload" }, "result": { "$ref": "#/definitions/DataTestQuotaAsyncActionResult" }, "quota": { "$ref": "#/definitions/DataTestQuotaAsyncActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Async test action for exercising UnifiedApiAsyncAction quota behavior. Same input/output as DataTestQuotaAction; completion is asynchronous.", "default": "Test Async Quota" }, "DataTestQuotaActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/DataTestQuotaActionData" }, "guid": { "type": "string" }, "quota": { "$ref": "#/definitions/DataTestQuotaActionQuota" } }, "required": [ "auth", "data", "guid", "quota" ], "additionalProperties": false }, "DataTestQuotaActionData": { "type": "object", "properties": { "quota_start": { "type": "number", "description": "Starting quota units to require before running the action (passed to requireMinimumQuota)." }, "quota_total": { "type": "number", "description": "Total quota units to report after the action (returned from getTotalQuota)." }, "error": { "type": "boolean", "description": "If true, will throw an error." } }, "required": [ "quota_start", "quota_total", "error" ], "additionalProperties": false, "examples": [ { "quota_start": 5, "quota_total": 10 }, { "quota_start": 1, "quota_total": 0, "error": true } ] }, "DataTestQuotaActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "dynamic" }, "path": { "type": "string", "const": "api.limits.mozscape.rows" } }, "required": [ "path", "type" ], "additionalProperties": false, "description": "Variable quota based on payload for testing." }, "DataTestQuotaAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/DataTestQuotaActionPayload" }, "result": { "$ref": "#/definitions/DataTestQuotaActionResult" }, "quota": { "$ref": "#/definitions/DataTestQuotaActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Test action for exercising UnifiedApiAction quota behavior. quota_start is used as the minimum required quota; quota_total is reported as the total used after success.", "default": "Test Quota" }, "MozbarPageDetailFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/MozbarPageDetailFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "MozbarPageDetailFetchActionData": { "type": "object", "properties": { "target_query": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataTargetQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataTargetQueryInputScopes" }, "locale": { "$ref": "#/definitions/MozbarPageDetailFetchDataTargetQueryInputLocale" } }, "required": [ "locale", "query", "scope" ], "additionalProperties": false } }, "required": [ "target_query" ], "additionalProperties": false, "examples": [ { "target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US" } }, { "target_query": { "query": "https://moz.com", "scope": "domain" } } ] }, "MozbarPageDetailFetchDataTargetQueryInputLocale": { "type": "string", "const": "en-US", "description": "Mozbar site metrics are currently all `en-US`" }, "MozbarPageDetailFetchActionResult": { "type": "object", "properties": { "quota": { "$ref": "#/definitions/QuotaUsageObject" }, "page_detail": { "$ref": "#/definitions/MozbarPageDetailObject" }, "target_query": { "$ref": "#/definitions/DataTargetQueryObject" } }, "required": [ "page_detail", "target_query" ], "additionalProperties": false, "examples": [ { "quota": { "path": "search.limits.mozbar.rows", "account_id": 123456789, "allotted": 75000, "used": 1, "reset": "month", "report": "month", "overage": false, "period_start": 1725174000, "period_reset": 1727766000, "usage_key": null, "usage_value": 1, "usage_action": "mozbar.page.detail.fetch" }, "page_detail": { "domain": { "domain_authority": 58 }, "domain_extended": { "brand_authority": 96, "linking_pages_count": 2921, "linking_domains_count": 142, "ranking_keywords_count": 5823 }, "page": { "page_authority": 8, "linking_pages_count": 505 }, "page_extended": { "linking_domains_count": 21, "ranking_keywords_count": 742, "spam_score": 13 } }, "target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US", "original_target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US" }, "suggestion": null } } ] }, "QuotaUsageObject": { "type": "object", "properties": { "path": { "type": "string", "description": "The quota path found in account_services." }, "account_id": { "type": "number", "description": "The account ID." }, "allotted": { "type": "number", "description": "The total available for the quota." }, "used": { "type": "number", "description": "The amount of quota used in the current period." }, "report": { "type": "string", "enum": [ "month", "week", "day", "hour", "minute" ], "description": "How granular reporting information for usage can be queried. Possible values are \"month\", \"week\", \"day\", \"hour\", \"minute\"" }, "reset": { "type": "string", "enum": [ "never", "month", "week", "day", "hour", "minute" ], "description": "How often the quota is reset. Possible values are \"never\", \"month\", \"week\", \"day\", \"hour\", \"minute\"" }, "overage": { "type": "boolean", "description": "Whether or not overages are allowed. This will apply to API calls." }, "period_start": { "type": [ "number", "null" ], "description": "Unix timestamp of when the current period started. Will be null if a static quota." }, "period_reset": { "type": [ "number", "null" ], "description": "Unix timestamp of when the current period will expire and quotas will reset. Will be null if a static quota." }, "usage_key": { "type": [ "string", "null" ], "description": "This value is used to enable clients to \"re-use\" quota for a specific query for a given period of time." }, "usage_action": { "type": "string", "description": "The specific action that is tied to the given usage of quota." }, "usage_value": { "type": "number", "description": "The amount of quota used." } }, "required": [ "account_id", "allotted", "overage", "path", "period_reset", "period_start", "report", "reset", "usage_action", "usage_key", "usage_value", "used" ], "additionalProperties": false }, "MozbarPageDetailObject": { "type": "object", "properties": { "domain": { "type": "object", "properties": { "domain_authority": { "type": "number", "description": "Domain Authority for the URL's domain." } }, "required": [ "domain_authority" ], "additionalProperties": false }, "domain_extended": { "anyOf": [ { "type": "object", "properties": { "brand_authority": { "type": "number", "description": "Brand Authority for the URL's domain." }, "linking_pages_count": { "type": "number", "description": "Number of pages that link to the URL's domain." }, "linking_domains_count": { "type": "number", "description": "Number of domains that link to the URL's domain." }, "ranking_keywords_count": { "type": "number", "description": "Number of keywords that the URL's domain ranks for." } }, "required": [ "brand_authority", "linking_pages_count", "linking_domains_count", "ranking_keywords_count" ], "additionalProperties": false }, { "type": "null" } ] }, "page": { "type": "object", "properties": { "page_authority": { "type": "number", "description": "Page Authority for the given URL." }, "linking_pages_count": { "type": "number", "description": "Number of pages that link to the given URL." } }, "required": [ "page_authority", "linking_pages_count" ], "additionalProperties": false }, "page_extended": { "anyOf": [ { "type": "object", "properties": { "linking_domains_count": { "type": "number", "description": "Number of domains that link to the given URL." }, "ranking_keywords_count": { "type": "number", "description": "Number of keywords that the given URL ranks for." }, "spam_score": { "type": "number", "description": "Spam score for the given URL." } }, "required": [ "linking_domains_count", "ranking_keywords_count", "spam_score" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "domain", "domain_extended", "page", "page_extended" ], "additionalProperties": false }, "MozbarPageDetailFetchActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "search.limits.mozbar.rows" }, "per_call_multiplier": { "type": "number", "const": 2 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses up to 2 quota per call. If the caller has a value of `1` for `account_services.search.limits.mozbar.detail`, will use one quota. If the caller has a value of `2` for `account_services.search.limits.mozbar.detail`, will use 2 quota." }, "MozbarPageDetailFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/MozbarPageDetailFetchActionPayload" }, "result": { "$ref": "#/definitions/MozbarPageDetailFetchActionResult" }, "quota": { "$ref": "#/definitions/MozbarPageDetailFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Get the MozbarPageDetail object for a single URL.", "default": "Fetch Mozbar Page Detail" }, "MozbarPageKeywordReportFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/MozbarPageKeywordReportFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "MozbarPageKeywordReportFetchActionData": { "type": "object", "properties": { "target_query": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataTargetQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataTargetQueryInputScopes" }, "locale": { "$ref": "#/definitions/MozbarPageKeywordReportFetchDataTargetQueryInputLocale" } }, "required": [ "locale", "query", "scope" ], "additionalProperties": false }, "keyword": { "type": "string", "description": "The keyword to evaluate the given target query for." } }, "required": [ "target_query", "keyword" ], "additionalProperties": false, "examples": [ { "keyword": "seo", "target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US" } }, { "keyword": "domain authority", "target_query": { "query": "https://moz.com", "scope": "domain" } } ] }, "MozbarPageKeywordReportFetchDataTargetQueryInputLocale": { "type": "string", "const": "en-US", "description": "Mozbar site metrics are currently all `en-US`" }, "MozbarPageKeywordReportFetchActionResult": { "type": "object", "properties": { "keyword_report": { "$ref": "#/definitions/MozbarPageKeywordReportObject" }, "target_query": { "$ref": "#/definitions/DataTargetQueryObject" } }, "required": [ "keyword_report", "target_query" ], "additionalProperties": false, "examples": [ { "target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US", "original_target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US" }, "suggestion": null }, "keyword_report": { "keyword": "seo", "keyword_counts": { "title": 1, "headline": 0, "strong": 4, "image": 4, "description": 3, "body": 73, "url": 0 }, "final_url": "https://moz.com/", "grade": 83, "title": "Moz - SEO Software for Smarter Marketing", "meta_description": "Backed by the largest community of SEOs on the planet, Moz builds the tools that make SEO, content marketing, market research, digital PR, and local SEO easy. Start your free 30-day trial today!", "marks": [ { "issue_type": "accessible_to_engines", "level": "error", "weight": 64, "importance": "high", "passed": true }, { "issue_type": "exact_keyword_usage_in_page_title", "level": "warning", "weight": 16, "importance": "moderate", "passed": true }, { "issue_type": "keyword_placement_in_page_title", "level": "warning", "weight": 16, "importance": "moderate", "passed": false }, { "issue_type": "avoid_keyword_stuffing_in_page_title", "level": "warning", "weight": 64, "importance": "high", "passed": true }, { "issue_type": "avoid_multiple_page_title_elements", "level": "warning", "weight": 64, "importance": "high", "passed": true }, { "issue_type": "appropriate_page_title_length", "level": "warning", "weight": 16, "importance": "moderate", "passed": true }, { "issue_type": "keyword_usage_in_url", "level": "warning", "weight": 16, "importance": "moderate", "passed": false }, { "issue_type": "static_url", "level": "warning", "weight": 16, "importance": "moderate", "passed": true }, { "issue_type": "avoid_keyword_stuffing_in_the_url", "level": "warning", "weight": 4, "importance": "low", "passed": true }, { "issue_type": "appropriate_url_length", "level": "warning", "weight": 4, "importance": "low", "passed": true }, { "issue_type": "appropriate_characters_in_the_url", "level": "warning", "weight": 16, "importance": "moderate", "passed": true }, { "issue_type": "meta_description_usage", "level": "warning", "weight": 16, "importance": "moderate", "passed": true }, { "issue_type": "keyword_usage_in_the_meta_description", "level": "warning", "weight": 16, "importance": "moderate", "passed": true }, { "issue_type": "no_more_than_one_meta_description_element", "level": "warning", "weight": 4, "importance": "low", "passed": true }, { "issue_type": "appropriate_meta_description_length", "level": "warning", "weight": 4, "importance": "low", "passed": true }, { "issue_type": "canonical_url_tag_usage", "level": "warning", "weight": 4, "importance": "low", "passed": true }, { "issue_type": "no_more_than_one_canonical_url_tag", "level": "warning", "weight": 64, "importance": "high", "passed": true }, { "issue_type": "exact_keyword_usage_in_document", "level": "warning", "weight": 64, "importance": "high", "passed": true }, { "issue_type": "appropriate_keyword_usage_in_h1_tag", "level": "warning", "weight": 16, "importance": "moderate", "passed": false }, { "issue_type": "keyword_usage_in_image_alt_attribute", "level": "warning", "weight": 16, "importance": "moderate", "passed": true }, { "issue_type": "sufficient_quantity_of_characters_in_content", "level": "warning", "weight": 64, "importance": "high", "passed": true }, { "issue_type": "sufficient_quantity_of_words_in_content", "level": "warning", "weight": 64, "importance": "high", "passed": true }, { "issue_type": "avoid_excessive_internal_links", "level": "warning", "weight": 4, "importance": "low", "passed": false }, { "issue_type": "avoid_excessive_external_links", "level": "warning", "weight": 4, "importance": "low", "passed": true }, { "issue_type": "employ_external_links", "level": "warning", "weight": 16, "importance": "moderate", "passed": false }, { "issue_type": "avoid_keyword_stuffing_in_document", "level": "warning", "weight": 64, "importance": "high", "passed": false }, { "issue_type": "broad_keyword_usage_in_page_title", "level": "warning", "weight": 64, "importance": "high", "passed": true } ] } } ] }, "MozbarPageKeywordReportObject": { "type": "object", "properties": { "keyword": { "type": "string", "description": "The keyword for the report." }, "keyword_counts": { "type": "object", "properties": { "title": { "type": "number", "description": "Number of times the keyword appears in title tags" }, "headline": { "type": "number", "description": "Number of times the keyword appears in H tags" }, "strong": { "type": "number", "description": "Number of times the keyword appears in strong tags" }, "image": { "type": "number", "description": "Number of times the keyword appears in image tags" }, "description": { "type": "number", "description": "Number of times the keyword appears in the description" }, "body": { "type": "number", "description": "Number of times the keyword appears in the body" }, "url": { "type": "number", "description": "Number of times the keyword appears in the url" } }, "required": [ "title", "headline", "strong", "image", "description", "body", "url" ], "additionalProperties": false, "description": "The count of the specific keyword found in each place within the page." }, "grade": { "type": "number", "description": "The grade for the report - between 1 and 100, 100 is better." }, "title": { "type": "string", "description": "The title for the given page." }, "final_url": { "type": "string", "description": "The final URL if a redirect occurred." }, "meta_description": { "type": "string", "description": "The meta description for the given page." }, "marks": { "type": "array", "items": { "type": "object", "properties": { "issue_type": { "type": "string", "enum": [ "accessible_to_engines", "exact_keyword_usage_in_page_title", "keyword_placement_in_page_title", "avoid_keyword_stuffing_in_page_title", "avoid_multiple_page_title_elements", "appropriate_page_title_length", "keyword_usage_in_url", "static_url", "avoid_keyword_stuffing_in_the_url", "appropriate_url_length", "appropriate_characters_in_the_url", "meta_description_usage", "keyword_usage_in_the_meta_description", "no_more_than_one_meta_description_element", "appropriate_meta_description_length", "canonical_url_tag_usage", "no_more_than_one_canonical_url_tag", "exact_keyword_usage_in_document", "appropriate_keyword_usage_in_h1_tag", "keyword_usage_in_image_alt_attribute", "sufficient_quantity_of_characters_in_content", "sufficient_quantity_of_words_in_content", "avoid_excessive_internal_links", "avoid_excessive_external_links", "employ_external_links", "avoid_keyword_stuffing_in_document", "broad_keyword_usage_in_page_title" ], "description": "The specific issue type. There is corresponding copy, messaging, and images that can correspond to each issue type.\n\nSee https://analytics.moz.com/constance/api/constants\n\ne.g. given `accessible_to_engines` - look for all keys in that above JSON response that start with `on_page_grade_report_v3.accessible_to_engines`" }, "level": { "type": "string", "enum": [ "error", "warning" ], "description": "Whether to render this as a warning or an error." }, "weight": { "type": "number", "description": "How important this issue is." }, "importance": { "type": "string", "enum": [ "low", "moderate", "high" ], "description": "How important this issue is, human readable?" }, "passed": { "type": "boolean", "description": "Whether or not the target URL passes this test." } }, "required": [ "issue_type", "level", "weight", "importance", "passed" ], "additionalProperties": false, "description": "A specific mark (or grade) that can apply when evaluating the success of the target for the given keyword." } } }, "required": [ "keyword", "keyword_counts", "grade", "title", "final_url", "meta_description", "marks" ], "additionalProperties": false }, "MozbarPageKeywordReportFetchActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota - but caller must have an active Moz Pro subscription." }, "MozbarPageKeywordReportFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/MozbarPageKeywordReportFetchActionPayload" }, "result": { "$ref": "#/definitions/MozbarPageKeywordReportFetchActionResult" }, "quota": { "$ref": "#/definitions/MozbarPageKeywordReportFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Get the MozbarPageKeywordReport object for a single URL.", "default": "Fetch Mozbar Page Keyword Report" }, "MozbarPageOverviewFetchMultipleActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/MozbarPageOverviewFetchMultipleActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "MozbarPageOverviewFetchMultipleActionData": { "type": "object", "properties": { "target_queries": { "type": "array", "items": { "type": "object", "properties": { "query": { "$ref": "#/definitions/DataTargetQueryInputQuery" }, "scope": { "$ref": "#/definitions/DataTargetQueryInputScopes" }, "locale": { "$ref": "#/definitions/MozbarPageOverviewFetchDataTargetQueryInputLocale" } }, "required": [ "locale", "query", "scope" ], "additionalProperties": false } } }, "required": [ "target_queries" ], "additionalProperties": false, "examples": [ { "target_queries": [ { "query": "https://moz.com/blog", "scope": "subdomain", "locale": "en-US" }, { "query": "https://www.example.com", "scope": "domain", "locale": "en-US" } ] }, { "target_queries": [ { "query": "https://moz.com/blog", "scope": "subdomain" }, { "query": "https://www.example.com", "scope": "domain" } ] } ] }, "MozbarPageOverviewFetchDataTargetQueryInputLocale": { "type": "string", "const": "en-US", "description": "Mozbar site metrics are currently all `en-US`" }, "MozbarPageOverviewFetchMultipleActionResult": { "type": "object", "properties": { "quota": { "$ref": "#/definitions/QuotaUsageObject" }, "results_by_target": { "type": "array", "items": { "type": "object", "properties": { "page_overview": { "$ref": "#/definitions/MozbarPageOverviewObject" }, "target_query": { "$ref": "#/definitions/DataTargetQueryObject" } }, "required": [ "page_overview", "target_query" ], "additionalProperties": false } } }, "required": [ "results_by_target" ], "additionalProperties": false, "examples": [ { "quota": { "path": "search.limits.mozbar.rows", "account_id": 10011659, "allotted": 75000, "used": 4, "reset": "month", "report": "month", "overage": false, "period_start": 1725174000, "period_reset": 1727766000, "usage_key": null, "usage_value": 1, "usage_action": "app" }, "results_by_target": [ { "page_overview": { "domain": { "domain_authority": 29 }, "domain_extended": { "brand_authority": 41, "linking_pages_count": 5879, "linking_domains_count": 459 }, "page": { "page_authority": 78, "linking_pages_count": 812 }, "page_extended": { "linking_domains_count": 29 } }, "target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US", "original_target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US" }, "suggestion": null } }, { "page_overview": { "domain": { "domain_authority": 62 }, "domain_extended": { "brand_authority": 7, "linking_pages_count": 5903, "linking_domains_count": 816 }, "page": { "page_authority": 39, "linking_pages_count": 654 }, "page_extended": { "linking_domains_count": 39 } }, "target_query": { "query": "https://moz.com", "scope": "domain", "locale": "en-US", "original_target_query": { "query": "https://moz.com/", "scope": "domain", "locale": "en-US" }, "suggestion": null } } ] } ] }, "MozbarPageOverviewObject": { "type": "object", "properties": { "domain": { "type": "object", "properties": { "domain_authority": { "type": "number", "description": "Domain Authority for the URL's domain." } }, "required": [ "domain_authority" ], "additionalProperties": false }, "domain_extended": { "anyOf": [ { "type": "object", "properties": { "brand_authority": { "type": "number", "description": "Brand Authority for the URL's domain." }, "linking_pages_count": { "type": "number", "description": "Number of pages that link to the URL's domain." }, "linking_domains_count": { "type": "number", "description": "Number of domains that link to the URL's domain." } }, "required": [ "brand_authority", "linking_pages_count", "linking_domains_count" ], "additionalProperties": false }, { "type": "null" } ] }, "page": { "type": "object", "properties": { "page_authority": { "type": "number", "description": "Page Authority for the given URL." }, "linking_pages_count": { "type": "number", "description": "Number of pages that link to the given URL." } }, "required": [ "page_authority", "linking_pages_count" ], "additionalProperties": false }, "page_extended": { "anyOf": [ { "type": "object", "properties": { "linking_domains_count": { "type": "number", "description": "Number of domains that link to the given URL." } }, "required": [ "linking_domains_count" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "domain", "domain_extended", "page", "page_extended" ], "additionalProperties": false }, "MozbarPageOverviewFetchMultipleActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_result" }, "path": { "type": "string", "const": "search.limits.mozbar.rows" }, "per_result_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_result_multiplier", "type" ], "additionalProperties": false, "description": "Uses one quota per returned result." }, "MozbarPageOverviewFetchMultipleAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/MozbarPageOverviewFetchMultipleActionPayload" }, "result": { "$ref": "#/definitions/MozbarPageOverviewFetchMultipleActionResult" }, "quota": { "$ref": "#/definitions/MozbarPageOverviewFetchMultipleActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Get the MozbarPageOverview object for multiple URLs.", "default": "Fetch Mozbar Page Overview" }, "MozbarPageRankingKeywordListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/MozbarPageRankingKeywordListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "MozbarPageRankingKeywordListActionData": { "type": "object", "properties": { "target_query": { "$ref": "#/definitions/DataTargetQueryInput" } }, "required": [ "target_query" ], "additionalProperties": false, "examples": [ { "target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US" } }, { "target_query": { "query": "https://moz.com", "scope": "domain" } } ] }, "MozbarPageRankingKeywordListActionResult": { "type": "object", "properties": { "quota": { "$ref": "#/definitions/QuotaUsageObject" }, "ranking_keywords": { "type": "array", "items": { "$ref": "#/definitions/MozbarPageRankingKeywordObject" } }, "target_query": { "$ref": "#/definitions/DataTargetQueryObject" } }, "required": [ "ranking_keywords", "target_query" ], "additionalProperties": false, "examples": [ { "quota": { "path": "search.limits.research.keyword.queries.total", "account_id": 123456789, "allotted": 30000, "used": 1, "reset": "month", "report": "week", "overage": false, "period_start": 1725174000, "period_reset": 1727766000, "usage_key": "{\"target\":{\"query\":\"https://moz.com\",\"scope\":\"domain\",\"locale\":\"en-US\"}}", "usage_value": 1, "usage_action": null }, "target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US", "original_target_query": { "query": "https://moz.com/blog", "scope": "url", "locale": "en-US" }, "suggestion": null }, "ranking_keywords": [ { "keyword": "moz", "ranking_page": "https://moz.com/", "rank_position": 1, "difficulty": 66, "volume": 6133 }, { "keyword": "domain authority checker", "ranking_page": "https://moz.com/domain-analysis", "rank_position": 1, "difficulty": 56, "volume": 3300 }, { "keyword": "check domain authority", "ranking_page": "https://moz.com/domain-analysis", "rank_position": 1, "difficulty": 57, "volume": 3300 }, { "keyword": "link building", "ranking_page": "https://moz.com/beginners-guide-to-link-building", "rank_position": 1, "difficulty": 68, "volume": 2433.595878206397 }, { "keyword": "domain authority", "ranking_page": "https://moz.com/learn/seo/domain-authority", "rank_position": 1, "difficulty": 69, "volume": 2200 }, { "keyword": "seo moz", "ranking_page": "https://moz.com/", "rank_position": 1, "difficulty": 60, "volume": 1200 }, { "keyword": "moz seo", "ranking_page": "https://moz.com/", "rank_position": 1, "difficulty": 63, "volume": 1200 }, { "keyword": "seomoz", "ranking_page": "https://moz.com/", "rank_position": 1, "difficulty": 64, "volume": 1200 }, { "keyword": "what is alt text", "ranking_page": "https://moz.com/learn/seo/alt-text", "rank_position": 1, "difficulty": 65, "volume": 1200 }, { "keyword": "domain authority checker moz", "ranking_page": "https://moz.com/domain-analysis", "rank_position": 1, "difficulty": 61, "volume": 1147 }, { "keyword": "moz.com", "ranking_page": "https://moz.com/", "rank_position": 1, "difficulty": 58, "volume": 1112 }, { "keyword": "moz com", "ranking_page": "https://moz.com/", "rank_position": 1, "difficulty": 61, "volume": 1112 }, { "keyword": "moz local", "ranking_page": "https://moz.com/products/local", "rank_position": 1, "difficulty": 57, "volume": 950 }, { "keyword": "moz.local", "ranking_page": "https://moz.com/products/local", "rank_position": 1, "difficulty": 58, "volume": 950 }, { "keyword": "seo competitors analysis tool", "ranking_page": "https://moz.com/competitive-research", "rank_position": 1, "difficulty": 50, "volume": 941 }, { "keyword": "seo tools competitor analysis", "ranking_page": "https://moz.com/competitive-research", "rank_position": 1, "difficulty": 50, "volume": 941 }, { "keyword": "competitive seo analysis tool", "ranking_page": "https://moz.com/competitive-research", "rank_position": 1, "difficulty": 51, "volume": 941 }, { "keyword": "competitor analysis tool seo", "ranking_page": "https://moz.com/competitive-research", "rank_position": 1, "difficulty": 51, "volume": 941 }, { "keyword": "competitor analysis seo tool", "ranking_page": "https://moz.com/competitive-research", "rank_position": 1, "difficulty": 53, "volume": 941 }, { "keyword": "keyword explorer", "ranking_page": "https://moz.com/explorer", "rank_position": 1, "difficulty": 64, "volume": 897 }, { "keyword": "seo for beginner", "ranking_page": "https://moz.com/beginners-guide-to-seo", "rank_position": 1, "difficulty": 66, "volume": 800 }, { "keyword": "seo and online marketing", "ranking_page": "https://moz.com/learn/seo/role-of-seo-in-digital-marketing", "rank_position": 1, "difficulty": 54, "volume": 783 }, { "keyword": "moz extension", "ranking_page": "https://moz.com/products/pro/seo-toolbar", "rank_position": 1, "difficulty": 58, "volume": 782 }, { "keyword": "list of websites", "ranking_page": "https://moz.com/top500", "rank_position": 1, "difficulty": 57, "volume": 723 }, { "keyword": "website list", "ranking_page": "https://moz.com/top500", "rank_position": 1, "difficulty": 60, "volume": 685 } ] } ] }, "MozbarPageRankingKeywordObject": { "type": "object", "properties": { "keyword": { "$ref": "#/definitions/MozbarPageRankingKeywordObjectKeyword" }, "ranking_page": { "$ref": "#/definitions/MozbarPageRankingKeywordObjectRankingPage" }, "rank_position": { "$ref": "#/definitions/MozbarPageRankingKeywordObjectRankPosition" }, "difficulty": { "$ref": "#/definitions/MozbarPageRankingKeywordObjectDifficulty" }, "volume": { "$ref": "#/definitions/MozbarPageRankingKeywordObjectVolume" } }, "required": [ "keyword", "ranking_page", "rank_position", "difficulty", "volume" ], "additionalProperties": false }, "MozbarPageRankingKeywordObjectKeyword": { "type": "string", "description": "The keyword that is ranked for. Assume the same locale as the provided input." }, "MozbarPageRankingKeywordObjectRankingPage": { "type": "string", "description": "The exact URL that ranks for the given keyword." }, "MozbarPageRankingKeywordObjectRankPosition": { "type": "number", "description": "The position of the given page for the given keyword on a SERP." }, "MozbarPageRankingKeywordObjectDifficulty": { "type": [ "number", "null" ], "description": "How difficult the keyword is to rank for - between 1 and 100 with 100 being the most difficult. If not available, will be null." }, "MozbarPageRankingKeywordObjectVolume": { "type": [ "number", "null" ], "description": "The approximate monthly search volume for the given keyword. If not available, will be null." }, "MozbarPageRankingKeywordListActionQuota": { "type": "object", "properties": { "type": { "type": "string", "const": "per_call" }, "path": { "type": "string", "const": "search.limits.research.keyword.queries.total" }, "per_call_multiplier": { "type": "number", "const": 1 } }, "required": [ "path", "per_call_multiplier", "type" ], "additionalProperties": false, "description": "Uses one quota from Keyword Explorer per call." }, "MozbarPageRankingKeywordListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/MozbarPageRankingKeywordListActionPayload" }, "result": { "$ref": "#/definitions/MozbarPageRankingKeywordListActionResult" }, "quota": { "$ref": "#/definitions/MozbarPageRankingKeywordListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Get the top 25 Ranking keywords for a single URL.", "default": "Fetch Mozbar Page Ranking Keywords" }, "APIQuotaLookupActionPayload": { "type": "object", "properties": { "auth": { "anyOf": [ { "$ref": "#/definitions/NoAuthPayload" }, { "$ref": "#/definitions/ValidAuthPayload" }, { "$ref": "#/definitions/ApiAuthPayload" }, { "$ref": "#/definitions/AdminAuthPayload" } ] }, "data": { "$ref": "#/definitions/APIQuotaLookupActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "NoAuthPayload": { "type": "object", "additionalProperties": false, "description": "NoAuth is an auth expectation that no auth data will be provided as it's not required to provide data for the action" }, "ApiAuthPayload": { "$ref": "#/definitions/ApiKeyAuthPayload", "description": "ApiAuth represents an auth expectation that calls will be made only using an API key. ApiAuth, by convention, is considered the highest level, working for any call, and considered above AdminAuth level." }, "AdminAuthPayload": { "$ref": "#/definitions/ValidAuthPayload", "description": "AdminAuth represents an auth expectation that the passed authentication passes an external check to validate that it can access admin level resources. Session input is checked for the user to be marked as an admin, and API level auth is always considered admin." }, "APIQuotaLookupActionData": { "type": "object", "properties": { "path": { "$ref": "#/definitions/QuotaPath" } }, "required": [ "path" ], "additionalProperties": false, "examples": [ { "path": "api.limits.data.rows" }, { "path": "api.limits.beta.rows" } ] }, "QuotaPath": { "type": "string", "enum": [ "api.limits.mozscape.rows", "api.limits.data.rows", "api.limits.beta.rows" ], "description": "The quota path specifies a particular quota for which to retrieve information (e.g. beta or production quotas). The quota used by a particular method is specified in the Quota Usage section at the bottom of the method documentation." }, "QuotaLookupActionResult": { "type": "object", "properties": { "quota": { "$ref": "#/definitions/QuotaObject" } }, "required": [ "quota" ], "additionalProperties": false, "description": "Results include the quota object.", "examples": [ { "quota": { "path": "api.limits.beta.rows", "account_id": 123456789, "allotted": 100, "used": 50, "reset": "month", "report": "day", "overage": false, "period_start": 1714546800, "period_reset": 1717225200 } } ] }, "QuotaObject": { "type": "object", "properties": { "path": { "type": "string", "description": "The quota path found in account_services." }, "account_id": { "type": "number", "description": "The account ID." }, "allotted": { "type": "number", "description": "The total available for the quota." }, "used": { "type": "number", "description": "The amount of quota used in the current period." }, "report": { "type": "string", "enum": [ "month", "week", "day", "hour", "minute" ], "description": "How granular reporting information for usage can be queried. Possible values are \"month\", \"week\", \"day\", \"hour\", \"minute\"" }, "reset": { "type": "string", "enum": [ "never", "month", "week", "day", "hour", "minute" ], "description": "How often the quota is reset. Possible values are \"never\", \"month\", \"week\", \"day\", \"hour\", \"minute\"" }, "overage": { "type": "boolean", "description": "Whether or not overages are allowed. This will apply to API calls." }, "period_start": { "type": [ "number", "null" ], "description": "Unix timestamp of when the current period started. Will be null if a static quota." }, "period_reset": { "type": [ "number", "null" ], "description": "Unix timestamp of when the current period will expire and quotas will reset. Will be null if a static quota." } }, "required": [ "path", "account_id", "allotted", "used", "report", "reset", "overage", "period_start", "period_reset" ], "additionalProperties": false }, "QuotaLookupActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "QuotaLookupAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/APIQuotaLookupActionPayload" }, "result": { "$ref": "#/definitions/QuotaLookupActionResult" }, "quota": { "$ref": "#/definitions/QuotaLookupActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Check how much quota is used/available for the current billing period, as well as additional information about the quota such as whether or not overages are enabled. This method can be performed for any quota to which your account has access (see acceptable values for `path` below).", "default": "Fetch Quota" }, "APIQuotaUsageReportActionPayload": { "type": "object", "properties": { "auth": { "anyOf": [ { "$ref": "#/definitions/NoAuthPayload" }, { "$ref": "#/definitions/ValidAuthPayload" }, { "$ref": "#/definitions/ApiAuthPayload" }, { "$ref": "#/definitions/AdminAuthPayload" } ] }, "data": { "$ref": "#/definitions/APIQuotaUsageReportActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "APIQuotaUsageReportActionData": { "type": "object", "properties": { "path": { "$ref": "#/definitions/QuotaPath" }, "period_start": { "$ref": "#/definitions/QuotaUsageReportActionDataPeriodStart" }, "period_end": { "$ref": "#/definitions/QuotaUsageReportActionDataPeriodEnd" }, "frequency": { "$ref": "#/definitions/QuotaUsageReportFrequency" } }, "required": [ "path", "period_start", "period_end" ], "additionalProperties": false, "examples": [ { "path": "api.limits.mozscape.rows" }, { "path": "api.limits.beta.rows" } ] }, "QuotaUsageReportActionDataPeriodStart": { "type": "number", "description": "The unix timestamp for the beginning of the reporting period." }, "QuotaUsageReportActionDataPeriodEnd": { "type": "number", "description": "The unix timestamp for the end of the reporting period." }, "QuotaUsageReportFrequency": { "type": "string", "enum": [ "day", "week", "month" ], "description": "The level of detail to group usage reporting." }, "QuotaUsageReportActionResult": { "type": "object", "properties": { "total_report": { "$ref": "#/definitions/QuotaUsageReportObject" }, "action_reports": { "type": "array", "items": { "$ref": "#/definitions/QuotaUsageReportObject" } } }, "required": [ "total_report", "action_reports" ], "additionalProperties": false, "examples": [ { "total_report": { "account_id": 123456789, "path": "api.limits.beta.rows", "frequency": "day", "usage_action": null, "period_start": 1714546800, "period_end": 1714805000, "periods": [ { "period_start": 1714546800, "used": 100 }, { "period_start": 1714633200, "used": 50 }, { "period_start": 1714719600, "used": 650 } ] }, "action_reports": [ { "account_id": 123456789, "path": "api.limits.beta.rows", "frequency": "day", "usage_action": "beta.data.keyword.search.intent.fetch", "period_start": 1714546800, "period_end": 1714805000, "periods": [ { "period_start": 1714546800, "used": 75 }, { "period_start": 1714633200, "used": 50 }, { "period_start": 1714719600, "used": 550 } ] }, { "account_id": 123456789, "path": "api.limits.beta.rows", "frequency": "day", "usage_action": "beta.data.keyword.metrics.fetch", "period_start": 1714546800, "period_end": 1714805000, "periods": [ { "period_start": 1714546800, "used": 25 }, { "period_start": 1714633200, "used": 0 }, { "period_start": 1714719600, "used": 100 } ] } ] } ] }, "QuotaUsageReportObject": { "type": "object", "properties": { "account_id": { "type": "number", "description": "The account ID." }, "path": { "type": "string", "description": "The quota path found in account_services." }, "frequency": { "$ref": "#/definitions/QuotaUsageReportFrequency" }, "usage_action": { "type": "string", "description": "The specific action that is tied to the given usage of quota." }, "period_start": { "$ref": "#/definitions/QuotaUsageReportObjectPeriodStart" }, "period_end": { "$ref": "#/definitions/QuotaUsageReportObjectPeriodEnd" }, "periods": { "type": "array", "items": { "$ref": "#/definitions/QuotaUsageReportPeriodObject" } } }, "required": [ "account_id", "path", "frequency", "usage_action", "period_start", "period_end", "periods" ], "additionalProperties": false }, "QuotaUsageReportObjectPeriodStart": { "type": "number", "description": "The unix timestamp for the beginning of the reporting period." }, "QuotaUsageReportObjectPeriodEnd": { "type": "number", "description": "The unix timestamp for the end of the reporting period." }, "QuotaUsageReportPeriodObject": { "type": "object", "properties": { "period_start": { "$ref": "#/definitions/QuotaUsageReportPeriodObjectPeriodStart" }, "used": { "$ref": "#/definitions/QuotaUsageReportPeriodObjectUsed" } }, "required": [ "period_start", "used" ], "additionalProperties": false }, "QuotaUsageReportPeriodObjectPeriodStart": { "type": "number", "description": "The unix timestamp for the beginning of the reporting period." }, "QuotaUsageReportPeriodObjectUsed": { "type": "number", "description": "The amount of quota used in the given reporting period." }, "QuotaUsageReportActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "QuotaUsageReportAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/APIQuotaUsageReportActionPayload" }, "result": { "$ref": "#/definitions/QuotaUsageReportActionResult" }, "quota": { "$ref": "#/definitions/QuotaUsageReportActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Generate a report on the usage of a quota for a given time period.", "default": "Report Quota Usage" }, "APIQuotaUsageTotalActionPayload": { "type": "object", "properties": { "auth": { "anyOf": [ { "$ref": "#/definitions/NoAuthPayload" }, { "$ref": "#/definitions/ValidAuthPayload" }, { "$ref": "#/definitions/ApiAuthPayload" }, { "$ref": "#/definitions/AdminAuthPayload" } ] }, "data": { "$ref": "#/definitions/APIQuotaUsageTotalActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "APIQuotaUsageTotalActionData": { "type": "object", "properties": { "path": { "$ref": "#/definitions/QuotaPath" }, "period_start": { "$ref": "#/definitions/QuotaUsageTotalActionDataPeriodStart" }, "period_end": { "$ref": "#/definitions/QuotaUsageTotalActionDataPeriodEnd" } }, "required": [ "path", "period_start", "period_end" ], "additionalProperties": false, "examples": [ { "path": "api.limits.mozscape.rows", "period_start": 1715593986, "period_end": 1715598986 } ] }, "QuotaUsageTotalActionDataPeriodStart": { "type": "number", "description": "The unix timestamp for the beginning of the reporting period." }, "QuotaUsageTotalActionDataPeriodEnd": { "type": "number", "description": "The unix timestamp for the end of the reporting period." }, "QuotaUsageTotalActionResult": { "type": "object", "properties": { "path": { "$ref": "#/definitions/QuotaUsageTotalActionResultPath" }, "total": { "$ref": "#/definitions/QuotaUsageTotalActionResultTotal" }, "period_start": { "$ref": "#/definitions/QuotaUsageTotalActionResultPeriodStart" }, "period_end": { "$ref": "#/definitions/QuotaUsageTotalActionResultPeriodEnd" } }, "required": [ "path", "total", "period_start", "period_end" ], "additionalProperties": false, "description": "Results include the total quota used, in addition to the start and end period timestamps.", "examples": [ { "total": 5726192, "period_start": 1714546800, "period_reset": 1717225200 } ] }, "QuotaUsageTotalActionResultPath": { "type": "string", "description": "The quota path that is totaled." }, "QuotaUsageTotalActionResultTotal": { "type": "number", "description": "The total quota used in the given period." }, "QuotaUsageTotalActionResultPeriodStart": { "type": "number", "description": "The unix timestamp for the beginning of the reporting period." }, "QuotaUsageTotalActionResultPeriodEnd": { "type": "number", "description": "The unix timestamp for the end of the reporting period." }, "QuotaUsageTotalActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "QuotaUsageTotalAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/APIQuotaUsageTotalActionPayload" }, "result": { "$ref": "#/definitions/QuotaUsageTotalActionResult" }, "quota": { "$ref": "#/definitions/QuotaUsageTotalActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "A simplified report on the total usage of a quota for a given time period.", "default": "Fetch Quota Usage" }, "MetadataIndexFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/MetadataIndexFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "MetadataIndexFetchActionData": { "type": "object", "additionalProperties": false, "description": "This method does not require any input.", "examples": [ {} ] }, "MetadataIndexFetchActionResult": { "type": "object", "properties": { "index_id": { "$ref": "#/definitions/MetadataIndexFetchActionResultIndexId" } }, "required": [ "index_id" ], "additionalProperties": false, "description": "Results include the unique identifier for the current index.", "examples": [ { "index_id": "tD4grH2TmrmTfXW65xr+tg==" } ] }, "MetadataIndexFetchActionResultIndexId": { "type": "string", "description": "The unique identifier for the current index." }, "MetadataIndexFetchActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "MetadataIndexFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/MetadataIndexFetchActionPayload" }, "result": { "$ref": "#/definitions/MetadataIndexFetchActionResult" }, "quota": { "$ref": "#/definitions/MetadataIndexFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Use this endpoint to track when the index is updated with new data. When queried, the endpoint returns an ID that changes when the data in the index changes. This information can be helpful when you're looking to understand the freshness of the data. It can also help benchmark when new links are discovered - particularly if you're tracking a link building Campaign and want to keep an eye out for index updates that may include new links.", "default": "Fetch Current Index ID", "title": "metadata.index.fetch" }, "LocalAccountCreateActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalAccountCreateActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalAccountCreateActionData": { "type": "object", "properties": { "account": { "$ref": "#/definitions/LocalAccountCreateObject" } }, "required": [ "account" ], "additionalProperties": false, "examples": [ { "account": { "name": "Example Business" } } ] }, "LocalAccountCreateObject": { "type": "object", "properties": { "name": { "$ref": "#/definitions/AccountName" } }, "required": [ "name" ], "additionalProperties": false, "description": "A payload to create a local account." }, "AccountName": { "type": "string", "description": "The name of the local account." }, "LocalAccountCreateActionResult": { "type": "object", "properties": { "account": { "$ref": "#/definitions/LocalAccountObject" } }, "required": [ "account" ], "additionalProperties": false, "examples": [ { "account": { "id": 12345, "name": "Example Business" } } ] }, "LocalAccountObject": { "type": "object", "properties": { "id": { "$ref": "#/definitions/AccountId" }, "name": { "$ref": "#/definitions/AccountName" } }, "required": [ "id", "name" ], "additionalProperties": false, "description": "Local Account Object" }, "AccountId": { "type": "number", "description": "The ID of the local account." }, "LocalAccountCreateActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalAccountCreateAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalAccountCreateActionPayload" }, "result": { "$ref": "#/definitions/LocalAccountCreateActionResult" }, "quota": { "$ref": "#/definitions/LocalAccountCreateActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Creates a new Moz Local Account.", "enterprise_only": true, "default": "Create Account" }, "LocalAccountListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalAccountListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalAccountListActionData": { "type": "object", "additionalProperties": false, "description": "This method does not require any input.", "examples": [ {} ] }, "LocalAccountListActionResult": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/definitions/LocalAccountObject" } } }, "required": [ "accounts" ], "additionalProperties": false, "examples": [ { "accounts": [ { "id": 12345, "name": "Example Business" }, { "id": 54321, "name": "Another Example Business" } ] } ] }, "LocalAccountListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalAccountListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalAccountListActionPayload" }, "result": { "$ref": "#/definitions/LocalAccountListActionResult" }, "quota": { "$ref": "#/definitions/LocalAccountListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "List all Moz Local Accounts.", "enterprise_only": true, "default": "List Accounts" }, "LocalAccountLookupActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalAccountLookupActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalAccountLookupActionData": { "type": "object", "properties": { "id": { "$ref": "#/definitions/AccountId" } }, "required": [ "id" ], "additionalProperties": false, "examples": [ { "id": 123 } ] }, "LocalAccountLookupActionResult": { "type": "object", "properties": { "account": { "$ref": "#/definitions/LocalAccountObject" } }, "required": [ "account" ], "additionalProperties": false, "examples": [ { "account": { "id": 12345, "name": "Example Business" } } ] }, "LocalAccountLookupActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalAccountLookupAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalAccountLookupActionPayload" }, "result": { "$ref": "#/definitions/LocalAccountLookupActionResult" }, "quota": { "$ref": "#/definitions/LocalAccountLookupActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Lookup a specific Moz Local Account by ID.", "enterprise_only": true, "default": "Lookup Account" }, "LocalGroupCreateActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalGroupCreateActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalGroupCreateActionData": { "type": "object", "properties": { "group": { "$ref": "#/definitions/LocalGroupCreateObject", "description": "A payload to create a local group." } }, "required": [ "group" ], "additionalProperties": false, "examples": [ { "group": { "name": "Franchise Locations", "account_id": 123 } } ] }, "LocalGroupCreateObject": { "type": "object", "properties": { "name": { "$ref": "#/definitions/GroupName" }, "account_id": { "$ref": "#/definitions/GroupAccountId" } }, "required": [ "name", "account_id" ], "additionalProperties": false, "description": "A payload to create a local group." }, "GroupName": { "type": "string", "description": "The name of the local group." }, "GroupAccountId": { "type": "number", "description": "The Moz Local Account ID the group belongs to." }, "LocalGroupCreateActionResult": { "type": "object", "properties": { "group": { "$ref": "#/definitions/LocalGroupObject", "description": "Local Group Object" } }, "required": [ "group" ], "additionalProperties": false, "examples": [ { "group": { "id": 12345, "name": "Franchise Locations", "account_id": 123 } } ] }, "LocalGroupObject": { "type": "object", "properties": { "id": { "$ref": "#/definitions/GroupId" }, "name": { "$ref": "#/definitions/GroupName" }, "account_id": { "$ref": "#/definitions/GroupAccountId" } }, "required": [ "id", "name", "account_id" ], "additionalProperties": false, "description": "Local Group Object" }, "GroupId": { "type": "number", "description": "The ID of the local group." }, "LocalGroupCreateActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalGroupCreateAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalGroupCreateActionPayload" }, "result": { "$ref": "#/definitions/LocalGroupCreateActionResult" }, "quota": { "$ref": "#/definitions/LocalGroupCreateActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Creates a new group in a Moz Local Account to organize locations.", "enterprise_only": true, "default": "Create Group" }, "LocalGroupFilterAccountActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalGroupFilterAccountActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalGroupFilterAccountActionData": { "type": "object", "properties": { "account_id": { "$ref": "#/definitions/LocationAccountId", "description": "The Local Account ID to filter by." } }, "required": [ "account_id" ], "additionalProperties": false, "examples": [ { "account_id": 123 } ] }, "LocationAccountId": { "type": [ "number", "null" ], "description": "The id of the local account the location resides in. May be null for legacy inactive locations." }, "LocalGroupFilterAccountActionResult": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/definitions/LocalGroupObject" } } }, "required": [ "groups" ], "additionalProperties": false, "examples": [ { "groups": [ { "id": 12345, "name": "Franchise Locations", "account_id": 123 }, { "id": 54321, "name": "Corporate Locations", "account_id": 123 } ] } ] }, "LocalGroupFilterAccountActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalGroupFilterAccountAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalGroupFilterAccountActionPayload" }, "result": { "$ref": "#/definitions/LocalGroupFilterAccountActionResult" }, "quota": { "$ref": "#/definitions/LocalGroupFilterAccountActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "List all groups for a given Moz Local Account ID.", "enterprise_only": true, "default": "Filter Groups by Account" }, "LocalGroupListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalGroupListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalGroupListActionData": { "type": "object", "additionalProperties": false, "description": "This method does not require any input.", "examples": [ {} ] }, "LocalGroupListActionResult": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/definitions/LocalGroupObject" } } }, "required": [ "groups" ], "additionalProperties": false, "examples": [ { "groups": [ { "id": 12345, "name": "Franchise Locations", "account_id": 123 }, { "id": 54321, "name": "Corporate Locations", "account_id": 123 }, { "id": 65432, "name": "Self-Service Kiosks", "account_id": 321 } ] } ] }, "LocalGroupListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalGroupListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalGroupListActionPayload" }, "result": { "$ref": "#/definitions/LocalGroupListActionResult" }, "quota": { "$ref": "#/definitions/LocalGroupListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "List all local groups.", "enterprise_only": true, "default": "List Groups" }, "LocalGroupLocationAddActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalGroupLocationAddActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalGroupLocationAddActionData": { "type": "object", "properties": { "group_id": { "$ref": "#/definitions/GroupId" }, "location_id": { "$ref": "#/definitions/LocationId" } }, "required": [ "group_id", "location_id" ], "additionalProperties": false, "examples": [ { "group_id": 123, "location_id": 456 } ] }, "LocationId": { "type": "number", "description": "The id of the location" }, "LocalGroupLocationAddActionResult": { "type": "object", "additionalProperties": false, "properties": {}, "description": "Returns an empty object on success.", "examples": [ {} ] }, "LocalGroupLocationAddActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalGroupLocationAddAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalGroupLocationAddActionPayload" }, "result": { "$ref": "#/definitions/LocalGroupLocationAddActionResult" }, "quota": { "$ref": "#/definitions/LocalGroupLocationAddActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Add a location to a group.", "examples": [ {} ], "enterprise_only": true, "default": "Add Location to Group" }, "LocalGroupLocationListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalGroupLocationListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalGroupLocationListActionData": { "type": "object", "properties": { "group_id": { "$ref": "#/definitions/GroupId" }, "page": { "$ref": "#/definitions/LocalGroupLocationListInputPage" } }, "required": [ "group_id" ], "additionalProperties": false, "examples": [ { "group_id": 123, "page": { "n": 0, "limit": 25 } } ] }, "LocalGroupLocationListInputPage": { "type": "object", "properties": { "n": { "$ref": "#/definitions/DataPageInputN" }, "limit": { "$ref": "#/definitions/LocalGroupLocationListInputPageInputLimit" } }, "additionalProperties": false, "description": "Control the number of results returned per call in addition to fetching additional results. The default `limit` is 25 with an `n` value of 0 (indicating the first page of results). Make subsequent calls to the endpoint with incrementing `n` values to fetch additional pages of results. To get all results, you must continue making calls with incrementing `n` values until an empty result set is returned." }, "LocalGroupLocationListInputPageInputLimit": { "type": "number", "description": "The number of results per page. Maximum is 50.", "default": 25 }, "LocalGroupLocationListActionResult": { "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/definitions/LocalLocationIdObject" } }, "page": { "$ref": "#/definitions/PageObject" } }, "required": [ "locations", "page" ], "additionalProperties": false, "examples": [ { "locations": [ { "id": 1001 }, { "id": 1002 }, { "id": 1003 } ], "page": { "n": 0, "limit": 25 } } ] }, "LocalLocationIdObject": { "type": "object", "properties": { "id": { "$ref": "#/definitions/LocationId" } }, "required": [ "id" ], "additionalProperties": false, "description": "A simplified location object containing only the ID. Used for listing location IDs in a group." }, "PageObject": { "type": "object", "properties": { "n": { "$ref": "#/definitions/PageObjectN" }, "limit": { "$ref": "#/definitions/PageObjectLimit" }, "order": { "$ref": "#/definitions/PageObjectOrder" } }, "additionalProperties": false, "description": "Control how much data is returned by providing a specific page number (n) and limit to the number of results in a given page. Additionally, may provide a sort order." }, "PageObjectN": { "type": "number", "description": "The page number to load.", "default": 0 }, "PageObjectLimit": { "type": "number", "description": "The number of results per page.", "default": 50 }, "PageObjectOrder": { "type": "string", "enum": [ "asc", "desc" ], "description": "The sort order for results.", "default": "asc" }, "LocalGroupLocationListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalGroupLocationListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalGroupLocationListActionPayload" }, "result": { "$ref": "#/definitions/LocalGroupLocationListActionResult" }, "quota": { "$ref": "#/definitions/LocalGroupLocationListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "List locations in a given group. This endpoint returns a simplified response containing only location IDs.", "enterprise_only": true, "default": "List Group Locations" }, "LocalGroupLocationRemoveActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalGroupLocationRemoveActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalGroupLocationRemoveActionData": { "type": "object", "properties": { "group_id": { "$ref": "#/definitions/GroupId" }, "location_id": { "$ref": "#/definitions/LocationId" } }, "required": [ "group_id", "location_id" ], "additionalProperties": false, "examples": [ { "group_id": 12345, "location_id": 67890 } ] }, "LocalGroupLocationRemoveActionResult": { "type": "object", "additionalProperties": false, "properties": {}, "description": "Returns an empty object on success.", "examples": [ {} ] }, "LocalGroupLocationRemoveActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalGroupLocationRemoveAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalGroupLocationRemoveActionPayload" }, "result": { "$ref": "#/definitions/LocalGroupLocationRemoveActionResult" }, "quota": { "$ref": "#/definitions/LocalGroupLocationRemoveActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Remove a location from a group.", "enterprise_only": true, "default": "Remove Location from Group" }, "LocalGroupLookupActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalGroupLookupActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalGroupLookupActionData": { "type": "object", "properties": { "id": { "$ref": "#/definitions/GroupId", "description": "The ID of the local group." } }, "required": [ "id" ], "additionalProperties": false, "examples": [ { "id": 12345 } ] }, "LocalGroupLookupActionResult": { "type": "object", "properties": { "group": { "$ref": "#/definitions/LocalGroupObject", "description": "Local Group Object" } }, "required": [ "group" ], "additionalProperties": false, "examples": [ { "group": { "id": 12345, "name": "Franchise Locations", "account_id": 123 } } ] }, "LocalGroupLookupActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalGroupLookupAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalGroupLookupActionPayload" }, "result": { "$ref": "#/definitions/LocalGroupLookupActionResult" }, "quota": { "$ref": "#/definitions/LocalGroupLookupActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Lookup a specific group by ID.", "enterprise_only": true, "default": "Lookup Group" }, "LocalLocationCancelActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationCancelActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationCancelActionData": { "type": "object", "properties": { "id": { "$ref": "#/definitions/LocationId" } }, "required": [ "id" ], "additionalProperties": false, "examples": [ { "id": 12345 } ] }, "LocalLocationCancelActionResult": { "type": "object", "properties": { "location": { "$ref": "#/definitions/LocalLocationObject" } }, "required": [ "location" ], "additionalProperties": false, "examples": [ { "location": { "id": 12345, "level": "local-lite", "status": "canceled", "account_id": 123, "auto_sync_enabled": 1, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "timezone": "America/New_York", "store_code": "", "tagline": "Your neighborhood business", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": [ "tutoring", "online tutoring", "test preparation", "academic tutoring" ], "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": 0, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "reopen_date": "0000-00-00", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": {}, "opening_hours_notes": "", "opening_date": "0000-00-00", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "" } } ] }, "LocalLocationObject": { "type": "object", "properties": { "id": { "$ref": "#/definitions/LocationId" }, "level": { "$ref": "#/definitions/LocationLevel" }, "status": { "$ref": "#/definitions/LocationStatus" }, "account_id": { "$ref": "#/definitions/LocationAccountId" }, "auto_sync_enabled": { "$ref": "#/definitions/LocationAutoSyncEnabled" }, "remote_id": { "$ref": "#/definitions/LocationRemoteId" }, "listings_name": { "$ref": "#/definitions/LocationListingsName" }, "location_name": { "$ref": "#/definitions/LocationLocationName" }, "website_url": { "$ref": "#/definitions/LocationWebsiteUrl" }, "email_address": { "$ref": "#/definitions/LocationEmailAddress" }, "timezone": { "$ref": "#/definitions/LocationTimezone" }, "store_code": { "$ref": "#/definitions/LocationStoreCode" }, "tagline": { "$ref": "#/definitions/LocationTagline" }, "short_description": { "$ref": "#/definitions/LocationShortDescription" }, "long_description": { "$ref": "#/definitions/LocationLongDescription" }, "languages": { "$ref": "#/definitions/LocationLanguages" }, "keywords": { "$ref": "#/definitions/LocationKeywords" }, "brands": { "$ref": "#/definitions/LocationBrands" }, "payment_forms": { "$ref": "#/definitions/LocationPaymentForms" }, "price_range": { "$ref": "#/definitions/LocationPriceRange" }, "service_areas": { "$ref": "#/definitions/LocationServiceAreas" }, "service_area_only": { "$ref": "#/definitions/LocationServiceAreaOnly" }, "services": { "$ref": "#/definitions/LocationServices" }, "primary_category": { "$ref": "#/definitions/LocationPrimaryCategory" }, "additional_categories": { "$ref": "#/definitions/LocationAdditionalCategories" }, "attributes": { "$ref": "#/definitions/LocationAttributes" }, "address": { "$ref": "#/definitions/LocationAddress" }, "lat": { "$ref": "#/definitions/LocalLocationLatitude" }, "long": { "$ref": "#/definitions/LocalLocationLongitude" }, "opening_status": { "$ref": "#/definitions/LocationOpeningStatus" }, "reopen_date": { "$ref": "#/definitions/LocationReopenDate" }, "hours": { "$ref": "#/definitions/LocationOpeningHours" }, "more_hours": { "$ref": "#/definitions/LocationMoreHours" }, "opening_hours_notes": { "$ref": "#/definitions/LocationOpeningHoursNotes" }, "opening_date": { "$ref": "#/definitions/LocationOpeningDate" }, "special_hours": { "$ref": "#/definitions/LocationSpecialHours" }, "phone": { "$ref": "#/definitions/LocationPhone" }, "fax": { "$ref": "#/definitions/LocationFax" } }, "required": [ "id", "level", "status", "account_id", "listings_name" ], "additionalProperties": false, "description": "A Moz Local location." }, "LocationLevel": { "type": "string", "description": "The name of the tier of service for the location." }, "LocationStatus": { "type": "string", "enum": [ "active", "canceled", "closed", "suspended" ], "description": "The status of the location" }, "LocationAutoSyncEnabled": { "type": "boolean", "description": "Enables or disables automatic data synchronization to native networks", "default": false }, "LocationRemoteId": { "type": "string", "description": "The internal ID property of the source of data" }, "LocationListingsName": { "type": "string", "description": "The listings name (that gets published) of the location" }, "LocationLocationName": { "type": "string", "description": "The internal name of the location" }, "LocationWebsiteUrl": { "type": "string", "description": "The website URL for the location" }, "LocationEmailAddress": { "type": "string", "description": "The email address for the location, or a corporate email address" }, "LocationTimezone": { "type": "string", "description": "The location timezone" }, "LocationStoreCode": { "type": "string", "description": "Unique store identifier" }, "LocationTagline": { "type": "string", "description": "Tagline or main headline for the location" }, "LocationShortDescription": { "type": "string", "description": "A short description up to 255 characters" }, "LocationLongDescription": { "type": "string", "description": "A long description up to 750 characters" }, "LocationLanguages": { "type": "array", "items": { "$ref": "#/definitions/LocationLanguage" }, "description": "The language(s) in which customers can interact with the location's staff" }, "LocationLanguage": { "type": "string", "enum": [ "en_US", "en_CA", "en_GB", "en_IN", "en_PI", "af_ZA", "ar_AR", "az_AZ", "be_BY", "bg_BG", "bn_IN", "bs_BA", "ca_ES", "cs_CZ", "cx_PH", "cy_GB", "da_DK", "de_DE", "el_GR", "eo_EO", "es_ES", "es_LA", "et_EE", "eu_ES", "fa_IR", "fb_LT", "fi_FI", "fo_FO", "fr_CA", "fr_FR", "fy_NL", "ga_IE", "gl_ES", "gn_PY", "gu_IN", "he_IL", "hi_IN", "hr_HR", "hu_HU", "hy_AM", "id_ID", "is_IS", "it_IT", "ja_JP", "ja_KS", "jv_ID", "ka_GE", "kk_KZ", "km_KH", "kn_IN", "ko_KR", "ku_TR", "la_VA", "lt_LT", "lv_LV", "mk_MK", "ml_IN", "mn_MN", "mr_IN", "ms_MY", "nb_NO", "ne_NP", "nl_NL", "nn_NO", "pa_IN", "pl_PL", "ps_AF", "pt_BR", "pt_PT", "ro_RO", "ru_RU", "si_LK", "sk_SK", "sl_SI", "sq_AL", "sr_RS", "sv_SE", "sw_KE", "ta_IN", "te_IN", "tg_TJ", "th_TH", "tl_PH", "tr_TR", "uk_UA", "ur_PK", "uz_UZ", "vi_VN", "zh_CN", "zh_HK", "zh_TW" ], "description": "A language in which customers can interact with the location's staff" }, "LocationKeywords": { "type": "array", "items": { "$ref": "#/definitions/LocationKeyword" }, "description": "The keyword(s) associated with your business" }, "LocationKeyword": { "type": "string", "description": "A keyword used to describe your business" }, "LocationBrands": { "type": "array", "items": { "$ref": "#/definitions/LocationBrand" }, "description": "The brand(s) associated with your business" }, "LocationBrand": { "type": "string", "description": "A brand associated with your business" }, "LocationPaymentForms": { "type": "array", "items": { "$ref": "#/definitions/LocationPaymentForm" }, "description": "List of forms of payment accepted" }, "LocationPaymentForm": { "type": "string", "enum": [ "American Express", "Discover", "Google Pay", "Apple Pay", "Cash", "Visa", "Mastercard" ], "description": "A form of payment accepted" }, "LocationPriceRange": { "type": "string", "enum": [ "omit", "$", "$$", "$$$", "$$$$", "n/a" ], "description": "The location's product or service estimated price range" }, "LocationServiceAreas": { "type": "array", "items": { "$ref": "#/definitions/LocationServiceArea" }, "description": "All applicable page service areas found using Google Places" }, "LocationServiceArea": { "type": "object", "properties": { "text": { "$ref": "#/definitions/ServiceAreasText" }, "id": { "$ref": "#/definitions/ServiceAreasId" } }, "required": [ "text", "id" ], "additionalProperties": false, "description": "A page service areas found using Google Places" }, "ServiceAreasText": { "type": "string", "description": "The name of the place" }, "ServiceAreasId": { "type": "string", "description": "The place id found using Google Places search" }, "LocationServiceAreaOnly": { "type": "boolean", "description": "Set this location as a \"service-area only\" business" }, "LocationServices": { "type": "array", "items": { "$ref": "#/definitions/LocationService" }, "description": "Location services" }, "LocationService": { "type": "string", "description": "A location service" }, "LocationPrimaryCategory": { "type": "string", "description": "The primary category ID from Google" }, "LocationAdditionalCategories": { "type": "array", "items": { "$ref": "#/definitions/LocationAdditionalCategory" }, "description": "Array of additionally applicable category ids" }, "LocationAdditionalCategory": { "type": "string", "description": "Category ids from Google" }, "LocationAttributes": { "type": "array", "items": { "$ref": "#/definitions/LocationAttribute" }, "description": "Array of attributes." }, "LocationAttribute": { "type": "object", "properties": { "id": { "$ref": "#/definitions/AttributeId" }, "value": { "$ref": "#/definitions/AttributeValue" } }, "required": [ "id", "value" ], "additionalProperties": false, "description": "Location attribute" }, "AttributeId": { "type": "string", "description": "The id from Google" }, "AttributeValue": { "type": "string", "description": "The string value" }, "LocationAddress": { "type": "object", "properties": { "address_line_1": { "$ref": "#/definitions/AddressAddressLine1" }, "address_line_2": { "$ref": "#/definitions/AddressAddressLine2" }, "sublocality": { "$ref": "#/definitions/AddressSublocality" }, "county": { "$ref": "#/definitions/AddressCounty" }, "city": { "$ref": "#/definitions/AddressCity" }, "state_province": { "$ref": "#/definitions/AddressStateProvince" }, "postal_code": { "$ref": "#/definitions/AddressPostalCode" }, "country": { "$ref": "#/definitions/AddressCountry" } }, "required": [ "address_line_1", "city", "state_province", "postal_code", "country" ], "additionalProperties": false, "description": "The location's physical address" }, "AddressAddressLine1": { "type": "string", "description": "Name of the street where the premises are located" }, "AddressAddressLine2": { "type": "string", "description": "Any additional premises data, such as suite number, building number etc." }, "AddressSublocality": { "type": "string", "description": "The neighborhood" }, "AddressCounty": { "type": "string", "description": "The county in which the premises are located" }, "AddressCity": { "type": "string", "description": "The geographical city of the premises" }, "AddressStateProvince": { "type": "string", "description": "The geographical state or province in which the premises are" }, "AddressPostalCode": { "type": "string", "description": "The geographical area in which a premises resides" }, "AddressCountry": { "type": "string", "description": "The country in which the premises resides" }, "LocalLocationLatitude": { "type": "number", "description": "The location's latitude" }, "LocalLocationLongitude": { "type": "number", "description": "The location's longitude" }, "LocationOpeningStatus": { "type": "string", "enum": [ "open", "selected_hours", "always_open", "temporarily_closed", "permanently_closed", "no_hours", "not_selected" ], "description": "The location open status", "default": "open" }, "LocationReopenDate": { "type": "string", "description": "Reopen date if location is temporarily closed" }, "LocationOpeningHours": { "type": "object", "properties": { "monday": { "$ref": "#/definitions/OpeningHoursMondayArray" }, "tuesday": { "$ref": "#/definitions/OpeningHoursTuesdayArray" }, "wednesday": { "$ref": "#/definitions/OpeningHoursWednesdayArray" }, "thursday": { "$ref": "#/definitions/OpeningHoursThursdayArray" }, "friday": { "$ref": "#/definitions/OpeningHoursFridayArray" }, "saturday": { "$ref": "#/definitions/OpeningHoursSaturdayArray" }, "sunday": { "$ref": "#/definitions/OpeningHoursSundayArray" } }, "additionalProperties": false, "description": "The regular opening hours keyed by the day" }, "OpeningHoursMondayArray": { "type": "array", "items": { "$ref": "#/definitions/OpeningHoursMonday" }, "description": "Time slots for Monday" }, "OpeningHoursMonday": { "type": "string", "description": "A time slot for Monday" }, "OpeningHoursTuesdayArray": { "type": "array", "items": { "$ref": "#/definitions/OpeningHoursTuesday" }, "description": "Time slots for Tuesday" }, "OpeningHoursTuesday": { "type": "string", "description": "A time slot for Tuesday" }, "OpeningHoursWednesdayArray": { "type": "array", "items": { "$ref": "#/definitions/OpeningHoursWednesday" }, "description": "Time slots for Wednesday" }, "OpeningHoursWednesday": { "type": "string", "description": "A time slot for Wednesday" }, "OpeningHoursThursdayArray": { "type": "array", "items": { "$ref": "#/definitions/OpeningHoursThursday" }, "description": "Time slots for Thursday" }, "OpeningHoursThursday": { "type": "string", "description": "A time slot for Thursday" }, "OpeningHoursFridayArray": { "type": "array", "items": { "$ref": "#/definitions/OpeningHoursFriday" }, "description": "Time slots for Friday" }, "OpeningHoursFriday": { "type": "string", "description": "A time slot for Friday" }, "OpeningHoursSaturdayArray": { "type": "array", "items": { "$ref": "#/definitions/OpeningHoursSaturday" }, "description": "Time slots for Saturday" }, "OpeningHoursSaturday": { "type": "string", "description": "A time slot for Saturday" }, "OpeningHoursSundayArray": { "type": "array", "items": { "$ref": "#/definitions/OpeningHoursSunday" }, "description": "Time slots for Sunday" }, "OpeningHoursSunday": { "type": "string", "description": "A time slot for Sunday" }, "LocationMoreHours": { "type": "object", "additionalProperties": { "$ref": "#/definitions/LocationOpeningHours" }, "description": "Service-based opening hours keyed by the function" }, "LocationOpeningHoursNotes": { "type": "string", "description": "Notes pertaining to opening hours" }, "LocationOpeningDate": { "type": "string", "description": "The date the business opened or is expected to open" }, "LocationSpecialHours": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/definitions/OpeningHoursTimeSlots" } }, "description": "The special opening hours keyed by the date in YYYY-MM-DD format" }, "OpeningHoursTimeSlots": { "type": "array", "items": { "$ref": "#/definitions/OpeningHoursTimeSlot" }, "description": "An array of time ranges in format \"HH:MM-HH:MM\"" }, "OpeningHoursTimeSlot": { "type": "string", "description": "A time ranges in format \"HH:MM-HH:MM\"" }, "LocationPhone": { "type": "string", "description": "The primary phone numberfor the location" }, "LocationFax": { "type": "string", "description": "The primary fax numberfor the location" }, "LocalLocationCancelActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationCancelAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationCancelActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationCancelActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationCancelActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Cancel a specific location by ID.", "enterprise_only": true, "default": "Cancel Location" }, "LocalLocationCategoryListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationCategoryListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationCategoryListActionData": { "type": "object", "additionalProperties": false, "description": "This method does not require any input.", "examples": [ {} ] }, "LocalLocationCategoryListActionResult": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/definitions/LocationCategory" } } }, "required": [ "categories" ], "additionalProperties": false, "examples": [ { "categories": [ { "id": "gcid:three_d_printing_service", "name": "3D printing service" }, { "id": "gcid:acai_shop", "name": "A\u00e7a\u00ed shop" } ] } ] }, "LocationCategory": { "type": "object", "properties": { "id": { "type": "string", "description": "The Google category ID (e.g., \"gcid:tax_accounting\")" }, "name": { "type": "string", "description": "The human-readable name of the category" } }, "required": [ "id", "name" ], "additionalProperties": false, "description": "A category ID from Google" }, "LocalLocationCategoryListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationCategoryListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationCategoryListActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationCategoryListActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationCategoryListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Retrieve a list of Google category IDs that can be used for `primary_category` or `additional_categories` when creating or updating a location.", "enterprise_only": true, "default": "List Categories" }, "LocalLocationCloseActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationCloseActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationCloseActionData": { "type": "object", "properties": { "id": { "$ref": "#/definitions/LocationId", "description": "The ID of the location to close." } }, "required": [ "id" ], "additionalProperties": false, "examples": [ { "id": 12345 } ] }, "LocalLocationCloseActionResult": { "type": "object", "properties": { "location": { "$ref": "#/definitions/LocalLocationObject" } }, "required": [ "location" ], "additionalProperties": false, "examples": [ { "location": { "id": 12345, "level": "local-lite", "status": "closed", "account_id": 123, "auto_sync_enabled": true, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "store_code": "", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": [ "tutoring", "online tutoring", "test preparation", "academic tutoring" ], "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": false, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "permanently_closed", "reopen_date": "0000-00-00", "hours": { "monday": [], "tuesday": [], "wednesday": [], "thursday": [], "friday": [], "saturday": [], "sunday": [] }, "more_hours": {}, "opening_hours_notes": "", "opening_date": "0000-00-00", "special_hours": {}, "network_fields": [], "phone": "+1 561-395-5555", "fax": "" } } ] }, "LocalLocationCloseActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationCloseAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationCloseActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationCloseActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationCloseActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Closes a location, setting its status to closed and opening status to permanently closed.", "enterprise_only": true, "default": "Close Location" }, "LocalLocationCreateActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationCreateActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationCreateActionData": { "type": "object", "properties": { "location": { "$ref": "#/definitions/LocalLocationCreateObject" } }, "required": [ "location" ], "additionalProperties": false, "examples": [ { "location": { "level": "local-lite", "account_id": 123, "auto_sync_enabled": true, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "store_code": "", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": [ "tutoring", "online tutoring", "test preparation", "academic tutoring" ], "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": false, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": { "kitchen hours": { "monday": [ "09:00-21:00" ] } }, "opening_hours_notes": "", "opening_date": "2025-03-01", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "", "create_page": true, "published": false } } ] }, "LocalLocationCreateObject": { "type": "object", "properties": { "level": { "$ref": "#/definitions/LocationLevel" }, "account_id": { "$ref": "#/definitions/LocationAccountId" }, "auto_sync_enabled": { "$ref": "#/definitions/LocationAutoSyncEnabled" }, "remote_id": { "$ref": "#/definitions/LocationRemoteId" }, "listings_name": { "$ref": "#/definitions/LocationListingsName" }, "location_name": { "$ref": "#/definitions/LocationLocationName" }, "website_url": { "$ref": "#/definitions/LocationWebsiteUrl" }, "email_address": { "$ref": "#/definitions/LocationEmailAddress" }, "timezone": { "$ref": "#/definitions/LocationTimezone" }, "store_code": { "$ref": "#/definitions/LocationStoreCode" }, "tagline": { "$ref": "#/definitions/LocationTagline" }, "short_description": { "$ref": "#/definitions/LocationShortDescription" }, "long_description": { "$ref": "#/definitions/LocationLongDescription" }, "languages": { "$ref": "#/definitions/LocationLanguages" }, "keywords": { "$ref": "#/definitions/LocationKeywords" }, "brands": { "$ref": "#/definitions/LocationBrands" }, "payment_forms": { "$ref": "#/definitions/LocationPaymentForm" }, "price_range": { "$ref": "#/definitions/LocationPriceRange" }, "service_areas": { "$ref": "#/definitions/LocationServiceAreas" }, "service_area_only": { "$ref": "#/definitions/LocationServiceAreaOnly" }, "services": { "$ref": "#/definitions/LocationServices" }, "primary_category": { "$ref": "#/definitions/LocationPrimaryCategory" }, "additional_categories": { "$ref": "#/definitions/LocationAdditionalCategories" }, "attributes": { "$ref": "#/definitions/LocationAttributes" }, "address": { "$ref": "#/definitions/LocationAddress" }, "lat": { "$ref": "#/definitions/LocalLocationLatitude" }, "long": { "$ref": "#/definitions/LocalLocationLongitude" }, "opening_status": { "$ref": "#/definitions/LocationOpeningStatus" }, "reopen_date": { "$ref": "#/definitions/LocationReopenDate" }, "hours": { "$ref": "#/definitions/LocationOpeningHours" }, "opening_hours_notes": { "$ref": "#/definitions/LocationOpeningHoursNotes" }, "opening_date": { "$ref": "#/definitions/LocationOpeningDate" }, "special_hours": { "$ref": "#/definitions/LocationSpecialHours" }, "phone": { "$ref": "#/definitions/LocationPhone" }, "fax": { "$ref": "#/definitions/LocationFax" }, "published": { "$ref": "#/definitions/LocationPublished" }, "create_pages": { "$ref": "#/definitions/LocationCreatePages" } }, "required": [ "level", "account_id", "listings_name", "address" ], "additionalProperties": false, "description": "A location to be created." }, "LocationPublished": { "type": "boolean", "description": "If true, location would be published when created", "default": true }, "LocationCreatePages": { "type": "boolean", "description": "If true, pages will be created for the location", "default": false }, "LocalLocationCreateActionResult": { "type": "object", "properties": { "location": { "$ref": "#/definitions/LocalLocationObject" } }, "required": [ "location" ], "additionalProperties": false, "examples": [ { "location": { "id": 12345, "level": "local-lite", "status": "active", "account_id": 123, "auto_sync_enabled": true, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "store_code": "", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": "tutoring,online tutoring,test preparation,academic tutoring", "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": false, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": { "kitchen hours": { "monday": [ "09:00-21:00" ] } }, "opening_hours_notes": "", "opening_date": "2025-03-01", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "" } } ] }, "LocalLocationCreateActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationCreateAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationCreateActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationCreateActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationCreateActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Creates a new location.", "enterprise_only": true, "default": "Create location" }, "LocalLocationFilterAccountActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationFilterAccountActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationFilterAccountActionData": { "type": "object", "properties": { "page": { "$ref": "#/definitions/LocalLocationFilterAccountInputPage" } }, "additionalProperties": false, "examples": [ { "account_id": 4321 }, { "page": { "n": 1, "limit": 25 }, "account_id": 4321 } ] }, "LocalLocationFilterAccountInputPage": { "type": "object", "properties": { "n": { "$ref": "#/definitions/DataPageInputN" }, "limit": { "$ref": "#/definitions/LocalLocationFilterAccountInputPageInputLimit" } }, "additionalProperties": false, "description": "Control the number of results returned per call in addition to fetching additional results. The default `limit` is 25 with an `n` value of 0 (indicating the first page of results). Make subsequent calls to the endpoint with incrementing `n` values to fetch additional pages of results. To get all results, you must continue making calls with incrementing `n` values until an empty result set is returned." }, "LocalLocationFilterAccountInputPageInputLimit": { "type": "number", "description": "The number of results per page. Maximum is 50.", "default": 25 }, "LocalLocationFilterAccountActionResult": { "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/definitions/LocalLocationObject" } }, "account_id": { "$ref": "#/definitions/LocationAccountId" }, "page": { "$ref": "#/definitions/DataPageInput" } }, "required": [ "locations", "account_id", "page" ], "additionalProperties": false, "examples": [ { "locations": [ { "id": 4, "level": "local-lite", "status": "active", "account_id": 1, "auto_sync_enabled": true, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "store_code": "", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": [ "tutoring", "online tutoring", "test preparation", "academic tutoring" ], "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": false, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "reopen_date": "0000-00-00", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": { "kitchen hours": { "monday": [ "09:00-21:00" ] } }, "opening_hours_notes": "", "opening_date": "0000-00-00", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "" } ], "account_id": 4321, "page": { "n": 0, "limit": 25 } } ] }, "LocalLocationFilterAccountActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationFilterAccountAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationFilterAccountActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationFilterAccountActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationFilterAccountActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "List all active locations filtered by Moz Local Account ID.", "default": "Filter Locations by Account" }, "LocalLocationFilterStatusActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationFilterStatusActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationFilterStatusActionData": { "type": "object", "properties": { "page": { "$ref": "#/definitions/LocalLocationFilterStatusInputPage" }, "status": { "$ref": "#/definitions/LocationStatus" } }, "required": [ "status" ], "additionalProperties": false, "examples": [ { "status": "active" }, { "page": { "n": 1, "limit": 25 }, "status": "active" } ] }, "LocalLocationFilterStatusInputPage": { "type": "object", "properties": { "n": { "$ref": "#/definitions/DataPageInputN" }, "limit": { "$ref": "#/definitions/LocalLocationFilterStatusInputPageInputLimit" } }, "additionalProperties": false, "description": "Control the number of results returned per call in addition to fetching additional results. The default `limit` is 25 with an `n` value of 0 (indicating the first page of results). Make subsequent calls to the endpoint with incrementing `n` values to fetch additional pages of results. To get all results, you must continue making calls with incrementing `n` values until an empty result set is returned." }, "LocalLocationFilterStatusInputPageInputLimit": { "type": "number", "description": "The number of results per page. Maximum is 50.", "default": 25 }, "LocalLocationFilterStatusActionResult": { "type": "object", "properties": { "status": { "$ref": "#/definitions/LocationStatus" }, "locations": { "type": "array", "items": { "$ref": "#/definitions/LocalLocationObject" } } }, "required": [ "status", "locations" ], "additionalProperties": false, "examples": [ { "status": "active", "page": { "n": 1, "limit": 25 }, "locations": [ { "id": 4, "level": "local-lite", "status": "active", "account_id": 1, "auto_sync_enabled": true, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "store_code": "", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": [ "tutoring", "online tutoring", "test preparation", "academic tutoring" ], "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": false, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "reopen_date": "0000-00-00", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": { "kitchen hours": { "monday": [ "09:00-21:00" ] } }, "opening_hours_notes": "", "opening_date": "0000-00-00", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "" } ] } ] }, "LocalLocationFilterStatusActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationFilterStatusAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationFilterStatusActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationFilterStatusActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationFilterStatusActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "List locations filtered by status.", "default": "Filter Locations by Status" }, "LocalLocationInsightGbpImpressionHistoryFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionHistoryFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationInsightGbpImpressionHistoryFetchActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" }, "date_start": { "$ref": "#/definitions/LocalNetworkInsightDateStart" }, "date_end": { "$ref": "#/definitions/LocalNetworkInsightDateEnd" }, "keyword_limit": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionKeywordLimit", "description": "Max number of top keywords to return per bucket. Defaults to `50` when omitted." } }, "required": [ "location_id", "date_start", "date_end" ], "additionalProperties": false, "examples": [ { "location_id": 12345, "date_start": "2025-01-01", "date_end": "2025-12-31", "keyword_limit": 50 } ] }, "LocalNetworkInsightDateStart": { "type": "string", "description": "Inclusive range start, `YYYY-MM-DD`." }, "LocalNetworkInsightDateEnd": { "type": "string", "description": "Inclusive range end, `YYYY-MM-DD`. Date range may not exceed 12 months." }, "LocalNetworkInsightGbpImpressionKeywordLimit": { "type": "number", "description": "Max number of top keywords returned per Google Business Profile impression bucket." }, "LocalLocationInsightGbpImpressionHistoryFetchActionResult": { "type": "object", "properties": { "gbp_impression_history": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionHistoryObject" } }, "required": [ "gbp_impression_history" ], "additionalProperties": false, "examples": [ { "gbp_impression_history": { "location_id": 12345, "date_start": "2025-01-01", "date_end": "2025-12-31", "keyword_limit": 50, "gbp_impression_history_reports": [ { "date": "2025-01-01", "impressions": [ { "keyword": "tutoring", "value": 291 }, { "keyword": "online tutoring", "value": 55 } ] } ] } } ] }, "LocalNetworkInsightGbpImpressionHistoryObject": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId", "description": "Echo of the requested location id." }, "date_start": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "Echo of the requested inclusive range start, `YYYY-MM-DD`." }, "date_end": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "Echo of the requested inclusive range end, `YYYY-MM-DD`." }, "keyword_limit": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionKeywordLimit", "description": "The keyword limit used for the request (defaults to 50)." }, "gbp_impression_history_reports": { "type": "array", "items": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionHistoryReportObject" }, "description": "Impression-history buckets ordered oldest to newest." } }, "required": [ "location_id", "date_start", "date_end", "keyword_limit", "gbp_impression_history_reports" ], "additionalProperties": false, "description": "Google Business Profile keyword-impression history for a location over a date range. Echoes back the requested location, range, and keyword limit and carries the per-bucket reports." }, "LocalNetworkInsightDate": { "type": "string", "description": "A calendar date in `YYYY-MM-DD` format." }, "LocalNetworkInsightGbpImpressionHistoryReportObject": { "type": "object", "properties": { "date": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "The bucket date in `YYYY-MM-DD` format." }, "impressions": { "type": "array", "items": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionObject" }, "description": "Per-keyword impression values." } }, "required": [ "date", "impressions" ], "additionalProperties": false, "description": "A single Google Business Profile impression-history bucket for a location. Each object covers one month of GBP keyword-impression activity. Buckets are returned ordered oldest to newest." }, "LocalNetworkInsightGbpImpressionObject": { "type": "object", "properties": { "keyword": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionKeyword" }, "value": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionValue" } }, "required": [ "keyword", "value" ], "additionalProperties": false, "description": "A single keyword's impression value within a bucket." }, "LocalNetworkInsightGbpImpressionKeyword": { "type": "string", "description": "A keyword the impressions are attributed to." }, "LocalNetworkInsightGbpImpressionValue": { "type": [ "number", "null" ], "description": "Impression count for a keyword within a bucket. `null` implies no significant volume." }, "LocalLocationInsightGbpImpressionHistoryFetchActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationInsightGbpImpressionHistoryFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionHistoryFetchActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionHistoryFetchActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionHistoryFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns Google Business Profile keyword-impression history over time (month by month) for a location's top-performing keywords. Buckets are returned ordered oldest to newest.", "enterprise_only": true, "default": "Fetch GBP Impression History" }, "LocalLocationInsightGbpImpressionTotalFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionTotalFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationInsightGbpImpressionTotalFetchActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" }, "date_start": { "$ref": "#/definitions/LocalNetworkInsightDateStart" }, "date_end": { "$ref": "#/definitions/LocalNetworkInsightDateEnd" }, "page": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionTotalInputPage", "description": "The paging data." } }, "required": [ "location_id", "date_start", "date_end" ], "additionalProperties": false, "examples": [ { "location_id": 12345, "date_start": "2025-01-01", "date_end": "2025-12-31" }, { "location_id": 12345, "date_start": "2025-01-01", "date_end": "2025-12-31", "page": { "n": 1, "limit": 25 } } ] }, "LocalLocationInsightGbpImpressionTotalInputPage": { "type": "object", "properties": { "n": { "$ref": "#/definitions/DataPageInputN" }, "limit": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionTotalInputPageInputLimit" } }, "additionalProperties": false, "description": "Control the number of results returned per call in addition to fetching additional results. The default `limit` is 25 with an `n` value of 0 (indicating the first page of results). Make subsequent calls to the endpoint with incrementing `n` values to fetch additional pages of results. To get all results, you must continue making calls with incrementing `n` values until an empty result set is returned." }, "LocalLocationInsightGbpImpressionTotalInputPageInputLimit": { "type": "number", "description": "The number of keywords to return per page. Maximum is 50.", "default": 25 }, "LocalLocationInsightGbpImpressionTotalFetchActionResult": { "type": "object", "properties": { "gbp_impression_total": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionTotalObject" }, "page": { "$ref": "#/definitions/DataPageInput", "description": "The Page being returned." } }, "required": [ "gbp_impression_total", "page" ], "additionalProperties": false, "examples": [ { "gbp_impression_total": { "location_id": 12345, "date_start": "2025-01-01", "date_end": "2025-12-31", "gbp_impression_keyword_totals": [ { "keyword": "tutoring near me", "value": 792 }, { "keyword": "tutoring", "value": null } ] }, "page": { "n": 0, "limit": 25 } } ] }, "LocalNetworkInsightGbpImpressionTotalObject": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId", "description": "Echo of the requested location id." }, "date_start": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "Echo of the requested inclusive range start, `YYYY-MM-DD`." }, "date_end": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "Echo of the requested inclusive range end, `YYYY-MM-DD`." }, "gbp_impression_keyword_totals": { "type": "array", "items": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionKeywordTotalObject" }, "description": "Keyword impression totals ordered from most to least impressions." } }, "required": [ "location_id", "date_start", "date_end", "gbp_impression_keyword_totals" ], "additionalProperties": false, "description": "Total Google Business Profile keyword impressions for a location over a date range. Echoes back the requested location and date range and carries the per-keyword totals ordered from most to least impressions." }, "LocalNetworkInsightGbpImpressionKeywordTotalObject": { "type": "object", "properties": { "keyword": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionKeyword", "description": "The ranking keyword." }, "value": { "$ref": "#/definitions/LocalNetworkInsightGbpImpressionValue", "description": "Total impressions for the keyword in the requested range." } }, "required": [ "keyword", "value" ], "additionalProperties": false, "description": "Total Google Business Profile impressions for a single ranking keyword." }, "LocalLocationInsightGbpImpressionTotalFetchActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationInsightGbpImpressionTotalFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionTotalFetchActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionTotalFetchActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationInsightGbpImpressionTotalFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns total Google Business Profile keyword impressions for a given location and date range, ordered from most to least impressions. The date range may not exceed 12 months.", "enterprise_only": true, "default": "Fetch GBP Impressions" }, "LocalLocationInsightGbpLeadHistoryFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationInsightGbpLeadHistoryFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationInsightGbpLeadHistoryFetchActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" }, "date_start": { "$ref": "#/definitions/LocalNetworkInsightDateStart" }, "date_end": { "$ref": "#/definitions/LocalNetworkInsightDateEnd" }, "date_aggregation": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadDateAggregation", "description": "Bucket size for the time series. Defaults to `month` when omitted." } }, "required": [ "location_id", "date_start", "date_end" ], "additionalProperties": false, "examples": [ { "location_id": 12345, "date_start": "2025-01-01", "date_end": "2025-12-31", "date_aggregation": "month" } ] }, "LocalNetworkInsightGbpLeadDateAggregation": { "type": "string", "enum": [ "day", "week", "month" ], "description": "The bucket size used to aggregate a Google Business Profile insight time series. Accepted and returned in lowercase." }, "LocalLocationInsightGbpLeadHistoryFetchActionResult": { "type": "object", "properties": { "gbp_lead_history": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadHistoryObject" } }, "required": [ "gbp_lead_history" ], "additionalProperties": false, "examples": [ { "gbp_lead_history": { "location_id": 12345, "date_start": "2025-01-01", "date_end": "2025-12-31", "date_aggregation": "month", "gbp_lead_history_reports": [ { "date": "2025-01-01", "total_leads": 120, "actions_website": 80, "actions_phone": 25, "actions_driving_directions": 15, "total_impressions": 5400, "ctr": 0.022 } ] } } ] }, "LocalNetworkInsightGbpLeadHistoryObject": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId", "description": "Echo of the requested location id." }, "date_start": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "Echo of the requested inclusive range start, `YYYY-MM-DD`." }, "date_end": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "Echo of the requested inclusive range end, `YYYY-MM-DD`." }, "date_aggregation": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadDateAggregation", "description": "The bucket size used for the time series (defaults to `month`)." }, "gbp_lead_history_reports": { "type": "array", "items": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadHistoryReportObject" }, "description": "Lead-history buckets ordered oldest to newest." } }, "required": [ "location_id", "date_start", "date_end", "date_aggregation", "gbp_lead_history_reports" ], "additionalProperties": false, "description": "Google Business Profile lead history for a location over a date range. Echoes back the requested location and date range and carries the per-bucket reports." }, "LocalNetworkInsightGbpLeadHistoryReportObject": { "type": "object", "properties": { "date": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "The bucket start date in `YYYY-MM-DD` format." }, "total_leads": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadTotalLeads" }, "actions_website": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadActionsWebsite" }, "actions_phone": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadActionsPhone" }, "actions_driving_directions": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadActionsDrivingDirections" }, "total_impressions": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadTotalImpressions" }, "ctr": { "$ref": "#/definitions/LocalNetworkInsightGbpLeadCtr" } }, "required": [ "date", "total_leads", "actions_website", "actions_phone", "actions_driving_directions", "total_impressions", "ctr" ], "additionalProperties": false, "description": "A single Google Business Profile lead-history bucket for a location. Each object covers one time bucket (day, week, or month) of GBP lead activity. Buckets are returned ordered oldest to newest." }, "LocalNetworkInsightGbpLeadTotalLeads": { "type": "number", "description": "Total Google Business Profile leads in the bucket." }, "LocalNetworkInsightGbpLeadActionsWebsite": { "type": "number", "description": "Leads in the bucket that clicked through to the website." }, "LocalNetworkInsightGbpLeadActionsPhone": { "type": "number", "description": "Leads in the bucket that placed a phone call." }, "LocalNetworkInsightGbpLeadActionsDrivingDirections": { "type": "number", "description": "Leads in the bucket that requested driving directions." }, "LocalNetworkInsightGbpLeadTotalImpressions": { "type": "number", "description": "Total business impressions in the bucket." }, "LocalNetworkInsightGbpLeadCtr": { "type": "number", "description": "Clickthrough rate for the bucket." }, "LocalLocationInsightGbpLeadHistoryFetchActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationInsightGbpLeadHistoryFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationInsightGbpLeadHistoryFetchActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationInsightGbpLeadHistoryFetchActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationInsightGbpLeadHistoryFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns Google Business Profile lead history over time for a given location, bucketed by day, week, or month. The date range may not exceed 12 months and buckets are returned ordered oldest to newest.", "enterprise_only": true, "default": "Fetch GBP Lead History" }, "LocalLocationLevelListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationLevelListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationLevelListActionData": { "type": "object", "additionalProperties": false, "description": "This method does not require any input.", "examples": [ {} ] }, "LocalLocationLevelListActionResult": { "type": "object", "properties": { "levels": { "$ref": "#/definitions/LocalLocationLevels" } }, "required": [ "levels" ], "additionalProperties": false, "examples": [ { "levels": [ "local-lite", "local-preferred" ] } ] }, "LocalLocationLevels": { "type": "array", "items": { "$ref": "#/definitions/LocationLevel" }, "description": "The available levels of service for locations." }, "LocalLocationLevelListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationLevelListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationLevelListActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationLevelListActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationLevelListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "List the available levels of service for locations.", "enterprise_only": true, "default": "Fetch Available Levels" }, "LocalLocationLevelUpdateActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationLevelUpdateActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationLevelUpdateActionData": { "type": "object", "properties": { "id": { "$ref": "#/definitions/LocationId" }, "level": { "$ref": "#/definitions/LocationLevel" } }, "required": [ "id", "level" ], "additionalProperties": false, "examples": [ { "id": 12345, "level": "local-elite" } ] }, "LocalLocationLevelUpdateActionResult": { "type": "object", "properties": { "location": { "$ref": "#/definitions/LocalLocationObject" } }, "required": [ "location" ], "additionalProperties": false, "examples": [ { "location": { "id": 12345, "level": "local-elite", "status": "active", "account_id": 1, "auto_sync_enabled": 1, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "timezone": "America/New_York", "store_code": "", "tagline": "Your neighborhood business", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": [ "tutoring", "online tutoring", "test preparation", "academic tutoring" ], "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": 0, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "reopen_date": "0000-00-00", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": {}, "opening_hours_notes": "", "opening_date": "0000-00-00", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "" } } ] }, "LocalLocationLevelUpdateActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationLevelUpdateAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationLevelUpdateActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationLevelUpdateActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationLevelUpdateActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Updates the tier of service for a single location", "enterprise_only": true, "default": "Update Location Level" }, "LocalLocationListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationListActionData": { "type": "object", "properties": { "page": { "$ref": "#/definitions/LocalLocationListInputPage" } }, "additionalProperties": false, "examples": [ {}, { "page": { "n": 1, "limit": 25 } } ] }, "LocalLocationListInputPage": { "type": "object", "properties": { "n": { "$ref": "#/definitions/DataPageInputN" }, "limit": { "$ref": "#/definitions/LocalLocationListInputPageInputLimit" } }, "additionalProperties": false, "description": "Control the number of results returned per call in addition to fetching additional results. The default `limit` is 25 with an `n` value of 0 (indicating the first page of results). Make subsequent calls to the endpoint with incrementing `n` values to fetch additional pages of results. To get all results, you must continue making calls with incrementing `n` values until an empty result set is returned." }, "LocalLocationListInputPageInputLimit": { "type": "number", "description": "The number of results per page. Maximum is 50.", "default": 25 }, "LocalLocationListActionResult": { "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/definitions/LocalLocationObject" } } }, "required": [ "locations" ], "additionalProperties": false, "examples": [ { "locations": [ { "id": 4, "level": "local-lite", "status": "active", "account_id": 1, "auto_sync_enabled": true, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "store_code": "", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": [ "tutoring", "online tutoring", "test preparation", "academic tutoring" ], "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": false, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "reopen_date": "0000-00-00", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": { "kitchen hours": { "monday": [ "09:00-21:00" ] } }, "opening_hours_notes": "", "opening_date": "0000-00-00", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "" } ] } ] }, "LocalLocationListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationListActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationListActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "List all locations.", "default": "List Locations" }, "LocalLocationListingListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationListingListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationListingListActionData": { "type": "object", "properties": { "id": { "$ref": "#/definitions/LocationId" } }, "required": [ "id" ], "additionalProperties": false, "examples": [ { "id": 12345 } ] }, "LocalLocationListingListActionResult": { "type": "object", "properties": { "listings": { "type": "array", "items": { "$ref": "#/definitions/LocalLocationListingObject" } } }, "required": [ "listings" ], "additionalProperties": false, "examples": [ { "listings": [ { "name": "gmb", "status": "synced", "url": "https://maps.google.com/maps?cid=123123123321321321" }, { "name": "facebook", "status": "synced", "url": "https://www.facebook.com/2341234324234" }, { "name": "bing", "status": "submitted", "url": null } ] } ] }, "LocalLocationListingObject": { "type": "object", "properties": { "name": { "$ref": "#/definitions/ListingName" }, "status": { "$ref": "#/definitions/ListingStatus" }, "url": { "$ref": "#/definitions/ListingUrl" } }, "required": [ "name", "status", "url" ], "additionalProperties": false, "description": "A location listing object." }, "ListingName": { "type": "string", "description": "The listing name (network)." }, "ListingStatus": { "type": "string", "enum": [ "synced", "submitted", "not_synced", "network_limitation", "error", "processing" ], "description": "The status of the listing." }, "ListingUrl": { "type": [ "string", "null" ], "description": "The URL of the listing." }, "LocalLocationListingListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationListingListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationListingListActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationListingListActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationListingListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns a list of listings for a given location. A listing is a publication of a location on a given network.", "enterprise_only": true, "default": "Fetch Location Listings" }, "LocalLocationLocalGridHistoryFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationLocalGridHistoryFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationLocalGridHistoryFetchActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" }, "keyword": { "$ref": "#/definitions/LocalGridKeyword", "description": "The Local Grid keyword to fetch grid ranks for." }, "device": { "$ref": "#/definitions/LocalGridDevice", "description": "The device to perform the query for." }, "engine": { "$ref": "#/definitions/LocalGridEngine", "description": "The engine for the query." }, "date_start": { "$ref": "#/definitions/LocalGridDateStart" }, "date_end": { "$ref": "#/definitions/LocalGridDateEnd" } }, "required": [ "location_id", "keyword", "device", "engine", "date_start", "date_end" ], "additionalProperties": false, "examples": [ { "location_id": 12345, "keyword": "tutoring", "device": "mobile", "engine": "google", "date_start": "2026-01-01", "date_end": "2026-04-01" } ] }, "LocalGridKeyword": { "type": "string", "description": "The Local Grid keyword the grid ranks are for." }, "LocalGridDevice": { "type": "string", "enum": [ "desktop", "mobile" ], "description": "The device to perform the query for." }, "LocalGridEngine": { "type": "string", "const": "google", "description": "The engine for the query." }, "LocalGridDateStart": { "type": "string", "description": "Inclusive range start, `YYYY-MM-DD`." }, "LocalGridDateEnd": { "type": "string", "description": "Inclusive range end, `YYYY-MM-DD`. Date range may not exceed 12 months." }, "LocalLocationLocalGridHistoryFetchActionResult": { "type": "object", "properties": { "local_grid_history": { "$ref": "#/definitions/LocalGridHistoryObject" } }, "required": [ "local_grid_history" ], "additionalProperties": false, "examples": [ { "local_grid_history": { "location_id": 12345, "date_start": "2026-01-01", "date_end": "2026-04-01", "keyword": "tutoring", "device": "mobile", "engine": "google", "grids": [ { "grid_size": 3, "grid_distance": 1, "grid_distance_unit": "miles", "formatted_grid_distance": "1 miles", "date": "2026-02-12", "dots": [ { "row": -1, "column": -1, "lat": 40.01, "long": -74.01, "rank": 1, "rating": 4.8, "votes_count": 25 }, { "row": -1, "column": 0, "lat": 40.01, "long": -74, "rank": 1, "rating": 4.8, "votes_count": 25 }, { "row": -1, "column": 1, "lat": 40.01, "long": -73.99, "rank": 2, "rating": 4.8, "votes_count": 25 }, { "row": 0, "column": -1, "lat": 40, "long": -74.01, "rank": 1, "rating": 4.8, "votes_count": 25 }, { "row": 0, "column": 0, "lat": 40, "long": -74, "rank": 1, "rating": 4.8, "votes_count": 25 }, { "row": 0, "column": 1, "lat": 40, "long": -73.99, "rank": 1, "rating": 4.8, "votes_count": 25 }, { "row": 1, "column": -1, "lat": 39.99, "long": -74.01, "rank": 2, "rating": 4.8, "votes_count": 25 }, { "row": 1, "column": 0, "lat": 39.99, "long": -74, "rank": 1, "rating": 4.8, "votes_count": 25 }, { "row": 1, "column": 1, "lat": 39.99, "long": -73.99, "rank": 1, "rating": 4.8, "votes_count": 25 } ] } ] } } ] }, "LocalGridHistoryObject": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId", "description": "Echo of the requested location id." }, "date_start": { "$ref": "#/definitions/LocalGridDate", "description": "Echo of the requested inclusive range start, `YYYY-MM-DD`." }, "date_end": { "$ref": "#/definitions/LocalGridDate", "description": "Echo of the requested inclusive range end, `YYYY-MM-DD`." }, "keyword": { "$ref": "#/definitions/LocalGridKeyword", "description": "Echo of the requested keyword." }, "device": { "$ref": "#/definitions/LocalGridDevice", "description": "The device to perform the query for." }, "engine": { "$ref": "#/definitions/LocalGridEngine", "description": "The engine for the query." }, "grids": { "type": "array", "items": { "$ref": "#/definitions/LocalGridHistoryGridObject" }, "description": "Grid results ordered oldest to newest by their date." } }, "required": [ "location_id", "date_start", "date_end", "keyword", "device", "engine", "grids" ], "additionalProperties": false, "description": "Local Grid history for a location, keyword, engine, and device over a date range. Echoes back the requested location, range, keyword, device, and engine and carries the per-search-date grids." }, "LocalGridDate": { "type": "string", "description": "A calendar date in `YYYY-MM-DD` format." }, "LocalGridHistoryGridObject": { "type": "object", "properties": { "grid_size": { "$ref": "#/definitions/LocalGridSize" }, "grid_distance": { "$ref": "#/definitions/LocalGridDistance" }, "grid_distance_unit": { "$ref": "#/definitions/LocalGridDistanceUnit" }, "formatted_grid_distance": { "$ref": "#/definitions/LocalGridFormattedDistance" }, "date": { "$ref": "#/definitions/LocalGridDate", "description": "The search date in `YYYY-MM-DD` format." }, "dots": { "type": "array", "items": { "$ref": "#/definitions/LocalGridHistoryDotObject" }, "description": "One entry per dot in the grid." } }, "required": [ "grid_size", "grid_distance", "grid_distance_unit", "formatted_grid_distance", "date", "dots" ], "additionalProperties": false, "description": "A single LocalGrid result (one search date) with all of its dots. Grid settings are carried per grid because they can change over time if the LocalGrid configuration is adjusted." }, "LocalGridSize": { "type": "number", "description": "Number of dots per side of the grid (e.g. `5` for a 5x5 grid)." }, "LocalGridDistance": { "type": "number", "description": "Distance between adjacent dots in the grid." }, "LocalGridDistanceUnit": { "type": "string", "description": "Unit for the grid distance (e.g. \"miles\", \"meters\")." }, "LocalGridFormattedDistance": { "type": "string", "description": "Human-readable grid distance (e.g. \"1 miles\")." }, "LocalGridHistoryDotObject": { "type": "object", "properties": { "row": { "$ref": "#/definitions/LocalGridDotRow" }, "column": { "$ref": "#/definitions/LocalGridDotColumn" }, "lat": { "$ref": "#/definitions/LocalGridDotLat" }, "long": { "$ref": "#/definitions/LocalGridDotLong" }, "rank": { "$ref": "#/definitions/LocalGridDotRank" }, "rating": { "$ref": "#/definitions/LocalGridDotRating" }, "votes_count": { "$ref": "#/definitions/LocalGridDotVotesCount" } }, "required": [ "row", "column", "lat", "long", "rank", "rating", "votes_count" ], "additionalProperties": false, "description": "A single dot of a LocalGrid result." }, "LocalGridDotRow": { "type": "number", "description": "Grid row offset from the center dot at (0, 0). Negative is north of center." }, "LocalGridDotColumn": { "type": "number", "description": "Grid column offset from the center dot at (0, 0). Negative is west of center." }, "LocalGridDotLat": { "type": "number", "description": "Latitude of a grid dot." }, "LocalGridDotLong": { "type": "number", "description": "Longitude of a grid dot." }, "LocalGridDotRank": { "type": [ "number", "null" ], "description": "The location's rank at the dot, clamped to 1-100. `null` when no rank could be determined for the dot." }, "LocalGridDotRating": { "type": [ "number", "null" ], "description": "The location's star rating observed at the dot. `null` when no rating was available." }, "LocalGridDotVotesCount": { "type": [ "number", "null" ], "description": "Review count backing the rating at the dot. `null` when not available." }, "LocalLocationLocalGridHistoryFetchActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationLocalGridHistoryFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationLocalGridHistoryFetchActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationLocalGridHistoryFetchActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationLocalGridHistoryFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns all Local Grid results over time for a given keyword, device, engine, and location, including every dot of each grid. Grids are returned ordered oldest to newest by their search date.", "enterprise_only": true, "default": "Fetch Local Grid History" }, "LocalLocationLocalGridKeywordListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationLocalGridKeywordListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationLocalGridKeywordListActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" } }, "required": [ "location_id" ], "additionalProperties": false, "examples": [ { "location_id": 12345 } ] }, "LocalLocationLocalGridKeywordListActionResult": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "$ref": "#/definitions/LocalGridKeyword" }, "description": "Available Local Grid keywords." } }, "required": [ "keywords" ], "additionalProperties": false, "examples": [ { "keywords": [ "tutoring", "tutoring near me" ] } ] }, "LocalLocationLocalGridKeywordListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationLocalGridKeywordListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationLocalGridKeywordListActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationLocalGridKeywordListActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationLocalGridKeywordListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns the keywords available to generate a Local Grid report on for a given location. A Local Grid report shows how a location ranks for a keyword across a geographic grid of search points.", "enterprise_only": true, "default": "Fetch Local Grid Keywords" }, "LocalLocationLookupActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationLookupActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationLookupActionData": { "type": "object", "properties": { "id": { "$ref": "#/definitions/LocationId" } }, "required": [ "id" ], "additionalProperties": false, "examples": [ { "id": 123 } ] }, "LocalLocationLookupActionResult": { "type": "object", "properties": { "location": { "$ref": "#/definitions/LocalLocationObject" } }, "required": [ "location" ], "additionalProperties": false, "examples": [ { "location": { "id": 12345, "level": "local-lite", "status": "active", "account_id": 123, "auto_sync_enabled": 1, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "timezone": "America/New_York", "store_code": "", "tagline": "Your neighborhood business", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": [ "tutoring", "online tutoring", "test preparation", "academic tutoring" ], "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": 0, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "reopen_date": "0000-00-00", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": {}, "opening_hours_notes": "", "opening_date": "0000-00-00", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "" } } ] }, "LocalLocationLookupActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationLookupAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationLookupActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationLookupActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationLookupActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Lookup a specific location by ID.", "default": "Lookup Location" }, "LocalLocationNetworkFieldIssueListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationNetworkFieldIssueListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationNetworkFieldIssueListActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" } }, "required": [ "location_id" ], "additionalProperties": false, "examples": [ { "location_id": 12345 } ] }, "LocalLocationNetworkFieldIssueListActionResult": { "type": "object", "properties": { "field_issues": { "type": "array", "items": { "$ref": "#/definitions/LocalNetworkFieldIssueObject" } } }, "required": [ "field_issues" ], "additionalProperties": false, "examples": [ { "field_issues": [ { "location_id": 12345, "network_type": "google_my_business", "network_name": "Google My Business", "field_name": "Address" } ] } ] }, "LocalNetworkFieldIssueObject": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" }, "network_type": { "$ref": "#/definitions/LocalNetworkType", "description": "The network type. Matches the type values used by LocalLocationNetworkList." }, "network_name": { "$ref": "#/definitions/LocalNetworkFieldIssueNetworkName" }, "field_name": { "$ref": "#/definitions/LocalNetworkFieldName" } }, "required": [ "location_id", "network_type", "network_name", "field_name" ], "additionalProperties": false, "description": "A single field-level discrepancy issue for a location across a network. Returned by LocalLocationNetworkFieldIssueList. One record per unique field + network combination. Deduplicated by the action before returning." }, "LocalNetworkType": { "type": "string", "enum": [ "facebook", "twitter", "instagram", "google_my_business", "google_pages", "linkedin" ], "description": "The type of the network" }, "LocalNetworkFieldIssueNetworkName": { "type": "string", "description": "Plain text display name of a network (e.g. \"Google My Business\", \"Apple Maps\")." }, "LocalNetworkFieldName": { "type": "string", "description": "In-app display name for a tracked listing field (e.g. \"Listings Name\", \"Address\", \"Phone\")." }, "LocalLocationNetworkFieldIssueListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationNetworkFieldIssueListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationNetworkFieldIssueListActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationNetworkFieldIssueListActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationNetworkFieldIssueListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns field-level discrepancy issues for a given location. Each item describes one field + network combination where the stored value differs from what is live on the network. Deduplicated by field + network.", "enterprise_only": true, "default": "Fetch Network Field Issues" }, "LocalLocationNetworkFieldStatusListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationNetworkFieldStatusListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationNetworkFieldStatusListActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" } }, "required": [ "location_id" ], "additionalProperties": false, "examples": [ { "location_id": 12345 } ] }, "LocalLocationNetworkFieldStatusListActionResult": { "type": "object", "properties": { "field_statuses": { "type": "array", "items": { "$ref": "#/definitions/LocalNetworkFieldStatusObject" } } }, "required": [ "field_statuses" ], "additionalProperties": false, "examples": [ { "field_statuses": [ { "field_name": "name", "networks_with_field": 5, "healthy_networks": 3, "pending_issues": 2, "solved_issues": 10, "dismissed_issues": 1 } ] } ] }, "LocalNetworkFieldStatusObject": { "type": "object", "properties": { "field_name": { "$ref": "#/definitions/LocalNetworkFieldName", "description": "In-app display name for a tracked listing field (e.g. \"Listings Name\", \"Address\", \"Phone\")." }, "networks_with_field": { "$ref": "#/definitions/LocalNetworkNetworksWithFieldCount" }, "healthy_networks": { "$ref": "#/definitions/LocalNetworkHealthyNetworksCount" }, "pending_issues": { "$ref": "#/definitions/LocalNetworkPendingIssuesCount" }, "solved_issues": { "$ref": "#/definitions/LocalNetworkSolvedIssuesCount" }, "dismissed_issues": { "$ref": "#/definitions/LocalNetworkDismissedIssuesCount" } }, "required": [ "field_name", "networks_with_field", "healthy_networks", "pending_issues", "solved_issues", "dismissed_issues" ], "additionalProperties": false, "description": "Field-level listing health data for a single location.\n\nEach object covers one tracked field and its health across networks. All issue counts are lifetime-to-date totals \u2014 this query accepts no date range, so nothing here is scoped to a rolling window." }, "LocalNetworkNetworksWithFieldCount": { "type": "number", "description": "Number of networks currently monitoring this field for the location." }, "LocalNetworkHealthyNetworksCount": { "type": "number", "description": "Networks monitoring this field that have no pending discrepancies." }, "LocalNetworkPendingIssuesCount": { "type": "number", "description": "Lifetime-to-date count of currently unresolved discrepancies for this field." }, "LocalNetworkSolvedIssuesCount": { "type": "number", "description": "Lifetime-to-date count of solved discrepancies for this field." }, "LocalNetworkDismissedIssuesCount": { "type": "number", "description": "Lifetime-to-date count of dismissed discrepancies for this field." }, "LocalLocationNetworkFieldStatusListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationNetworkFieldStatusListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationNetworkFieldStatusListActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationNetworkFieldStatusListActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationNetworkFieldStatusListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns field-level listing health data for a given location. Each item describes one tracked field with counts of networks monitoring it, healthy networks, and pending/solved/dismissed discrepancies.", "enterprise_only": true, "default": "Fetch Network Field Status" }, "LocalLocationNetworkListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationNetworkListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationNetworkListActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" } }, "required": [ "location_id" ], "additionalProperties": false, "examples": [ { "location_id": 12345 } ] }, "LocalLocationNetworkListActionResult": { "type": "object", "properties": { "networks": { "type": "array", "items": { "$ref": "#/definitions/LocalNetworkObject" } } }, "required": [ "networks" ], "additionalProperties": false, "examples": [ { "networks": [ { "id": 1234566788, "remote_network_id": "12345", "name": "Example Google Page", "type": "google_pages", "picture": null, "error": null, "profile_url": "https://maps.google.com/maps?cid=12345" }, { "id": 1234566789, "remote_network_id": "54321", "name": "Example Facebook Page", "type": "facebook", "picture": null, "error": null, "profile_url": "https://meta.com/pages?cid=12345" } ] } ] }, "LocalNetworkObject": { "type": "object", "properties": { "type": { "$ref": "#/definitions/LocalNetworkType" }, "id": { "$ref": "#/definitions/LocalNetworkId" }, "name": { "$ref": "#/definitions/LocalNetworkName" }, "remote_network_id": { "$ref": "#/definitions/LocalNetworkRemoteNetworkId" }, "picture": { "$ref": "#/definitions/LocalNetworkPicture" }, "profile_url": { "$ref": "#/definitions/LocalNetworkProfileUrl" }, "error": { "$ref": "#/definitions/LocalNetworkError" } }, "required": [ "type", "id", "name", "remote_network_id", "picture", "profile_url", "error" ], "additionalProperties": false, "description": "An object representing a network" }, "LocalNetworkId": { "type": "number", "description": "The internal id of the network" }, "LocalNetworkName": { "type": "string", "description": "Name as it appears on the network" }, "LocalNetworkRemoteNetworkId": { "type": "string", "description": "The id of network" }, "LocalNetworkPicture": { "type": [ "string", "null" ], "description": "URL representing the location of a picture for the given network" }, "LocalNetworkProfileUrl": { "type": [ "string", "null" ], "description": "URL representing the location in connected network." }, "LocalNetworkError": { "type": [ "string", "null" ], "description": "If present, a string representation of an error with the connection to the network" }, "LocalLocationNetworkListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationNetworkListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationNetworkListActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationNetworkListActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationNetworkListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns a list of networks for a given location. A network represents an authenticated connection to a third party platform for a given location.", "enterprise_only": true, "default": "Fetch Location Networks" }, "LocalLocationNetworkStatusListActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationNetworkStatusListActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationNetworkStatusListActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" } }, "required": [ "location_id" ], "additionalProperties": false, "examples": [ { "location_id": 12345 } ] }, "LocalLocationNetworkStatusListActionResult": { "type": "object", "properties": { "network_statuses": { "type": "array", "items": { "$ref": "#/definitions/LocalNetworkStatusObject" } } }, "required": [ "network_statuses" ], "additionalProperties": false, "examples": [ { "network_statuses": [ { "network_name": "Google My Business", "network_type": "google_my_business", "monitored_fields": 12, "healthy_fields": 12 }, { "network_name": "Facebook", "network_type": "facebook", "monitored_fields": 12, "healthy_fields": 11 } ] } ] }, "LocalNetworkStatusObject": { "type": "object", "properties": { "network_name": { "$ref": "#/definitions/LocalNetworkName" }, "network_type": { "$ref": "#/definitions/LocalNetworkListingType" }, "monitored_fields": { "$ref": "#/definitions/LocalNetworkMonitoredFields" }, "healthy_fields": { "$ref": "#/definitions/LocalNetworkHealthyFields" } }, "required": [ "network_name", "network_type", "monitored_fields", "healthy_fields" ], "additionalProperties": false, "description": "An object representing the listing-health status of a single network for a location." }, "LocalNetworkListingType": { "type": "string", "enum": [ "google_my_business", "facebook", "apple_maps", "bing", "yelp", "city_squares", "my_local_services", "show_me_local", "network_411" ], "description": "The network a listing-health status is for." }, "LocalNetworkMonitoredFields": { "type": [ "number", "null" ], "description": "Number of fields being monitored for the network." }, "LocalNetworkHealthyFields": { "type": [ "number", "null" ], "description": "Number of monitored fields with no outstanding discrepancies." }, "LocalLocationNetworkStatusListActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationNetworkStatusListAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationNetworkStatusListActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationNetworkStatusListActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationNetworkStatusListActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns a list of statuses per network for a given location. Each status describes one network monitored for the location, including how many fields are monitored, how many are healthy, and the total number of outstanding issues.", "enterprise_only": true, "default": "Fetch Network Status" }, "LocalLocationRankingHistoryFetchActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/ValidAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationRankingHistoryFetchActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationRankingHistoryFetchActionData": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId" }, "date_start": { "$ref": "#/definitions/LocalNetworkInsightDateStart" }, "date_end": { "$ref": "#/definitions/LocalNetworkInsightDateEnd" }, "engine": { "$ref": "#/definitions/LocalLocationRankingEngine", "description": "The engine for the query." }, "device": { "$ref": "#/definitions/LocalLocationRankingDevice", "description": "The device to perform the query for." } }, "required": [ "location_id", "date_start", "date_end", "engine", "device" ], "additionalProperties": false, "examples": [ { "location_id": 12345, "date_start": "2026-01-01", "date_end": "2026-06-01", "engine": "google", "device": "desktop" } ] }, "LocalLocationRankingEngine": { "type": "string", "const": "google", "description": "The engine for the query." }, "LocalLocationRankingDevice": { "type": "string", "enum": [ "desktop", "mobile" ], "description": "The device to perform the query for." }, "LocalLocationRankingHistoryFetchActionResult": { "type": "object", "properties": { "ranking_history": { "$ref": "#/definitions/LocalLocationRankingHistoryObject" } }, "required": [ "ranking_history" ], "additionalProperties": false, "examples": [ { "ranking_history": { "location_id": 12345, "date_start": "2026-01-01", "date_end": "2026-06-01", "engine": "google", "device": "desktop", "ranking_history_reports": [ { "date": "2026-01-01", "ranks": [ { "keyword": "physical therapy near me", "rank": 1 }, { "keyword": "rehabilitation center in {%City}", "rank": null } ] } ] } } ] }, "LocalLocationRankingHistoryObject": { "type": "object", "properties": { "location_id": { "$ref": "#/definitions/LocationId", "description": "Echo of the requested location id." }, "date_start": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "Echo of the requested inclusive range start, `YYYY-MM-DD`." }, "date_end": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "Echo of the requested inclusive range end, `YYYY-MM-DD`." }, "engine": { "$ref": "#/definitions/LocalLocationRankingEngine", "description": "The engine for the query." }, "device": { "$ref": "#/definitions/LocalLocationRankingDevice", "description": "The device to perform the query for." }, "ranking_history_reports": { "type": "array", "items": { "$ref": "#/definitions/LocalLocationRankingHistoryReportObject" }, "description": "Ranking-history buckets ordered oldest to newest." } }, "required": [ "location_id", "date_start", "date_end", "engine", "device", "ranking_history_reports" ], "additionalProperties": false, "description": "Keyword ranking history for a location over a date range. Echoes the requested location and range and carries the per-date reports (oldest to newest)." }, "LocalLocationRankingHistoryReportObject": { "type": "object", "properties": { "date": { "$ref": "#/definitions/LocalNetworkInsightDate", "description": "The bucket date in `YYYY-MM-DD` format." }, "ranks": { "type": "array", "items": { "$ref": "#/definitions/LocalLocationRankingReportRankObject" }, "description": "Best rank per keyword for the bucket." } }, "required": [ "date", "ranks" ], "additionalProperties": false, "description": "A single ranking-history bucket for a location: one date and the best rank per tracked keyword on that date." }, "LocalLocationRankingReportRankObject": { "type": "object", "properties": { "keyword": { "type": "string", "description": "The tracked keyword." }, "rank": { "$ref": "#/definitions/LocalLocationRankingRank", "description": "Best position across Local Pack + Organic; null when not ranking." } }, "required": [ "keyword", "rank" ], "additionalProperties": false, "description": "A single keyword's best ranking position within a date bucket." }, "LocalLocationRankingRank": { "type": [ "number", "null" ], "description": "Best keyword rank position in `1..20`, or `null` when the keyword did not rank in the top 20." }, "LocalLocationRankingHistoryFetchActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationRankingHistoryFetchAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationRankingHistoryFetchActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationRankingHistoryFetchActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationRankingHistoryFetchActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Returns keyword ranking position over time for a location's tracked keywords.", "enterprise_only": true, "default": "Fetch Ranking History" }, "LocalLocationUpdateActionPayload": { "type": "object", "properties": { "auth": { "$ref": "#/definitions/TokenIdAuthPayload" }, "data": { "$ref": "#/definitions/LocalLocationUpdateActionData" }, "guid": { "type": "string" } }, "required": [ "auth", "data", "guid" ], "additionalProperties": false }, "LocalLocationUpdateActionData": { "type": "object", "properties": { "location": { "$ref": "#/definitions/LocalLocationUpdateObject" } }, "required": [ "location" ], "additionalProperties": false, "examples": [ { "location": { "auto_sync_enabled": true, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "store_code": "", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": "tutoring,online tutoring,test preparation,academic tutoring", "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": false, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "reopen_date": "0000-00-00", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": { "kitchen hours": { "monday": [ "09:00-21:00" ] } }, "opening_hours_notes": "", "opening_date": "0000-00-00", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "", "create_page": true, "published": false } } ] }, "LocalLocationUpdateObject": { "type": "object", "properties": { "id": { "$ref": "#/definitions/LocationId" }, "auto_sync_enabled": { "$ref": "#/definitions/LocationAutoSyncEnabled" }, "remote_id": { "$ref": "#/definitions/LocationRemoteId" }, "listings_name": { "$ref": "#/definitions/LocationListingsName" }, "location_name": { "$ref": "#/definitions/LocationLocationName" }, "website_url": { "$ref": "#/definitions/LocationWebsiteUrl" }, "email_address": { "$ref": "#/definitions/LocationEmailAddress" }, "timezone": { "$ref": "#/definitions/LocationTimezone" }, "store_code": { "$ref": "#/definitions/LocationStoreCode" }, "tagline": { "$ref": "#/definitions/LocationTagline" }, "short_description": { "$ref": "#/definitions/LocationShortDescription" }, "long_description": { "$ref": "#/definitions/LocationLongDescription" }, "languages": { "$ref": "#/definitions/LocationLanguages" }, "keywords": { "$ref": "#/definitions/LocationKeywords" }, "brands": { "$ref": "#/definitions/LocationBrands" }, "payment_forms": { "$ref": "#/definitions/LocationPaymentForm" }, "price_range": { "$ref": "#/definitions/LocationPriceRange" }, "service_areas": { "$ref": "#/definitions/LocationServiceAreas" }, "service_area_only": { "$ref": "#/definitions/LocationServiceAreaOnly" }, "services": { "$ref": "#/definitions/LocationServices" }, "primary_category": { "$ref": "#/definitions/LocationPrimaryCategory" }, "additional_categories": { "$ref": "#/definitions/LocationAdditionalCategories" }, "attributes": { "$ref": "#/definitions/LocationAttributes" }, "address": { "$ref": "#/definitions/LocationAddress" }, "lat": { "$ref": "#/definitions/LocalLocationLatitude" }, "long": { "$ref": "#/definitions/LocalLocationLongitude" }, "opening_status": { "$ref": "#/definitions/LocationOpeningStatus" }, "reopen_date": { "$ref": "#/definitions/LocationReopenDate" }, "hours": { "$ref": "#/definitions/LocationOpeningHours" }, "opening_hours_notes": { "$ref": "#/definitions/LocationOpeningHoursNotes" }, "opening_date": { "$ref": "#/definitions/LocationOpeningDate" }, "special_hours": { "$ref": "#/definitions/LocationSpecialHours" }, "phone": { "$ref": "#/definitions/LocationPhone" }, "fax": { "$ref": "#/definitions/LocationFax" }, "create_pages": { "$ref": "#/definitions/LocationCreatePages" }, "published": { "$ref": "#/definitions/LocationPublished" } }, "required": [ "id" ], "additionalProperties": false, "description": "A payload to update one or more fields for a location." }, "LocalLocationUpdateActionResult": { "type": "object", "properties": { "location": { "$ref": "#/definitions/LocalLocationObject" } }, "required": [ "location" ], "additionalProperties": false, "examples": [ { "location": { "id": 12345, "level": "local-lite", "status": "active", "account_id": 123, "auto_sync_enabled": 1, "remote_id": "ExampleBusiness", "listings_name": "Example Business", "location_name": "Example Business", "website_url": "https://www.example-business.com", "email_address": "info@example-business.com", "timezone": "America/New_York", "store_code": "", "tagline": "Your neighborhood business", "short_description": "Doing things since 1986.", "long_description": "Really long descriptions.", "languages": [], "keywords": [ "tutoring", "online tutoring", "test preparation", "academic tutoring" ], "brands": [ "example" ], "payment_forms": [], "price_range": "omit", "service_areas": [], "service_area_only": 0, "services": [], "primary_category": "gcid:educational_consultant", "additional_categories": [ "gcid:tutoring_service", "gcid:private_tutor" ], "attributes": [], "address": { "address_line_1": "1234 Astroworld Ave", "address_line_2": "Suite 306", "sublocality": "", "county": "Roswell", "city": "Schenectady", "state_province": "NY", "postal_code": "12345", "country": "US" }, "opening_status": "open", "reopen_date": "0000-00-00", "hours": { "monday": [ "09:00-21:00" ], "tuesday": [ "09:00-21:00" ], "wednesday": [ "09:00-21:00" ], "thursday": [ "09:00-21:00" ], "friday": [ "09:00-21:00" ], "saturday": [ "09:00-21:00" ], "sunday": [ "09:00-21:00" ] }, "more_hours": {}, "opening_hours_notes": "", "opening_date": "0000-00-00", "special_hours": { "2025-08-04": [ "04:00-02:30" ], "2025-08-05": [ "04:00-02:30" ], "2025-08-06": [ "04:00-02:30" ] }, "network_fields": [], "phone": "+1 561-395-5555", "fax": "" } } ] }, "LocalLocationUpdateActionQuota": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "const": "free" } }, "required": [ "type" ], "description": "Does not require any quota." }, "LocalLocationUpdateAction": { "type": "object", "properties": { "payload": { "$ref": "#/definitions/LocalLocationUpdateActionPayload" }, "result": { "$ref": "#/definitions/LocalLocationUpdateActionResult" }, "quota": { "$ref": "#/definitions/LocalLocationUpdateActionQuota" } }, "required": [ "payload", "result", "quota" ], "additionalProperties": false, "description": "Update a single location.", "enterprise_only": true, "default": "Update Location" } } }