Phrase Trends Live

{
  "$defs": {
    "ContentAnalysisPhraseTrendsLiveRequestInfo": {
      "properties": {
        "date_from": {
          "description": "starting date of the time rangerequired fielddate format: \"yyyy-mm-dd\"example:\"2019-01-15\"",
          "type": "string"
        },
        "date_group": {
          "anyOf": [
            {
              "description": "time range which will be used to group the resultsoptional fielddefault value: monthpossible values: day, week, month",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "date_to": {
          "anyOf": [
            {
              "description": "ending date of the time rangeoptional fieldif you don't specify this field, today's date will be used by defaultdate format: \"yyyy-mm-dd\"example:\"2019-01-15\"",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "initial_dataset_filters": {
          "anyOf": [
            {
              "description": "initial dataset filtering parametersoptional fieldinitial filtering parameters that apply to fields in the Search endpoint;you can add several filters at once (8 filters maximum);you should set a logical operator and, or between the conditions;the 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 characters;example",
              "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"
            }
          ]
        },
        "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 data on all citations for the target keywordone_per_domain - returns data on 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/ContentAnalysisPhraseTrendsLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}