Search Live

{
  "$defs": {
    "ContentAnalysisSearchLiveRequestInfo": {
      "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, like,not_like, match, not_matchyou can use the % operator with like and not_like to match any string of zero or more charactersexample:[\"country\",\"=\", \"US\"][[\"domain_rank\",\">\",800],\"and\",[\"content_info.connotation_types.",
              "items": {
                "anyOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "keyword": {
          "description": "target keywordrequired fieldUTF-8 encodingthe keywords will be converted to a lowercase format;Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: `\"keyword\": \"\\\"tesla palo alto\\\"\"`learn more about rules and limitations of keyword and keywords fields in Asale APIs in this Help Center article",
          "type": "string"
        },
        "keyword_fields": {
          "anyOf": [
            {
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "description": "target keyword fields and target keywordsoptional fielduse this parameter to filter the dataset by keywords that certain fields should contain;fields you can specify: title, main_title, previous_title, snippetyou can indicate several fields;Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example:`\"keyword_fields\": {\"snippet\": \"\\\"logitech mouse\\\"\",\"main_title\": \"sale\"}\"`",
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "limit": {
          "anyOf": [
            {
              "description": "the maximum number of returned citationsoptional fielddefault value: 100maximum value: 1000",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "offset": {
          "anyOf": [
            {
              "description": "offset in the results array of returned citationsoptional fielddefault value: 0if you specify the 10 value, the first ten citations in the results array will be omitted and the data will be provided for the successive citationsNote: we recommend using this parameter only when retrieving up to 10,000 resultsfor retrieving over 10,000 results, use the offset_token instead.",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "offset_token": {
          "anyOf": [
            {
              "description": "offset token for subsequent requestsoptional fieldprovided in the identical field of the response to each request;use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be take",
              "type": "string"
            },
            {
              "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:[\"content_info.sentiment_connotations.anger,desc\"]default rule:[\"content_info.sentiment_connotations.anger,desc\"]note that you can set no more than three sorting rules in a single requestyou should use a comma to",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "page_type": {
          "anyOf": [
            {
              "description": "target page typesoptional fielduse this parameter to filter the dataset by page typespossible values: \"ecommerce\", \"news\", \"blogs\", \"message-boards\", \"organization\"",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "rank_scale": {
          "anyOf": [
            {
              "description": "defines the scale used for calculating and displaying the domain_rank, and url_rank valuesoptional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:one_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works in this Help Center article",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "search_mode": {
          "anyOf": [
            {
              "description": "results grouping typeoptional fieldpossible grouping types:as_is - returns all citations for the target keywordone_per_domain - returns one citation of the keyword per domaindefault value: as_is",
              "type": "string"
            },
            {
              "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"
            }
          ]
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/ContentAnalysisSearchLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}