Rating Distribution Live

{
  "$defs": {
    "ContentAnalysisRatingDistributionLiveRequestInfo": {
      "properties": {
        "initial_dataset_filters": {
          "anyOf": [
            {
              "description": "initial dataset filtering parametersoptional fieldinitial filtering parameters that apply to fields in the Search endpointyou 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, has, has_not, match, not_matchyou can use the % operator with like and not_like to match any string of zero or more charactersexample:[\"d",
              "items": {
                "anyOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "internal_list_limit": {
          "anyOf": [
            {
              "description": "maximum number of elements within internal arraysoptional fieldyou can use this field to limit the number of elements within the following arrays:top_domainstext_categoriespage_categoriescountrieslanguagesdefault value: 1maximum value: 20",
              "type": "integer"
            },
            {
              "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"
            }
          ]
        },
        "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"
            }
          ]
        },
        "positive_connotation_threshold": {
          "anyOf": [
            {
              "description": "positive connotation thresholdoptional fieldspecified as the probability index threshold for positive sentiment related to the citation contentif you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified valuepossible values: from 0 to 1default value: 0.4",
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "rank_scale": {
          "anyOf": [
            {
              "description": "defines the scale used for calculating and displaying the 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"
            }
          ]
        },
        "sentiments_connotation_threshold": {
          "anyOf": [
            {
              "description": "sentiment connotation thresholdoptional fieldspecified as the probability index threshold for sentiment connotations related to the citation contentif you specify this field, sentiment_connotations object in the response will only contain data on citations where the probability per each sentiment is more than or equal to the specified valuepossible values: from 0 to 1default value: 0.4",
              "type": "number"
            },
            {
              "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/ContentAnalysisRatingDistributionLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}