Google Ranked Keywords Live

{
  "$defs": {
    "DataforseoLabsGoogleRankedKeywordsLiveRequestInfo": {
      "properties": {
        "filters": {
          "anyOf": [
            {
              "description": "array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_likeyou can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more charactersexample:[\"ranked_serp_element.serp_item.rank_",
              "items": {
                "anyOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "historical_serp_mode": {
          "anyOf": [
            {
              "description": "data collection modeoptional fieldyou can use this field to filter the results;possible types of filtering:live — return keywords for which the specified target currently has ranking results in SERP;lost — return keywords for which the specified target had previously had ranking results in SERP, but didn't have them during the last check;all — return both types of keywords.default value: live",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "ignore_synonyms": {
          "anyOf": [
            {
              "description": "ignore highly similar keywordsoptional fieldif set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "include_clickstream_data": {
          "anyOf": [
            {
              "description": "include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, clickstream_gender_distribution, clickstream_age_distribution, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculat",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "item_types": {
          "anyOf": [
            {
              "description": "display results by item typeoptional fieldindicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\", \"ai_overview_reference\"]default value: [\"organic\", \"paid\"]",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "language_code": {
          "anyOf": [
            {
              "description": "language codeoptional fieldif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code by making a separate request to the this field to get the results for all available languagesexample:en",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "language_name": {
          "anyOf": [
            {
              "description": "full name of the languageoptional fieldif you use this field, you don't need to specify language_codeyou can receive the list of available languages with their language_name by making a separate request to the this field to get the results for all available languagesexample:English",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "limit": {
          "anyOf": [
            {
              "description": "the maximum number of returned keywordsoptional fielddefault value: 100maximum value: 1000",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "load_rank_absolute": {
          "anyOf": [
            {
              "description": "return rankings distribution by rank_absoluteoptional fielddefault value: falseif set to true, we will return the field metrics_absolute containing rankings distribution by the rank_absolute parameter that indicates the result’s position among all SERP elements",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "location_code": {
          "anyOf": [
            {
              "description": "location codeoptional fieldif you use this field, you don't need to specify location_nameyou can receive the list of available locations with their location_code by making a separate request to the this field to get the results for all available locationsexample:2840",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "location_name": {
          "anyOf": [
            {
              "description": "full name of the locationoptional fieldif you use this field, you don't need to specify location_codeyou can receive the list of available locations with their location_name by making a separate request to the this field to get the results for all available locationsexample:United Kingdom",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "offset": {
          "anyOf": [
            {
              "description": "offset in the results array of returned keywordsoptional fielddefault value: 0if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "order_by": {
          "anyOf": [
            {
              "description": "results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderyou should use a comma to set up a sorting typeexample:[\"keyword_data.keyword_info.competition,desc\"]default rule:[\"ranked_serp_element.serp_item.rank_group,asc\"]note that you can set no more than three sorting rules in a single requestyou should use a comma to separ",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "tag": {
          "anyOf": [
            {
              "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "target": {
          "description": "domain name or page urlrequired fieldthe domain name of the target website, subdomain or URL of the target webpage;the domain name must be specified without or www.;the subdomain must be specified without webpage URL must be specified with or www.Note: if you specify the webpage URL without or www., the result will be returned for the entire domain rather than the specific page",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/DataforseoLabsGoogleRankedKeywordsLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}