Llm Mentions Multi Target Metrics Live

{
  "$defs": {
    "AiOptimizationLLmMentionsMultiTargetMetricsRequestInfo": {
      "properties": {
        "key": {
          "anyOf": [
            {
              "description": "key for grouping the results required field groups results for comparison and serves as a label for the group; you can specify up to 250 characters in the key field",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "target": {
          "anyOf": [
            {
              "items": {
                "anyOf": [
                  {
                    "oneOf": [
                      {
                        "$ref": "#/$defs/BaseAiOptimizationLLmMentionsTargetElement"
                      }
                    ],
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    },
    "AiOptimizationLlmMentionsMultiTargetMetricsLiveRequestInfo": {
      "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:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_matchyou can use the % operator with like and not_like to match any string of zero or more charactersexample:[\"ai_search_volume\",\">\",1000]The full list of possible filters is available here.",
              "items": {
                "anyOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "initial_dataset_filters": {
          "anyOf": [
            {
              "description": "array of filter expressions applied before aggregationoptional fieldyou can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:=, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_matchyou can use the % operator with like and not_like to m",
              "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:sources_domainsearch_results_domainminimum value: 1maximum value: 10default value: 5",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "language_code": {
          "anyOf": [
            {
              "description": "search language codeoptional fieldif you use this field, you don't need to specify language_name;you can receive the list of available languages of the search engine with their language_code by making a separate request to the value: enNote: chat_gpt data is available for en only",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "language_name": {
          "anyOf": [
            {
              "description": "full name of search languageoptional fieldif you use this field, you don't need to specify language_code;if you don't specify this field, the language_code with en value will be used by default;you can receive the list of available languages of the search engine with their language_name by making a separate request to the chat_gpt data is available for English only",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "limit": {
          "anyOf": [
            {
              "description": "the maximum number of returned objectsoptional fielddefault value: 100maximum value: 1000",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "location_code": {
          "anyOf": [
            {
              "description": "search location codeoptional fieldif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engine with their location_code by making a separate request to the value: 2840Note: chat_gpt data is available for 2840 only",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "location_name": {
          "anyOf": [
            {
              "description": "full name of search locationoptional fieldif you use this field, you don't need to specify location_codeif you don't specify this field, the location_code with 2840 value will be used by default;you can receive the list of available locations of the search engine with their location_name by making a separate request to the chat_gpt data is available for United States only",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "offset": {
          "anyOf": [
            {
              "description": "offset in the results array of the returned mentions dataoptional fielddefault value: 0example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;Note: the maximum value is 1000000, use the search_after_token if you would like to offset more results",
              "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:[\"ai_search_volume,desc\"]Note: you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rules",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "platform": {
          "anyOf": [
            {
              "description": "target platformoptional fieldpossible values:chat_gpt, googledefault value: googleNote: if the platform is not specified, the data is returned for both platformsNote #2:chat_gpt data is available for the United States and English only",
              "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"
            }
          ]
        },
        "targets": {
          "anyOf": [
            {
              "items": {
                "anyOf": [
                  {
                    "oneOf": [
                      {
                        "$ref": "#/$defs/AiOptimizationLLmMentionsMultiTargetMetricsRequestInfo"
                      }
                    ],
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    },
    "BaseAiOptimizationLLmMentionsTargetElement": {
      "properties": {
        "search_filter": {
          "anyOf": [
            {
              "description": "target domain search filter optional field possible values: include, exclude default value: include",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "search_scope": {
          "anyOf": [
            {
              "description": "target domain search scope optional field possible values: any, sources, search_results default value: any",
              "items": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/AiOptimizationLlmMentionsMultiTargetMetricsLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}