The Response Object in detail¶
The response is a complex json object.
You will find 2 main sections, the request section containing a copy of the SERPs sent request and the response section containing Structured Keyword Rankings results parsed from the SERPs page.
The response section itself is divided into two sub sections, the summary section and the results section.
The summary is divided into two sub sections the global section showing an aggregated count of the different search results found and the total number of results reported by the search engine and the pages section containing a page by page breakdown of the different search results found.
The Response¶
{
"request": {
...
},
"ready": true,
"jid": "7338aa04-d750-43c6-a3fc-e2762e16e503",
"response": {
"results": {
"video": {},
"organic": {
...
},
"universal": {
"1": {
"rich_snippets": [
],
"description": "How good is your SEO? enter your domain below to find out ... Domain ... Get this for your site! Want to offer free SEO audits to your users? Get in touch.",
"url": "http:\/\/howgoodisyourseo.com\/",
"title": "How good is your SEO?",
"type": "organic",
"page_number": 1,
"top_left": "150,176",
"bottom_right": "782,328"
},
...
},
"image": {},
"news": {},
"place": {}
},
"summary": {
"global": {
"video": 0,
"organic": 10,
"total": 42200000,
"image": 0,
"news": 0,
"place": 0
},
"pages": {
"1": {
"video": 0,
"organic": 10,
"image": 0,
"news": 0,
"place": 0
},
...
}
}
}
}
Response Codes¶
Code | Name | Description |
---|---|---|
200 | OK | We found the jid and returned available data |
404 | Not Found | The jid does not exist or has already expired |
Note
The parsed results expire after 24 hours, so if you do not fetch your data in time it will be deleted and you have to repeat the request.
The Response Object¶
Field | Type | Description | Notes |
---|---|---|---|
jid | string | the unique identifier for your job (job id) | |
ready | boolean | if false then the job is still being processed | |
request | object | contains a copy of your request | |
error | string | contains an error message | only present if there is an error |
response | object | when ready it will contain the processed SERPs page results | see the response structure section |
The response field named response will contain the parsed SERPs results.
The Response Structure¶
{
"response": {
"results": {
"video": {},
"organic":{
.....
},
"universal": {
"1": {
"rich_snippets": [
],
"description": "How good is your SEO? enter your domain below to find out ... Domain ... Get this for your site! Want to offer free SEO audits to your users? Get in touch.",
"url": "http:\/\/howgoodisyourseo.com\/",
"title": "How good is your SEO?",
"type": "organic",
"page_number": 1,
"top_left": "150,176",
"bottom_right": "782,328"
},
......
},
"news": {},
"image": {},
"place": {}
},
"summary": {
"global": {
"video": 0,
"organic": 10,
"total": 42200000,
"image": 0,
"news": 0,
"place": 0
},
"pages": {
"1": {
"video": 0,
"news": 0,
"image": 0,
"place": 0,
"organic": 10
}
}
}
}
}
The response object has two main elements results and summary.
Summary Object¶
The summary object contains two objects the global and the pages.
The global shows an aggregated count of the different search results found and the total number of results reported by the search engine.
The total field of the global summary contains the total number of search results the selected search engine has, not the number of returned elements.
Example Global Summary Object
"global": {
"video": 0,
"organic": 10,
"total": 42200000,
"image": 0,
"news": 0,
"place": 0
}
The pages object contains a breakdown of the search results per page. It has a similar structure to the global object but with the page number as key.
Example Page Summary Object
"pages": {
"1": {
"video": 0,
"news": 0,
"image": 0,
"place": 0,
"organic": 10
},
"2": {
"video": 0,
"news": 3,
"image": 0,
"place": 0,
"organic": 9
}
}
Attention
Not all search results are supported in all search engines, if a specific search result is not supported its summary count will have 0 as value.
Results Object¶
The results element contains structured information about the search results entries found grouped by type.
The special type Universal contains all "organic" elements, if include_all_in_universal option is set then it also includes paid elements.
The special type Paid contains all "paid" elements (e.g. advertisements or shopping list results).
Each results entry is structured with the position (ranking) as key and the search result parsed information as value.
So each Search Result type will have a structure similar to the one presented below:
"universal": {
<RANKING> : <SEARCH RESULT OBJECT>
}
Types of Search Results:¶
- class SearchResult¶
Represent a generic search result item
Search Result Object
Field Type Description Notes Type string the type of search result can be for example organic, image, video, etc title string the item title url string the url of the item page_number integer the page number where the item was found rich_snippets array an array of rich snippets objects see the Rich Snippet section markup integer the version of the markup parsed the same search result might be presented in different ways by the same search engine, this number represents our internal version of the parser used top_left string the result's top left corner coordinates (pixels) bottom_right string the result's bottom right corner coordinates (pixels) visible boolean is the result visible on the page all results apart from those requiring scrolling in a carousel are visible above_the_fold boolean is the result immediately visible on page load this will be true for results that do not require any scrolling to view Example Search Result
"1": { "markup": 0, "url": "http:\/\/www.analyticsseo.com\/", "rich_snippets": [ { "type": "site_links", "links": [ { "description": "Considering a new career? Come and join a passionate, talented ...", "url": "http:\/\/www.analyticsseo.com\/jobs\/", "title": "Jobs" }, { "description": "FREE accounts available! Our SEO Software & Online ...", "url": "http:\/\/www.analyticsseo.com\/us\/", "title": "US" }, { "description": "Using the New Analytics SEO Browser Page Load Speed ...", "url": "http:\/\/www.analyticsseo.com\/blog\/", "title": "Blog" }, { "description": "Agencies will benefit from our multi task site ... SEO Software for ...", "url": "http:\/\/www.analyticsseo.com\/seo-software-agencies\/", "title": "SEO Software for Agencies" }, { "description": "Can't find what you need? Larger plans are available for Agencies ...", "url": "http:\/\/www.analyticsseo.com\/sme\/", "title": "SME" }, { "description": "We can help customers research and track keyword rankings in ...", "url": "http:\/\/www.analyticsseo.com\/keyword-research-rankings\/", "title": "Keyword Research & Rankings" } ] } ], "description": "FREE accounts available! Our SEO Software & Online Marketing tools will help you measure any SEO and Social Marketing campaign. Track. Measure. Improve ...", "type": "organic", "title": "Analytics SEO", "page_number": 1, "above_the_fold": true, "bottom_right": "766,251", "top_left": "166,175", "visible": true }
- class ArticleSearchResult¶
Article Search Result
Contains the same fields as the Search Result with the type set to article
Additional Fields
Field Type Description Notes author string Author(s) name date string Article date
- class BuyingGuideSearchResult¶
Buying Guide Search Result
Contains the same fields as the Search Result with the type set to buying_guide
- class DestinationSearchResult¶
Destination Search Result
Top destinations for the search phrase
Only contains the type set to destination
- class DirectAnswerSearchResult¶
Direct Answer Search Result
Contains the same fields as the Search Result with the type set to direct_answer
Additional Fields
Field Type Description Notes sub_type string the type of Direct Answer currency_converter, translation, stock price, dictionary or other header string the title of Direct Answer only filled if title is present in the result
- class DiscoverMorePlacesSearchResult¶
Discover More Places Search Result
Only contains the type set to discover_more_places
Additional Fields
Field Type Description Notes carousel boolean True if result is a carousel
- class DiscussionAndForumSearchResult¶
Discussion And Forum Search Result
Only contains the type set to discussion_and_forum
- class EventFinderSearchResult¶
Event Finder Search Result
Contains the same fields as the Search Result with the type set to event_finder
- class FeaturedSnippetSearchResult¶
Featured Snippet Search Result
Contains the same fields as the Search Result with the type set to featured_snippet
Additional Fields
Field Type Description Notes sub_type string the type of Featured Snippet paragraph, list, table, video header string the title of Featured Snippet only filled if title is present in the result steps object the steps detected on the list featured snippet of sub_type list contains "steps" (ordered list of entries), those are stored here
- class FilterSearchResult¶
Filter Search Result
Contains the same fields as the Search Result with the type set to filter
- class FindResultsOnSearchResult¶
Find Results On Search Result
Contains the same fields as the Search Result with the type set to find_results_on
- class GenerativeSearchResult¶
Generative Search Result
Contains the same fields as the Search Result with the type set to generative
Additional Fields
Field Type Description Notes sub_type string Result type product, product_carousel, place, suggested_query, video or empty for regular result position string Position of result: left or right
- class GenerativeTriggerSearchResult¶
Generative Trigger Search Result
Contains the same fields as the Search Result with the type set to generative_trigger
Additional Fields
Field Type Description Notes content string Generated content sub_type string Type of trigger
- class ImageSearchResult¶
Image Search Result
Contains the same fields as the Search Result with the type set to image.
Additional Fields
Field Type Description Notes position string the result position left or right
- class InterestingFindsSearchResult¶
Interesting Finds Search Result
Contains the same fields as the Search Result with the type set to interesting_finds
- class JobFinderSearchResult¶
Job Finder Search Result
Contains the same fields as the Search Result with the type set to job_finder
Additional Fields
Field Type Description items object job offers filters object job filters
- class KnowledgeGraphSearchResult¶
Knowledge Graph Search Result
Contains the same fields as the Search Result with the type set to knowledge_graph
Additional Fields
Field Type Description Notes entity_url string the optional url to connected resource position string the result position left or right sub_title string the additional sub title sub_type string the type of Knowledge Graph local_business_listing, book, review, sport or other knowledge_graph_id string the Google id of Knowledge Graph other_items object the additional items additional information like address, reviews profiles object the social profiles facebook, twitter, etc. profile urls rating float average rating number_of_reviews int number of reviews
- class LocalServicesSearchResult¶
Local Services Search Result
Contains the same fields as the Search Result with the type set to local_services
Additional Fields
Field Type Description Notes name string the name of service rating float average rating number_of_reviews int number of reviews google_guaranteed boolean True if service is guaranteed by Google location string Service location
- class MapSearchResult¶
Map Search Result
Contains the same fields as the Search Result with the type set to map
Navigation Search Result
Contains the same fields as the Search Result with the type set to navigation
Additional Fields
Field Type Description Notes position string the result position left or right sub_title string the additional sub title menu_labels object the menu labels ad
- class NewsSearchResult¶
News Search Result
Contains the same fields as the Search Result with the type set to news
Additional Fields
Field Type Description Notes amp boolean True if result is an AMP page Is the result an AMP (google accelerated mobile page) carousel boolean True if result is a carousel video boolean True if result is a video
- class OrganicSearchResult¶
Organic Search Result
Contains the same fields as the Search Result with the type set to organic.
Additional Fields
Field Type Description Notes amp boolean True if result is an AMP page Is the result an AMP (google accelerated mobile page) carousel boolean True if result is a carousel faq boolean True if result contains FAQ indented boolean True if result in indented thumbnail boolean True if result contains thumbnail video_thumbnail boolean True if result contains video thumbnail
- class PeopleAlsoAskSearchResult¶
People Also Ask Search Result
Contains the same fields as the Search Result with the type set to people_also_ask
Additional Fields
Field Type Description Notes question string the question answer string the answer
- class PeopleAlsoBuyFromSearchResult¶
People Also Buy From Search Result
Contains the same fields as the Search Result with the type set to people_also_buy_from
Additional Fields
- class PeopleAlsoSearchForSearchResult¶
People Also Search For Search Result
Contains the same fields as the Search Result with the type set to people_also_search_for
Additional Fields
Field Type Description Notes phrases object the phrases people also search for
- class PlaceSearchResult¶
Place Search Result
Contains the same fields as the Search Result with the type set to place
- class PodcastSearchResult¶
Podcast Search Result
Contains the same fields as the Search Result with the type set to podcast
Additional Fields
Field Type Description Notes carousel boolean True if result is a carousel age string the age of podcast length string the length of podcast
- class ProductGridSearchResult¶
Product Grid Search Result
Contains the same fields as the Search Result with the type set to product_grid
Additional Fields
Field Type Description Notes items object the products
- class ProductSiteSearchResult¶
Product Site Search Result
Contains the same fields as the Search Result with the type set to product_site
- class RecipeSearchResult¶
Recipe Search Result
Contains the same fields as the Search Result with the type set to recipe
- class RefineBySearchResult¶
Refine by Search Result
Contains the same fields as the Search Result with the type set to refine_by
Additional Fields
Field Type Description Notes brand boolean true if it's refine by brand result items object the refine by items items like brands, products, product attributes
- class RelatedEntitySearchResult¶
Related Entity Search Result
Contains the same fields as the Search Result with the type set to related_entity
Additional Fields
Field Type Description Notes items object the related search entities
- class RelatedSearchSearchResult¶
Related Search Search Result
Contains the same fields as the Search Result with the type set to related_search
- class ResearchGuideSearchResult¶
Research Guide Search Result
Contains the same fields as the Search Result with the type set to research_guide
Additional Fields
Field Type Description Notes amp boolean True if result is an AMP page Is the result an AMP (google accelerated mobile page) carousel boolean True if result is a carousel
- class ReviewSearchResult¶
Review Search Result
Contains the same fields as the Search Result with the type set to review
Additional Fields
Field Type Description Notes items object the reviews each review is an object containing: name, review, url (all strings)
- class SeeResultsAboutSearchResult¶
See Results About Search Result
Contains the same fields as the Search Result with the type set to see_results_about
- class SocialMediaSearchResult¶
Social Media Search Result
Contains the same fields as the Search Result with the type set to social_media
Additional Fields
Field Type Description Notes sub_type string the type of Knowledge Graph twitter carousel boolean True if result is a carousel video boolean True if result is a video
- class TravelFinderSearchResult¶
Travel Finder Search Result
Only contains the type set to travel_finder
- class VideoSearchResult¶
Video Search Result
Contains the same fields as the Search Result with the type set to video.
- class WatchFilmSearchResult¶
Watch Film Search Result
Contains the same fields as the Search Result with the type set to watch_film
Additional Fields
Attention
Not all search results are supported in all search engines
Types of Paid Search Results:¶
- class AdvertisementSearchResult¶
Advertisement Search Result
Contains the same fields as the Search Result with the type set to ad
Additional Fields
Field Type Description Notes on_top boolean True is result is on top of SERPS On top means that it appears before any other type of search results rating float average rating number_of_reviews int number of reviews site_links array an array of site links phone_number string Note
Some markups might not link directly to a landing site and instead use a redirection link to the ad network, in most cases an "user friendly" landing URL is displayed with the ad and it will be used instead of the ad network URL That "user friendly" URL might not contain the protocol (e.g: www.foo.bar instead of http://www.foo.bar)
- class FlightFinderSearchResult¶
Flight Finder Search Result
Flights for the search phrase
Only contains the type set to flight_finder
- class HotelFinderSearchResult¶
Hotel Finder Search Result
Hotels for the search phrase
Only contains the type set to hotel_finder
Additional Fields
Field Type Description Notes items object hotels list
- class ShoppingItemSearchResult¶
Shopping Search Result
Contains the same fields as the Search Result with the type set to shopping
Additional Fields
Field Type Description Notes merchant string the merchant name rating float the rating value number_of_reviews int number of reviews price string the product price position string the result position left or right info string the additional information shop_for boolean true if it's a Google shopping offer
Attention
Paid results are only supported on google search engine
Types of Rich Snippet:¶
- class SiteLinksRichSnippet¶
Site links Search Result enrichment
Field Type Description Notes type string the type of snippet always set to site_links links array list of links object see the site link table for information about the link object Link Object
Field Type Description url string the link url title string the link title description string the link description example snippet
{ "type": "site_links", "links": [ { "url": "http:\/\/www.anandtech.com\/show\/8526\/nvidia-geforce-gtx-980-review\/2", "description": "", "title": "Our deep dive on the Maxwell ..." }, { "url": "http:\/\/www.anandtech.com\/show\/8526\/nvidia-geforce-gtx-980-review\/22", "description": "", "title": "Overclocking GTX 980" }, { "url": "http:\/\/www.anandtech.com\/show\/8526\/nvidia-geforce-gtx-980-review\/20", "description": "", "title": "Compute" }, { "url": "http:\/\/www.anandtech.com\/show\/8526\/nvidia-geforce-gtx-980-review\/13", "description": "", "title": "Battlefield 4" } ] }
- class BreadcrumbRichSnippet¶
Breadcrumb Search Result enrichment
Field Type Description Notes type string the type of snippet always set to breadcrumb path string the path shown this might not be the full breadcrumb, it is just what the search engine shows Example Snippet
{ "type": "breadcrumb", "path": "www.XXXXXXX.co.uk › View from the pressbox" }
- class MoreResultsRichSnippet¶
More Results Search Result enrichment
Field Type Description Notes type string the type of snippet always set to more_results Example Snippet
{ "type": "more_results", }
- class SearchBoxRichSnippet¶
Search Box Search Result enrichment
Field Type Description Notes type string the type of snippet always set to search_box Example Snippet
{ "type": "search_box", }
- class PersonRichSnippet¶
Search Box Search Result enrichment
Field Type Description Notes type string the type of snippet always set to person location string Main location of person or employer might not always be shown position string Known role might not always be shown Example Snippet
{ "type": "person", "location": "Twickenham, Greater London, United Kingdom", "position": "CEO at Analytics SEO" }
- class RatingRichSnippet¶
Rating Search Result enrichment
Field Type Description Notes type string the type of snippet always set to rating score integer the rating might not always be shown votes integer the number of votes might not always be shown raw string the raw snippet exactly as present in the search result reviewer string the entity making a review might not always be shown date string the date might not always be shown time string the time for example cooking time, might not always be shown price string the price it can also be a price range, might not always be shown guessed_type string the type of rating based on what we can extract we will try to guess the type of item being rated ** guessed_type ** defaults to review, currently product, review and recipe are supported
Example Snippet
{ "guessed_type": "review", "type": "rating", "raw": " Rating: 4.7 - 8 votes", "votes": 8, "score": 4.7 }
Attention
Not all Rich Snippets are supported in all search engines.