Skip to content

SeoSerpRequest.md

Latest commit

 

History

History
51 lines (42 loc) · 3.88 KB

SeoSerpRequest.md

File metadata and controls

51 lines (42 loc) · 3.88 KB
Raw

SeoSerpRequest

Properties

Name Type Description Notes
query str Search query to inspect.
target str Optional domain or URL to mark in the results, such as example.com or https://example.com/page. [optional]
location SeoSerpLocation [optional]
language str Search language as an ISO code or full language name. Defaults to en. [optional]
device str SERP device type. Defaults to desktop. [optional]
os SeoSerpOs [optional]
page int 1-based Google result page to start from. Defaults to 1. Implemented with Google's start parameter and ranks are adjusted to global SERP positions. [optional]
depth int Organic result depth to crawl from the requested page. Defaults to 10. DataForSEO bills source in 10-result pages; UnifAPI bills returned billable organic records. [optional]
limit int Number of organic results to return, matching the limit parameter used across other UnifAPI endpoints. Maps to DataForSEO depth and is used only when depth is omitted; defaults to 10. [optional]
view SeoSerpView [optional]
include_ai_overview bool When true, ask DataForSEO to load asynchronous Google AI Overview blocks in the organic SERP when available. This can add source cost. [optional]
people_also_ask_depth int Optional click depth for People Also Ask expansion. Useful for SEO content-gap research and can add source cost. [optional]
include_pixel_rankings bool When true, request pixel rectangle data for above-the-fold and visual rank analysis. This can add source cost. [optional]
viewport SeoSerpViewport [optional]
google_domain str Optional Google domain override such as google.co.uk or google.de. [optional]
google_search_params str Advanced Google search URL parameters such as nfpr=1. Prefer typed fields like page and include_omitted_results when available. [optional]
include_omitted_results bool When true, adds filter=0 to inspect Google results that may otherwise be omitted. Useful for deep rank checks. [optional]
remove_url_params List[str] URL query parameters to remove from result URLs before matching, such as srsltid. [optional]
expand_related_results bool When true, return related/sitelink-style organic results as separate organic elements instead of nesting them. [optional]
stop_at_target bool When true and target is provided, stop crawling once the target is found. Useful for cheaper deep-rank checks, but later competitors may be omitted. [optional]
target_match SeoSerpTargetMatch [optional]
target_search_mode SeoSerpTargetSearchMode [optional]
target_element_types List[SeoSerpTargetElementType] SERP element types to inspect for stop_at_target matches. Defaults to all first-level URL/domain elements. [optional]

Example

from unifapi.models.seo_serp_request import SeoSerpRequest

# TODO update the JSON string below
json = "{}"
# create an instance of SeoSerpRequest from a JSON string
seo_serp_request_instance = SeoSerpRequest.from_json(json)
# print the JSON string representation of the object
print(SeoSerpRequest.to_json())

# convert the object into a dict
seo_serp_request_dict = seo_serp_request_instance.to_dict()
# create an instance of SeoSerpRequest from a dict
seo_serp_request_from_dict = SeoSerpRequest.from_dict(seo_serp_request_dict)

[Back to Model list] [Back to API list] [Back to README]